Вы находитесь на странице: 1из 3190

Alcatel-Lucent 7302

INTELLIGENT SERVICES ACCESS MANAGER

Alcatel-Lucent 7330
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE NODE

Alcatel-Lucent 7356
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE BUILDING
CLI COMMAND GUIDE FOR FD 24GBPS NT
R E LE ASE 5.1

3 H H-0 4 4 16-EBAA-TCZZA Edi ti on 0 1 Rel eas ed

Alcatel-Lucent Proprietary
This document contains proprietary information of Alcatel-Lucent and is not to be disclosed
or used except in accordance with applicable agreements.
Copyright 2014 Alcatel-Lucent. All rights reserved.

Status
Change Note
Short Title

Released

Released
CD CLI CMD GUIDE
All rigths reserved. Passing on and copying of this
document, use and communication of its contents not
permitted without written authorization from
Alcatel-Lucent.

3HH-04416-EBAA-TCZZA

01

Contents

Contents
1- ISAM CLI

1.1 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3 CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4 Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8 Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9 The CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . .
1.10 Entering CLI Commands . . . . . . . . . . . . . . . . . . . .
1.11 CLI Backward Compatibility . . . . . . . . . . . . . . . . . .
1.12 Phase Out Strategy Obsolete Commands and/or Parameters
1.13 Command Phase Out Annoucement Release . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

2- Environment Configuration Commands

2
41
42
43
44
47
48
49
50
51
52
54
55

56

2.1 Environment Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 57


2.2 Environment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

3- Alarm Configuration Commands


3.1 Alarm Configuration Command Tree . . . . . . . . .
3.2 Alarm Log Configuration Command . . . . . . . . . .
3.3 Alarm Entry Configuration Command . . . . . . . . .
3.4 Alarm Delta Log Configuration Command . . . . . .
3.5 SHub Alarm Configuration Command . . . . . . . . .
3.6 Customizable Alarm Profile Configuration Command
3.7 Alarm Filter Configuration Command . . . . . . . . .

60
.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

4- Trap Configuration Commands

.
.
.
.
.
.
.

61
63
65
83
85
88
93

111

4.1 Trap Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112


4.2 Trap Definition Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
4.3 Trap Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

5- Equipment Configuration Commands


5.1 Equipment Configuration Command Tree . . . . . . . . . . . .
5.2 Rack Configuration Command . . . . . . . . . . . . . . . . . . .
5.3 Shelf Configuration Command . . . . . . . . . . . . . . . . . . .
5.4 Slot Configuration Command . . . . . . . . . . . . . . . . . . .
5.5 Applique Configuration Command . . . . . . . . . . . . . . . . .
5.6 Protection Group Configuration Command . . . . . . . . . . . .
5.7 Protection Element Configuration Command . . . . . . . . . . .
5.8 External-link-host Configuration Commands . . . . . . . . . . .
5.9 Host Shelf SFP Configuration Commands . . . . . . . . . . . .
5.10 2xE1/DS1 CLOCK configuration Command . . . . . . . . . . .
5.11 2xE1/DS1 Pseudo Wire TDM Interface configuration Command
5.12 2xE1/DS1 Pseudo Wire TDM SFP configuration Command . .
5.13 2xE1/DS1 Framer configuration Command . . . . . . . . . . .
5.14 2xE1/DS1 Line Interface Unit SFP configuration Command . .
5.15 NE Configuration Command . . . . . . . . . . . . . . . . . . .
5.16 Environment Monitoring Configuration Command . . . . . . .

3HH-04416-EBAA-TCZZA 01

120
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

121
123
124
126
128
130
131
133
135
137
139
141
144
148
151
152

Contents

5.17 Configure Fan Tray parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

6- Port Protection Configuration Commands

154

6.1 Port Protection Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . 155


6.2 Port Protection Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

7- xDSL Configuration Commands

158

7.1 xDSL Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . .


7.2 xDSL Common Service Profile Configuration Command . . . . . . . . . . . .
7.3 xDSL Common Spectrum Profile Configuration Command . . . . . . . . . . .
7.4 xDSL Artificial Noise Downstream Configuration Command . . . . . . . . . . .
7.5 xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command . . . . . . .
7.6 xDSL Spectrum Profile for RE-ADSL2 Configuration Command . . . . . . . .
7.7 xDSL Spectrum Profile for ADSL2 Plus Configuration Command . . . . . . . .
7.8 ADSL2-plus Custom PSD shape Configuration Command . . . . . . . . . . .
7.9 xDSL Spectrum Profile for VDSL Configuration Command . . . . . . . . . . .
7.10 VDSL Ghs Tones Transmission Power Control Configuration Command . . .
7.11 VDSL Custom PSD shape Downstream Configuration Command . . . . . . .
7.12 VDSL Custom RX PSD shape Upstream Configuration Command . . . . . .
7.13 VDSL Power Back Off Configuration Command . . . . . . . . . . . . . . . .
7.14 xDSL Spectrum Profile for VDSL2 Configuration Command . . . . . . . . . .
7.15 VDSL2 Custom PSD shape Downstream Configuration Command . . . . . .
7.16 VDSL2 Custom PSD shape Upstream Configuration Command . . . . . . . .
7.17 VDSL2 Custom RX PSD shape Upstream Configuration Command . . . . . .
7.18 VDSL2 Virtual Noise Downstream Configuration Command . . . . . . . . . .
7.19 VDSL2 Virtual Noise Upstream Configuration Command . . . . . . . . . . . .
7.20 VDSL2 Power Back Off Configuration Command . . . . . . . . . . . . . . . .
7.21 xDSL DPBO Profile Configuration Command . . . . . . . . . . . . . . . . . .
7.22 xDSL DPBO Mode Independent Custom PSD Mask Configuration Command
7.23 xDSL DPBO Exchange PSD Mask Configuration Command . . . . . . . . . .
7.24 xDSL RTX Profile Configuration Command . . . . . . . . . . . . . . . . . . .
7.25 xDSL Vectoring Profile Configuration Command . . . . . . . . . . . . . . . .
7.26 xDSL Vectoring Control Entity Profile Configuration Command . . . . . . . .
7.27 xDSL Board Configuration Command . . . . . . . . . . . . . . . . . . . . . .
7.28 xDSL Board Vectoring Fallback Configuration Command . . . . . . . . . . .
7.29 xDSL Vectoring Processing Board Configuration Command . . . . . . . . . .
7.30 xDSL Line Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
7.31 xDSL Line TCA Threshold Configuration Command . . . . . . . . . . . . . .
7.32 xDSL Per Line Overrule Configuration Command . . . . . . . . . . . . . . .
7.33 xDSL Overrule Noise Psd Shape Downstream Configuration Command . . .
7.34 xDSL Overrule Noise Psd Shape Upstream Configuration Command . . . . .
7.35 xDSL INS Near End Configuration Command . . . . . . . . . . . . . . . . . .
7.36 xDSL INS Far End Configuration Command . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

8- ATM Configuration Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

160
168
172
178
180
183
185
189
191
198
200
202
204
205
211
213
215
217
219
221
223
225
227
229
233
236
239
242
245
247
252
255
262
264
266
268

270

8.1 ATM Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271


8.2 ATM PVC Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
8.3 IPOA X-connect L2 interworking port Configuration Command . . . . . . . . . . . . . . . . 274

9- Interface Management Configuration Commands


9.1 Interface Management Configuration Command Tree .
9.2 Network Interface Configuration Command . . . . . . .
9.3 Extend Interface Configuration Command . . . . . . .
9.4 Interface Alarm Configuration Command . . . . . . . .
9.5 SHub Management Interface Configuration Command
9.6 SHub IP Configuration Command . . . . . . . . . . . .
9.7 SHub ICMP Configuration Command . . . . . . . . . .

ii

Released

.
.
.
.
.
.
.

.
.
.
.
.
.
.

276
.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

277
279
283
284
286
287
288

01

Contents

9.8 SHub Multi-Network Configuration Command . . . . . . . . . .


9.9 SHub Unnumbered Interface Configuration Command . . . . .
9.10 SHub External Voice forwarding Configuration Command . . .
9.11 SHub Port Control Configuration Command . . . . . . . . . . .
9.12 SHub Interface Uplink Group Configuration Command . . . . .
9.13 SHub Interface Uplink Group Portlist Configuration Command .
9.14 SHub System Port Mirroring Configuration Command . . . . .
9.15 SHub External-Traffic-Mirroring Configuration Command . . .
9.16 SHub Internal-Traffic-Mirroring Configuration Command . . . .
9.17 SHub System Voice Traffic Mirroring Configuration Command
9.18 Ingress Port List Configuration Command . . . . . . . . . . . .
9.19 Egress Port List Configuration Command . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

10- Error Configuration Commands

.
.
.
.
.
.
.
.
.
.
.
.

289
290
291
292
294
295
296
297
299
301
303
304

305

10.1 Error Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306


10.2 Error Log Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

11- System Configuration Commands

308

11.1 System Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . .


11.2 System Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . .
11.3 System Management IP related Configuration Command . . . . . . . . . . .
11.4 System Management Vlan Host IP-Address Configuration Command . . . . .
11.5 System Management Default Route Configuration Command . . . . . . . . .
11.6 System SNTP Configuration Command . . . . . . . . . . . . . . . . . . . . .
11.7 System SNTP Server Table Configuration Command . . . . . . . . . . . . .
11.8 System Loop ID Syntax Configuration Command . . . . . . . . . . . . . . . .
11.9 SHub System ICMP Filter Configuration Command . . . . . . . . . . . . . .
11.10 SHub System ICMP Filter In Port List Configuration Command . . . . . . .
11.11 SHub System ICMP Filter Out Port List Configuration Command . . . . . .
11.12 SHub System TCP Filter Configuration Command . . . . . . . . . . . . . .
11.13 SHub System TCP Filter In Port List Configuration Command . . . . . . . .
11.14 SHub System TCP Filter Out Port List Configuration Command . . . . . . .
11.15 SHub System UDP Filter Configuration Command . . . . . . . . . . . . . .
11.16 SHub System UDP Filter In Port List Configuration Command . . . . . . . .
11.17 SHub System UDP Filter Out Port List Configuration Command . . . . . . .
11.18 SHub System Other Protocol Filter Configuration Command . . . . . . . . .
11.19 SHub System Other Protocol Filter In Port List Configuration Command . .
11.20 SHub System Other Protocol Filter Out Port List Configuration Command . .
11.21 SHub System Other Protocol Filter Ip-filter In-port Configuration Command .
11.22 SHub System Other Protocol Filter Ip-filter Out-port Configuration Command
11.23 SHub System ID Configuration Command . . . . . . . . . . . . . . . . . . .
11.24 SHub System VLAN Group Configuration Command . . . . . . . . . . . . .
11.25 SHub System ICMP Configuration Command . . . . . . . . . . . . . . . . .
11.26 System Clock Configuration Command . . . . . . . . . . . . . . . . . . . .
11.27 System Synchronous Interface Timing Clock Configuration Command . . .
11.28 System Clock Bits Mode Configuration Command . . . . . . . . . . . . . .
11.29 System Clock Source Priority Configuration Command . . . . . . . . . . . .
11.30 System Clock Synchronous Status Message Configuration Command . . .
11.31 System Clock Synchronous Source port Configuration Command . . . . . .
11.32 System Clock Force Reference Configuration Command . . . . . . . . . . .
11.33 SSMOut Configuration Command for synce ports . . . . . . . . . . . . . . .
11.34 SSMOut Configuration Command for XDSL ports . . . . . . . . . . . . . . .
11.35 Maximum Lt Link Speed Configuration Command . . . . . . . . . . . . . . .
11.36 ALS State Configuration Command . . . . . . . . . . . . . . . . . . . . . .
11.37 Configure system auto-switch . . . . . . . . . . . . . . . . . . . . . . . . .

12- Security Configuration Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

310
313
316
317
318
319
320
321
323
326
327
329
332
333
335
338
339
341
344
345
347
350
353
354
355
356
358
361
362
363
366
368
369
371
373
374
375

376

12.1 Security Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

3HH-04416-EBAA-TCZZA 01

Released

iii

Contents

12.2 Security Banner Configuration Commmand . . . . . . . . . . . . . . . . .


12.3 Operator Configuration Command . . . . . . . . . . . . . . . . . . . . . .
12.4 Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
12.5 Default Profile Configuration Command . . . . . . . . . . . . . . . . . . .
12.6 SNMP View Configuration Command . . . . . . . . . . . . . . . . . . . .
12.7 Security SNMP Community Configuration Command . . . . . . . . . . . .
12.8 Security SNMPv3 Group Configuration Command . . . . . . . . . . . . .
12.9 Security SNMPv3 User Configuration Command . . . . . . . . . . . . . .
12.10 Security SNMPv3 User-Group Configuration Command . . . . . . . . .
12.11 SNMP Notify View Configuration Command . . . . . . . . . . . . . . . .
12.12 Security SNMP Notification Profile Configuration Command . . . . . . .
12.13 Security SNMP Notification Profile Filter Configuration Command . . . .
12.14 Security SNMP Element Manager Configuration Command . . . . . . .
12.15 Security RADIUS Client Configuration Command . . . . . . . . . . . . .
12.16 Security RADIUS Authentication Server Configuration Command . . . .
12.17 Security RADIUS Accounting Server Configuration Command . . . . . .
12.18 Security RADIUS Dynamic Authorization Client Configuration Command
12.19 Security RADIUS Policy Configuration Command . . . . . . . . . . . . .
12.20 Security RADIUS Server Configuration Command . . . . . . . . . . . .
12.21 Security Domain Configuration Command . . . . . . . . . . . . . . . . .
12.22 Security Connection Profile Configuration Command . . . . . . . . . . .
12.23 Security Connection Policy Configuration Command . . . . . . . . . . .
12.24 Security 802.1x PAE System Configuration Command . . . . . . . . . .
12.25 Security 802.1x Port Authentication Configuration Command . . . . . .
12.26 Security 802.1x Extension, Port Authentication Configuration Command
12.27 Security 802.1x Port Configuration Command . . . . . . . . . . . . . . .
12.28 Security Password Policy Configuration Commmand . . . . . . . . . . .
12.29 File Transfer Configure Command . . . . . . . . . . . . . . . . . . . . .
12.30 file Transfer server Configure Commands . . . . . . . . . . . . . . . . .
12.31 PM File Upload Configure Command . . . . . . . . . . . . . . . . . . .
12.32 PM File Upload Configure Command . . . . . . . . . . . . . . . . . . .
12.33 MAC Filter Configuration Command . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

13- Secure Shell Configuration Commands


13.1 Secure Shell Configuration Command Tree . . . .
13.2 SSH Server Configuration Command . . . . . . .
13.3 Secure Shell User Configuration Command . . . .
13.4 Secure Shell Access Configuration Command . .
13.5 Secure Shell SFTP User Configuration Command

382
383
385
392
398
400
402
405
407
409
411
413
415
417
418
420
422
424
426
428
430
431
432
433
436
438
440
442
443
444
445
447

448
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

14- Transaction Configuration Commands

449
450
451
452
454

455

14.1 Transaction Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 456


14.2 Transaction Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

15- SYSLOG Configuration Commands

458

15.1 SYSLOG Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459


15.2 SYSLOG Destination Configuration command . . . . . . . . . . . . . . . . . . . . . . . . 460
15.3 SYSLOG Route Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

16- PCCP Configuration Commands

465

16.1 PCCP Configuration Command Tree . . . . . . . . . . . . . . . . .


16.2 SHub PCCP Module Configuration Command . . . . . . . . . . . .
16.3 SHub PCCP Group Entry Configuration Command . . . . . . . . . .
16.4 SHub Static network Port for PCCP Group Configuration Command

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

17- Software Management Configuration Commands

iv

Released

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

466
467
468
470

471

3HH-04416-EBAA-TCZZA

01

Contents

17.1 Software Management Configuration Command Tree . . . . . . . . . . . . . . . . . . . . 472


17.2 Software Management Overall Software Package Configuration Command . . . . . . . . 473
17.3 Database Automatic Activation Configure Command . . . . . . . . . . . . . . . . . . . . . 476

18- Ethernet Configuration Commands


18.1 Ethernet Configuration Command Tree . . . . . . . . . . . .
18.2 Ethernet IP Configuration Command . . . . . . . . . . . . .
18.3 SHub Ethernet MAC Filter Configuration Command . . . . .
18.4 SHub Ethernet MAC Filter Port List Configuration Command
18.5 SHub Ethernet MAC Filter Configuration Command . . . . .
18.6 SHub Ethernet Rate Configuration Command . . . . . . . .

478
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

19.1 QoS Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .


19.2 QoS Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.3 QoS 802.1P Class-to-Queue Mapping Configuration Command . . . . . . . . . . . .
19.4 QoS Dsl Control Pkt Policer Configuration Command . . . . . . . . . . . . . . . . .
19.5 QoS Nni Control Pkt Policer Configuration Command . . . . . . . . . . . . . . . . .
19.6 QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command .
19.7 QoS Queue Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . .
19.8 QoS Scheduler Node Profile Configuration Command . . . . . . . . . . . . . . . . .
19.9 QoS CAC Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
19.10 QoS Single Dot1P Marker Configuration Command . . . . . . . . . . . . . . . . . .
19.11 QoS Single DSCP Marker Configuration Command . . . . . . . . . . . . . . . . . .
19.12 QoS DSCP Contract Table Marker Configuration Command . . . . . . . . . . . . .
19.13 QoS DSCP Contract Table Code-point Configuration Command For DSCP-contract
19.14 QoS Dot1P and DSCP Contract Table Marker Configuration Command . . . . . . .
19.15 DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract .
19.16 QoS Dot1P and Single DSCP Marker Configuration Command . . . . . . . . . . .
19.17 QoS Dot1P Alignment Marker Configuration Command . . . . . . . . . . . . . . . .
19.18 QoS Dot1P Remark Table Marker Configuration Command . . . . . . . . . . . . .
19.19 QoS Dot1P Remark Table Dot1p-value Configuration Command For Dot1P-Remark
19.20 QoS Policer Profile Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.21 QoS L2 Filter Profile Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.22 QoS L3 Filter Profile Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.23 QoS Policy Action Profile Configuration Command . . . . . . . . . . . . . . . . . .
19.24 QoS Policy Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . .
19.25 QoS Session Profile Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.26 QoS Session Upstream Policy List Configuration Command . . . . . . . . . . . . .
19.27 QoS Session Downstream Policy List Configuration Command . . . . . . . . . . .
19.28 QoS Shaper Profile Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.29 QoS Bandwidth Profile Configuration Command . . . . . . . . . . . . . . . . . . .
19.30 QoS IngressQoS Profile Configuration Command . . . . . . . . . . . . . . . . . . .
19.31 QoS Rate Limit Profile Configuration Command . . . . . . . . . . . . . . . . . . . .
19.32 QoS DSCP to Pbit Mapping Profile Configuration Command . . . . . . . . . . . . .
19.33 QoS DSCP to Pbit Mapping Profile Configuration Command . . . . . . . . . . . . .
19.34 QoS Board-Level Queue and Performance Configuration Command . . . . . . . .
19.35 QoS Queue Threshold Crossing Alarm Configuration Command . . . . . . . . . . .
19.36 QoS DSL Link Configuration Command . . . . . . . . . . . . . . . . . . . . . . . .
19.37 QoS LIM Queue Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
19.38 QoS ShdSL Link Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
19.39 QoS LIM Queue (SHDSL) Configuration Command . . . . . . . . . . . . . . . . . .
19.40 QoS Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . .
19.41 QoS Interface Queue Configuration Command . . . . . . . . . . . . . . . . . . . .
19.42 QoS Interface Upstream Queue Configuration Command . . . . . . . . . . . . . .
19.43 QoS Interface Remote Downstream Queue Configuration Command . . . . . . . .
19.44 SHub QoS Traffic Class Configuration Command . . . . . . . . . . . . . . . . . . .
19.45 SHub QoS Queue Configuration Command . . . . . . . . . . . . . . . . . . . . . .
19.46 SHub QoS DSCP2P Map Configuration Command . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

19- QoS Configuration Commands

3HH-04416-EBAA-TCZZA 01

479
480
481
483
485
487

489

Released

491
497
499
501
503
504
505
508
510
512
513
514
515
516
517
518
519
521
522
523
526
528
531
533
535
538
539
540
542
544
547
550
551
552
554
557
559
561
563
565
570
573
577
580
581
583

Contents

19.47 SHub QoS Flow Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 584


19.48 SHub QoS Policer Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 586
19.49 SHub QoS Ingress Policing on Port Configuration Command . . . . . . . . . . . . . . . 588
19.50 QoS Line Control Packets Rate Limit Configuration Command . . . . . . . . . . . . . . . 589
19.51 P-bit Based Scheduling For SC Forwarder Cross Connect/Residential Bridge Configuration
591
Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20- VLAN Configuration Commands

593

20.1 VLAN Configuration Command Tree . . . . . . . . . . . . . . . . . . .


20.2 VLAN General Configuration Command . . . . . . . . . . . . . . . . . .
20.3 Virtual MAC Configuration Command . . . . . . . . . . . . . . . . . . .
20.4 VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . . .
20.5 VLAN Filtering Database Configuration Command . . . . . . . . . . . .
20.6 VLAN Port Filtering Database Configuration Command . . . . . . . . .
20.7 VLAN Protocol-based Configuration Command . . . . . . . . . . . . . .
20.8 SHub General VLAN Configuration Command . . . . . . . . . . . . . .
20.9 SHub VLAN Configuration Command . . . . . . . . . . . . . . . . . . .
20.10 SHub Static Egress Port for VLAN Configuration Command . . . . . .
20.11 SHub Static Untagged Egress Port for VLAN Configuration Command
20.12 SHub Unicast MAC Filtering Database Configuration Command . . . .
20.13 Vlan Pbit Traffic Counter Configuration Command . . . . . . . . . . .
20.14 Vlan Priority Regeneration Profile Configuration Command . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

21- Bridge Configuration Commands


21.1 Bridge Configuration Command Tree . . . . . . . . . . .
21.2 Bridge General Configuration Command . . . . . . . . .
21.3 Bridge Port Configuration Command . . . . . . . . . . .
21.4 Bridge Port to VLAN Association Configuration Command
21.5 L2 Static User Ip Address Configuration Command . . . .
21.6 L2 Static User Ipv6 Address Configuration Command . .
21.7 SHub Bridge Configuration Command . . . . . . . . . . .
21.8 SHub Bridge Port Configuration Command . . . . . . . .
21.9 Mac learning Configuration Command . . . . . . . . . . .

594
596
597
598
605
607
610
613
614
616
618
619
621
624

626
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

22- Link Aggregation Configuration Commands

627
629
630
636
642
644
646
647
649

650

22.1 Link Aggregation Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . 651


22.2 Link Aggregation Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 652
22.3 Link Aggregation Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 653

23- Multiple Spanning Tree Configuration Commands

656

23.1 Multiple Spanning Tree Configuration Command Tree . . . .


23.2 SHub MSTP general configuration Command . . . . . . . .
23.3 SHub MSTP Instance configuration Command . . . . . . . .
23.4 SHub MSTP Vlan-Instance Mapping configuration Command
23.5 SHub MSTP Port configuration Command . . . . . . . . . .
23.6 SHub MSTP Port-Instance configuration Command . . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

24- IP Configuration Commands


24.1 IP Configuration Command Tree . . . . . . . . . . . . . . .
24.2 VLAN Bundle Configuration Command . . . . . . . . . . .
24.3 VRF Configuration Command . . . . . . . . . . . . . . . .
24.4 IP Interface Network Configuration Command . . . . . . .
24.5 IP Interface Network Numbered Configuration Command .
24.6 IP Interface User Port Configuration Command . . . . . . .
24.7 IP User Port ARP Proxy Statistics Configuration Command
24.8 IP Interface User Bridge Port Configuration Command . . .

vi

Released

657
658
660
661
662
664

666
.
.
.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

667
669
670
672
673
674
676
678

01

Contents

24.9 IP User Gateway Interface VRF Configuration Command


24.10 VRF Route Configuration Command . . . . . . . . . . .
24.11 IP SHub VRF Configuration Command . . . . . . . . .
24.12 IP SHub VRF Route Map Command . . . . . . . . . . .
24.13 IP SHub VRF Route Preference Command . . . . . . .
24.14 IP SHub VRF Route Configuration Command . . . . . .
24.15 IP SHub VRF ARP Configuration Command . . . . . . .
24.16 IP SHub ARP Configuration Command . . . . . . . . .
24.17 IP SHub ARP per VLAN Configuration Command . . . .
24.18 IP SHub VRF Route Preference Command . . . . . . .

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

25- ARP-RELAY Configuration Commands

.
.
.
.
.
.
.
.
.
.

680
681
683
685
687
688
690
691
692
693

694

25.1 ARP-RELAY Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 695


25.2 Arp-Relay Statistics Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 696

26- IGMP Configuration Commands

698

26.1 IGMP Configuration Command Tree . . . . . . . . . . . . . . . . . . . .


26.2 IGMP Channel Configuration Command . . . . . . . . . . . . . . . . .
26.3 IGMP Channel Permission Package Members Configuration Command
26.4 IGMP Channel Preview Package Members Configuration Command . .
26.5 IGMP Package Bitmaps Configuration Command . . . . . . . . . . . .
26.6 IGMP System Configuration Command . . . . . . . . . . . . . . . . . .
26.7 IGMP System CDR Type Configuration Command . . . . . . . . . . . .
26.8 IGMP Vlan System Configuration Command . . . . . . . . . . . . . . .
26.9 SHub IGMP IGS System Configuration Command . . . . . . . . . . . .
26.10 SHub IGMP Response Timer Configuration Command . . . . . . . . .
26.11 SHub IGMP Router Port Configuration Command . . . . . . . . . . . .
26.12 SHub IGMP VLAN Filter Configuration Command . . . . . . . . . . . .
26.13 Shub IGMP Vlan enhanced performance Configuration Command . .
26.14 Shub IGMP CAC BUNDLE TABLE Configuration Command . . . . . .
26.15 IGMP Multicast Vlan Translation Command . . . . . . . . . . . . . . .
26.16 IGMP Multicast Pon Vlan Translation Command . . . . . . . . . . . .
26.17 Igmp Multicast Service Context Configuration Command . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

27- Multicast Configuration Commands


27.1 Multicast Configuration Command Tree . . . . . . . . . . . . .
27.2 Multicast General Group Configuration Command . . . . . . .
27.3 General Multicast Package Members Configuration Command
27.4 Multicast Capacity Configuration Command . . . . . . . . . . .
27.5 Multicast Channel Configuration Command . . . . . . . . . . .
27.6 Multicast Channel Package Members Configuration Command
27.7 Multicast Channel Configuration Command . . . . . . . . . . .
27.8 Multicast Channel Package Members Configuration Command
27.9 Multicast Monitoring Source Configuration Command . . . . .
27.10 Multicast Monitoring Channel Configuration Command . . . .
27.11 Multicast Static Branch Configuration Command . . . . . . .
27.12 SHub IGMP CAC Multicast System Configuration Command .
27.13 SHub Static Multicast Streams Configuration Command . . .
27.14 SHub Static Multicast Egress Port Configuration Command .
27.15 SHub IGMP CAC Multicast Sources Configuration Command

732
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

28.1 PPPoX-Relay Configuration Command Tree . . . . . . . . . . . .


28.2 PPPoX Cross-connect Global Configuration Command . . . . . .
28.3 PPPoX Cross-connect Engine Configuration Command . . . . . .
28.4 PPPoX Cross-connect Engine Monitoring Configuration Command
28.5 PPPCC Engine TCA Threshold Configuration Command . . . . .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

28- PPPoX-Relay Configuration Commands

3HH-04416-EBAA-TCZZA 01

699
702
707
710
713
715
718
719
720
722
723
724
727
728
729
730
731

733
735
737
738
739
741
742
744
745
746
747
749
750
751
753

755

Released

756
757
759
761
762

vii

Contents

28.6 PPPoX Cross-connect Client Port Configuration Command . . . . . . . . . . . . . . . . . 764


28.7 PPPoX Cross-connect Client Port Monitoring Configuration Command . . . . . . . . . . . 767

29- PPPoE Configuration Commands

770

29.1 PPPoE Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771


29.2 PPPoE Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
29.3 PPPoE Client Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 774

30- DHCP Relay Configuration Commands

776

30.1 DHCP Relay Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . .


30.2 DHCP Relay User Port Configuration Command . . . . . . . . . . . . . . . . . . .
30.3 DHCP Relay Agent Configuration Command . . . . . . . . . . . . . . . . . . . . .
30.4 DHCP Relay SHub Configuration Command . . . . . . . . . . . . . . . . . . . . .
30.5 DHCP Relay SHub Server Configuration Command per VRF . . . . . . . . . . . .
30.6 DHCP Relay SHub Agent Configuration Command per VRF . . . . . . . . . . . . .
30.7 DHCP Relay SHub Configuration Command per VRF . . . . . . . . . . . . . . . .
30.8 DHCP Relay SHub Server Configuration Command per VRF . . . . . . . . . . . .
30.9 DHCP Relay SHub Agent Instances Configuration Command per VRF . . . . . . .
30.10 DHCP Relay SHub Server Configuration Command per VRF and Agent instance
30.11 DHCP Relay SHub Agent Interface Association Command . . . . . . . . . . . . .
30.12 DHCP v6 Relay User Port Configuration Command . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

31- OSPF Configuration Commands


.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

32- RIP Configuration Commands

viii

Released

777
779
782
784
785
786
788
789
790
792
793
794

796

31.1 OSPF Configuration Command Tree . . . . . . . . .


31.2 OSPF Parameters Configuration Command . . . . .
31.3 OSPF Area Configuration Command . . . . . . . . .
31.4 OSPF Interface Configuration Command . . . . . . .
31.5 OSPF Interface Timers Configuration Command . . .
31.6 OSPF Interface MD5 Key Configuration Command . .
31.7 OSPF Interface Metric Configuration Command . . .
31.8 OSPF Aggregate Configuration Command . . . . . .
31.9 OSPF External Aggregate Configuration Command .
31.10 OSPF Stub Area Configuration Command . . . . . .
31.11 OSPF Interface Configuration Command . . . . . .
31.12 OSPF Interface Timers Configuration Command . .
31.13 OSPF Interface MD5 Key Configuration Command .
31.14 OSPF Interface Metric Configuration Command . . .
31.15 OSPF Stub Aggregate Configuration Command . . .
31.16 OSPF NSSA Area Configuration Command . . . . .
31.17 OSPF Interface Configuration Command . . . . . .
31.18 OSPF Interface Timers Configuration Command . .
31.19 OSPF Interface MD5 Key Configuration Command .
31.20 OSPF Interface Metric Configuration Command . . .
31.21 OSPF NSSA Aggregate Configuration Command . .
31.22 OSPF External Aggregate Configuration Command .
31.23 OSPF Redistribution Configuration Command . . . .
31.24 OSPF Redistribution Route Configuration Command

32.1 RIP Configuration Command Tree . . . . . . . .


32.2 RIP Common Configuration Command . . . . .
32.3 RIP Redistribution Configuration Command . . .
32.4 RIP Interface Configuration Command . . . . .
32.5 RIP Interface Timers Configuration Command .
32.6 RIP Interface MD5 Key Configuration Command
32.7 RIP Interface Route Map Command . . . . . . .
32.8 RIP Route Aggregation Command . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

797
800
802
803
805
807
809
810
811
813
814
816
818
820
821
822
824
826
828
830
831
832
834
835

836
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

837
838
839
840
842
843
845
847

01

Contents

32.9 RIP Route Map Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848

33- Cluster Management Configure Commands

850

33.1 Cluster Management Configure Command Tree . . .


33.2 Cluster System Configuration Command . . . . . . .
33.3 Cluster Neighbor Discovery Configuration Command
33.4 Cluster Topology Collection Configuration Command
33.5 Cluster Port Configuration Command . . . . . . . . .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

34- XDSL Bonding Configuration Commands

851
852
853
854
855

856

34.1 XDSL Bonding Configuration Command Tree . . . . . . . . . . . .


34.2 XDSL Bonding Assembly Timer Configuration Command . . . . .
34.3 xDSL Bonding Group Profile Configuration Command . . . . . . .
34.4 xDSL Bonding Group Rtx Profile Configuration Command . . . . .
34.5 xDSL Bonding Configuration Command . . . . . . . . . . . . . . .
34.6 xDSL Bonding Configuration Command . . . . . . . . . . . . . . .
34.7 xDSL Bonding Board Configuration Command . . . . . . . . . . .
34.8 xDSL Bonding Board Vectoring Fallback Configuration Command

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

35- CPE Remote Configuration Commands

857
859
860
863
867
869
870
871

873

35.1 CPE Remote Configuration Command Tree . . . . . . . . .


35.2 CPE Remote Management System Configuration Commands
35.3 CPE Manager Configuration Command . . . . . . . . . . . .
35.4 CPE IPProxy Session Configuration Command . . . . . . . .
35.5 CPE IPProxy Shub Vlan Configuration Command . . . . . .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

36- SHDSL Configuration Commands


36.1 SHDSL Configuration Command Tree . . .
36.2 SHDSL Span Configuration Command . .
36.3 SHDSL Unit Configuration Command . . .
36.4 SHDSL Segment Configuration Command

.
.
.
.
.

874
875
876
877
878

879
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

37- IMA Configuration Commands

.
.
.
.

880
882
887
889

891

37.1 IMA Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892


37.2 IMA Group Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
37.3 IMA Link Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895

38- L2CP Configuration Commands


38.1 L2CP Configuration Command Tree . . . . . . . .
38.2 L2CP Configuration Command . . . . . . . . . . .
38.3 L2CP Session Configuration Command . . . . . .
38.4 L2CP User Port Partition Configuration Command

896
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

39.1 Voice Configuration Command Tree . . . . . . . . . . . . . . . .


39.2 Voice Sip Server Configuration Commands . . . . . . . . . . . .
39.3 Voice Sip LineId Syntax Profile Configuration Commands . . . .
39.4 Voice Sip User Agent Configuration Commands . . . . . . . . .
39.5 Sip Voice Service Provider Configuration Commands . . . . . .
39.6 Voice Sip User Agent Access Point Configuration Command . .
39.7 Voice Sip Dial Plan Configuration Commands . . . . . . . . . .
39.8 Voice Sip Dial Plan Digitmap Configuration Commands . . . . .
39.9 Voice Sip Termination Configuration Commands . . . . . . . . .
39.10 Voice Sip Termination TCA Threshold Configuration Command
39.11 Sip Voice Register Configuration Commands . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

39- Voice Configuration Commands

3HH-04416-EBAA-TCZZA 01

897
898
899
902

903

Released

904
910
913
915
918
924
926
928
929
934
936

ix

Contents

39.12 Voice Sip Transport Configuration Commands . . . . . . . . . . . . . . . . .


39.13 Voice Sip Redundancy Table Configuration Commands . . . . . . . . . . . .
39.14 Voice Sip System Session Timer Configuration Commands . . . . . . . . . .
39.15 Voice Sip DNS Server Configuration Commands . . . . . . . . . . . . . . . .
39.16 Voice Sip DHCP Authentication Params Configuration Commands . . . . . .
39.17 Voice Sip Restoration Failover/Failback Type/Mode Configuration Commands
39.18 Voice Statistics Configure Command . . . . . . . . . . . . . . . . . . . . . . .
39.19 Voice Cluster Configuration Commands . . . . . . . . . . . . . . . . . . . . .
39.20 Voice Megaco IP Configuration Commands . . . . . . . . . . . . . . . . . . .
39.21 Voice Megaco Equipment Configuration Commands . . . . . . . . . . . . . .
39.22 Voice Megaco Equipment Board Configuration Commands . . . . . . . . . .
39.23 Voice Megaco Equipment Termination Configuration Commands . . . . . . .
39.24 Voice Megaco Termination Configuration Commands . . . . . . . . . . . . .
39.25 Voice Megaco Media Gateway Configuration Commands . . . . . . . . . . .
39.26 Voice Megaco Signal Gateway Configuration Commands . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

40- Debug Configuration Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

938
940
944
946
948
950
951
952
953
955
957
959
963
965
976

978

40.1 Debug Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979


40.2 Protocol Tracing Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 980

41- Ethernet User Ports Configuration Commands


41.1 Ethernet User Ports Configuration Command Tree . . .
41.2 Ethernet Line Configuration Command . . . . . . . . .
41.3 Ethernet Line TCA Threshold Configuration Command
41.4 Ethernet Line Mau Configuration Command . . . . . .

982
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

42- Efm Oam Configuration Commands

.
.
.
.

983
984
985
987

990

42.1 Efm Oam Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . 991


42.2 Efm Oam Interface ConfigurationCommand . . . . . . . . . . . . . . . . . . . . . . . . . . 992

43- CFM Configuration Commands

994

43.1 CFM Configuration Command Tree . . . . . . . . . . . . . . . . . . .


43.2 Maintenance Domain Configuration Command . . . . . . . . . . . . .
43.3 Maintenance Association Configuration Command . . . . . . . . . . .
43.4 Maintenance Association End Point Configuration Command . . . . .
43.5 Remote Maintenance Association End Point Configuration Command
43.6 Synthetic Loss Measurement configuration Commands . . . . . . . .
43.7 CFM PM-Proactive test management Command . . . . . . . . . . . .
43.8 CFM PM Proactive test management Command . . . . . . . . . . . .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

44- Trouble-Shooting Configuration Commands

. 995
. 996
. 998
.1001
.1004
.1005
.1006
.1007

1009

44.1 Trouble-Shooting Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . .1010


44.2 Trouble-shooting Interface Configuration Commands . . . . . . . . . . . . . . . . . . . .1011

45- IPoA/E IW Configuration Commands

1013

45.1 IPoA/E IW Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .1014


45.2 IPoA/E IW Interworking Port Configuration Command . . . . . . . . . . . . . . . . . . . .1015
45.3 IPoA/E IW Gateway Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . .1017

46- LineTest Configuration Commands


46.1 LineTest Configuration Command Tree . . . . . . .
46.2 Megaco LineTest Session Configuration Command
46.3 Megaco LineTest Line Configuration Command . .
46.4 MEGACO LineTest Param Configuration Command
46.5 SINGLE LineTest Session Configuration Command

Released

1018
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.1019
.1021
.1025
.1027
.1032

01

Contents

46.6 SINGLE LineTest Line Configuration Command . . . . . . . . . . . . . . . . . . . . . . .1036


46.7 SINGLE LineTest Param Configuration Command . . . . . . . . . . . . . . . . . . . . . .1038

47- LACP Configuration Commands

1043

47.1 LACP Configuration Command Tree . . .


47.2 LACP general configuration command . .
47.3 LACP port configuration command . . . .
47.4 LACP group configuration command . . .
47.5 LACP Group Port configuration command .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

48- MSTP Configuration Commands

1050

48.1 MSTP Configuration Command Tree . . . . . . . . . .


48.2 MSTP general configuration Command . . . . . . . . .
48.3 MSTP Instance configuration Command . . . . . . . .
48.4 MSTP Vlan-Instance Mapping configuration Command
48.5 MSTP Port configuration Command . . . . . . . . . . .
48.6 MSTP Port-Instance configuration Command . . . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

49- Distributed Router Configuration Commands


49.1 Distributed Router Configuration Command Tree . . .
49.2 Drouter IP Configuration Command . . . . . . . . . .
49.3 Inbound MPLS LSP Configuration Command . . . . .
49.4 Static Outbound MPLS LSP Configuration Command
49.5 SDP Configuration Command . . . . . . . . . . . . .

50.1 Distributed Service Configuration Command Tree


50.2 Distributed Service Configuration Command . . .
50.3 SDP Binding Configuration Command . . . . . . .
50.4 APIPE SDP Binding Configuration Command . . .
50.5 VCL Binding Configuration Command . . . . . . .

.
.
.
.
.

.
.
.
.
.

.1051
.1052
.1054
.1055
.1056
.1058

1060
.
.
.
.
.

50- Distributed Service Configuration Commands


.
.
.
.
.

.1061
.1062
.1064
.1065
.1067

1068

51- Equipment Status Commands


51.1 Equipment Status Command Tree . . . .
51.2 Slot Status Command . . . . . . . . . .
51.3 Profile Description Command . . . . . .
51.4 Applique Status Command . . . . . . . .
51.5 Shelf Summary Status Command . . . .
51.6 Protection Element Status Command . .
51.7 Protection Group Status Command . . .
51.8 External-link-host Status Commands . .
51.9 External-link-remote Status Commands .
51.10 SFP/XFP Diagnostics Status Command
51.11 Sfp RSSI Configuration Command . . .
51.12 Board Temperature Status Command .
51.13 Board Planned Resource Command . .
51.14 Transceiver Inventory Status Command
51.15 NE Status Command . . . . . . . . . .
51.16 Rack Status Command . . . . . . . . .
51.17 Shelf Status Command . . . . . . . . .

.1044
.1045
.1046
.1047
.1049

.1069
.1070
.1072
.1073
.1074

1076
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

52- Protection Group Status Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1077
.1078
.1083
.1084
.1088
.1090
.1093
.1096
.1100
.1103
.1109
.1110
.1112
.1114
.1119
.1121
.1123

1126

52.1 Protection Group Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .1127


52.2 Protection Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1128

3HH-04416-EBAA-TCZZA 01

Released

xi

Contents

53- Trap Status Commands

1130

53.1 Trap Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1131


53.2 Trap Manager Queue Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1132

54- Alarm Log Status Commands

1133

54.1 Alarm Log Status Command Tree . . . . . . . . . . . . . . . .


54.2 Alarm Log Status Command . . . . . . . . . . . . . . . . . . .
54.3 Equipment Alarm Log Status Command . . . . . . . . . . . . .
54.4 Equipment Holder Alarm Log Status Command . . . . . . . . .
54.5 Equipment Holder Extended Alarm Log Status Command . . .
54.6 Plug-in Unit Alarm Log Status Command . . . . . . . . . . . .
54.7 ATM Alarm Log Status Command . . . . . . . . . . . . . . . .
54.8 Ethernet Interface Alarm Log Status Command . . . . . . . . .
54.9 Software Management Alarm Log Status Command . . . . . .
54.10 Temporal Filter Alarm Log Status Command . . . . . . . . .
54.11 Spatial Filter Alarm Log Status Command . . . . . . . . . . .
54.12 xDSL Common Alarm Log Status Command . . . . . . . . .
54.13 xDSL Near-end Alarm Log Status Command . . . . . . . . .
54.14 xDSL Far-end Alarm Log Status Command . . . . . . . . . .
54.15 TCA xDSL Alarm Log Status Command . . . . . . . . . . . .
54.16 Vectoring Line Alarm Log Status Command . . . . . . . . . .
54.17 Vectoring Board Alarm Log Status Command . . . . . . . . .
54.18 Electrical-to-Optical Conversion Alarm Log Status Command
54.19 Authentication Alarm Log Status Command . . . . . . . . . .
54.20 xDSL Bonding Alarm Log Status Command . . . . . . . . . .
54.21 Redundancy Alarm Log Status Command . . . . . . . . . . .
54.22 Custom Alarm Log Status Command . . . . . . . . . . . . . .
54.23 SFP Alarm Log Status Command . . . . . . . . . . . . . . .
54.24 Custom External Alarm Log Status Command . . . . . . . . .
54.25 SFP RSSI for NT Alarm Log Status Command . . . . . . . .
54.26 PPP Cross-Connect Engine TCA Alarm Log Status Command
54.27 2xE1/DS1 SFP Clock Alarm Log Status Command . . . . . .
54.28 2xE1/DS1 SFP Framer Alarm Log Status Command . . . . .
54.29 Plug In Unit Extended Alarm Log Status Command . . . . . .
54.30 SIP Server Alarm Log Status Commands . . . . . . . . . . .
54.31 SIP VSP Alarm Log Status Commands . . . . . . . . . . . .
54.32 SIP Dial Plan Alarm Log Status Commands . . . . . . . . . .
54.33 SIP Slot Alarm Log Status Commands . . . . . . . . . . . . .
54.34 SIP Termination Alarm Log Status Commands . . . . . . . .
54.35 Megaco Media Gateway Alarm Log Status Command . . . .
54.36 Megaco Signaling Gateway Alarm Log Status Command . . .
54.37 Megaco Plug Unit Alarm Log Status Command . . . . . . . .
54.38 Megaco Termination Alarm Log Status Command . . . . . .
54.39 Megaco Signaling Lt Alarm Log Status Command . . . . . . .
54.40 Shdsl Alarm Log Status Command . . . . . . . . . . . . . . .
54.41 Shdsl Alarm Log Status Command . . . . . . . . . . . . . . .
54.42 Ima-Group Alarm Log Status Command . . . . . . . . . . . .
54.43 Ima-Link Alarm Log Status Command . . . . . . . . . . . . .
54.44 Ether-Tca Alarm Log Status Command . . . . . . . . . . . .
54.45 Ether-Sfp Alarm Log Status Command . . . . . . . . . . . . .
54.46 Alarm Qos Slot Log Status Commands . . . . . . . . . . . .
54.47 Alarm Qos Queue Log Status Commands . . . . . . . . . . .
54.48 Log File Transfer Server Alarm Log Status Command . . . .
54.49 Log Lsm Redundancy Alarm Log Status Command . . . . . .
54.50 Log L2 Forward Alarm Log Status Command . . . . . . . . .
54.51 External Device Alarm Log Status Command . . . . . . . . .
54.52 LT CFM Alarm Log Status Command . . . . . . . . . . . . .
54.53 Sync Clock Alarm Log Status Command . . . . . . . . . . . .

xii

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1135
.1138
.1142
.1145
.1148
.1152
.1156
.1158
.1159
.1162
.1170
.1178
.1181
.1184
.1188
.1194
.1197
.1200
.1202
.1204
.1208
.1210
.1214
.1218
.1220
.1225
.1227
.1230
.1234
.1238
.1240
.1242
.1243
.1245
.1250
.1252
.1253
.1255
.1258
.1260
.1263
.1266
.1269
.1272
.1275
.1278
.1281
.1283
.1285
.1287
.1290
.1291
.1293

01

Contents

54.54 EFM-OAM Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1296


54.55 Alarm Table Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1298
54.56 Auto-Switch Alarm Log Status command . . . . . . . . . . . . . . . . . . . . . . . . . .1300

55- Current Alarm Status Commands


55.1 Current Alarm Status Command Tree . . . . . . . . . . . . . . . . .
55.2 Alarm Current Status Command . . . . . . . . . . . . . . . . . . . .
55.3 Equipment Current Alarm Status Command . . . . . . . . . . . . .
55.4 Equipment Holder Current Alarm Status Command . . . . . . . . .
55.5 Equipment Holder Extended Current Alarm Status Command . . . .
55.6 Plug-in Unit Current Alarm Status Command . . . . . . . . . . . . .
55.7 ATM Current Alarm Status Command . . . . . . . . . . . . . . . . .
55.8 Ethernet Interface Current Alarm Status Command . . . . . . . . . .
55.9 Software Management Current Alarm Status Command . . . . . . .
55.10 Temporal Filter Current Alarm Status Command . . . . . . . . . .
55.11 Spatial Filter Current Alarm Status Command . . . . . . . . . . . .
55.12 xDSL Current Alarm Status Command . . . . . . . . . . . . . . . .
55.13 TCA xDSL Current Alarm Status Command . . . . . . . . . . . . .
55.14 Vectoring Line Current Alarm Status Command . . . . . . . . . . .
55.15 Vectoring Board Current Alarm Status Command . . . . . . . . . .
55.16 Electrical-to-Optical Conversion Current Alarm Status Command .
55.17 Authentication Current Alarm Status Command . . . . . . . . . . .
55.18 xDSL Bonding Current Alarm Status Command . . . . . . . . . . .
55.19 Redundancy Current Alarm Status Command . . . . . . . . . . . .
55.20 Custom Current Alarm Status Command . . . . . . . . . . . . . .
55.21 SFP Current Alarm Status Command . . . . . . . . . . . . . . . .
55.22 Custom External Current Alarm Status Command . . . . . . . . . .
55.23 SFP RSSI Current Alarm Status Command . . . . . . . . . . . . .
55.24 PPP Cross-Connect Engine TCA Current Alarm Status Command
55.25 2xE1/DS1 SFP Clock Current Alarm Status Command . . . . . . .
55.26 2xE1/DS1 SFP Framer Alarm Status Command . . . . . . . . . .
55.27 Plug In Unit Extended Current Alarm Status Command . . . . . . .
55.28 SIP Server Current Alarm Status Command . . . . . . . . . . . . .
55.29 SIP VSP Current Alarm Status Command . . . . . . . . . . . . . .
55.30 SIP Dial Plan Current Alarm Status Command . . . . . . . . . . .
55.31 SIP Slot Current Alarm Status Command . . . . . . . . . . . . . .
55.32 SIP Termination Current Alarm Status Command . . . . . . . . . .
55.33 Megaco Media Gateway Current Alarm Status Command . . . . .
55.34 Megaco Signaling Gateway Current Alarm Status Command . . . .
55.35 Megaco Plugin Unit Current Alarm Status Command . . . . . . . .
55.36 Megaco Termination Current Alarm Status Command . . . . . . .
55.37 Megaco Signaling Lt Current Alarm Status Command . . . . . . .
55.38 Shdsl Current Alarm Status Command . . . . . . . . . . . . . . . .
55.39 Shdsl Current Alarm Status Command . . . . . . . . . . . . . . . .
55.40 Ima-Group Current Alarm Status Command . . . . . . . . . . . . .
55.41 Ima-Link Current Alarm Status Command . . . . . . . . . . . . . .
55.42 Alarm Current Ether-Tca Status Command . . . . . . . . . . . . .
55.43 Alarm Current Ether-Sfp Status Command . . . . . . . . . . . . .
55.44 Alarm Current Qos Slot Status Command . . . . . . . . . . . . . .
55.45 Alarm Current Qos Queue Status Command . . . . . . . . . . . .
55.46 Alarm File Transfer Server Status Command . . . . . . . . . . . .
55.47 Alarm LSM Redundancy Status Command . . . . . . . . . . . . .
55.48 Alarm L2 Forward Status Command . . . . . . . . . . . . . . . . .
55.49 Alarm Current External Device Status Command . . . . . . . . . .
55.50 Sync Clock Current Alarm Status Command . . . . . . . . . . . .
55.51 LT Cfm Current Alarm Status Command . . . . . . . . . . . . . . .
55.52 EFM-OAM Current Alarm Status Command . . . . . . . . . . . . .
55.53 Alarm Table Current Alarm Status Command . . . . . . . . . . . .
55.54 Auto-Switch Current Alarm Status Command . . . . . . . . . . . .

3HH-04416-EBAA-TCZZA 01

1302
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1304
.1307
.1311
.1313
.1315
.1318
.1321
.1323
.1324
.1326
.1330
.1334
.1338
.1342
.1344
.1346
.1348
.1349
.1352
.1353
.1356
.1360
.1362
.1366
.1368
.1371
.1375
.1378
.1379
.1381
.1382
.1384
.1387
.1389
.1390
.1392
.1394
.1396
.1398
.1400
.1402
.1404
.1406
.1408
.1410
.1412
.1413
.1415
.1417
.1418
.1420
.1422
.1424
.1425

xiii

Contents

56- Alarm Snap-shot Status Commands

1426

56.1 Alarm Snap-shot Status Command Tree . . . . . . . . . . . . . . . . .


56.2 Alarm Snapshot Status Command . . . . . . . . . . . . . . . . . . . . .
56.3 Alarm Snapshot Equipment Status Command . . . . . . . . . . . . . .
56.4 Equipment Holder Alarm Log Status Command . . . . . . . . . . . . . .
56.5 Equipment Holder Alarm Extended Log Status Command . . . . . . . .
56.6 Plug-in Unit Alarm Log Status Command . . . . . . . . . . . . . . . . .
56.7 ATM Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . .
56.8 Alarm Snapshot Ethernet Interface Status Command . . . . . . . . . .
56.9 Alarm Snapshot Software Management Status Command . . . . . . . .
56.10 Alarm Snapshot Temporal Filter Status Command . . . . . . . . . . .
56.11 Alarm Snapshot Spatial Filter Status Command . . . . . . . . . . . . .
56.12 Alarm xDSL Snapshot Status Command . . . . . . . . . . . . . . . . .
56.13 TCA xDSL Alarm Log Status Command . . . . . . . . . . . . . . . . .
56.14 Alarm Vectoring Line Snapshot Status Command . . . . . . . . . . . .
56.15 Alarm Vectoring Board Snapshot Status Command . . . . . . . . . . .
56.16 Alarm Electrical-to-Optical Conversion for Snapshot Status Command
56.17 Authentication Alarms for Snapshot Status Command . . . . . . . . .
56.18 Alarm xDSL Bonding Snap Shot Status Command . . . . . . . . . . .
56.19 Alarm Redundancy Snapshot Status Command . . . . . . . . . . . . .
56.20 Alarm Custom Snapshot Status Command . . . . . . . . . . . . . . .
56.21 Alarm SFP Snapshot Status Command . . . . . . . . . . . . . . . . .
56.22 Alarm Custom External Snap Shot Status Command . . . . . . . . . .
56.23 Alarm RSSI SFP Snapshot Status Command . . . . . . . . . . . . . .
56.24 Alarm PPP Cross-Connect Engine TCA Snapshot Status Command .
56.25 2xE1/DS1 SFP Clock Snapshot Status Command . . . . . . . . . . .
56.26 2xE1/DS1 SFP Framer Snapshot Status Command . . . . . . . . . .
56.27 Alarm Plug In Unit Extended Snap Shot Status Command . . . . . . .
56.28 Alarm Snap-shot SIP Server Status Command . . . . . . . . . . . . .
56.29 Alarm Snap-shot SIP VSP Status Command . . . . . . . . . . . . . .
56.30 Alarm Snap-shot SIP Dial Plan Status Command . . . . . . . . . . . .
56.31 Alarm Snap-shot SIP Slot Status Command . . . . . . . . . . . . . . .
56.32 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . .
56.33 Alarm Snap-shot Megaco Media Gateway Status Command . . . . . .
56.34 Alarm Snap-shot Megaco Signaling Gateway Status Command . . . .
56.35 Alarm Snap-shot Megaco Plug Unit Status Command . . . . . . . . .
56.36 Alarm Snap-shot Megaco Termination Status Command . . . . . . . .
56.37 Alarm Snap-shot Megaco Signaling Lt Status Command . . . . . . . .
56.38 Alarm Snap-shot Shdsl Status Command . . . . . . . . . . . . . . . .
56.39 Alarm Snap-shot Shdsl Status Command . . . . . . . . . . . . . . . .
56.40 Alarm Snap-shot Ima-Group Status Command . . . . . . . . . . . . .
56.41 Alarm Snap-shot Ima-Link Status Command . . . . . . . . . . . . . .
56.42 Alarm Snap-shot Ether-Tca Status Command . . . . . . . . . . . . . .
56.43 Alarm Snap-shot Ether-Sfp Status Command . . . . . . . . . . . . . .
56.44 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . .
56.45 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . .
56.46 Alarm File Transfer Server Status Command . . . . . . . . . . . . . .
56.47 Alarm Lsm Redundancy Status Command . . . . . . . . . . . . . . . .
56.48 Alarm L2 Forward Status Command . . . . . . . . . . . . . . . . . . .
56.49 Alarm Snap-shot External Device Status Command . . . . . . . . . .
56.50 Sync Clock Alarm SnapShot Status Command . . . . . . . . . . . . .
56.51 LT CFM Alarm SnapShot Status Command . . . . . . . . . . . . . . .
56.52 EFM-OAM alarm Snap-shot Status Command . . . . . . . . . . . . .
56.53 Alarm Table Snapshot Status Command . . . . . . . . . . . . . . . . .
56.54 Auto-Switch Alarm Snapshot Status Command . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

57- Alarm Delta Log Status Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1428
.1431
.1435
.1437
.1439
.1442
.1445
.1447
.1448
.1450
.1454
.1458
.1462
.1466
.1468
.1470
.1471
.1472
.1475
.1476
.1479
.1483
.1485
.1489
.1491
.1494
.1498
.1501
.1502
.1504
.1505
.1506
.1509
.1510
.1511
.1512
.1514
.1516
.1518
.1520
.1522
.1524
.1526
.1528
.1530
.1532
.1533
.1535
.1537
.1538
.1540
.1542
.1544
.1545

1547

57.1 Alarm Delta Log Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .1548

xiv

Released

3HH-04416-EBAA-TCZZA

01

Contents

57.2 Alarm Generic Delta Alarm Log Status Command


57.3 Indeterminate Alarm Delta Log Status Command .
57.4 Warning Alarm Delta Log Status Command . . . .
57.5 Minor Alarm Delta Log Status Command . . . . .
57.6 Major Alarm Delta Log Status Command . . . . .
57.7 Critical Alarm Delta Log Status Command . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

58.1 SHub Alarm Status Command Tree . . . . . . . . . . . . . .


58.2 SHub Alarm Snapshot Status Command . . . . . . . . . . .
58.3 SHub Alarm Equipment Snap-shot Status Command . . . .
58.4 SHub Alarm Snapshot Ethernet Interface Status Command .
58.5 SHub Alarm RIP Snapshot Status Command . . . . . . . . .
58.6 SHub Alarm OSPF Snap-shot Status Command . . . . . . .
58.7 SHub Alarm Uplink Group Snapshot Status Command . . . .
58.8 SHub Alarm Forwarding Snapshot Status Command . . . . .
58.9 SHub Alarm Global RIP Snapshot Status Command . . . . .
58.10 SHub Alarm Global OSPF Snapshot Status Command . . .
58.11 SHub Alarm Global Forwarding Snapshot Status Command
58.12 SHub Alarm Delta Log Changes Status Command . . . . .

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.

58- SHub Alarm Status Command

.1549
.1551
.1569
.1587
.1605
.1623

1641

59- ATM Status Commands

.1642
.1643
.1645
.1647
.1649
.1651
.1653
.1654
.1656
.1657
.1659
.1660

1661

59.1 ATM Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


59.2 ATM Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .
59.3 PVC Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59.4 TC Adapter Protocol Interval Status Command . . . . . . . . . . . . . . . . . . .
59.5 TC Adapter Protocol Current Quarter Performance Data Command . . . . . . . .
59.6 TC Adapter Protocol Current Day Performance Data Command . . . . . . . . . .
59.7 TC Adapter Protocol Performance Data for Previous Quarter Intervals Command
59.8 TC Adapter Protocol Performance Data for Previous Day Intervals Command . .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

60- Bridge Status Commands

.1662
.1663
.1665
.1667
.1669
.1671
.1673
.1675

1677

60.1 Bridge Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1678


60.2 SHub Bridge Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1679
60.3 SHub Bridge Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1680

61- VLAN Status Commands


61.1 VLAN Status Command Tree . . . . . . . . . . . . . . . . . .
61.2 Global VLAN Status Command . . . . . . . . . . . . . . . . .
61.3 Residential Bridge VLAN Summary Status Command . . . . .
61.4 Residential Bridge VLAN Extensive Status Command . . . . .
61.5 Cross-connect VLAN Status Command . . . . . . . . . . . . .
61.6 Stacked VLAN Status Command . . . . . . . . . . . . . . . .
61.7 Stacked QoS VLAN Status Command . . . . . . . . . . . . . .
61.8 QoS C-VLAN Status Command . . . . . . . . . . . . . . . . .
61.9 Layer-2 Terminated VLAN Status Command . . . . . . . . . .
61.10 VLAN Name Mapping Status Command . . . . . . . . . . . .
61.11 VLAN Filtering Database Per LIM Status Command . . . . .
61.12 Bridge Port Filtering Database Status Command . . . . . . .
61.13 VLAN Priority Regeneration Profile Status Command . . . . .
61.14 VLAN Priority Regeneration Profile Name Status Command .
61.15 Show Next Free ID of VLAN Priority Regeneration Profile . .
61.16 Duplicate MAC Alarm Status Command . . . . . . . . . . . .
61.17 Port Event Status Command . . . . . . . . . . . . . . . . . .
61.18 Port Statistics for Current Quarter Status Command . . . . .
61.19 Port Statistics for Current Day Status Command . . . . . . .
61.20 Port Statistics for Previous Quarter Intervals Status Command

3HH-04416-EBAA-TCZZA 01

1684
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1685
.1687
.1688
.1691
.1696
.1701
.1703
.1705
.1706
.1708
.1709
.1712
.1715
.1718
.1721
.1722
.1725
.1727
.1730
.1733

xv

Contents

61.21 Port Statistics for Previous Day Intervals Status Command . . . . . .


61.22 VLAN Port Statistics for Current Quarter Status Command . . . . . .
61.23 VLAN Port Statistics for Current Day Status Command . . . . . . . .
61.24 VLAN Port Statistics for Previous Quarter Intervals Status Command
61.25 VLAN Port Statistics for Previous Day Intervals Status Command . .
61.26 SHub Port VLAN Association Status Command . . . . . . . . . . . .
61.27 SHub VLAN Name Mapping Status Command . . . . . . . . . . . .
61.28 SHub VLAN Filtering Database Status Command . . . . . . . . . . .
61.29 SHub Filtering Database Entry Status Command . . . . . . . . . . .
61.30 SHub Duplicate MAC Alarm Status Command . . . . . . . . . . . .
61.31 SHub Number Of Active Multicast Entries Status Command . . . . .
61.32 VLAN Filtering Database Status Command . . . . . . . . . . . . . .
61.33 P-bit Traffic Counters Status Command . . . . . . . . . . . . . . . .
61.34 Current VLAN Filtering Database Status Command . . . . . . . . . .
61.35 Accumulated Port Statistics . . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

62- Link Aggregation Status Commands


62.1 Link Aggregation Status Command Tree . . . .
62.2 Link Aggregation Group Status Command . . .
62.3 Link Aggregation Member List Status Command
62.4 Link Aggregate Member Link Status Command .

1771
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

63- QOS Status Commands

Released

.1772
.1773
.1778
.1780

1787

63.1 QOS Status Command Tree . . . . . . . . . . . . . . . . . . . . .


63.2 QoS Session Profile Status Command . . . . . . . . . . . . . . .
63.3 QoS Marker Profile Status Command . . . . . . . . . . . . . . . .
63.4 QoS Policer Profile Status Command . . . . . . . . . . . . . . . .
63.5 QoS Queue Profile Status Command . . . . . . . . . . . . . . . .
63.6 QoS Scheduler Node Profile Status Command . . . . . . . . . . .
63.7 QoS CAC Profile Status Command . . . . . . . . . . . . . . . . .
63.8 QoS Policy Profile Status Command . . . . . . . . . . . . . . . .
63.9 QoS L2 Filter Profile Status Command . . . . . . . . . . . . . . .
63.10 QoS L3 Filter Profile Status Command . . . . . . . . . . . . . . .
63.11 QoS Policy Action Profile Status Command . . . . . . . . . . . .
63.12 QoS IngressQoS Profile Status Command . . . . . . . . . . . . .
63.13 QoS Shaper Profile Status Command . . . . . . . . . . . . . . .
63.14 QoS Bandwidth Profile Status Command . . . . . . . . . . . . .
63.15 QoS Rate Limit Profile Status Command . . . . . . . . . . . . . .
63.16 QoS DSCP to PBIT Profile Status Command . . . . . . . . . . .
63.17 QoS Ingress filter Resource Usage Status Command . . . . . . .
63.18 QoS DSL Bandwidth Status Command . . . . . . . . . . . . . .
63.19 QoS Shdsl Bandwidth Status Command . . . . . . . . . . . . . .
63.20 QoS Ethernet Bandwidth Status Command . . . . . . . . . . . .
63.21 QoS Interface Bandwidth Status Command . . . . . . . . . . . .
63.22 QoS Total Buffer Overflow Statistics for Previous Quarter . . . .
63.23 QoS Total Buffer Overflow Statistics for Current Quarter . . . . .
63.24 QoS Total Buffer Overflow Statistics for Previous Day Command
63.25 QoS Total Buffer Overflow Statistics for Current Day . . . . . . .
63.26 QoS Total Buffer Overflow Statistics Total Status Command . . .
63.27 QoS Interface Buffer Overflow Statistics for Previous Quarter . .
63.28 QoS Interface Buffer Overflow Statistics for Current Quarter . . .
63.29 QoS Fan Out Statistics for Previous Quarter . . . . . . . . . . . .
63.30 QoS Fan Out Statistics for Current 15 minutes . . . . . . . . . .
63.31 QoS Fan Out Statistics for Previous Day . . . . . . . . . . . . . .
63.32 QoS Fan Out Statistics for Current Day . . . . . . . . . . . . . .
63.33 QoS LT Queue Overflow Statistics for Previous Quarter . . . . .
63.34 QoS LT Queue Overflow Statistics for current Quarter . . . . . .
63.35 QoS SHub Meter Statistics Status Command . . . . . . . . . . .
63.36 QoS SHub Flow Statistics Status Command . . . . . . . . . . . .

xvi

.1736
.1739
.1742
.1745
.1748
.1751
.1753
.1754
.1756
.1758
.1760
.1761
.1764
.1767
.1769

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1788
.1790
.1791
.1792
.1793
.1794
.1795
.1796
.1797
.1798
.1799
.1800
.1801
.1802
.1803
.1804
.1805
.1807
.1809
.1811
.1813
.1817
.1820
.1823
.1826
.1829
.1833
.1836
.1839
.1841
.1843
.1845
.1847
.1849
.1851
.1852

01

Contents

63.37 QoS TC2QMapping Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1853

64- IP Status Commands

1855

64.1 IP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .


64.2 IP VRF Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64.3 IP Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . .
64.4 IP VRF Interface User Port Status Command . . . . . . . . . . . . . . . .
64.5 IP VRF Interface User Port Status Command . . . . . . . . . . . . . . . .
64.6 IP VRF Routes Status Command . . . . . . . . . . . . . . . . . . . . . .
64.7 IP VRF Net-to-Media Statistics Command . . . . . . . . . . . . . . . . . .
64.8 IP VRF Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64.9 IP VRF Next Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64.10 IP SHub VRF Status Command . . . . . . . . . . . . . . . . . . . . . .
64.11 IP SHub VRF Route Status Command . . . . . . . . . . . . . . . . . . .
64.12 IP SHub ARP Statistics Command . . . . . . . . . . . . . . . . . . . . .
64.13 IP SHub VRF Media Status Command . . . . . . . . . . . . . . . . . . .
64.14 IP SHub VRF Routing Status Command . . . . . . . . . . . . . . . . . .
64.15 IP DHCP Session Status Command . . . . . . . . . . . . . . . . . . . .
64.16 IP User Port ARP Proxy Statistics Status Command . . . . . . . . . . .
64.17 IP Untagged User Port ARP Proxy Statistics Status Command . . . . .
64.18 IP Untagged User Port ARP Proxy Summary Statistics Status Command
64.19 IP Untagged User Port ARP Proxy Detailed Statistics Status Command .
64.20 IP Tagged User Port ARP Proxy Statistics Status Command . . . . . . .
64.21 IP Tagged User Port ARP Proxy Summary Statistics Status Command .
64.22 IP Tagged User Port ARP Proxy Detailed Statistics Status Command . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

65- ARP-RELAY Status Commands


65.1 ARP-RELAY Status Command Tree . . . . . . . .
65.2 ARP-RELAY statistics Status Command . . . . .
65.3 ARP-RELAY summary statistics Status Command
65.4 ARP-RELAY detailed statistics Status Command .

1903
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

66- xDSL Status Commands


66.1 xDSL Status Command Tree . . . . . . . . . . . . . . . . . .
66.2 xDSL Profiles Status Command . . . . . . . . . . . . . . . .
66.3 xDSL PM Interval Per Interface Status Command . . . . . .
66.4 xDSL Operational Data Near End Line Status Command . .
66.5 xDSL Operational Data Near End Channel Status Command
66.6 xDSL Operational Data Far End Line Status Command . . .
66.7 xDSL Operational Data Far End Channel Status Command .
66.8 xDSL Operational Data Statistics . . . . . . . . . . . . . . .
66.9 xDSL Carrier Data Near End Status Command . . . . . . . .
66.10 xDSL Carrier Data Far End Status Command . . . . . . . .
66.11 xDSL Failure Status Near End Status Command . . . . . .
66.12 xDSL Failure Status Far End Status Command . . . . . . .
66.13 xDSL Vectored Line Failure Status Command . . . . . . . .
66.14 xDSL Vectoring Board Failure Status Command . . . . . .
66.15 xDSL Counters Near End Line Current 15 Min . . . . . . .
66.16 xDSL Counters Near End Line Current Day . . . . . . . . .
66.17 xDSL Counters Near End Line Previous 15 Min . . . . . . .
66.18 xDSL Counters Near End Of Line Previous Day . . . . . . .
66.19 xDSL Counters Near End Channel Current 15 Min . . . . .
66.20 xDSL Counters Near End Channel Current Day . . . . . . .
66.21 xDSL Counters Near End Channel Previous 15 Min . . . .
66.22 xDSL Counters Near End Channel Previous Day . . . . . .
66.23 xDSL Counters Far End Line Current 15 Min . . . . . . . .
66.24 xDSL Counters Far End Line Current Day . . . . . . . . . .
66.25 xDSL Counters Far End Line Previous 15 Min . . . . . . . .

3HH-04416-EBAA-TCZZA 01

.1856
.1858
.1859
.1863
.1866
.1868
.1872
.1874
.1875
.1876
.1878
.1880
.1883
.1885
.1886
.1889
.1890
.1891
.1893
.1896
.1898
.1900

.1904
.1905
.1907
.1909

1912
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1914
.1918
.1920
.1922
.1931
.1933
.1941
.1943
.1947
.1952
.1955
.1958
.1961
.1963
.1965
.1967
.1969
.1972
.1975
.1977
.1979
.1981
.1983
.1985
.1987

xvii

Contents

66.26 xDSL Counters Far End Line Previous Day . . . . . . . . .


66.27 xDSL Counters Far End Channel Current 15 Min . . . . . .
66.28 xDSL Counters Far End Channel Current Day . . . . . . . .
66.29 xDSL Counters Far End Channel Previous 15 Min . . . . .
66.30 xDSL Counters Far End Channel Previous Day . . . . . . .
66.31 xDSL XTU-R Inventory Status Command . . . . . . . . . .
66.32 xDSL XTU-C Inventory Status Command . . . . . . . . . .
66.33 xDSL Board Capability Status Command . . . . . . . . . .
66.34 xDSL Low Rate Alarm Timestamp Command . . . . . . . .
66.35 xDSL Low Rate Alarm Line Bitmap Status Command . . . .
66.36 xDSL Low Rate Alarm Linkup Record Data Command . . .
66.37 xDSL INS Near End Operational Data Status Command . .
66.38 xDSL INS Near End Current 15Min Data Status Command .
66.39 xDSL INS Near End Current 15Min IAT Histogram . . . . .
66.40 xDSL INS Near End Current 15Min EINP Histogram . . . .
66.41 xDSL INS Near End Current Day Data Status Command . .
66.42 xDSL INS Near End Current Day IAT Histogram . . . . . .
66.43 xDSL INS Near End Current Day EINP Histogram . . . . .
66.44 xDSL INS Near End Previous 15Min Data Status Command
66.45 xDSL INS Near End Previous 15Min IAT Histogram . . . .
66.46 xDSL INS Near End Previous 15Min EINP Histogram . . .
66.47 xDSL INS Near End Previous Day Data Status Command .
66.48 xDSL INS Near End Previous Day IAT Histogram . . . . . .
66.49 xDSL INS Near End Previous Day EINP Histogram . . . . .
66.50 xDSL INS Far End Operational Data Status Command . . .
66.51 xDSL INS Far End Current 15Min Data Status Command .
66.52 xDSL INS Far End Current 15Min IAT Histogram . . . . . .
66.53 xDSL INS Far End Current 15Min EINP Histogram . . . . .
66.54 xDSL INS Far End Current Day Data Status Command . . .
66.55 xDSL INS Far End Current Day IAT Histogram . . . . . . .
66.56 xDSL INS Far End Current Day EINP Histogram . . . . . .
66.57 xDSL INS Far End Previous 15Min Data Status Command .
66.58 xDSL INS Far End Previous 15Min IAT Histogram . . . . .
66.59 xDSL INS Far End Previous 15Min EINP Histogram . . . .
66.60 xDSL INS Far End Previous Day Status Command . . . . .
66.61 xDSL INS Far End Previous Day IAT Histogram . . . . . .
66.62 xDSL INS Far End Previous Day EINP Histogram . . . . . .
66.63 xDSL Downstream Vectoring Disturberlist Status Command
66.64 xDSL Upstream Vectoring Disturberlist Status Command .
66.65 xDSL Downstream Vectoring Disturberlist Status Command
66.66 xDSL Vectoring Carrier Data Near End Status Command .
66.67 xDSL Vectoring Carrier Data Far End Status Command . .
66.68 xDSL Vectoring Processing Board Status Command . . . .
66.69 xDSL Vectoring Processing Group Status Command . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

67- Configuration Data Status Commands


67.1 Configuration Data Status Command Tree . . . . . . . .
67.2 xDSL Port Configuration Status Command . . . . . . . .
67.3 xDSL Port ATM Configuration Status Command . . . . .
67.4 xDSL Port ATM Interface Configuration Status Command
67.5 xDSL Port Interface Configuration Status Command . . .
67.6 xDSL IGMP Configuration Status Command . . . . . . .
67.7 xDSL Security PAE Configuration Status Command . . .
67.8 xDSL BridgePort Configuration Status Command . . . .
67.9 xDSL QoS Configuration Status Command . . . . . . . .
67.10 xDSL PPPoX Relay Configuration Status Command . .
67.11 xDSL Bonding Group Configuration Status Command .

2059
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

68- Operational Data Status Commands

xviii

Released

.1989
.1991
.1993
.1995
.1997
.1999
.2001
.2003
.2009
.2010
.2011
.2014
.2016
.2017
.2018
.2019
.2020
.2021
.2022
.2023
.2024
.2025
.2026
.2027
.2028
.2030
.2031
.2032
.2033
.2034
.2035
.2036
.2037
.2038
.2039
.2040
.2041
.2042
.2044
.2046
.2048
.2051
.2054
.2056

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.2060
.2062
.2068
.2070
.2072
.2074
.2076
.2079
.2083
.2085
.2087

2089

3HH-04416-EBAA-TCZZA

01

Contents

68.1 Operational Data Status Command Tree . . . . . .


68.2 xDSL Port Operational Status Command . . . . . .
68.3 xDSL BridgePort Operational Status Command . .
68.4 xDSL Port ATM Operational Status Command . . .
68.5 xDSL Port Interface Configuration Status Command
68.6 xDSL IGMP Operational Status Command . . . . .
68.7 xDSL Port Ip Bridge Operational Status Command .
68.8 xDSL QoS Opertaional Status Command . . . . . .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

69- xDSL Bonding Status Commands


69.1 xDSL Bonding Status Command Tree . . . . . . . . . . . . .
69.2 xDSL Bonding Group Profiles Status Command . . . . . . .
69.3 xDSL Bonding Group Rtx Profiles Status Command . . . . .
69.4 xDSL Bonding Near End Operational Data Status Command
69.5 xDSL Bonding Far End Operational Data Status Command .
69.6 xDSL Bonding Group Operational Data Command . . . . . .
69.7 xDSL Bonding Link Operational Data Command . . . . . . .
69.8 xDSL Bonding Near End Failure Status Command . . . . . .
69.9 xDSL Bonding Far End Failure Status Command . . . . . . .
69.10 xDSL Bonding Group Failure Status Command . . . . . . .
69.11 xDSL Bonding Group Summary Info Command . . . . . . .

.2090
.2091
.2095
.2097
.2099
.2101
.2104
.2106

2108
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

70- PPPoE Status Commands

.2109
.2110
.2112
.2114
.2116
.2118
.2120
.2122
.2124
.2126
.2128

2129

70.1 PPPoE Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2130


70.2 PPPoE Client Emulation Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2131
70.3 PPPoE Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2134

71- Interface Status Commands

2136

71.1 Interface Status Command Tree . . . . . . . . . . . . . . . . . . . . .


71.2 Interface Alarm Status Command . . . . . . . . . . . . . . . . . . . .
71.3 Physical Interface Status Command . . . . . . . . . . . . . . . . . . .
71.4 Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . .
71.5 Interface Test Status Command . . . . . . . . . . . . . . . . . . . . .
71.6 Interface Stack Status Command . . . . . . . . . . . . . . . . . . . .
71.7 SHub Interface Status Command . . . . . . . . . . . . . . . . . . . .
71.8 SHub Interface Port Control Status Command . . . . . . . . . . . . .
71.9 SHub Interface Uplink Group Status Command . . . . . . . . . . . . .
71.10 Interface Statistics Commands . . . . . . . . . . . . . . . . . . . . .
71.11 Interface Shub Troubleshooting Statistics Commands . . . . . . . .
71.12 Interface Shub Ethernet statistics Current 15 min Status Command .
71.13 Interface Shub Ethernet Statistics current one day status command .
71.14 Interface Shub Ethernet statistics Previous 15 min Status Command
71.15 Interface Shub Ethernet Statistics current one day status command .
71.16 Interface Extensive Status Command . . . . . . . . . . . . . . . . .
71.17 Interface Troubleshooting Ethernet Statistics Commands . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

72- SNTP Status Commands

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.2137
.2138
.2140
.2141
.2151
.2156
.2164
.2166
.2169
.2170
.2173
.2177
.2180
.2183
.2186
.2189
.2191

2194

72.1 SNTP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2195


72.2 SNTP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2196

73- SNTP Server Commands

2197

73.1 SNTP Server Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2198


73.2 SNTP Server Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2199

74- System Status Commands

2200

74.1 System Status Command Tree

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2201

3HH-04416-EBAA-TCZZA 01

Released

xix

Contents

74.2 SHub System Version Status Command . . .


74.3 SHub System HTTP Status Command . . . .
74.4 SHub System Common Status Command . . .
74.5 SHub System Control Status Command . . . .
74.6 SHub IP Filter Status Command . . . . . . . .
74.7 System Statistics Command . . . . . . . . . .
74.8 System Licenses Status Command . . . . . .
74.9 System Clock Status Command . . . . . . . .
74.10 Show syslog parameters . . . . . . . . . . .
74.11 System Memory Usage Status Command . .
74.12 System CPU Load Status Command . . . . .
74.13 System CDE Command . . . . . . . . . . . .
74.14 System Clock Management Status Command

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

75- PCCP Status Commands

.2202
.2203
.2204
.2205
.2207
.2212
.2213
.2217
.2219
.2220
.2222
.2224
.2225

2228

75.1 PCCP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2229


75.2 SHub PCCP Group Entry Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2230
75.3 SHub PCCP Group Port Entry Status Command . . . . . . . . . . . . . . . . . . . . . . .2231

76- Transaction Status Commands

2233

76.1 Transaction Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2234


76.2 Transaction Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2235
76.3 Transaction Log Entry Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .2237

77- Error Status Command

2238

77.1 Error Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2239


77.2 Error Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2240

78- Software Status Commands


78.1 Software Status Command Tree . . . . . . .
78.2 Database Status Command . . . . . . . . .
78.3 Disk Status Command . . . . . . . . . . . .
78.4 Overall Software Package Status Command
78.5 Software Package Status Command . . . .
78.6 File Status Command . . . . . . . . . . . . .
78.7 Upload/Download Status Command . . . . .
78.8 Software Version For ANSI Status Command
78.9 Software Version For ETSI Status Command

2242
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

79- SHub Software Management Status Command

.2243
.2244
.2246
.2248
.2251
.2253
.2255
.2258
.2259

2260

79.1 SHub Software Management Status Command Tree . . . . . . . . . . . . . . . . . . . . .2261


79.2 SHub Configuration File Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .2262
79.3 Status of the SHub Boot ROM Update Command . . . . . . . . . . . . . . . . . . . . . .2264

80- CDE Status Commands

2265

80.1 CDE Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2266


80.2 CDE download Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2267

81- IGMP Status Commands


81.1 IGMP Status Command Tree . . . . . . . . . .
81.2 IGMP System Status Command . . . . . . . . .
81.3 IGMP Channel Sources Status Command . . .
81.4 IGMP Channel Miscellaneous Status Command
81.5 IGMP Channel Protocol Status Command . . .
81.6 IGMP package to multicast source Command .

xx

Released

2269
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.2270
.2272
.2274
.2277
.2280
.2284

01

Contents

81.7 IGMP Group to Package Status Command . . . . . . .


81.8 Show Multicast Source Statistics Command . . . . . .
81.9 Show Multicast Channel Statistics Command . . . . . .
81.10 IGMP Module Counter Status Command . . . . . . .
81.11 IGMP Module Time Status Command . . . . . . . . .
81.12 IGMP Module Miscellaneous Status Command . . . .
81.13 IGMP System Status Command . . . . . . . . . . . .
81.14 SHub IGMP VLAN Router Port Status Command . . .
81.15 Shub IGMP System Status Command . . . . . . . . .
81.16 Shub IGMP CAC System Status Command . . . . . .
81.17 Shub IGMP CAC Multicast Sources Status Command
81.18 Shub IGMP CAC Bundle Status Command . . . . . .
81.19 Shub IGMP CAC Bundle to Source Command . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

82- Transport Status Commands


82.1 Transport Status Command Tree . . .
82.2 ICMP Status Command . . . . . . . .
82.3 IP Address Status Command . . . . .
82.4 IP Statistics . . . . . . . . . . . . . . .
82.5 IP Route Status Command . . . . . . .
82.6 IP Net-to-media Status Command . . .
82.7 SNMP Protocol Statistics Command . .
82.8 SNMP Engine Status Command . . . .
82.9 System Status Command . . . . . . .
82.10 UDP Status Command . . . . . . . .
82.11 UDP Listener Status Command . . .
82.12 SHub Ethernet Dot3 Status Command
82.13 SHub Dot3 Control Status Command
82.14 SHub Dot3 Pause Status Command .
82.15 SHub Ethernet Dot3 Status Command
82.16 SHub L2 Filter Status Command . . .
82.17 SHub Rate Status Command . . . . .
82.18 SFP status commands . . . . . . . .
82.19 Interface MAU Status Command . . .
82.20 Ethernet Lt Dot3 Status Command . .

2309
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

83- Efm Oam Status Commands


83.1 Efm Oam Status Command Tree . . . . . . . . . . .
83.2 Efm Oam Mac Statistics Command . . . . . . . . . .
83.3 Efm Oam Pme Statistics Command . . . . . . . . . .
83.4 Efm Oam Local Information Status Command . . . .
83.5 Efm Oam Peer Information Status Command . . . . .
83.6 Efm Oam statistics Status Command . . . . . . . . .
83.7 Efm Oam loopback Status Command . . . . . . . . .
83.8 Efm Oam Internal Traffic generator Status Command

.2310
.2311
.2314
.2316
.2319
.2321
.2322
.2325
.2326
.2327
.2328
.2329
.2330
.2332
.2334
.2338
.2340
.2342
.2344
.2349

2351
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

84.1 DHCP Relay Status Command Tree . . . . . . . . . . . . . . . . . .


84.2 DHCP Relay Port Statistics . . . . . . . . . . . . . . . . . . . . . . .
84.3 DHCP Relay Port Statistics Related To Untagged Frames . . . . . .
84.4 DHCP Relay Port Summary Statistics Related To Untagged Frames
84.5 DHCP Relay Port Detailed Statistics Related To Untagged Frames .
84.6 DHCP Relay Port Statistics Related To Vlan Ports . . . . . . . . . .
84.7 DHCP Relay Port Summary Statistics Related To Vlan Ports . . . .
84.8 DHCP Relay Port Detailed Statistics Related To Vlan Ports . . . . .
84.9 DHCP v6 Relay Port Statistics . . . . . . . . . . . . . . . . . . . . .
84.10 DHCP v6 Relay Port Statistics Related To Vlan Ports . . . . . . . .
84.11 DHCP v6 Relay Port Summary Statistics Related To Vlan Ports . .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

84- DHCP Relay Status Commands

3HH-04416-EBAA-TCZZA 01

.2285
.2286
.2288
.2290
.2293
.2295
.2297
.2298
.2300
.2302
.2304
.2306
.2308

.2352
.2353
.2356
.2358
.2360
.2362
.2364
.2366

2368

Released

.2369
.2370
.2372
.2374
.2376
.2383
.2385
.2387
.2394
.2396
.2398

xxi

Contents

84.12 DHCP v6 Relay Port Detailed Statistics Related To Vlan Ports . . . . . . . . . . . . . . .2400
84.13 SHub DHCP Relay Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2404
84.14 DHCP Relay Session Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .2407

85- IPv6 Users Status Commands

2411

85.1 IPv6 Users Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2412


85.2 IPv6 Users Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2413

86- Multicast Status Commands

2416

86.1 Multicast Status Command Tree . . . . . . . . . . . . . . . . . . . . . . .


86.2 Multicast Active Groups Status Command . . . . . . . . . . . . . . . . .
86.3 Multicast PON Active Groups Status Command . . . . . . . . . . . . . .
86.4 Multicast ONT Active Groups Status Command . . . . . . . . . . . . . .
86.5 Multicast Group Membership Status Command . . . . . . . . . . . . . . .
86.6 Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command
86.7 SHub Multicast Status Command . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

87- CPE Management Status Commands

.2417
.2418
.2421
.2424
.2427
.2430
.2432

2433

87.1 CPE Management Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .2434


87.2 CPE Management Show Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2435

88- Session Status Commands

2436

88.1 Session Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2437


88.2 Session Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2438

89- PPPoX-Relay Status Commands

2440

89.1 PPPoX-Relay Status Command Tree . . . . . . . . . . .


89.2 PPPoX CC Engine Statistics . . . . . . . . . . . . . . . .
89.3 PPPoX CC Client Port Statistics . . . . . . . . . . . . . .
89.4 PPPoX CC Engine Monitor Statistics . . . . . . . . . . .
89.5 PPPoX CC Client Port Monitor Statistics . . . . . . . . .
89.6 PPPoX CC Session Engine Status Command . . . . . .
89.7 PPPoX CC Session Client Port Status Command . . . .
89.8 PPPCC Engine Current 15Minute Statistics Command . .
89.9 PPPCC Engine Current 1day Statistics Command . . . .
89.10 PPPCC Engine Previous 15Minute Statistics Command
89.11 PPPCC Engine Previous 1day Statistics Command . . .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

90- OSPF Status Commands

2466

90.1 OSPF Status Command Tree . . . . . . . . .


90.2 OSPF Area Status Command . . . . . . . . .
90.3 OSPF LSA Status Command . . . . . . . . .
90.4 OSPF External Link State Status Command .
90.5 OSPF Interface Status Command . . . . . . .
90.6 OSPF Neighbor Status Command . . . . . . .
90.7 OSPF Routing Status Command . . . . . . . .
90.8 OSPF Redistributed Routing Status Command
90.9 OSPF Statistics . . . . . . . . . . . . . . . . .
90.10 OSPF Parameter Status Command . . . . .

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

91- RIP Status Commands


91.1 RIP Status Command Tree . .
91.2 RIP Statistics Command . . .
91.3 RIP Peer Status Command .
91.4 RIP Routing Status Command

xxii

Released

.2441
.2442
.2444
.2447
.2449
.2452
.2455
.2458
.2460
.2462
.2464

.2467
.2468
.2470
.2472
.2474
.2477
.2479
.2481
.2483
.2484

2486
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.2487
.2488
.2489
.2490

01

Contents

91.5 RIP Global Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2492

92- Cluster Status Commands


92.1 Cluster Status Command Tree . . . . .
92.2 Cluster Port Counter Status Command
92.3 Neighbor Device Status Command . .
92.4 Topology Device Status Command . .
92.5 Topology Connect Status Command .

2494
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

93- SHDSL Status Commands

2504

93.1 SHDSL Status Command Tree . . . . . . . . . . . . . . . . . . . . .


93.2 SHDSL Inventory Status Command . . . . . . . . . . . . . . . . . . .
93.3 SHDSL Span Status Command . . . . . . . . . . . . . . . . . . . . .
93.4 SHDSL Unit Status Command . . . . . . . . . . . . . . . . . . . . . .
93.5 SHDSL Segment Status Command . . . . . . . . . . . . . . . . . . .
93.6 SHDSL Segment Counters Current Interval Status Command . . . . .
93.7 SHDSL Segment Counters Current Day Status Command . . . . . . .
93.8 SHDSL Segment Counters Previous Interval Status Command . . . .
93.9 SHDSL Segment Counters Previous Day Status Command . . . . . .
93.10 SHDSL Span Current Interval Performance Data Status Command .
93.11 SHDSL Span Current Day Performance Data Status Command . . .
93.12 SHDSL Span Previous Interval Performance Data Status Command
93.13 SHDSL Span Previous Day Performance Data Status Command . .

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

94.1 IMA Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .


94.2 IMA Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .
94.3 IMA Group Near-End Current Interval Performance Data Status Command
94.4 IMA Group Near-End Previous Interval Performance Data Status Command
94.5 IMA Group Far-End Current Interval Performance Data Status Command .
94.6 IMA Group Far-End Previous Interval Performance Data Status Command .
94.7 IMA Link Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .
94.8 IMA Link Near-End Current Interval Performance Data Status Command . .
94.9 IMA Link Near-End Previous Interval Performance Data Status Command .
94.10 IMA Link Far-End Current Interval Performance Data Status Command . .
94.11 IMA Link Far-End Previous Interval Performance Data Status Command .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

94- IMA Status Commands

3HH-04416-EBAA-TCZZA 01

.2505
.2507
.2509
.2516
.2518
.2523
.2526
.2529
.2532
.2535
.2537
.2539
.2541

2543

95- Voice Status Commands


95.1 Voice Status Command Tree . . . . . . . . . . . . . . . . . . . . . .
95.2 Voice Sip Server Status Commands . . . . . . . . . . . . . . . . . .
95.3 Voice Sip User Agent Access Point Show Commands . . . . . . . .
95.4 Voice Sip Statistics System Status Command . . . . . . . . . . . .
95.5 Voice Sip Statistics Perfinfo Status Command . . . . . . . . . . . .
95.6 Voice Sip Termination Statistics Command for Current 15 Minutes .
95.7 Voice Sip Termination Statistics Command for Current Day . . . . .
95.8 Voice Sip Termination Statistics Command for Previous 15 Minutes
95.9 Voice Sip Termination Statistics Command for Previous day . . . . .
95.10 Voice Sip Call Statistics Command . . . . . . . . . . . . . . . . . .
95.11 Voice Sip board Statistics Command for Current one Day . . . . .
95.12 Voice Sip Board Statistics Command for Previous day . . . . . . .
95.13 Voice Sip Board Statistics Command for Current 15 Minutes . . . .
95.14 Voice Sip Board Statistics Command for Previous 15 Minutes . . .
95.15 Voice Sip Statistics Perfinfo Status Command per board . . . . . .
95.16 Voice Sip restoration: Redundancy Status Commands . . . . . . .
95.17 Voice Sip restoration: Redundancy Status Commands . . . . . . .
95.18 Voice Sip Redundancy Status Commands . . . . . . . . . . . . . .
95.19 Voice Sip Termination Status Commands . . . . . . . . . . . . . .

.2495
.2496
.2498
.2500
.2502

.2544
.2545
.2550
.2552
.2554
.2556
.2558
.2562
.2564
.2566
.2568

2570
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.2571
.2573
.2574
.2576
.2577
.2579
.2582
.2585
.2588
.2591
.2593
.2597
.2601
.2605
.2609
.2611
.2613
.2615
.2616

xxiii

Contents

95.20 Voice Megaco Equipment Board Status Commands


95.21 Voice Megaco Equipment Status Commands . . . .
95.22 Voice Megaco MGI Status Commands . . . . . . . .
95.23 Voice Megaco Database Status Commands . . . . .
95.24 Voice Megaco IP Status Commands . . . . . . . . .
95.25 Voice Megaco SGI Status Commands . . . . . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

96- L2CP Status Commands


96.1 L2CP Status Command Tree . . .
96.2 L2CP Status Command . . . . .
96.3 L2CP Status Command . . . . .
96.4 L2CP Status Command . . . . .
96.5 L2CP Partition Status Command .

.2619
.2621
.2624
.2626
.2627
.2628

2630
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

97- MSTP Status Commands


97.1 MSTP Status Command Tree . . . . . . . .
97.2 SHub MSTP Bridge Status Command . . . .
97.3 SHub MSTP Instance Status Command . . .
97.4 SHub MSTP Network Port Status Command
97.5 SHub MSTP Port Instance Status Command

.2631
.2632
.2634
.2636
.2637

2638
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

98- Ethernet Lt Configuration Data Status Commands


98.1 Ethernet Lt Configuration Data Status Command Tree .
98.2 Ethernet Port Interface Configuration Status Command
98.3 Ethernet IGMP Configuration Status Command . . . . .
98.4 Ethernet Security PAE Configuration Status Command
98.5 Ethernet BridgePort Configuration Status Command . .
98.6 Ethernet QoS Configuration Status Command . . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

2650
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

99- Ethernet Status Commands


99.1 Ethernet Status Command Tree . . . . . . . . . . .
99.2 Interface MAU Status Command . . . . . . . . . . .
99.3 SFP status commands . . . . . . . . . . . . . . . .
99.4 Ethernet Counters Near End Line Current 15 Min .
99.5 Ethernet Counters Near End Line Current Day . . .
99.6 Ethernet Counters Near End Line Previous 15 Min .
99.7 Ethernet Counters Near End Line Previous Day . .
99.8 Ethernet PM Interval Per Interface Status Command
99.9 Ethernet Lt Dot3 Status Command . . . . . . . . .
99.10 Ethernet RMON Counters Status Command . . . .
99.11 Ethernet Statistics Line Status Command . . . . .

.2639
.2640
.2642
.2644
.2647

.2651
.2652
.2654
.2657
.2660
.2664

2666
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

100- Ethernet Lt Operational Data Status Commands


100.1 Ethernet Lt Operational Data Status Command Tree .
100.2 Ethernet Port Operational Status Command . . . . . .
100.3 Ethernet BridgePort Operational Status Command . .
100.4 Ethernet Port Interface Operational Status Command
100.5 Ethernet IGMP Operational Status Command . . . . .
100.6 Ethernet Port Ip Bridge Operational Status Command
100.7 Ethernet QoS Opertaional Status Command . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.2667
.2668
.2673
.2675
.2678
.2681
.2684
.2687
.2689
.2691
.2695

2698

101- Debug Status Commands

.2699
.2700
.2702
.2704
.2706
.2709
.2711

2713

101.1 Debug Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2714


101.2 SW Error Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2715

xxiv

Released

3HH-04416-EBAA-TCZZA

01

Contents

102- Trouble-Shooting Status Commands

2716

102.1 Trouble-Shooting Status Command Tree . . . . . . . . . . . . . . . . .


102.2 Trouble-shooting Statistics To One Port . . . . . . . . . . . . . . . . . .
102.3 Trouble-shooting Statistics on a Port (DSL or Ethernet) or PVC Interface
102.4 Trouble-shooting Statistics To One VlanPort . . . . . . . . . . . . . . .
102.5 Summary Trouble-shooting Statistics To Vlan Ports . . . . . . . . . . . .
102.6 Extensive Trouble-shooting Statistics To Vlan Ports . . . . . . . . . . .
102.7 Extensive Trouble-shooting ipv4-antispoofing Statistics To One UNI Port

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

103- CFM Status Commands

.2717
.2718
.2720
.2722
.2724
.2727
.2731

2733

103.1 CFM Status Command Tree . . . . . . . . . . . . . . . . . . . . . .


103.2 Maintenance Domain on NT Status Command . . . . . . . . . . . .
103.3 Maintenance Association on NT Status Command . . . . . . . . . .
103.4 Maintenance Association End Point on NT Status Command . . . .
103.5 CFM Stack on NT Status Command . . . . . . . . . . . . . . . . . .
103.6 Maintenance Association End Point CCM Database show Command
103.7 Maintenance Association End Point on NT Runtime Info Command .
103.8 LT CFM SLM Responder Statistics Table . . . . . . . . . . . . . . .
103.9 PM proactive show . . . . . . . . . . . . . . . . . . . . . . . . . . .
103.10 Proactive CFM PM show command for the current 15 min . . . . .
103.11 Proactive CFM PM show command for the current 15 min . . . . .
103.12 Proactive CFM PM show command for the current 1 day . . . . . .
103.13 Proactive CFM PM show command for the current 1 day . . . . . .
103.14 Proactive CFM PM show command for the previous 15 min . . . . .
103.15 Proactive CFM PM show command for the previous 15 min . . . . .
103.16 Proactive CFM PM show command for the previous 1 day . . . . .
103.17 Proactive CFM PM show command for the previous 1 day . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

104- IPoA/E IW Status Commands

.2734
.2736
.2738
.2741
.2745
.2748
.2751
.2755
.2757
.2758
.2759
.2764
.2765
.2770
.2771
.2776
.2777

2782

104.1 IPoA/E IW Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2783


104.2 IPoA/E IW Interworking Port Status Command . . . . . . . . . . . . . . . . . . . . . . .2784

105- LineTest Status Commands

2786

105.1 LineTest Status Command Tree . . . . . . . . . . . .


105.2 Megaco LineTest Available Session Status Command
105.3 Megaco LineTest Session Status Command . . . . .
105.4 Megaco LineTest Line Status Command . . . . . . . .
105.5 Megaco LineTest LineId ExtReport Status Command .
105.6 SINGLE LineTest Available Session Status Command
105.7 SINGLE LineTest Session Status Command . . . . .
105.8 SINGLE LineTest Line Status Command . . . . . . .
105.9 SINGLE LineTest LineId ExtReport Status Command
105.10 SINGLE LineTest Chipset Data Command . . . . . .
105.11 SINGLE LineTest Session busy port Command . . .

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

106- LACP status commands


106.1 LACP status commands Tree . . . . .
106.2 LACP Port Status Command . . . . .
106.3 LACP Group Status Command . . . .
106.4 LACP Member Port Status Command

.2787
.2788
.2789
.2791
.2795
.2801
.2802
.2805
.2809
.2815
.2816

2818
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

107- MSTP Status Commands

.2819
.2820
.2826
.2828

2830

107.1 MSTP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2831


107.2 MSTP Bridge Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2832
107.3 MSTP Instance Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2834

3HH-04416-EBAA-TCZZA 01

Released

xxv

Contents

107.4 MSTP Network Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .2836


107.5 MSTP Port Instance Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .2839

108- Distributed Service Status Commands

2842

108.1 Distributed Service Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . .2843


108.2 Service Access Mapping Status Command . . . . . . . . . . . . . . . . . . . . . . . . .2844
108.3 APIPE-PVC Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2846

109- IPv6 Users Status Commands

2848

109.1 IPv6 Users Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2849


109.2 IPv6 Users Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2850

110- Security Status Commands

2853

110.1 Security Status Command Tree . . . . . . . . . . . . . . .


110.2 Operator Information Status Command . . . . . . . . . . .
110.3 Domain Status Command . . . . . . . . . . . . . . . . . . .
110.4 User Sessions Status Command . . . . . . . . . . . . . . .
110.5 Connection Profile Status Command . . . . . . . . . . . . .
110.6 RADIUS Authentication Server Statistics Command . . . .
110.7 RADIUS Authentication Server Status Command . . . . . .
110.8 RADIUS Accounting Server Statistics Command . . . . . .
110.9 RADIUS Accounting Server Status Command . . . . . . . .
110.10 RADIUS Dynamic Authentication Client Status Command
110.11 RADIUS Next Available Index Command . . . . . . . . . .
110.12 RADIUS Client Status Command . . . . . . . . . . . . . .
110.13 PAE Authenticator Status Command . . . . . . . . . . . .
110.14 EAPOL Statistics Command . . . . . . . . . . . . . . . . .
110.15 Diagnostic Information Status Command . . . . . . . . . .
110.16 Session Statistics Command . . . . . . . . . . . . . . . .
110.17 PAE Port System Status Command . . . . . . . . . . . . .
110.18 MAC Address related EAPOL Status Command . . . . . .
110.19 SSH Server Status Command . . . . . . . . . . . . . . . .
110.20 PM File Upload Status Command . . . . . . . . . . . . . .
110.21 PM File Upload Status Command . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

111.1 Alarm Management Command Tree . . . . . . . . . . . . . .


111.2 Alarm Management Command . . . . . . . . . . . . . . . . .
111.3 Snapshot Management Command . . . . . . . . . . . . . . .
111.4 SHub Snapshot Management Command . . . . . . . . . . .
111.5 Shub Ospf Clear management Command . . . . . . . . . . .
111.6 Alarm Delta Log Management Command . . . . . . . . . . .
111.7 Log Management Command . . . . . . . . . . . . . . . . . .
111.8 Alarm Filetransfer Manual Clearance Management Command

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

111- Alarm Management Commands

.2854
.2856
.2858
.2859
.2865
.2866
.2869
.2870
.2872
.2873
.2875
.2876
.2877
.2880
.2883
.2888
.2891
.2893
.2895
.2896
.2897

2899

112- ATM Management Commands

.2900
.2901
.2902
.2904
.2905
.2906
.2907
.2908

2909

112.1 ATM Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2910


112.2 ATM Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2911

113- IGMP Management Commands


113.1 IGMP Management Command Tree . . . . . . .
113.2 IGMP Management Command . . . . . . . . . .
113.3 IGMP Multicast Sources Management Command
113.4 IGMP Multicast Channel Management Command
113.5 IGMP Multicast Channel Management Command
113.6 IGMP Slot Management Command . . . . . . .

xxvi

Released

2913
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.2914
.2915
.2916
.2917
.2918
.2920

01

Contents

113.7 Shub IGMP CAC Bundle Management Command .


113.8 Shub IGMP CAC Source Management Command .
113.9 Shub IGMP CAC System Management Command .
113.10 Shub IGMP VLAN System Management Command
113.11 IGMP Channel Management Command . . . . . .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

114- PPPoX Management Commands

.2921
.2922
.2923
.2924
.2925

2928

114.1 PPPoX Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .2929


114.2 PPPoX Engine Port Management Command . . . . . . . . . . . . . . . . . . . . . . . .2930

115- PPPoE Management Commands

2931

115.1 PPPoE Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .2932


115.2 PPPoE Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2933

116- xDSL Management Commands

2935

116.1 xDSL Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2936


116.2 xDSL Line Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2937

117- Software Management Commands


117.1 Software Management Command Tree .
117.2 Software Management Command . . . .
117.3 OSWP Software Management Command
117.4 Database Management Command . . . .
117.5 File Management Command . . . . . . .
117.6 SHub Software Management Command .
117.7 SHub Database Management Command
117.8 Update the SHub Boot ROM Command .
117.9 CDE Management Command . . . . . .

2939
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

118- OSPF Management Commands

.2940
.2941
.2942
.2944
.2946
.2947
.2948
.2949
.2950

2951

118.1 OSPF Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2952


118.2 OSPF Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . .2953

119- RIP Management Commands

2955

119.1 RIP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2956


119.2 RIP Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . . .2957

120- SHDSL Management Commands

2958

120.1 SHDSL Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .2959


120.2 SHDSL Segment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . .2960

121- Session Management Commands

2962

121.1 Session Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .2963


121.2 Forced Disconnect Session Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .2964

122- System Management Commands


122.1 System Management Command Tree . . . . . . .
122.2 SYSLOG Management command . . . . . . . . .
122.3 Secure Shell Server Key Regeneration Command
122.4 PM File Upload Management Command . . . . . .
122.5 PM File Upload Management Command . . . . . .
122.6 CPU Load Management Command . . . . . . . .

3HH-04416-EBAA-TCZZA 01

2965
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

Released

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.2966
.2967
.2968
.2969
.2970
.2971

xxvii

Contents

123- UDP debug Management Commands

2973

123.1 UDP debug Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .2974


123.2 Forced Disconnect UDP debug Command . . . . . . . . . . . . . . . . . . . . . . . . . .2975

124- Trouble-Shooting Management Commands

2976

124.1 Trouble-Shooting Management Command Tree . . . . . . . . . . . . . . . . . . . . . . .2977


124.2 Trouble-shooting Interface Management Commands . . . . . . . . . . . . . . . . . . . .2978

125- Voice Management Commands

2980

125.1 Voice Management Command Tree . . . . . . . . . . . . . .


125.2 Voice Megaco Database Management Command . . . . . . .
125.3 Voice Megaco Termination Lock Management Command . .
125.4 Voice Megaco Media Gateway Lock Management Command

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

126- MSTP Management Commands

.2981
.2982
.2983
.2985

2987

126.1 MSTP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2988


126.2 MSTP Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2989

127- Distributed Service Management Commands

2990

127.1 Distributed Service Management Command Tree . . . . . . . . . . . . . . . . . . . . . .2991


127.2 APIPE-PVC Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2992

128- CFM Unicast Loopback Management Command.

2993

128.1 CFM Unicast Loopback Management Command. Tree . . . . . . . . . . . . . . . . . . .2994


128.2 Unicast Loopback message Management Command . . . . . . . . . . . . . . . . . . . .2995

129- CFM Multicast Loopback Management Command

2999

129.1 CFM Multicast Loopback Management Command Tree . . . . . . . . . . . . . . . . . .3000


129.2 Multicast Loopback message Management Command . . . . . . . . . . . . . . . . . . .3001

130- CFM Linktrace management command

3003

130.1 CFM Linktrace management command Tree . . . . . . . . . . . . . . . . . . . . . . . .3004


130.2 Linktrace message Management Command . . . . . . . . . . . . . . . . . . . . . . . . .3005

131- CFM Single Ended Synthetic Loss Measurement message Management3011


Command
131.1 CFM Single Ended Synthetic Loss Measurement message Management Command Tree3012
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
131.2 Single Ended Synthetic Loss Measurement message Management Command . . . . . .3013

132- Efm Oam Management Command

3016

132.1 Efm Oam Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .3017


132.2 Efm Oam Interface Management Command . . . . . . . . . . . . . . . . . . . . . . . . .3018

133- Equipment Management Commands


133.1 Equipment Management Command Tree
133.2 Equipment Management Command . . .
133.3 Slot Management Command . . . . . . .
133.4 SHub Port Management Command . . .

xxviii

Released

.
.
.
.

3020
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

3HH-04416-EBAA-TCZZA

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.3021
.3022
.3023
.3025

01

Contents

134- Ethernet Management Commands

3027

134.1 Ethernet Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .3028


134.2 Ethernet Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3029
134.3 Ethernet Statistics Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3030

135- Bridge Management Commands

3031

135.1 Bridge Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3032


135.2 Learned Unicast MAC Address Management Command . . . . . . . . . . . . . . . . . .3033
135.3 VLAN Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3036

136- Trap Management Commands

3037

136.1 Trap Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3038


136.2 Trap Manager Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .3039

137- Interface Management commands


137.1 Interface Management commands Tree . . . . . . . . . .
137.2 Interface Troubleshooting Ethernet Statistics Commands .
137.3 Shub Troubleshooting Statistics Management Command .
137.4 Interface Shub Ethernet Statistics Management Command

3040
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

138.1 IP Management Command Tree . . . . . . . . . . . . . . .


138.2 Slot-related VRF Management Command . . . . . . . . . .
138.3 IP VRF Interface Reset Management Command . . . . . .
138.4 IP VRF Interface bridgeport Reset Management Command
138.5 Vlan Interface Delete Command . . . . . . . . . . . . . . .
138.6 ARP statistics Management Command . . . . . . . . . . .
138.7 SHub ARP Statistics Management Command . . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

138- IP Management Commands

3047

139- DHCP Management Command


139.1 DHCP Management Command Tree . . . . . . . . . . . . .
139.2 DHCP Relay User Port Management Command . . . . . .
139.3 DHCP Relay User Port Management Command . . . . . .
139.4 SHub DHCP Relay Agent Statistics Management Command

.3041
.3042
.3043
.3045

.3048
.3049
.3050
.3052
.3054
.3055
.3057

3058
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

140- ARP-RELAY statistics Management Commands

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.3059
.3060
.3063
.3065

3066

140.1 ARP-RELAY statistics Management Command Tree . . . . . . . . . . . . . . . . . . . .3067


140.2 Arp-relay statistics Management Command . . . . . . . . . . . . . . . . . . . . . . . . .3068

141- Transport Management Commands

3070

141.1 Transport Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .3071


141.2 IP Net-to-media Management Command . . . . . . . . . . . . . . . . . . . . . . . . . .3072

142- SNTP Management Commands

3073

142.1 SNTP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3074


142.2 SNTP Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3075

143- Transactions Management Commands

3076

143.1 Transactions Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . .3077


143.2 Transaction Configuration Management Command . . . . . . . . . . . . . . . . . . . . .3078

3HH-04416-EBAA-TCZZA 01

Released

xxix

Contents

144- Security Management Commands

3079

144.1 Security Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .3080


144.2 Security 802.1x Port Authentication Management Command . . . . . . . . . . . . . . . .3081

145- MSTP Bridge Management Commands

3083

145.1 MSTP Bridge Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . .3084


145.2 Port-related MSTP Management Command . . . . . . . . . . . . . . . . . . . . . . . . .3085

146- Debug commands

3086

146.1 Debug commands Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3087


146.2 Debug commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3088

147- Ping Commands

3089

147.1 Ping Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3090


147.2 Ping Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3091
147.3 Ping Per Vrf Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3093

148- Traceroute Commands

3095

148.1 Traceroute Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3096


148.2 Traceroute Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3097
148.3 Traceroute Per Vrf Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3099

149- Global And Environmental Commands


149.1 History Command . . . . . .
149.2 Echo Command . . . . . . .
149.3 Telnet Command . . . . . .
149.4 Telnet AI Command . . . . .
149.5 Exec Command . . . . . . .
149.6 Sleep Command . . . . . . .
149.7 Tree Command . . . . . . .
149.8 Write Command . . . . . . .
149.9 Logout Command . . . . . .
149.10 Help Command . . . . . . .
149.11 Info Command . . . . . . .
149.12 Exit Command . . . . . . .
149.13 Back Command . . . . . .
149.14 Delete Command . . . . .
149.15 In Command . . . . . . . .
149.16 Configure Command . . . .
149.17 Action Command . . . . . .
149.18 Show Command . . . . . .
149.19 Recursive Show Command
149.20 Sample Command . . . . .
149.21 Poll Command . . . . . . .
149.22 Debug Command . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

3101
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

150- CLI Filters

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.3102
.3103
.3104
.3105
.3106
.3108
.3109
.3110
.3111
.3112
.3113
.3116
.3117
.3118
.3119
.3120
.3122
.3123
.3124
.3125
.3126
.3127

3128

150.1 Count Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3129


150.2 Match Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3130
150.3 Tee Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3131

151- CLI Printers

3132

151.1 More . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3133

xxx

Released

3HH-04416-EBAA-TCZZA

01

Contents

151.2 No-More . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3134


151.3 Discard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3135

Index

3HH-04416-EBAA-TCZZA 01

3136

Released

xxxi

Contents

xxxii

Released

3HH-04416-EBAA-TCZZA

01

1- ISAM CLI

1.1 History
1.2 Preface
1.3 CLI Commands
1.4 Nodes
1.5 Parameters
1.6 Filters
1.7 Printers
1.8 Getting help
1.9 The CLI Prompt
1.10 Entering CLI Commands
1.11 CLI Backward Compatibility
1.12 Phase Out Strategy Obsolete Commands and/or
Parameters
1.13 Command Phase Out Annoucement Release

3HH-04416-EBAA-TCZZA 01

1-2
1-41
1-42
1-43
1-44
1-47
1-48
1-49
1-50
1-51
1-52
1-54
1-55

Released

1 ISAM CLI

1.1 History
This history section enumerates the CLI commands which are new, modified or removed between any two
subsequent releases. No details are provided within this section. The command description, syntax and parameters for
each new and modified command is in the Command Syntax section of the respective command in the CLI
Command Guide. To know the difference between e.g R4.6 and R4.5, review the delta's of the releases R4.5.01
versus R4.5 and R4.5.02 versus R4.5.01 and R4.6 versus R4.5.02.

Command delta R5.1 versus R5.0.01


Modified Commands
configure cfm domain association mep (supporting LM originator and historical counters for past
measurements on VDSL LTs)
configure cfm y1731pm domain association (supporting LM originator and historical counters for past
measurements on VDSL LTs)
configure equipment shelf (adding mode that supports NT-B slot that can be used as LT slot)
show equipment shelf (adding mode that supports NT-B slot that can be used as LT slot)
configure linetest cluster ltparm test-name (adding megaco testtypes, GR909 faults testing, fixing dial
tone delay)
configure linetest cluster ltsession (adding megaco testtypes, GR909 faults testing, fixing dial tone delay)
show linetest cluster lineid-ext-rept (adding megaco testtypes, GR909 faults testing, fixing dial tone
delay)
configure qos dsl-ctrl-pkt-policer (adding option to disable policing of RIP/ARP traffic on data plane in
upstream)
configure system (adding support for voice image selection)
configure vlan id (removed obsoleted parameters broadcast-frames and secure-forwarding)
configure voice cluster media-gateway (updating supported MGC types)
configure voice cluster equipment termination (updating supported termination for 270duratelsplitter and
2703splitter)
configure voice sip termination (updating supported termination for 270duratelsplitter and 2703splitter)
show system license (lining up license key counters for TL1 and CLI)
show xdsl config-data-port igmp (remove PON identifiers from the res-ids)
show interface port (updated description of last-chg-opr-stat)
configure equipment applique (adding support for FNIO-A)
show equipment applique (adding support for FNIO-A)
admin voice cluster media-gateway (adding support for Single Node Standalone SOS operation, adding
failover to ESA MGC alarm type)
configure alarm entry (adding failover to ESA MGC alarm type)
configure alarm filter filterid (adding failover to ESA MGC alarm type)
New Commands

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show equipment planned-resource (showing the actual values of configured hardware resources on
boards)
configure qos pbit-scheduling (configuring the p-bit behavior of the S+C vlan forwarding model in both
upstream and downstream direction)
configure xdsl-bonding board (adding bonding vectoring fallback for future use)
configure xdsl-bonding board vect-fallback (adding bonding vectoring fallback for future use)
show mcast ont-active-groups (shows the list of active multicast streams per user interface on a particular
ONT)
show mcast pon-active-groups (shows the list of active multicast streams per user interface on a particular
PON)

Command delta R5.0.01 versus R5.0


Modified Commands
configure voice cluster media-gateway (new parameter quat-mgc-ip and quat-mgc-udp for IMS Geo
Redundancy)
configure voice cluster signal-gateway (new parameter quat-asp-ip and quat-sctp-port for IMS Geo
Redundancy)
configure voice sip user-agent-ap slot-id (adding support for NTIO board)
show voice sip redundancy-node ext-redundancy-state (adding support for NTIO board)
show voice sip redundancy-node redundancy-state (adding support for NTIO board)
show voice sip user-agent-ap (adding support for NTIO board)
configure alarm entry (updating alarm list with new alarms, adding power alarms introduced for 7363
ISAM MX and 7367 ISAM SX)
configure alarm filter filterid (updating alarm list with new alarms)
show alarm delta-log indeterminate (updating alarm list with new alarms)
show alarm delta-log warning (updating alarm list with new alarms)
show alarm delta-log minor (updating alarm list with new alarms)
show alarm delta-log major (updating alarm list with new alarms)
show alarm delta-log critical (updating alarm list with new alarms)
configure ethernet line mau (addng supported mau types)
configure qos profiles policer (updating policer profile ranges for MEF certification and MEF Policer rate
calculation to include only L2 bytes)
configure vlan id (adding new parameter 'cvlan4095passthru' to forward c-vid 4095 transparently)
show qos statistics buffer-overflow current-1day (removal of obsolete parameter values for 'slotindex')
show vlan bridge-port-fdb (enabling retrieval of mac-adresses learned on uplink lt)
show vlan fdb-board (improved display of dup mac alarm)
show vlan dup-mac-alarm (improved display of dup mac alarm)
configure system security login-banner (expanding Logon banner to 2048 characters)
configure system loop-id-syntax (adding 'LzNVID' as keyword to construct the system loop ID)

3HH-04416-EBAA-TCZZA 01

Released

1 ISAM CLI

show xdsl counters near-end line previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters near-end line previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters near-end channel previous-interval (adding a timestamp to each PM interval,
specifying the date and time of the start of the PM interval)
show xdsl counters near-end channel previous-day (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters far-end line previous-interval (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters far-end line previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl counters far-end channel previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show xdsl counters far-end channel previous-day (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show xdsl imp-noise-sensor near-end previous-interval (adding a timestamp to each PM interval,
specifying the date and time of the start of the PM interval)
show xdsl imp-noise-sensor far-end previous-interval (adding a timestamp to each PM interval, specifying
the date and time of the start of the PM interval)
show shdsl segment-counters previous-15min (adding a timestamp to each PM interval, specifying the
date and time of the start of the PM interval)
show shdsl segment-counters previous-1day (adding a timestamp to each PM interval, specifying the date
and time of the start of the PM interval)
show shdsl span-counters previous-15min (adding a timestamp to each PM interval, specifying the date
and time of the start of the PM interval)
show shdsl span-counters previous-1day (adding a timestamp to each PM interval, specifying the date and
time of the start of the PM interval)
New Commands
configure cfm y1731pm (adding on-demand and proactive performance monitoring compliant with
Y.1731)
configure cfm y1731pm domain association (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm (adding on-demand and proactive performance monitoring compliant with Y.1731)
show cfm y1731pm curr-15min-stats (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm curr-15min-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm curr-day-stats (adding on-demand and proactive performance monitoring compliant
with Y.1731)
show cfm y1731pm curr-day-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm prev-15min-stats (adding on-demand and proactive performance monitoring
compliant with Y.1731)

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show cfm y1731pm prev-15min-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
show cfm y1731pm prev-day-stats (adding on-demand and proactive performance monitoring compliant
with Y.1731)
show cfm y1731pm prev-day-stats domain (adding on-demand and proactive performance monitoring
compliant with Y.1731)
Removed Commands or Commands with removed parameters
show system sync-if-timing-ptp (removing obsolete command)

Command delta R5.0 versus R4.6.02


Modified Commands
configure alarm entry (OLT support SIPPING Alarms, ONTalarms, removal of obsolete alarms)
configure cfm domain association mep (support Y.1731 SLM Originator and LM responder on CATAN
based VDSL LT's)
show system license (support Y.1731 SLM Originator and LM responder on CATAN based VDSL LT's)
show cfm mep-config-data domain (support Y.1731 SLM Originator and LM responder on CATAN
based VDSL LT's)
configure ethernet line tca-line-threshold (Extend TCA on Eth Phy PM traffic counters)
configure qos interface (allow vlanport on DSL/ETH interface)
configure qos tca queue (allow vlanport on DSL/ETH interface)
show interface port (improved display parameters as an extension of the interface MIB for the efm
interface according to RFC2863 )
show qos interface-bandwidth (allow vlanport on DSL/ETH interface)
show qos statistics queue current-15min (allow vlanport on DSL/ETH interface)
show qos statistics queue prev-15min (allow vlanport on DSL/ETH interface)
configure qos profiles policer (The use of 'discard' value for GreenAction is disabled)
configure system security filetransfer server (improved security for operator password)
configure system security pmfile upload (improved security for operator password)
configure system security radius acc-server (name) router-instance (improved security for operator
password)
configure system security radius auth-server (name) router-instance (improved security for operator
password)
configure system security radius dyn-auth-client (name) router-instance (improved security for operator
password)
show xdsl config-data-port pppox-relay (improved response speed)
show alarm current ether=tca (extend TCA on Eth Phy PM traffic counters)
show alarm snap-shot ether=tca (extend TCA on Eth Phy PM traffic counters)
show alarm log ether=tca (extend TCA on Eth Phy PM traffic counters)
show xdsl vect-carrier-data far-end (improved value range)

3HH-04416-EBAA-TCZZA 01

Released

1 ISAM CLI

show xdsl vect-carrier-data near-end (improved value range)


configure linetest single ltsession (adding SIP NBLT session busy-overwrite parameter :
"busy-overwrite")
configure system clock-mgmt (clock input failure derived from AIS)
configure vlan id (updated description of parameter 'new-broadcast')
configure voice sip termination (improved security for operator password)
configure voice sip termination (add line signal on remote answer parameter : "linesig-remanswer")
configure voice sip termination (add test access parameters : "testaccessstate", "busyoverwrite" and
"accessontimeout")
configure voice sip termination (add line identification parameter (pani-header): "line-id")
configure voice sip digitmap (size of parameter "rule" increased to 100 bytes)
show config-data-port security-pae (add missing PON types)
show oper-data-port ip-bridge-port (add missing PON types)
New Commands
admin cfm single-ended-slm (support Y.1731 SLM Originator and LM responder on CATAN based
VDSL LT's)
admin cfm single-ended-slm domain association mep target-mac (support Y.1731 SLM Originator and
LM responder on CATAN based VDSL LT's)
configure alarm filter filterid (CLI coverage of TL1 Alarm Filter)
show alarm current spatial (add spatial filter alarm)
show alarm current temporal (add temporal filter alarm)
show alarm log spatial (add spatial filter alarm)
show alarm log temporal (add temporal filter alarm)
show alarm snap-shot spatial (add spatial filter alarm)
show alarm snap-shot temporal (add temporal filter alarm)
configure voice cluster equipment termination tca (Voice QoS threshold TCA (drop rate, jitter, loop
delay) )
show qos resource-usage (QOS resource usage status (NELT-B HighCap UNI increment))
show qos resource-usage ingress-hw-filter (QOS resource usage status (NELT-B HighCap UNI
increment))
admin interface shub eth-frame (statistics for ethernet counter uplink port statistics)
admin interface shub eth-frame statistics (statistics for ethernet counter uplink port statistics)
show interface shub eth-frame (statistics for ethernet counter uplink port statistics)
show interface shub eth-frame statistics (statistics for ethernet counter uplink port statistics)
show interface shub eth-frame statistics current-1day (statistics for ethernet counter uplink port statistics)
show interface shub eth-frame statistics current-interval (statistics for ethernet counter uplink port
statistics)
show interface shub eth-frame statistics previous-1day (statistics for ethernet counter uplink port
statistics)
show interface shub eth-frame statistics previous-interval (statistics for ethernet counter uplink port

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

statistics)
New commands NOT supported yet
configure system auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm current auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm log auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm snap-shot auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
configure alarm entry auto-switch-status (Auto-switching between ATMoADSL and PTMoVDSL)
configure alarm filter auto-switch-status (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm delta-log auto-switch-status (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm current table auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm log table auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show alarm snap-shot table auto-switch (Auto-switching between ATMoADSL and PTMoVDSL)
show equipment planned-resource
Removed Commands or Commands with removed parameters
configure bridge port (removal of obsolete parameters old-tag accept-frame-type)
configure vlan (removal of obsolete parameter pvid-usage)
configure vlan id (removal of obsolete parameters pppoe-relay circuit-id remote-id)
configure system security snmp community host-address (obsolete parameter values removed)

Command delta R4.6.02 versus R4.6.01


Modified Commands
show xdsl vect-carrier-data far-end (improved display of sampling rate)
show xdsl vect-carrier-data near-end (improved display of sampling rate)
configure xdsl-bonding group (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding operational-data group (2-pair VDSL2 PTM bonding in combination with G.inp)
configure system sync-if-timing ref-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b", restrictions removed)
configure system sync-if-timing ssm-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b", restrictions removed)
show system sync-if-timing (Synchronisation Redundancy for BITS/SyncE/IEEE1588 parameter value
"ieee1588" replaced by "ieee1588-a" or "ieee1588-b", restrictions removed)
New Commands
configure xdsl-bonding group-rtx-profile (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding group-rtx-profiles (2-pair VDSL2 PTM bonding in combination with G.inp)

3HH-04416-EBAA-TCZZA 01

Released

1 ISAM CLI

Command delta R4.6.01 versus R4.6


Modified Commands
show dhcp-relay port-stats vlan (improved response on SLT platform)
show dhcp-relay v6-port-stats vlan (improved response on SLT platform)
show vlan port-15min-stats (improved parameter range display)
show vlan port-prev-day-stats (improved parameter range display)
show vlan previous-15min-stats (improved parameter range display)
show vlan vlan-day-stats (improved parameter range display)
configure alarm entry (support new alarms for different features, improved alarm mechanism
specification)
configure alarm log-sev-level (improved alarm mechanism specification)
configure alarm shub entry (improved alarm mechanism specification)
configure trap manager (improved alarm mechanism specification)
show alarm log table (improved alarm mechanism specification)
show alarm current table (improved alarm mechanism specification)
show alarm snap-shot table (improved alarm mechanism specification)
configure bridge port (support bp and vp for uplink port)
configure cfm domain association (ONT CFM SW enhancements)
configure cfm domain association mep (support Y.1731 DM responder)
show cfm mep-config-data domain association mep (support Y.1731 DM responder)
configure system security pmfile upload (automatic PM collection)
admin system security pmfile upload (automatic PM collection)
show equipment shelf detail (retrieve serial Number, ICS and variant of the shelf)
show equipment transceiver-inventory (Report B+/C+ type for GPON SFPs)
show security pmfile upload (automatic PM collection)
configure ip shub vrf (update CLI for lanxVrfName and lanxVrfMode)
New Commands
admin ethernet statistics (support RMON counters on NELT-B interfaces)
show ethernet etherstats (support RMON counters on NELT-B interfaces)
show cfm slm-responder-stats (SLM Responder on CATAN VDSL LT and NELT-B UNI)
show cfm slm-responder-stats domain (SLM Responder on CATAN VDSL LT and NELT-B UNI)
show vlan port-accumu-stats (support display of accumulate statistics on the bridge port)
show system sync-if-timing-ptp (Synchronisation Redundancy for BITS/SyncE/IEEE1588)
Removed Commands or Commands with removed parameters
configure system snmp manager (improved usage of SNMPv3, dpoe parameter removed)

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

New Commands NOT supported yet


configure xdsl-bonding [no] group-rtx-profile (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding group-rtx-profiles (2-pair VDSL2 PTM bonding in combination with G.inp)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)
configure xdsl-bonding group (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding operational-data group (2-pair VDSL2 PTM bonding in combination with G.inp)
Commands with new parameters or parameter values with LIMITED support (commands
are NOT backward compatible with previous releases. Note : configure maximum only
one IEEE1588 clock source. In duplex NT mode, this clock source can be configured on
either NT-A or NT-B, independently of which one is the active one. The NT that has the
clock source configured will pass on the signal to its peer NT)
configure system sync-if-timing ref-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b")
configure system sync-if-timing ssm-order (Synchronisation Redundancy for BITS/SyncE/IEEE1588
parameter value "ieee1588" replaced by "ieee1588-a" or "ieee1588-b")

Command delta R4.6 versus R4.5.02


Modified Commands
configure bridge port [no] vlan-id (implement dedicated downstream voice queue, for VOIP services on
both VOIP and VEIP UNI's)
configure cfm domain association [no] mep (iY.1731 SLM Responder on CATAN based VDSL LT's and
NELT-B UNI)
configure cfm domain association [no] name (improvement : [no] command removed)
configure equipment sfpe1t1 framer (removal of obsolete loopback parameters)
configure mcast static [no] branch (GPON static Multicast per ONT, add AID for GPON vlan port)
configure qos profiles [no] bandwidth (support for MEF qualification MIB Impact)
configure qos profiles [no] l3-filter (support L3 ACLs in an IPv6 context)
configure system (PPPoE / DHCP customer-id configuration at system level)
configure system pon-ont (SN bundle with LOID or SLID)
configure system security snmp [no] community (DOCSIS Provisioning Framework)
configure system security snmp [no] group (DOCSIS Provisioning Framework)
configure system security snmp [no] manager (DOCSIS Provisioning Framework)
configure voice sip redundancy (Configurable DNS Selection Algorithm)
configure xdsl [no] service-profile (increase the number of service profiles to 1024)
configure xdsl line [no] service-profile (increase the number of service profiles to 1024)
configure xdsl board vect-fallback [no] service-profile (increase the number of service profiles to 1024)

3HH-04416-EBAA-TCZZA 01

Released

1 ISAM CLI

show system license (MPLS ring with sub 50 ms switchover)


show cfm mep-configdata domain (Y.1731 SLM Responder on CATAN based VDSL LT's and NELT-B
UNI)
show cfm mep-info domain (improvement : displays each field of a CCM packet)
configure bridge port (Support for Multiple LLID on EPON ONU for DPoE)
configure system (Support for Multiple LLID on EPON ONU for DPoE)
configure qos (Support for Multiple LLID on EPON ONU for DPoE)
configure vlan (Support for Multiple LLID on EPON ONU for DPoE)
configure arp-relay (Support for Multiple LLID on EPON ONU for DPoE)
configure qos interface ellid (Support for Multiple LLID on EPON ONU for DPoE)
configure system management (replaces "configure transport ip default-ttl")
Removed Commands or Commands with removed parameters
configure equipment sfpe1t1 global (removal of obsolete loopback commands)
configure alarm entry (removal of obsolete alarms lt-problem and applique-problem)
New Commands
configure cfm slm (Y.1731 SLM Responder on CATAN based VDSL LT's and NELT-B UNI)
show ethernet dot3stats (ether-like counters on NELT-B, replaces show transport ether-ifdot3lt)
show ethernet mau (replaces "show transport ether-ifmault" for NELT-B MAU operational data)
show ethernet sfp (replaces "show transport ether-ifsfplt" for NELT-B SFP inventory data)
New Commands not supported yet
configure xdsl-bonding [no] group-rtx-profile (2-pair VDSL2 PTM bonding in combination with G.inp)
show xdsl-bonding group-rtx-profiles (2-pair VDSL2 PTM bonding in combination with G.inp)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)
configure xdsl-bonding group (2-pair VDSL2 PTM bonding in combination with G.inp)

Command delta R4.5.02 versus R4.5.01


Modified Commands
configure alarm entry (support new alarms for different features)
configure bridge port vlan-id (MAC learning control per vlanport on GPON LT)
configure cfm domain association (CFM Enhancement to support CCM messages)
configure cfm domain association mep (CFM Enhancement to support CCM messages)
show cfm mep-config-data domain (CFM Enhancement to support CCM messages)

10

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show cfm ma-config-data domain (CFM Enhancement to support CCM messages)


configure qos interface upstream-queue (Traffic Rate Limiting per GEM port)
configure qos profiles marker [no] d1p-alignment (support for multiple DSCP to pbit mapping profiles)
configure voice sip [no] termination (ANSI E911 Emergency Call features for SIP)
configure xdsl board (vectoring functionality on NRCD-C REM controller board, Cross-DSLAM
vectoring)
configure xdsl vp-board (vectoring functionality on NRCD-C REM controller board, Cross-DSLAM
vectoring)
Show alarm log vect-board (vectoring functionality on NRCD-C REM controller board, Cross-DSLAM
vectoring)
Show alarm current vect-board (vectoring functionality on NRCD-C REM controller board,
Cross-DSLAM vectoring)
Show alarm snap-shot vect-board (vectoring functionality on NRCD-C REM controller board,
Cross-DSLAM vectoring)
show xdsl vp-board (vectoring functionality on NRCD-C REM controller board, Cross-DSLAM
vectoring)
Show xdsl vect-group (vectoring functionality on NRCD-C REM controller board, Cross-DSLAM
vectoring)
Show xdsl failure-status vect-board (vectoring functionality on NRCD-C REM controller board,
Cross-DSLAM vectoring)
configure xdsl board vect-fallback (allows fallback mode for configuration not feasible,Cross-DSLAM
Vectoring)
show xdsl vect-carrier-data far-end (Cross-DSLAM full vectoring support)
show xdsl vect-carrier-data near-end (Cross-DSLAM full vectoring support)
Removed Commands or Commands with removed parameters
show system license cci-enabled-mep (replaced by "show system license eth-oam-adv-mon")
admin ethernet (obsolete because "ethernet" is not applicable in this context)
show interface port (obsolete parameter value "ethernet" is not applicable in this context)
show interface stack (obsolete parameter value "ethernet" is not applicable in this context)
show interface test (obsolete parameter value "ethernet" is not applicable in this context)
New Commands
admin interface trouble-shooting ethernet statistics (troubleshooting counters on the FD-REM link)
show interface trouble-shooting ethernet statistics (troubleshooting counters on the FD-REM link)
configure cfm domain association remote-mep (CFM Enhancement to support CCM messages)
show alarm current cfm (CFM Enhancement to support CCM messages)
show alarm log cfm (CFM Enhancement to support CCM messages)
show alarm snap-shot cfm (CFM Enhancement to support CCM messages)
show cfm ccm-database (CFM Enhancement to support CCM messages)
show cfm ccm-database domain (CFM Enhancement to support CCM messages)

3HH-04416-EBAA-TCZZA 01

Released

11

1 ISAM CLI

show cfm mep-info domain (CFM Enhancement to support CCM messages)


show alarm current efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
show alarm log efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
show alarm snap-shot efm-oam (DSL/ETH LT 802.3ah Critical Event Notification support)
configure pppox-relay cross-connect engine (troubleshooting improvement for PPP Relay with MAC
concentration)
show alarm current pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC
concentration)
show alarm log pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC concentration)
show alarm snap-shot pppcc-engine-tca (troubleshooting improvement for PPP Relay with MAC
concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine curr-15min-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine curr-1day-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine prev-15min-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
show pppox-relay cross-connect trouble-shooting-cntrs engine prev-1day-stats (troubleshooting
improvement for PPP Relay with MAC concentration)
configure qos profiles [no] dscp-pbit (support for multiple DSCP to pbit mapping profiles)
configure qos profiles codepoint (support for multiple DSCP to pbit mapping profiles)
show qos profile-usage dscp-pbit (support for multiple DSCP to pbit mapping profiles)
show system license eth-oam-adv-mon (replaces "show system license cci-enabled-mep")
admin interface shub trouble-shooting statistics (troubleshooting counters on the FD-REM link)
show interface shub trouble-shooting statistics (troubleshooting counters on the FD-REM link)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure xdsl line (new parameter "auto-switch" to switch between ATMoADSL and PTMoVDSL)

Command delta R4.5.01 versus R4.5


Modified Commands
configure alarm entry (new parameter values allowed)
configure bridge [no] port (regeneration profile selection by name)
configure debug-trace [no] protocol-trace (Protocol tracing on NGLT-A/C)
configure igmp [no] channel (to configure IGMP Message rate per IGMP control channel)
configure voice cluster equipment [no] termination (Allows to configure the codec type used at TDM
side.Change for feature support ISDN G.711 A-law and u-law terminals)
configure voice sip [no] dialplan (change for feature Digitmap minimum match)
configure voice sip [no] termination (change for feature Hotline (FDC-I) and Warmline (FDC-T)

12

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

subscriber control by IMS NOTIFY and call waiting, call transfer, call hold, call conference)
configure voice sip redundancy (change for feature Foreground Monitoring Enhancement)
configure voice sip user-agent-ap slot-id (change for feature DHCP Option 82)
configure voice sip vsp (change for feature Subscribe and DHCP Option 82 and Fax/Modem negotiation)
configure voice sip system session-timer (Change for feature Session Timer Refresher)
configure xdsl board (extended with auto-discovery functionality, vectoring processing board in controller
slot)
configure xdsl spectrum-profile vdsl2 (New UPBO method or Alternative Electrical Length Estimation
Mode)
configure xdsl vp-board vp-link (nbr of vectored lines per vectoring processing board increased, vp-board
in controller slot)
configure xdsl [no] vect-profile (introducing new parameters in the vect-profile to configure crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show config-data-port bridge-port (for regeneration profile selection)
show system license (adding a new license counter, vectoring-legacy, for the introduction of crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show voice sip termination (Show Voice SIP Termination Status)
show xdsl config-data-port bridge-port (for regeneration profile selection)
show xdsl failure-status vect-board (vectoring processing board in controller slot)
show xdsl vect-disturber-list downstream (nbr of vectored lines per vectoring processing board increased,
disturber-list parameter modified)
show xdsl vp-board (nbr of vectored lines per vectoring processing board increased, vp-board in
controller slot)
Removed Commands
configure bcmp (command not applicable for FD 24 GBPS NT)
configure bcmp system (command not applicable for FD 24 GBPS NT)
show bcmp (command not applicable for FD 24 GBPS NT)
show bcmp counters (command not applicable for FD 24 GBPS NT)
New Commands
configure qos nni-ctrl-pkt-policer (to configure OBC policer for NNI port)
configure qos profiles [no] rate-limit (IPv6 protocol policer per LLID on FX 10G/EPON)
configure system auto-laser-shutdown (Configurable ALS)
show alarm current efm-oam (new alarm)
show alarm log efm-oam (new alarm)
show alarm snap-shot efm-oam (new alarm)
show qos profile-usage rate-limit (show IPv6 protocol policer)
show vlan prio-regen-name (show regeneration profile selection by name)
show vlan prio-regen-next (show next regeneration profile selection)
show voice sip redundancy-node ext-redundancy-state (change for feature Autonomous fail-over

3HH-04416-EBAA-TCZZA 01

Released

13

1 ISAM CLI

indication)
show xdsl vect-disturber-list upstream (nbr of vectored lines per vectoring processing board increased,
disturber-list parameter modified)
show xdsl vect-group (cross-dslam vectoring, vp-board in controller slot)
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
configure qos profiles marker [no] d1p-alignment
New Commands that are NOT supported yet
configure qos profiles [no] dscp-pbit
configure qos profiles dscp-pbit codepoint
show qos profile-usage dscp-pbit-prof

Command delta R4.5 versus R4.4.02


Modified Commands
configure alarm entry (to configure alarms on E1/DS1 SFP)
configure ethernet line mau (to configure autoneg capabilities)
configure linetest single ltparm test-name (values for MELT added)
configure linetest single ltsession (Increase test parameters for MELT )
configure vlan shub (use case-sensitive vlan name for support of voice traffic mirroring)
configure voice sip [no] termination (to match CDE splitters schematic change)
show linetest single lineid-ext-rept (Increase test parameters for MELT )
show xdsl vp-board (new display elements)
Removed Commands
admin alarm (removed parameter clr-shub-config-loss)
New Commands
admin alarm (new parameter names)
admin pppoe-client emulation client-id (to start or stop the PPPoE emulation of a specific interface on a
PPPoE client)
configure equipment sfpe1t1 (to configure the E1 service on E1/DS1 SFP)
configure interface shub mirror-voice-traffic (voice traffic mirroring at NANT-A/NRNT-A for voice
boards)
configure interface shub mirror-voice-traffic [no] egress-port (voice traffic mirroring at
NANT-A/NRNT-A for voice boards)
configure interface shub mirror-voice-traffic [no] ingress-port (voice traffic mirroring at
NANT-A/NRNT-A for voice boards)
configure pppoe-client (to configure the emulation interface on a PPPoE client port)

14

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show alarm current sfpe1t1-clock (to show the alarm on E1/DS1 SFP)
show alarm current sfpe1t1-framer (to show the alarm on E1/DS1 SFP)
show alarm log sfpe1t1-clock (to show the alarm on E1/DS1 SFP)
show alarm log sfpe1t1-framer (to show the alarm on E1/DS1 SFP)
show linetest single busy-status (to show test parameters for MELT )
show linetest single chipsetdata-for-slot (to show test parameters for MELT )
show pppoe-client (to retrieve the emulation details of PPPoE client interface)
show xdsl vect-disturber-list downstream (this command will replace "show xdsl vect-disturbers" )
Commands with new parameters or parameter values that are NOT supported yet
(commands remain backward compatible with previous releases)
admin efm-oam interface (traffgen-action parameter added)
configure efm-oam interface (new parameters for ethernet traffgen added)
configure voice cluster equipment termination (parameter values for impedance added)
configure voice sip system session-timer (status enable-uas added)
configure voice sip vsp (subscribe parameters added, reneg-ct-mode value added)
configure xdsl board (vplt-autodiscover parameter added)
configure xdsl [no] vect-profile (introducing new parameters in the vect-profile to configure crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show system license (adding a new license counter, vectoring-legacy, for the introduction of crosstalk
cancellation from legacy lines into G.vector lines in downstream)
show xdsl vect-carrier-data far-end (disturberline parameter type changed)
show xdsl vect-carrier-data near-end (disturberline parameter type changed)
New Commands that are NOT supported yet
configure qos profiles [no] rate-limit
show alarm snap-shot sfpe1t1-clock
show alarm snap-shot sfpe1t1-framer
show efm-oam int-traff-gen
show qos profile-usage rate-limit
show xdsl vect-disturber-list
show xdsl vect-disturber-list upstream
show xdsl vect-group

Command delta R4.4.02 versus R4.4


Modified Commands
configure alarm entry index (FR Fixing)
configure ethernet line (AUTO-SENSING fiber speed support for NELT-B)

3HH-04416-EBAA-TCZZA 01

Released

15

1 ISAM CLI

Info configure ethernet line (AUTO-SENSING fiber speed support for NELT-B)
configure l2cp user-port partition-id (FR Fixing)
configure linetest single ltsession (FR Fixing)
configure system security snmp community host-address (SNMP relay from core0 to AI platform)
configure system security snmp group security-level (SNMP relay from core0 to AI platform)
show l2cp partition (FR Fixing)
show port-protection port (FR Fixing)
configure qos interface epon ext-cac (10G-EPON LT)
configure qos profiles scheduler-node ext-shaper (10G-EPON LT)
configure qos interface ellid upstream-queue 255 ext-bw (10G-EPON LT)
show efm-oam oam-stats (OAM remote loopback in NELT-B)
configure qos interface eont ingress-profile (OAM support for downstream queuing and scheduling per
SFU)
configure vlan id (Stacked iBridge)
Info configure vlan id (Stacked iBridge)
configure equipment fan-tray (SW support for ISAM FX intelligent fan)
configure equipment rack (SW support for ISAM FX intelligent fan)
configure port-protection port paired-port (FR Fixing)
configure xdsl board vect-fallback (Fall-back configuration for vectoring)
New Commands
admin efm-oam (OAM remote Loopback support for NELT-B)
admin efm-oam interface interface loopback-action (OAM remote Loopback support for NELT-B)
show alarm current sfprssi (SFU or MDU Voice XML file downloading over OMCI)
Removed Commands
configure port-protection primary-port paired-port (FR Fixing)
show alarm current sfpsssi (FR Fixing)
show port-protection primary-port (FR Fixing)

Command delta R4.4 versus R4.3.02


Modified Commands
configure qos interface (GEM port sharing, OMCI for remote MDU management, FX GPON:CVLAN
translation)
admin arp-relay-stats (OMCI for remote MDU management)
admin bridge learned-unicast-mac (OMCI for remote MDU management)
admin dhcp-relay port-stats (OMCI for remote MDU management)
admin dhcp-relay v6-port-stats (OMCI for remote MDU management)

16

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

admin igmp channel (OMCI for remote MDU management)


admin security ext-authenticator (OMCI for remote MDU management)
admin trouble-shooting interface (OMCI for remote MDU management)
configure arp-relay (OMCI for remote MDU management)
configure cfm domain (OMCI for remote MDU management, 2p VDSL2 bonding with vectoring only in
SLV)
configure dhcp-relay port-stats (OMCI for remote MDU management)
configure dhcp-relay v6-port-stats (OMCI for remote MDU management)
configure igmp (OMCI for remote MDU management)
configure interface port (OMCI for remote MDU management)
configure pppox-relay cross-connect (OMCI for remote MDU management)
configure qos tca (OMCI for remote MDU management)
configure system security pae authenticator (OMCI for remote MDU management)
configure system security pae ext-authenticator (OMCI for remote MDU management)
configure system security pae port (OMCI for remote MDU management)
configure system sync-if-timing (OMCI for remote MDU management)
configure trouble-shooting statistics (OMCI for remote MDU management)
configure vlan (FX GPON:CVLAN translation)
configure vlan port-protocol protocol-group (OMCI for remote MDU management)
configure vlan unicast-mac vlan-id (OMCI for remote MDU management)
configure vlan vlan-port unicast-mac (OMCI for remote MDU management)
configure vlan pbit-statistics (OMCI for remote MDU management)
Modified Commands
show interface port (OMCI for remote MDU management, ATM Pseudowire)
show interface stack (OMCI for remote MDU management)
show interface test (OMCI for remote MDU management, ATM Pseudowire)
show ipv6 users (OMCI for remote MDU management)
show mcast active-groups (OMCI for remote MDU management)
show mcast grp-membership (OMCI for remote MDU management)
show oper-data-port (OMCI for remote MDU management)
show pppox-relay cross-connect monitor-statistics client-port (OMCI for remote MDU management)
show pppox-relay cross-connect session client-port (OMCI for remote MDU management)
show pppox-relay cross-connect statistics client-port (OMCI for remote MDU management)
show qos interface-bandwidth (OMCI for remote MDU management)
show qos statistics queue current-15min (OMCI for remote MDU management)
show qos statistics queue prev-15min (OMCI for remote MDU management)
show security pae authenticator (OMCI for remote MDU management)

3HH-04416-EBAA-TCZZA 01

Released

17

1 ISAM CLI

show security pae diagnostics (OMCI for remote MDU management)


show security pae eapol-stats (OMCI for remote MDU management)
show security pae port-details (OMCI for remote MDU management)
show security pae session-stats (OMCI for remote MDU management)
show vlan bridge-port-fdb (OMCI for remote MDU management)
show vlan cross-connect (OMCI for remote MDU management)
show vlan cross-connect vlan-id vlan-port (OMCI for remote MDU management)
show arp-relay-stats (OMCI for remote MDU management)
show cfm stack (OMCI for remote MDU management)
show config-data-port (OMCI for remote MDU management)
Modified Commands
show vlan dup-mac-alarm (OMCI for remote MDU management)
show vlan pbit-statistics port (OMCI for remote MDU management)
show vlan port-15min-stats (OMCI for remote MDU management)
show vlan port-curr-15min-stats (OMCI for remote MDU management)
show vlan port-curr-day-stats (OMCI for remote MDU management)
show vlan port-event (OMCI for remote MDU management)
show vlan port-prev-day-stats (OMCI for remote MDU management)
show vlan residential-bridge extensive (OMCI for remote MDU management)
show vlan residential-bridge summary (OMCI for remote MDU management)
show vlan vmac-bridge-port-fdb (OMCI for remote MDU management)
show xdsl config-data-port atm-pvc (OMCI for remote MDU management, ATM Pseudowire)
show xdsl oper-data-port igmp (OMCI for remote MDU management, ATM Pseudowire)
show trouble-shooting statistics interface (OMCI for remote MDU management, 2p VDSL2 bonding with
vectoring only in SLV)
show trouble-shooting statistics uni-interface (OMCI for remote MDU management, 2p VDSL2 bonding
with vectoring only in SLV)
configure bridge (OMCI for remote MDU management, SC VLAN and CVLAN attachment on untagged
frames)
configure atm (ATM Pseudowire)
configure voice sip (ISAM-V SIP : Warmline)
configure voice sip vsp (ISAM-V SIP : Warmline)
configure alarm entry (2p VDSL2 bonding with vectoring only in SLV)
configure xdsl-bonding (2p VDSL2 bonding with vectoring only in SLV)
configure xdsl vect-profile (Vectoring feature extension)
configure qos interface upstream-queue (FX GPON:CVLAN translation)
show vlan current-15min-stats (EPON support extended, OMCI for remote MDU management)
show vlan current-day-stats (EPON support extended, OMCI for remote MDU management)

18

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show vlan previous-15min-stats (EPON support extended, OMCI for remote MDU management)
Modified Commands
configure cfm (Minor Bug Fixing)
configure interface alarm (Minor Bug Fixing)
configure linetest cluster ltparm (Minor Bug Fixing)
configure system max-lt-link-speed (Minor Bug Fixing)
configure voice cluster equipment termination (Minor Bug Fixing)
configure linetest single ltparm (CI Drop)
configure linetest single ltparm test-name (CI Drop)
configure qos profiles (10G EPON)
configure trap (Minor Bug Fixing)
configure trap definition (Minor Bug Fixing)
show interface alarm (Minor Bug Fixing)
show dhcp-relay session (OMCI for remote MDU management)
show dhcp-relay v6-port-stats (OMCI for remote MDU management)
show igmp channel counter (OMCI for remote MDU management)
show igmp channel miscellaneous (OMCI for remote MDU management)
show igmp channel protocol (OMCI for remote MDU management)
show vlan vlan-day-stats (EPON support extended, OMCI for remote MDU management)
configure system security snmp community host-address (Minor Bug Fixing)
configure system security snmp group security-level (Minor Bug Fixing)
New Commands
admin cfm (CFM Application enhancements)
admin cfm ltm (CFM Application enhancements)
admin cfm ltm domain (CFM Application enhancements)
admin cfm mclbm (CFM Application enhancements)
admin cfm mclbm domain (CFM Application enhancements)
admin cfm uclbm domain (CFM Application enhancements)
configure port-protection paired-port (PON Redundancy for GPON Linecards)
show port-protection (PON Redundancy for GPON Linecards)
configure dist-router (ATM Pseudowire)
configure dist-router mpls (ATM Pseudowire)
configure dist-service (ATM Pseudowire)
admin dist-service (ATM Pseudowire)
admin dist-service statistics (ATM Pseudowire)
admin dist-service statistics apipe-pvc (ATM Pseudowire)

3HH-04416-EBAA-TCZZA 01

Released

19

1 ISAM CLI

show dist-service (ATM Pseudowire)


show dist-service accessport-svc (ATM Pseudowire)
show dist-service statistics (ATM Pseudowire)
show dist-service statistics apipe-pvc (ATM Pseudowire)
configure igmp mc-pon-vlan-xlate nwvlan ponvlan (Multicast Cross VLAN translation on FX EPON
OLT)
configure bridge port vlan-id static-user ipv6-address (IPv6 anti-spoofing on FD and FX)
New Commands
configure bcmp (FX EOPN features MIB readiness)
configure bcmp system (FX EOPN features MIB readiness)
configure voice sip statistics (10G EPON)
configure voice sip statistics stats-config (10G EPON)
show alarm current sfprssi (CI Drop)
show alarm log ontsnmp (CI Drop)
show alarm log sfprssi (CI Drop)
show alarm snap-shot ontsnmp (CI Drop)
show alarm snap-shot sfprssi (CI Drop)
show bcmp (FX EOPN features MIB readiness)
show bcmp counters (FX EOPN features MIB readiness)
configure equipment rssiprof (RSSI CLI development)
Removed Commands
show alarm current psc (DR6 Feature)
show alarm log psc (DR6 Feature)
show alarm snap-shot psc (DR6 Feature)

Command delta R4.3.02 and R4.3.01 versus R4.3


Modified Commands
configure alarm entry (Board Level Vectoring and System Level Vectoring alarms)
configure xdsl line (BL Vectoring SL Vectoring)
configure xdsl board (BL Vectoring SL Vectoring)
show alarm log xdsl near-end (BL Vectoring SL Vectoring)
show alarm current xdsl (BL Vectoring SL Vectoring)
show alarm snap-shot xdsl (BL Vectoring SL Vectoring)
show alarm log (BL Vectoring SL Vectoring)
show alarm current (BL Vectoring SL Vectoring)

20

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show alarm snap-shot (BL Vectoring SL Vectoring)


show alarm delta-log (BL Vectoring SL Vectoring)
show system license (BL Vectoring SL Vectoring)
show xdsl profiles (BL Vectoring SL Vectoring)
show xdsl operational-data near-end line (BL Vectoring SL Vectoring)
show xdsl carrier-data near-end (BL Vectoring SL Vectoring)
show xdsl carrier-data far-end (BL Vectoring SL Vectoring)
show xdsl failure-status far-end (BL Vectoring SL Vectoring)
show xdsl failure-status near-end (BL Vectoring SL Vectoring)
show xdsl counters near-end line current-interval (BL Vectoring SL Vectoring)
show xdsl counters near-end line current-1day (BL Vectoring SL Vectoring)
show xdsl counters near-end line previous-interval (BL Vectoring SL Vectoring)
show xdsl counters near-end line previous-1day (BL Vectoring SL Vectoring)
configure qos interface (Support for Ethernet DS and US queues on the ONT,GPON VLAN port level
queues for upstream - OLT part)
configure qos interface upstream-queue (Remote VLAN port queues in upstream)
configure qos tca queue (Remote VLAN port queues in upstream)
configure voice cluster equipment (Configurable line gain and line impedance)
configure voice sip termination (Configurable line gain and line impedance)
show qos interface-bandwidth (Remote VLAN port queues in upstream)
show qos statistics queue current-15min (Remote VLAN port queues in upstream)
show qos statistics queue prev-15min (Remote VLAN port queues in upstream)
configure system ( Allow U2U with Hairpin)
configure system security filetransfer (TFTP transfer blksize configurable)
configure xdsl overrule-data (Config of interleaver mem. split VDSL2)
configure xdsl service-profile (Config of interleaver mem. split VDSL2)
configure xdsl-bonding group-profile (enabling 8 port bonding in iSAM)
configure qos profile policer (CCL on NELT-B NNI and Extend EBS range to improve TCP goodput)
configure system loop-id-syntax (GPON support)
New Commands
show voice sip statistics board (SIP statistics)
show voice sip statistics board current-15min (SIP statistics)
show voice sip statistics board current-1day (SIP statistics)
show voice sip statistics board prev-15min (SIP statistics)
show voice sip statistics board prev-1day (SIP statistics)
show voice sip statistics board-perfinfo (SIP statistics)
show xdsl co-inventory (Parameter Alignment with G.997.1)

3HH-04416-EBAA-TCZZA 01

Released

21

1 ISAM CLI

show alarm log vect-line (BL Vectoring SL Vectoring)


show alarm current vect-line (BL Vectoring SL Vectoring)
show alarm snap-shot vect-line (BL Vectoring SL Vectoring)
show alarm log vect-board (SL Vectoring)
show alarm current vect-board (SL Vectoring)
show alarm snap-shot vect-board (SL Vectoring)
configure xdsl vect-profile (BL Vectoring SL Vectoring)
configure xdsl vce-profile (BL Vectoring SL Vectoring)
configure xdsl vp-board vp-link (SL Vectoring)
show xdsl vp-board vp-link (SL Vectoring)
show xdsl vect-disturbers max-reported-dist (BL Vectoring SL Vectoring)
show xdsl vect-carrier-data near-end disturber (BL Vectoring SL Vectoring)
show xdsl vect-carrier-data far-end disturber (BL Vectoring SL Vectoring)
show xdsl failure-status vect-board (SL Vectoring)
show xdsl failure-status vect-line-near-end (BL Vectoring SL Vectoring)
Removed Commands
show qos pcc-rules fwd-port (Resource Admission Control Feature)

Command delta R4.3 versus R4.2.03


Modified Commands
configure alarm entry (NTP and multiple xNTP servers support,NRCD-B cntrl card SW upgrade)
configure igmp channel (GPON IOP for IGMP CAC and access-rights)
configure igmp system (GPON IOP for IGMP CAC and access-rights)
configure l2cp session (ANCP - set Partition ID field)
configure mcast chn (GPON IOP for IGMP CAC and access-rights)
configure qos interface (GPON UNI scheduling/shaping based on queue parameters)
configure qos interface queue (GPON UNI scheduling/shaping based on queue parameters)
configure qos interface upstream-queue (upstream policing and queue config)
configure qos profiles ingress-qos (GPON LT color-aware trTCM)
configure qos profiles policer (GPON LT color-aware trTCM)
configure qos profiles scheduler-node (downstream UNI rate shaping to include multicast traffic)
configure qos profiles shaper (GPON UNI scheduling/shaping based on queue parameters)
configure system sync-if-timing (Full SSM on SyncE)
configure system sync-if-timing ssm (Full SSM on SyncE)
configure vlan id (Add DSL parameters in DHCPv4/v6 / PPPoE,ISAM acting as SNTP server towards
GPON ONTs)

22

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

configure voice cluster media-gateway (SIP Restoration)


configure voice cluster signal-gateway (SIP Restoration)
configure voice cluster equipment (SIP Restoration)
configure voice sip server (SIP Restoration)
configure voice sip termination (SIP Restoration)
configure voice sip user-agent (SIP Restoration)
configure voice sip system session-timer (SIP Restoration)
configure voice sip user-agent-ap (SIP Restoration)
configure voice sip vsp (SIP Restoration)
show equipment diagnostics sfp (Digital Diagnostics for SFP XFP modules)
New Commands
admin alarm clear-alarm filetransfer ip-address (manually clear filetransfer alarm)
admin system security pmfile upload (SIP: Collect statistics via FTP)
admin voice sip (Common Voice Software for ONT and ISAM-V)
configure igmp mc-vlan-xlate (GPON IOP for IGMP CAC and access-rights)
configure igmp mcast-svc-context (GPON IOP for IGMP CAC and access-rights)
configure qos ctrl-pkt-policer (Upstream policing per protocol)
configure qos profiles marker (GPON LT color-aware trTCM)
configure qos profiles marker dot1p-remark (GPON LT color-aware trTCM)
configure system security pmfile (SIP : Collect statistics via FTP)
configure system security pmfile upload (SIP : Collect statistics via FTP)
configure system sntp server-table (NTP and multiple xNTP servers support)
configure system sntp server-table ip-address (NTP and multiple xNTP servers support)
configure system sync-if-timing ssmout-ltport (Full SSM on SyncE)
configure system sync-if-timing ssmout-synce (Full SSM on SyncE)
configure system sync-if-timing t4-out-config (Full SSM on SyncE)
configure voice sip dhcp-authent-para (SIP Restoration)
configure voice sip dnsserver (SIP Restoration)
configure voice sip transport (SIP Restoration)
configure voice sip redundancy (SIP Restoration)
configure voice sip redundancy-cmd (SIP Restoration)
configure voice sip register (SIP Restoration)
configure xdsl vp-board (SLVectoring)
show alarm current sip-dial-plan (SIP Restoration)
show alarm current sip-server (SIP Restoration)
show alarm current sip-vsp (SIP Restoration)
show alarm log sip-dial-plan (SIP Restoration)

3HH-04416-EBAA-TCZZA 01

Released

23

1 ISAM CLI

show alarm log sip-server (SIP Restoration)


show alarm log sip-vsp (SIP Restoration)
show alarm snap-shot sip-dial-plan (SIP Restoration)
show alarm snap-shot sip-server (SIP Restoration)
show alarm snap-shot sip-vsp (SIP Restoration)
show equipment transceiver-inventory (Digital Diagnostics for SFP XFP modules)
show igmp mcast-svc-context (GPON IOP for IGMP CAC and access-rights)
show security pmfile upload (SIP: Collect statistics via FTP)
show sntp server-table (NTP and multiple xNTP servers support)
show system sync-if-timing-t4 (Full SSM on SyncE)
show trouble-shooting statistics uni-interface (IP anti-spoofing statistics)
show voice sip redundancy-node (SIP Restoration)
show voice sip redundancy-node redundancy-cmd (SIP Restoration)
show voice sip redundancy-node redundancy-state (SIP Restoration)
Removed Commands
configure system security domain ip-pool (removal of DR6ed feature)
configure system security domain user (removal of DR6ed feature)
configure voice sip termination local-loop (removal of DR6ed feature)
configure xdsl line local-loop (removal of DR6ed feature)
show alarm current llu-relay (removal of DR6ed feature)
show alarm current sip-user-agent (SIP Restoration)
show alarm log llu-relay (removal of DR6ed feature)
show alarm log sip-user-agent (SIP Restoration)
show alarm snap-shot llu-relay (removal of DR6ed feature)
show alarm snap-shot sip-user-agent (SIP Restoration)

Command delta R4.2.03 versus R4.2.02


Modified Commands
configure xdsl-bonding group-profile (Configuration of 8 port board level bonding)
show vlan current and previous stats commands (minor bug fixing)
show vlan port current and previous stats commands (minor bug fixing)
show vlan vlan-day-stats (minor bug fixing)

Command delta R4.2.02 versus R4.2


Modified Commands

24

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

configure igmp channel (Multicast channel selection by vlan-id)


configure igmp system (Multicast channel selection by vlan-id)
configure shdsl span (CTC support with SHDSL proxy)
configure system syslog (DomLead RAL Support (GPON))
configure trap manager (FD 36p Ethernet LT (NELT-B))
configure trap definition (FD 36p Ethernet LT (NELT-B))
configure alarm shub entry (NRNT-A mini ISAM NT)
configure alarm entry (minor problem solving)
show trouble-shooting statistics interface (FULL CLI)
show igmp grp-to-package (Multicast channel selection by vlan-id)
show igmp module-mcast-channel (Multicast channel selection by vlan-id)
show voice sip statistics call (ISAM_V,SIP POTS statistics feature)
configure cfm domain association (Jitter, Latency, RT performance report- CFM)
configure cfm domain association mep (Jitter, Latency, RT performance report- CFM)
show cfm stack (Jitter, Latency, RT performance report- CFM)
show arp-relay-stats vlan (minor problem solving)
New Commands
admin alarm shub clear-alarm (CLI clear command for Neighbour State Changed alarm on NANT-A)
admin xstp (FD 36p Ethernet LT (NELT-B))
admin xstp port (FD 36p Ethernet LT (NELT-B))
admin igmp mcast-chn (Multicast channel selection)
configure mcast (Multicast channel selection based on VlanID)
configure mcast chn (Multicast channel selection based on VlanID)
configure mcast monitor (Multicast channel selection based on VlanID)
show xdsl-bonding operational-data lin (Transport B-Fast)
configure linetest (ISAM-V H248 CLI enhancement)
configure linetest cluster (ISAM-V H248 CLI enhancement)
configure linetest cluster ltline (ISAM-V H248 CLI enhancement)
configure linetest cluster ltparam (ISAM-V H248 CLI enhancement)
configure linetest cluster ltsession (ISAM-V H248 CLI enhancement)
show linetest (ISAM-V H248 CLI enhancement)
show linetest cluster (ISAM-V H248 CLI enhancement)
show linetest cluster avail-sess (ISAM-V H248 CLI enhancement)
show linetest cluster lineid-ext-rept (ISAM-V H248 CLI enhancement)
show linetest cluster ltline (ISAM-V H248 CLI enhancement)
show linetest cluster ltsession (ISAM-V H248 CLI enhancement)
configure linetest single (ISAM-V H248 CLI enhancement)

3HH-04416-EBAA-TCZZA 01

Released

25

1 ISAM CLI

configure linetest single ltline (ISAM-V H248 CLI enhancement)


configure linetest single ltparam (ISAM-V H248 CLI enhancement)
configure linetest single ltsession (ISAM-V H248 CLI enhancement)
show linetest single (ISAM-V H248 CLI enhancement)
show linetest single avail-sess (ISAM-V H248 CLI enhancement)
show linetest single lineid-ext-rept (ISAM-V H248 CLI enhancement)
show linetest single ltline (ISAM-V H248 CLI enhancement)
show linetest single ltsession (ISAM-V H248 CLI enhancement)
Removed Commands
configure linetst (ISAM-V H248 CLI enhancement)
configure linetst cluster (ISAM-V H248 CLI enhancement)
configure linetst cluster ltline (ISAM-V H248 CLI enhancement)
configure linetst cluster ltparam (ISAM-V H248 CLI enhancement)
configure linetstcluster ltsession (ISAM-V H248 CLI enhancement)
configure linetst single (ISAM-V H248 CLI enhancement)
configure linetst single ltline (ISAM-V H248 CLI enhancement)
configure linetst single ltparam (ISAM-V H248 CLI enhancement)
configure linetst single ltsession (ISAM-V H248 CLI enhancement)
show linetst (ISAM-V H248 CLI enhancement)
show linetst cluster (ISAM-V H248 CLI enhancement)
show linetst cluster avail-sess (ISAM-V H248 CLI enhancement)
show linetst cluster lineid-ext-rept (ISAM-V H248 CLI enhancement)
show linetst cluster ltline (ISAM-V H248 CLI enhancement)
show linetst cluster ltsession (ISAM-V H248 CLI enhancement)
show linetst single (ISAM-V H248 CLI enhancement)
show linetst single avail-sess (ISAM-V H248 CLI enhancement)
show linetst single lineid-ext-rept (ISAM-V H248 CLI enhancement)
show linetst single ltline (ISAM-V H248 CLI enhancement)
show linetst single ltsession (ISAM-V H248 CLI enhancement)

Command delta R4.2 versus R4.0.10


Modified Commands
admin equipment port (NRNT-A; mini-ISAM NT)
admin equipment slot (NRNT-A; mini-ISAM NT)
admin mstp port (NRNT-A; mini-ISAM NT)
admin shdsl-seg unit-id (SHDSL evolution on NSLT-b)

26

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

admin system cpu-load (NRNT-A; mini-ISAM NT)


configure alarm entry (NRNT-A; mini-ISAM NT)
configure alarm shub entry (NRNT-A; mini-ISAM NT)
configure bridge shub port (NRNT-A; mini-ISAM NT)
configure cluster port (NRNT-A; mini-ISAM NT)
configure debug-trace protocol-trace (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure equipment slot (NRNT-A CLI/TL1 Adaptation)
configure ethernet line (FD 36p Ethernet LT (NELT-B))
configure igmp shub vlan-router-port (NRNT-A; mini-ISAM NT)
configure igmp channel (GPON support)
configure interface port (FD 36p Ethernet LT (NELT-B))
configure interface shub group group-id (NRNT-A; mini-ISAM NT)
configure interface shub mirror (NRNT-A; mini-ISAM NT)
configure interface shub mirror port (NRNT-A; mini-ISAM NT)
configure interface shub port (NRNT-A; mini-ISAM NT)
configure la aggregator-port (NRNT-A; mini-ISAM NT)
configure mcast shub mcast-addr vlan-id (NRNT-A; mini-ISAM NT)
configure mstp port (NRNT-A; mini-ISAM NT)
configure mstp port-instance (NRNT-A; mini-ISAM NT)
configure qos profiles l2-filter (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure qos profiles policer (FD 36p Ethernet LT (NELT-B))
configure qos profiles queue (FD 36p Ethernet LT (NELT-B))
configure qos shub policer (NRNT-A; mini-ISAM NT)
configure qos shub queue-config (NRNT-A; mini-ISAM NT)
configure qos tc-map-dot1p (FD 36p Ethernet LT (NELT-B))
configure qos tca queue (GPON support)
configure shdsl segment unit-id (SHDSL evolution on NSLT-b)
configure shdsl span (SHDSL evolution on NSLT-b)
configure shdsl unit unit-id (SHDSL evolution on NSLT-b)
configure system security profile (Lawful Intercept)
configure system security default-profile (Lawful Intercept)
configure system security snmp group security-level (Lawful Intercept)
configure system security snmp map-user-group (Lawful Intercept)
configure system shub filter ip-filter in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp out-port (NRNT-A; mini-ISAM NT)

3HH-04416-EBAA-TCZZA 01

Released

27

1 ISAM CLI

configure system shub filter ip-filter port-filter in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter port-filter out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp out-port (NRNT-A; mini-ISAM NT)
configure system syslog route msg-type (Lawful Intercept)
configure transport shub mac-infilter (NRNT-A; mini-ISAM NT)
configure transport shub rate-limit (NRNT-A; mini-ISAM NT)
configure trap manager (Reliable Trap management)
configure trap definition (Reliable Trap management)
configure vlan id (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure vlan port-protocol (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure vlan shub unicast-mac (NRNT-A; mini-ISAM NT)
configure vlan shub id egress-port (NRNT-A; mini-ISAM NT)
configure vlan shub id untag-port (NRNT-A; mini-ISAM NT)
configure voice cluster media-gateway (ISAM-V)
configure voice cluster equipment board (ISAM-V)
configure voice cluster equipment termination (ISAM-V)
configure voice sip termination (ISAM-V)
configure voice sip lineid-syn-prof (ISAM-V)
configure voice sip vsp (ISAM-V)
configure xdsl overrule-data (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl service-profile (SRA for VDSL2)
configure xdsl line (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl line tca-line-threshold (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl-bonding group-profile (8p PTM VDSL2 bonding on FD)
show bridge network-port (NRNT-A; mini-ISAM NT)
show cluster connect (NRNT-A; mini-ISAM NT)
show cluster counter (NRNT-A; mini-ISAM NT)
show cluster neighbour (NRNT-A; mini-ISAM NT)
show equipment slot (NRNT-A CLI/TL1 Adaptation)
show equipment temperature (NRNT-A; mini-ISAM NT)
show igmp shub vlan-router-port (NRNT-A; mini-ISAM NT)
show interface port (FD 36p Ethernet LT (NELT-B))
show interface shub port (NRNT-A; mini-ISAM NT)
show interface shub statistics (NRNT-A; mini-ISAM NT)

28

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show interface stack (FD 36p Ethernet LT (NELT-B))


show interface test (FD 36p Ethernet LT (NELT-B))
show la aggregate-list (NRNT-A; mini-ISAM NT)
show la aggregator-info (NRNT-A; mini-ISAM NT)
show la network-port-info (NRNT-A; mini-ISAM NT)
show mcast shub igs-vlan-grp (NRNT-A; mini-ISAM NT)
show mstp network-port (NRNT-A; mini-ISAM NT)
show mstp port-instance (NRNT-A; mini-ISAM NT)
show pccp port-entry (NRNT-A; mini-ISAM NT)
show qos interface-bandwidth (GPON support)
show qos statistics buffer-overflow current-1day (NRNT-A; mini-ISAM NT)
show qos statistics queue current-15min (GPON support)
show qos statistics queue prev-15min (GPON support)
show shdsl inventory (SHDSL evolution on NSLT-b)
show shdsl segment-counters current-15min (SHDSL evolution on NSLT-b)
show shdsl segment-counters current-1day (SHDSL evolution on NSLT-b)
show shdsl segment-counters previous-15min (SHDSL evolution on NSLT-b)
show shdsl segment-counters previous-1day (SHDSL evolution on NSLT-b)
show shdsl segment-status (SHDSL evolution on NSLT-b)
show shdsl unit-status (SHDSL evolution on NSLT-b)
show system cpu-load (NRNT-A; mini-ISAM NT)
show system license (NRNT-A CLI/TL1 Adaptation)
show system memory-usage (NRNT-A; mini-ISAM NT)
show system shub config-control (NRNT-A; mini-ISAM NT)
show transport shub dot3-control (NRNT-A; mini-ISAM NT)
show transport shub dot3-pause (NRNT-A; mini-ISAM NT)
show transport shub dot3-status (NRNT-A; mini-ISAM NT)
show transport shub mac (NRNT-A; mini-ISAM NT)
show transport shub rate (NRNT-A; mini-ISAM NT)
show trouble-shooting statistics interface (PT Counters)
show vlan residential-bridge extensive (FD 36p Ethernet LT (NELT-B))
show vlan residential-bridge summary (FD 36p Ethernet LT (NELT-B))
show vlan shub-dup-mac-alarm (NRNT-A; mini-ISAM NT)
show vlan shub-port-vlan-map (NRNT-A; mini-ISAM NT)
show voice sip statistics call (ISAM-V)
New Commands

3HH-04416-EBAA-TCZZA 01

Released

29

1 ISAM CLI

admin dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)


admin alarm shub clear-alarm vrf interface (Problem Solving)
admin voice cluster equipment (ISAM-V)
admin voice cluster media-gateway (ISAM-V)
admin xstp port clear-protocols (FD 36p Ethernet LT (NELT-B))
configure dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure ethernet line mau (FD 36p Ethernet LT (NELT-B))
configure linetest (ISAM-V H248 : CLI enhancements)
configure linetest cluster (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltline (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltparm (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltsession (ISAM-V H248 : CLI enhancements)
configure linetest single (ISAM-V H248 : CLI enhancements)
configure linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest single ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest single ltsession session-cmd (ISAM-V H248 : CLI enhancements)
configure link-agg (FD 36p Ethernet LT (NELT-B))
configure link-agg general priority (FD 36p Ethernet LT (NELT-B))
configure link-agg group load-sharing-policy (FD 36p Ethernet LT (NELT-B))
configure link-agg group port (FD 36p Ethernet LT (NELT-B))
configure link-agg port passive-lacp (FD 36p Ethernet LT (NELT-B))
configure mcast static (FD 36p Ethernet LT (NELT-B))
configure mcast static branch (FD 36p Ethernet LT (NELT-B))
configure system max-lt-link-speed link-speed (NRNT-A CLI/TL1 Adaptation)
configure system shub icmp time-stamp-reply (minor problem solving)
configure system sync-if-timing revert (NRNT-A; mini-ISAM NT)
configure system sync-if-timing bits
configure system sync-if-timing force-reference (NRNT-A; mini-ISAM NT)
configure system sync-if-timing ref-order priority (NRNT-A; mini-ISAM NT)
configure system sync-if-timing ssm ssmenable (NRNT-A; mini-ISAM NT)
configure system sync-if-timing synce (NRNT-A; mini-ISAM NT)
configure voice cluster signal-gateway (ISAM-V)
configure xdsl rtx-profile (standard ARQ for ADSL2 (+)and VDSL2)
configure xstp (FD 36p Ethernet LT (NELT-B))
configure xstp instance (FD 36p Ethernet LT (NELT-B))
configure xstp general enable-stp (FD 36p Ethernet LT (NELT-B))
configure xstp instance associate-vlan (FD 36p Ethernet LT (NELT-B))

30

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

configure xstp port priority (FD 36p Ethernet LT (NELT-B))


configure xstp port-instance instance (FD 36p Ethernet LT (NELT-B))
show alarm current megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm current megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm current megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm current megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm current megaco-term (ISAM-V H248 : CLI enhancements)
show alarm current sip-user-agent (minor problem solving)
show alarm current sync (NRNT-A CLI/TL1 Adaptation)
show alarm log megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm log megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm log megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm log megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm log megaco-term (ISAM-V H248 : CLI enhancements)
show alarm log sip-user-agent (minor problem solving)
show alarm log sync (NRNT-A CLI/TL1 Adaptation)
show alarm snap-shot megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-term (ISAM-V H248 : CLI enhancements)
show alarm snap-shot sip-user-agent (minor problem solving)
show alarm snap-shot sync (NRNT-A CLI/TL1 Adaptation)
show dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan v6extensive (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan v6summary (IPv6 Protocol Aware CC with DHCPv6 on FD)
show ethernet statistics (FD 36p Ethernet LT (NELT-B))
show ethernet statistics line (FD 36p Ethernet LT (NELT-B))
show ipv6 (IPv6 Protocol Aware CC with DHCPv6 on FD)
show linetest (ISAM-V H248 : CLI enhancements)
show linetest cluster (ISAM-V H248 : CLI enhancements)
show linetest cluster avail-sess (ISAM-V H248 : CLI enhancements)
show linetest cluster lineid-ext-rept (ISAM-V H248 : CLI enhancements)
show linetest cluster ltline (ISAM-V H248 : CLI enhancements)
show linetest cluster ltsession (ISAM-V H248 : CLI enhancements)

3HH-04416-EBAA-TCZZA 01

Released

31

1 ISAM CLI

show linetest single (ISAM-V H248 : CLI enhancements)


show linetest single avail-sess (ISAM-V H248 : CLI enhancements)
show linetest single lineid-ext-rept lineid (ISAM-V H248 : CLI enhancements)
show linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
show linetest single ltsession (ISAM-V H248 : CLI enhancements)
show link-agg (FD 36p Ethernet LT (NELT-B))
show link-agg group-info (FD 36p Ethernet LT (NELT-B))
show link-agg member-port port (FD 36p Ethernet LT (NELT-B))
show link-agg port-info port (FD 36p Ethernet LT (NELT-B))
show system sync-if-timing priority (NRNT-A CLI/TL1 Adaptation)
show voice cluster ip (ISAM-V)
show voice cluster signal-gateway (ISAM-V)
show xstp (FD 36p Ethernet LT (NELT-B))
show xstp bridge (FD 36p Ethernet LT (NELT-B))
show xstp instance (FD 36p Ethernet LT (NELT-B))
show xstp port (FD 36p Ethernet LT (NELT-B))
show xstp port-instance (FD 36p Ethernet LT (NELT-B))
Removed Commands
configure mcast src (Fixed multicast VLAN per IGMP channel)
configure mcast src packagemember (Fixed multicast VLAN per IGMP channel)
show bridge port-to-atm-pvc (ISAM-V H248:CLI enhancements)

Command delta R4.2 versus R4.1.02


Modified Commands
admin arp-relay-stats (GPON support)
admin bridge learned-unicast-mac (GPON support)
admin dhcp-relay port-stats (GPON support)
admin equipment port (NRNT-A; mini-ISAM NT)
admin equipment slot (NRNT-A; mini-ISAM NT)
admin igmp channel (GPON support)
admin mstp port (NRNT-A; mini-ISAM NT)
admin security ext-authenticator (GPON support)
admin system cpu-load (NRNT-A; mini-ISAM NT)
admin trouble-shooting interface (GPON support)
configure alarm entry (NRNT-A; mini-ISAM NT)
configure alarm shub entry (NRNT-A; mini-ISAM NT)

32

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

configure arp-relay statistics (GPON support)


configure bridge port (GPON support)
configure bridge shub port (NRNT-A; mini-ISAM NT)
configure cluster port (NRNT-A; mini-ISAM NT)
configure debug-trace protocol-trace (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure dhcp-relay port-stats (GPON support)
configure equipment slot (NRNT-A CLI/TL1 Adaptation)
configure ethernet line (FD 36p Ethernet LT (NELT-B))
configure igmp channel (GPON support)
configure igmp shub vlan-router-port (NRNT-A; mini-ISAM NT)
configure igmp system (GPON support)
configure interface port (FD 36p Ethernet LT (NELT-B))
configure interface shub group port (NRNT-A; mini-ISAM NT)
configure interface shub mirror (NRNT-A; mini-ISAM NT)
configure interface shub mirror port (NRNT-A; mini-ISAM NT)
configure interface shub port (NRNT-A; mini-ISAM NT)
configure la aggregator-port (NRNT-A; mini-ISAM NT)
configure mcast shub mcast-addr vlan-id (NRNT-A; mini-ISAM NT)
configure mstp port (NRNT-A; mini-ISAM NT)
configure mstp port-instance instance (NRNT-A; mini-ISAM NT)
configure pppox-relay cross-connect client-port (GPON support)
configure qos dsl-port (GPON support)
configure qos interface (GPON support)
configure qos interface queue (GPON support)
configure qos profiles cac (GPON support)
configure qos profiles l2-filter (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure qos profiles policer (FD 36p Ethernet LT (NELT-B))
configure qos profiles queue (GPON support)
configure qos profiles shaper (GPON support)
configure qos shdsl-port (GPON support)
configure qos shub policer (NRNT-A; mini-ISAM NT)
configure qos shub queue-config (NRNT-A; mini-ISAM NT)
configure qos tc-map-dot1p (FD 36p Ethernet LT (NELT-B))
configure qos tca queue (GPON support)
configure system loop-id-syntax (GPON support)
configure system security profile (Lawful Intercept)
configure system security default-profile (Lawful Intercept)

3HH-04416-EBAA-TCZZA 01

Released

33

1 ISAM CLI

configure system security pae authenticator (GPON support)


configure system security pae ext-authenticator (GPON support)
configure system security pae port (GPON support)
configure system security radius (GPON support)
configure system security ssh access (GPON support)
configure system security snmp group security-level (Lawful Intercept)
configure system security snmp map-user-group (Lawful Intercept)
configure system shub filter ip-filter in-port port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter out-port port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter icmp out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter port-filter in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter port-filter out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter tcp out-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp in-port (NRNT-A; mini-ISAM NT)
configure system shub filter ip-filter udp out-port (NRNT-A; mini-ISAM NT)
configure system syslog destination (GPON support)
configure system syslog route msg-type (GPON support)
configure transport shub mac-infilter port (NRNT-A; mini-ISAM NT)
configure transport shub rate-limit (NRNT-A; mini-ISAM NT)
configure trap manager (Reliable Trap management)
configure trouble-shooting statistics interface (GPON support)
configure trap definition (Reliable Trap management)
configure vlan id (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure vlan port-protocol protocol-group (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure vlan unicast-mac vlan-id (GPON support)
configure vlan vlan-port unicast-mac (GPON support)
configure vlan pbit-statistics port (GPON support)
configure vlan shub unicast-mac (NRNT-A; mini-ISAM NT)
configure vlan shub id egress-port (NRNT-A; mini-ISAM NT)
configure vlan shub id untag-port (NRNT-A; mini-ISAM NT)
configure voice cluster media-gateway (ISAM-V)
configure voice cluster equipment board (ISAM-V)
configure voice cluster equipment termination (ISAM-V)
configure voice sip termination (ISAM-V)
configure voice sip lineid-syn-prof (ISAM-V)

34

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

configure voice sip vsp (ISAM-V)


configure xdsl overrule-data (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl service-profile (SRA for VDSL2)
configure xdsl line (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl line tca-line-threshold (standard ARQ for ADSL2 (+)and VDSL2)
configure xdsl-bonding group-profile (8p PTM VDSL2 bonding on FD)
show arp-relay-stats (GPON support)
show bridge network-port (NRNT-A; mini-ISAM NT)
show cluster connect (NRNT-A; mini-ISAM NT)
show cluster counter (NRNT-A; mini-ISAM NT)
show cluster neighbour (NRNT-A; mini-ISAM NT)
show config-data-port igmp (GPON support)
show config-data-port qos scheduler-profile (GPON support)
show dhcp-relay port-stats (GPON support)
show dhcp-relay session (GPON support)
show equipment slot (NRNT-A CLI/TL1 Adaptation)
show equipment temperature (NRNT-A; mini-ISAM NT)
show igmp channel counter (GPON support)
show igmp channel miscellaneous (GPON support)
show igmp channel protocol (GPON support)
show igmp shub vlan-router-port (NRNT-A; mini-ISAM NT)
show interface port (FD 36p Ethernet LT (NELT-B))
show interface shub port (NRNT-A; mini-ISAM NT)
show interface shub statistics (NRNT-A; mini-ISAM NT)
show interface stack (FD 36p Ethernet LT (NELT-B))
show interface test (FD 36p Ethernet LT (NELT-B))
show la aggregate-list (NRNT-A; mini-ISAM NT)
show la aggregator-info (NRNT-A; mini-ISAM NT)
show la network-port-info (NRNT-A; mini-ISAM NT)
show mcast active-groups (NRNT-A; mini-ISAM NT)
show mcast grp-membership (NRNT-A; mini-ISAM NT)
show mcast shub igs-vlan-grp (NRNT-A; mini-ISAM NT)
show mstp network-port (NRNT-A; mini-ISAM NT)
show mstp port-instance (NRNT-A; mini-ISAM NT)
show oper-data-port igmp (GPON support)
show pccp port-entry (NRNT-A; mini-ISAM NT)
show pppox-relay cross-connect monitor-statistics client-port (GPON support)

3HH-04416-EBAA-TCZZA 01

Released

35

1 ISAM CLI

show pppox-relay cross-connect session client-port (GPON support)


show pppox-relay cross-connect statistics client-port (GPON support)
show qos statistics queue current-15min (GPON support)
show qos statistics queue prev-15min (GPON support)
show security pae authenticator (GPON support)
show security pae diagnostics (GPON support)
show security pae eapol-stats (GPON support)
show security pae port-details (GPON support)
show security pae session-stats (GPON support)
show system cpu-load (NRNT-A; mini-ISAM NT)
show system license (NRNT-A CLI/TL1 Adaptation)
show system memory-usage (NRNT-A; mini-ISAM NT)
show system shub config-control (NRNT-A; mini-ISAM NT)
show transport shub dot3-control (NRNT-A; mini-ISAM NT)
show transport shub dot3-pause (NRNT-A; mini-ISAM NT)
show transport shub dot3-status (NRNT-A; mini-ISAM NT)
show transport shub mac (NRNT-A; mini-ISAM NT)
show transport shub rate (NRNT-A; mini-ISAM NT)
show trouble-shooting statistics interface (GPON support)
show vlan bridge-port-fdb (GPON support)
show vlan cross-connect (GPON support)
show vlan current-15min-stats (GPON support)
show vlan current-day-stats (GPON support)
show vlan dup-mac-alarm (GPON support)
show vlan pbit-statistics port (GPON support)
show vlan port-15min-stats (GPON support)
show vlan port-curr-15min-stats (GPON support)
show vlan port-curr-day-stats (GPON support)
show vlan port-event (GPON support)
show vlan port-prev-day-stats (GPON support)
show vlan previous-15min-stats (GPON support)
show vlan residential-bridge extensive (FD 36p Ethernet LT (NELT-B))
show vlan residential-bridge summary (FD 36p Ethernet LT (NELT-B))
show vlan shub-dup-mac-alarm (NRNT-A; mini-ISAM NT)
show vlan shub-port-vlan-map (NRNT-A; mini-ISAM NT)
show vlan vlan-day-stats (GPON support)
show vlan vmac-bridge-port-fdb (GPON support)

36

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show voice sip statistics call interval (ISAM-V)


show xdsl config-data-port qos scheduler-profile (GPON support)
show xdsl oper-data-port igmp (GPON support)
New Commands
admin dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
admin voice cluster equipment (ISAM-V)
admin voice cluster media-gateway (ISAM-V)
configure dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
configure ethernet line mau (FD 36p Ethernet LT (NELT-B))
configure linetest (ISAM-V H248 : CLI enhancements)
configure linetest cluster (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest cluster ltsession (ISAM-V H248 : CLI enhancements)
configure linetest single (ISAM-V H248 : CLI enhancements)
configure linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
configure linetest single ltparm tst-type (ISAM-V H248 : CLI enhancements)
configure linetest single ltsession (ISAM-V H248 : CLI enhancements)
configure link-agg (FD 36p Ethernet LT (NELT-B))
configure link-agg general priority (FD 36p Ethernet LT (NELT-B))
configure link-agg group load-sharing-policy (FD 36p Ethernet LT (NELT-B))
configure link-agg group port (FD 36p Ethernet LT (NELT-B))
configure link-agg port passive-lacp (FD 36p Ethernet LT (NELT-B))
configure mcast monitor (GPON support)
configure mcast monitor src (GPON support)
configure mcast static (FD 36p Ethernet LT (NELT-B))
configure mcast static branch (FD 36p Ethernet LT (NELT-B))
configure qos interface upstream-queue (GPON support)
configure qos profiles bandwidth (GPON support)
configure qos profiles ingress-qos (GPON support)
configure qos profiles scheduler-node (GPON support)
configure system max-lt-link-speed (NRNT-A CLI/TL1 Adaptation)
configure system sync-if-timing revert (NRNT-A; mini-ISAM NT)
configure system sync-if-timing bits
configure system sync-if-timing force-reference (NRNT-A; mini-ISAM NT)
configure system sync-if-timing ref-order (NRNT-A; mini-ISAM NT)

3HH-04416-EBAA-TCZZA 01

Released

37

1 ISAM CLI

configure system sync-if-timing ssm (NRNT-A; mini-ISAM NT)


configure system sync-if-timing synce (NRNT-A; mini-ISAM NT)
configure voice cluster signal-gateway (ISAM-V)
configure xdsl rtx-profile (standard ARQ for ADSL2 (+)and VDSL2)
configure xstp (FD 36p Ethernet LT (NELT-B))
configure xstp instance (FD 36p Ethernet LT (NELT-B))
configure xstp general enable-stp (FD 36p Ethernet LT (NELT-B))
configure xstp instance associate-vlan (FD 36p Ethernet LT (NELT-B))
configure xstp port priority (FD 36p Ethernet LT (NELT-B))
configure xstp port-instance instance (FD 36p Ethernet LT (NELT-B))
show alarm current megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm current megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm current megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm current megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm current megaco-term (ISAM-V H248 : CLI enhancements)
show alarm current sip-user-agent (minor problem solving)
show alarm current sync (NRNT-A CLI/TL1 Adaptation)
show alarm log megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm log megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm log megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm log megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm log megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm log megaco-term (ISAM-V H248 : CLI enhancements)
show alarm log sip-user-agent (minor problem solving)
show alarm log sync (NRNT-A CLI/TL1 Adaptation)
show alarm snap-shot megaco-media-gw (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-plug-unit (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-sig-gw (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-sig-lt (ISAM-V H248 : CLI enhancements)
show alarm snap-shot megaco-term (ISAM-V H248 : CLI enhancements)
show alarm snap-shot sip-user-agent (minor problem solving)
show alarm snap-shot sync (NRNT-A CLI/TL1 Adaptation)
show dhcp-relay v6-port-stats (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan extensive (IPv6 Protocol Aware CC with DHCPv6 on FD)
show dhcp-relay v6-port-stats vlan v6summary (IPv6 Protocol Aware CC with DHCPv6 on FD)
show ethernet statistics (FD 36p Ethernet LT (NELT-B))

38

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

show ethernet statistics line (FD 36p Ethernet LT (NELT-B))


show ipv6 (IPv6 Protocol Aware CC with DHCPv6 on FD)
show ipv6 users ip-prefix (IPv6 Protocol Aware CC with DHCPv6 on FD)
show linetest (ISAM-V H248 : CLI enhancements)
show linetest cluster (ISAM-V H248 : CLI enhancements)
show linetest cluster avail-sess (ISAM-V H248 : CLI enhancements)
show linetest cluster lineid-ext-rept (ISAM-V H248 : CLI enhancements)
show linetest cluster ltline lineid (ISAM-V H248 : CLI enhancements)
show linetest cluster ltsession (ISAM-V H248 : CLI enhancements)
show linetest single (ISAM-V H248 : CLI enhancements)
show linetest single avail-sess (ISAM-V H248 : CLI enhancements)
show linetest single lineid-ext-rept (ISAM-V H248 : CLI enhancements)
show linetest single ltline lineid (ISAM-V H248 : CLI enhancements)
show linetest single ltsession (ISAM-V H248 : CLI enhancements)
show link-agg (FD 36p Ethernet LT (NELT-B))
show link-agg group-info (FD 36p Ethernet LT (NELT-B))
show link-agg member-port port (FD 36p Ethernet LT (NELT-B))
show link-agg port-info (FD 36p Ethernet LT (NELT-B))
show qos interface-bandwidth (GPON support)
show qos profile-usage bandwidth (GPON support)
show qos profile-usage ingress-qos (GPON support)
show qos profile-usage scheduler-node (GPON support)
show qos statistics lt-queue (GPON support)
show qos statistics lt-queue current-15min (GPON support)
show qos statistics lt-queue prev-15min (GPON support)
show qos tc-to-qmap (GPON support)
show system sync-if-timing (NRNT-A CLI/TL1 Adaptation)
show vlan fdb-board vlan-id (GPON support)
show voice cluster ip (ISAM-V)
show voice cluster signal-gateway (ISAM-V)
show xstp (FD 36p Ethernet LT (NELT-B))
show xstp bridge (FD 36p Ethernet LT (NELT-B))
show xstp instance (FD 36p Ethernet LT (NELT-B))
show xstp port (FD 36p Ethernet LT (NELT-B))
show xstp port-instance instance (FD 36p Ethernet LT (NELT-B))
Removed Commands

3HH-04416-EBAA-TCZZA 01

Released

39

1 ISAM CLI

configure mcast src (Fixed multicast VLAN per IGMP channel)


configure mcast src packagemember (Fixed multicast VLAN per IGMP channel)
configure qos profiles scheduler (GPON support)
show qos profile-usage scheduler (GPON support)
show vlan fdb mac (GPON support)
show bridge port-to-atm-pvc (ISAM-V H248:CLI enhancements)

40

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.2 Preface
Scope
This user guide describes the Command Line Interface (CLI) commands supported by the Alcatel-Lucent 7302
ISAM, 7330 ISAM FTTN and 7360 ISAM. These commands are used for installation, configuration, management
and troubleshooting.

User Profile
The guide is intended for operating personnel (sometimes called craft persons).

The CLI Structure


The ISAM CLI is a command-driven interface accessible via telnet or via the craft terminal.
The CLI can be used to configure and manage ISAM equipment.

3HH-04416-EBAA-TCZZA 01

Released

41

1 ISAM CLI

1.3 CLI Commands


Command Types
The commands of the CLI language can be divided into two groups: global and environmental commands.
Global commands (such as the logout command) can be entered in any context and have the same effect in each
context.
Environmental commands (such as the info command) can only be entered in some contexts (for example, the info
command cannot be used in the show node) and have a different effect in each context. The purpose of the
command (for example, showing the configuration) is the same but the implementation or the generated output is
different.
Some commands are also implicit. For example, when you enter only the node name configure system security
snmp community fden, you run an implicit command that changes your context to the specified node and that
creates this node if it did not previously exist.
The available commands are discussed in a separate chapter.

Access Rights
Not every operator can execute every command.
Access to commands is granted via the operator profile.
It is possible that an operator can execute a given command in one context and not in another.

Options and Parameters


Commands can have options and parameters.
Options are special parameters that are context insensitive. For example, you can enter the option detail after info
in any context.
Options must be given at the end of the command preceeding the filter and printer specifications.

42

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.4 Nodes
Node Definition
A command definition tree, further abbreviated to "command tree" is a structure of nested command nodes from
which CLI commands can be derived. A command node consists of a node name and zero or more resource
identifiers. The resource identifiers behave like parameters, but identify a particular resource. For example, public
in configure system security snmp community public is an unnamed resource identifier of the node community.
One such command node identifies a context. A CLI command can be derived from a command tree starting from
the root node, but a command with the same meaning and impact can also be derived from a lower level node or
subnode. The following are examples of equivalent commands:
info configure system security snmp community public in any node.
info system security snmp community public in node configure
info security snmp community public in node configure system
info snmp community public in node configure system security
info community public in node configure system security snmp
info in node configure system security snmp community public
The root node is the highest level. Directly below the root node are important command nodes such as configure
and show.

Node Creation
A dynamic node is a sub-node of the configure node that corresponds to a configurable resource that an operator
can create.
An operator can create a dynamic node by navigating to it. The system will automatically create the node. The
operator can configure its prompt in such a way that it shows if the operator navigated to an existing or a new node.
The ability to create nodes is limited by the access rights of the user.
It is also possible that the system creates additional subnodes in other nodes, for example, in the show node due to
the creation of a new dynamic node in the configure node.

Node Deletion
A dynamic node can be deleted by placing no in front of the node name. For example, configure system security
snmp no community public deletes the specified node and all its subnodes. The ability to delete nodes is limited
by the access rights of the operator.

Resource Attributes
The value of resource attributes can be changed by entering the name of the resource attribute followed by the new
value. For example, password plain:secret sets the value of the resource attribute named password to the plain
text string secret.
Resource attributes can be set to their default value by entering no followed by the name of the resource attribute.
For example, no password sets the value of the resource attribute named password to the default value (no
password required).

3HH-04416-EBAA-TCZZA 01

Released

43

1 ISAM CLI

1.5 Parameters
Named and Unnamed Parameters
Parameters are characterised by a name and a type.
Parameters can be named or unnamed.
Named parameters are entered as two tokens: a keyword and a value (for example, password plain:secret). Some
commands (such as info) require only the keyword.
Only the value token is entered for unnamed parameters (for example, public in the node name community
public).
Most options and first resource identifiers are unnamed.
Parameters can be entered in any order. Only unnamed keys must be entered directly after the node name.

Parameter Types
Parameter values belong to a parameter type. Parameter types limit the parameter values to strings that the system
can understand.
Parameter types consists of 1 to N fields with separators in between. Each field belongs to a basic type. The
separator is in most cases a colon : or a slash /.
The name of parameter types always starts with an uppercase character and can contain an optional domain name.
The domain name is separated from the parameter name by ::.
The sequence in which the fields appear can differ in case one of the fields belongs to an enumeration type. For
example, if provided some possible values for the parameter type ExtendedFileName (the first field is an
enumeration field with possible values file and ftp, host-name, user-name, password and local-file are also fields):
file: local-file
ftp: host-name @ user-name : password / local-file
Parameter types are built by combining 1 to N basic types.

Basic Types
Basic types can be divided in two groups: fixed length basic types and variable length basic types.
Examples of variable length basic types are:
integers
printable strings (representing operator chosen names or descriptions)
SNMP object identifiers
binary strings
The length of a variable length basic type is in most cases limited. The definition of logical length depends on the
basic type: number of characters for printable strings, number of bytes for binary strings, and number of numbers in
the object identfier for SNMP object identifiers.
Examples of fixed length basic types are:
ip-address
fixed-length printable strings
enumeration types (limited list of allowed strings)

44

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

Basic Type Formatting Rules


Integers can be entered in a decimal format. Large integers can be abbreviated as follows:
decimal-number k which is equal to decimal-number *1000 (For example: 3k is equal to 3000)
decimal-number M which is equal to decimal-number *1000000
decimal-number G which is equal to decimal-number *1000000000
Binary strings must be entered as: hex-byte : hex-byte :...: hex-byte. hex-byte is a number between 0 and 255 in
hexadecimal format (all lowercase).For example, 3f:23:ff:b2 is a valid binary string.
Object identifiers and ipv4-addresses must be entered as: decimal-number . decimal-number .....
decimal-number.For example, 128.17.32.45 is a valid object identifier.
The values of all fields may be placed within double quotes. A field separator can never be placed within double
quotes. For example, "1"/"1" is a valid shelf identifier, but "1/1" is not a valid shelf identifier.
A field value can contain multiple double quotes. For example, "hallo world" is equivalent to hallo" "world or to
"hallo"" ""world".
Printable strings must be placed within double quotes if they contain special characters: double quote ", a backslash
\, a question mark ?, a cross #, a space, a tab, a carriage return, or a new line.
The backslash \ is the escape character. The double quote " and backslash \ characters must be preceded by the
escape character. The \ char is equivalent to char with the following exceptions:
\r : carriage-return
\t : tab
\n : new-line
In some cases it is possible that a command is ambiguous. For example, info operator detail can be interpreted in
two ways: list the configuration of the operator with the name detail or list the configuration of all operators in
detail.
The ambiguity is solved by the parser in the following way: if the string contains quotes, it is interpreted as a
printable string, otherwise it is interpreted as a keyword. For example, info operator "detail" lists the
configuration of the operator with the name detail and info operator detail lists the configuration of all operators
in detail.

Syntax Check
The system verifies if each typed character is syntactically correct.
In case the system detects a syntax error, it will position the cursor at the offending character and beep.
This can give strange effects if you are entering characters in the 'insert mode': the invalid characters will shift to
the right and any newly entered character will be inserted in front of the faulty characters.
To avoid this strange effect, it is recommended to work in the (default) overwrite mode.

Command Repetition
Values of parameters may contain decimal, hexadecimal or character ranges. These ranges indicate that the
concerned command must be repeated a number of times with the different values as specified in the range.
Decimal ranges are entered as [ d: start...end ] in which start and end are integers. Example of a decimal range:
lt:1/1/[4...16]
Hexadecimal ranges are entered as [ h: start...end ] in which start and end are hexadecimal numbers. start and end
values may not contain uppercase characters and the number of characters of the first start value determines the
number of characters to be entered for the following values in the range. Example of a hexadecimal range:

3HH-04416-EBAA-TCZZA 01

Released

45

1 ISAM CLI

03:06:ff:[h:aa...bd]
Character ranges are entered as [ c: start...end ] in which start and end are characters. start and end value must
belong to the same character class: digit, lowercase or uppercase. Special characters are not allowed. Example of a
character range : operator[c:a...f]
Ranging is not supported for float values
Ranges have following restrictions:
One command may only contain 1 range.
The default range type is decimal. It will be used if the type is not explicitely mentioned with 'd:' , 'h:' or 'c:'.
Subranges can be separated with a comma. For example: [d:17...19,32,60...62] will be replaced consecutively
with the values 17, 18, 19, 32, 60, 61 and 62.
Ranges between quotes are not expanded.
Command completion may refuse to work once a range is entered.
Execution of command repetition will stop once an iteration in the range fails.
The system sometimes restricts which range type may be used: the system only allows a decimal range where a
decimal number can be entered or a hexadecimal range where a hexadecimal number can be entered. It even
imposes that the range replaces completely the number. Example: 1[2...3] is invalid, [12...13] must be entered
instead. Also the start and end of the range must fall in the allowed range for the number. Only text strings may
contain all types of ranges.
The way the system handles a range depends on the command.
Some commands can handle ranges directly. Repeating the command will be done internally. The command
will then behave for the operator as a normal command..
For the other commands, the system will execute the command end - start + 1 times in which the specified
range is each time replaced by a number out of the range. Each expanded command is shown to the operator.
Commands that normally change the context, don't do this in this case. The command repetition can be stopped
via an interrupt.
Range commands in combination with help "?" character always show the complete list of available parameters
and subnodes and do not suppress subnodes in case of the existing nodes.

Obsolete and Replaced Parameters


Parameters can become obsolete or parameters are substituted by new parameters. See the definition and strategy in
section 1.11 CLI Backward Compatibility.

46

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.6 Filters
The language provides filters to manipulate the output of commands.
For list of available filters, please refer to command description of section "CLI Filters".
Filters can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify a sequence of filters as in following example: info | match exact:1/1 | count lines.

3HH-04416-EBAA-TCZZA 01

Released

47

1 ISAM CLI

1.7 Printers
The language provides printers to allow the user to decide how the output must be printed on his terminal.
The available printers are discussed in detail in a separate chapter.
Printers can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify maximum one printer as in following example: info | match exact:1/1 | more
The default printer can be specified for the CLI session or the operator.

48

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.8 Getting help


The user can get help in two ways.
The first is using the help command. This gives an extensive explanation on the command.
The user can also enter a question-mark ? at each position in the command. He will then get a short explanation on
what he can enter at this position in the command.
For example: configure system security operator ? gives following output:
<Sec::OperatorName>

: the name of the operator [a-z0-9]

(1<=x<=11)

This has the following meaning:


Sec::OperatorName is the name of the parameter type. This indicates that the user must enter a parameter value.
: indicates that the concerned object is an optional parameter. Mandatory parameters are indicated with !, obsolete
parameters and obsolete nodes with X, regular nodes with +, commands with the name of the operator explains how the parameter will be interpreted by the system.
[a-z0-9] indicates that the value may consist of the lower-case alfanumeric characters, the ASCII characters a till
z and 0 till 9.
(1<=x<=11) indicates that the name must consist of at least 1 character and maximum 11 characters.

3HH-04416-EBAA-TCZZA 01

Released

49

1 ISAM CLI

1.9 The CLI Prompt


The prompt can be configured by the user. The prompt can be specified for the session, for an operator or for an
operator profile. If no specific prompt is specified for the session, the prompt specified for the operator is taken and
the prompt specified for the operator profile is taken if no prompt is specified for the operator.
The prompt can be composed with following components :
%n : the name of the current operator.
%s : the current numbering scheme (typ|leg|pos).
%! : the current history number.
% num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.

%% : a %
%c : # if the current node was an existing node or $ if it is newly created.
any other character is just added to the prompt as is.

The default prompt is "%s:%n%d%c "


The system will add a > at the end of each empty prompt or each prompt that consists purely out of white-space

50

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.10 Entering CLI Commands


Following key strokes are treated in a special way while entering commands:
arrow-left : move the cursor one position to the left.
arrow-right : move the cursor one position to the right.
arrow-up : get the previous stored command (round-robin, starts with the last stored command).
arrow-down : get the next stored command (round-robin, starts with the oldest stored command).
insert : toggle between insert and overwrite mode.
backspace : delete the character before the cursor and move the cursor one position to the left.
delete : delete the character under the cursor.
control-c : interrupt the current command or clear the current entered string on a telnet or SSH terminal.
control-a : move the cursor to the beginning of the line.
control-p : get the previous stored command (round-robin, starts with the last stored command).
control-n : get the next stored command (round-robin, starts with the oldest stored command).
control-k : delete all characters starting from the position of the cursor.
control-u : delete all entered characters.
control-w : delete one word before the cursor.
control-x : interrupt the current command or clear the current entered string on the craft terminal.
control-l : clear screen.
tab : trigger command completion.
space : terminate a token and trigger command completion, unless it is placed between double quotes.
# : treat all following commands as comment, unless they are placed between double quotes.
? : trigger online-help, unless it is placed between double quotes.
Entering a tab triggers command completion.
The system will try to expand the existing entered string until an ambiguity is found. If there is no ambiguity, a space
will be added behind the token.
Entering a space behind an entered string has - for keywords - the same effect as the tab.
For example: entering c followed by a tab in the root node will expand to configure.
For example: entering c followed by a space in the root node will expand to configure.
For example: entering configure system security operator admin pr followed by a tab will expand to configure
system security operator admin pro because there is still an ambiguity here between prompt and profile.

3HH-04416-EBAA-TCZZA 01

Released

51

1 ISAM CLI

1.11 CLI Backward Compatibility


Strategy
ISAM has provided a Command Line Interface since the beginning. With each new Software Release, new features
are added and as a consequence also the CLI commands need to evolve.
New features often result in new commands or extension of existing commands.

Strategy with respect to Configuration Commands


When new features become available, commands and parameters will be affected. The objective of the strategy is
that existing configuration scripts will not be broken, i.e. they can still be used without throwing errors.
New commands can be defined that are an add-on to the existing set of commands. Existing commands may need
to be expanded or they may be replaced by anew command. Old commands may become useless and will be
obsolete.
When existing commands are expanded, new parameters may need to be added on to a command, existing
parameters may need to be extended or parameters may be replaced by anew parameter.Exceptionally, parameters
become useless and will be obsolete.
Notice that obsolete commands and parameters will not be maintained for new features; moreover, eventually, in
due time, in the scope of a major SW release, an obsolete command and/or parameter will actually be removed
from the CLI Command Tree. See chapter 'Phase out strategy obsolete commands and/or parameters'.
Backward Compatibility support for configuration commands.
Configuration commands shall remain backwards compatible. A command may become obsolete because either it
is no longer useful or it needs to be replaced by a new command.
At the node level there are two ways:
Obsolete command
- A command becomes obsolete when the corresponding functionality is removed from the system. In order to
avoid that configuration scripts from previous software releases break, the command is not removed. Rather,
executing the command will have no effect and the command will never appear in the output of an info
command.

Obsolete and Replaced command


- A command may get replaced by a new one. This may occur when the corresponding functionality is
modified or expanded. In order to avoid that configuration scripts from previous software releases break, the
command is not removed. Rather, the command is defined as 'obsolete and replaced'. This means that the
command is still valid and can still be executed but it will never appear in the output of an info command.

Backward Compatibility support for Configuration Commands parameters.


Configuration commands shall remain backwards compatible. A way to accomplish this is by allowing parameters
of the command to evolve. A parameter becomes obsolete because either it is no longer useful or it needs to be
replaced by a new parameter.

52

Obsolete parameter
- A parameter becomes obsolete when the corresponding functionality is no longer supported by the system.
In order to avoid that configuration scripts from previous software releases break, the parameter is not
removed. Rather, entering the parameter will have no effect and the parameter will never appear in the
output of an info command.

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

Obsolete and Replaced parameter


- A parameter may get replaced by a new one. This may occur when the corresponding functionality is
modified or extended. In order to avoid that configuration scripts from previous software releases break, the
parameter is not removed. Rather, the parameter is defined as 'obsolete and replaced'. This means that the
parameter is still valid and can still be executed but it will never appear in the output of an info command.
The replacing parameter will appear in the output of an info command and supports the modified or
extended functionality.

Strategy with respect to Show Commands


The output of any show command is available in various formats. Formatting of the output may change over time.
XML type of output is formalized. Writers of CLI scripts are encouraged to use the XML format, as this output is
ignorant of any formatting.
The information displayed may change as a result of new features. The goal is to add new parameters to the
existing display output without modifying the current parameters. In exceptional cases the latter cannot be
guaranteed.

3HH-04416-EBAA-TCZZA 01

Released

53

1 ISAM CLI

1.12 Phase Out Strategy Obsolete Commands


and/or Parameters
This chapter describes the phase out strategy that will be followed for obsolete commands and/or obsolete
parameters.

Announcement Release
The announcement release is the release in which we announce to the customer that a defined set of "impacted" cli
commands will phase-out in the phase-out release. The announcement release is independent from the release in
which the commands and/or parameters became 'obsolete'. The "impacted" cli commands are the commands which
are obsolete or the commands which contain obsolete parameters.
See chapter 'Command Phase Out Annoucement Release' for the list of "impacted" CLI commands.

Phase Out Release


This is the future release in which the listed announced "impacted" commands are removed (obsolete command)
or modified (obsolete parameter).From this release onwards, obsolete commands and/or parameters are no longer
supported. The obsolete commands will be indicated as removed in the history section of the CLI user guide. The
commands with obsolete parameters will be indicated as modified commands in the history section of the CLI user
guide.
The phase-out release is at least the release succeeding the announcement release.

Customer Impact

54

List of impacted commands (See chapter 'Command Phase Out Annoucement Release') should carefully be
checked in the CLI Command Guide chapter Announcement Release. The obsolete commands and/or obsolete
parameters are indicated in the command tree by the prefix X.
The customer should determine the phase-out release.
Any OSS systems and/or scripts using CLI commands should be checked and updated if required.
Once the command is phased-out, the normal error reporting will be applicable.

Released

3HH-04416-EBAA-TCZZA

01

1 ISAM CLI

1.13 Command Phase Out Annoucement Release


This section gives a list of all the impacted CLI commands which will phase out in the phase-out release. See
previous chapter 'phase out strategy obsolete commands and/or parameters' for more info about the phase-out
release'. The listed CLI commands are commands which are obsolete or commands which contain obsolete
parameters.
Non supported commands/parameters from a later release onwards
configure transport ip default-ttl (obsolete and replaced by "configure system management default-ttl")
configure equipment sfpe1t1 framer (removal of obsolete loopback commands)
show qos dsl-bandwidth (will be replaced by "show qos interface-bandwidth")
show qos shdsl-bandwidth (will be replaced by "show qos interface-bandwidth")
show qos ethernet-bandwidth (will be replaced by "show qos interface-bandwidth")
show transport ether-ifmault (will be replaced by "show ethernet mau")
show transport ether-ifsfplt (will be replaced by "show ethernet sfp")
show transport ether-ifdot3lt (will be replaced by "show ethernet dot3stats")
configure atm [no]ip-cross-connect (obsolete and replaced by "configure ipoa/e-iw")
configure vlan (parameters "pvid-usage" "pppoe-relay" "circuit-id" "remoted-id" will be deleted)
configure vlan (parameter "broadcast-frames" is replaced by "new-broadcast" and will be deleted)
configure vlan (parameter "secure-forwarding" is replaced by "new-secure-fwd" and will be deleted)
configure bridge (obsolete parameter "accept-frame-type" will be deleted)
configure bridge (parameter "old-tag" is replaced by "tag" and will be deleted)

3HH-04416-EBAA-TCZZA 01

Released

55

2- Environment Configuration Commands

2.1 Environment Configuration Command Tree


2.2 Environment Configuration Command

56

Released

2-57
2-58

3HH-04416-EBAA-TCZZA

01

2 Environment Configuration Commands

2.1 Environment Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Environment Configuration Commands".

Command Tree
----environment
- [no] prompt
- [no] terminal-timeout
- [no] print
- [no] inhibit-alarms
- [no] mode

3HH-04416-EBAA-TCZZA 01

Released

57

2 Environment Configuration Commands

2.2 Environment Configuration Command


Command Description
This command allows the operator to manage the session-specific parameters. These parameters are only valid for
a specific session and are lost when the user logs out.
The default values for prompt and print can be found in configure system security operator operator-name.
The default value for terminal-timeout can be found in configure system security profile profile-name.
terminal-timeout: A value of 0 equals an infinite timeout value (i.e. the terminal will never time out).
The prompt can be composed with following components :
%n : the name of the current operator.
%s : the current numbering scheme (typ|leg|pos).
%! : the current history number.
% num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.

%% : a %
%c : # if the current node was an existing node or $ if it is newly created.
any other character is just added to the prompt as is.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> environment [ no prompt | prompt <Sec::Prompt> ] [ no terminal-timeout | terminal-timeout
<Sec::EnvInactivityTimeout> ] [ no print | print <Sec::EnvMore> ] [ [ no ] inhibit-alarms ] [ no mode | mode
<Cli::Mode> ]

Command Parameters
Table 2.2-2 "Environment Configuration Command" Command Parameters
Parameter

Type

Description

[no] prompt

Parameter type: <Sec::Prompt>


Format:
- a specification of the prompt
- length: x<=28
Parameter type: <Sec::EnvInactivityTimeout>
Format:
( default
| timeout : <Sec::InactivityTimeout> )
Possible values:

optional parameter with default


value: ""
the specification of the prompt

[no] terminal-timeout

58

Released

optional parameter with default


value: "timeout : 30"
specify the inactivity timeout of
the terminal

3HH-04416-EBAA-TCZZA

01

2 Environment Configuration Commands

Parameter

[no] print

[no] inhibit-alarms
[no] mode

3HH-04416-EBAA-TCZZA 01

Type

Description

- default : the default inactivity timeout


- timeout : specify the inactivity timeout
Field type <Sec::InactivityTimeout>
- specify the inactivity timeout of the terminal
- unit: minutes
- range: [0...120]
Parameter type: <Sec::EnvMore>
Format:
( more
| no-more
| default )
Possible values:
- more : the output is passed via the more filter
- no-more : the output is put directly on the terminal
- default : use the method as specified by the profile
Parameter type: boolean

optional parameter with default


value: "default"
specifies the way the output is
printed on the terminal

Parameter type: <Cli::Mode>


Format:
( batch
| interactive )
Possible values:
- batch : non-interactive mode intended for scripting tools
- interactive : interactive mode intended for human operators

optional parameter
disables the alarm reporting in
the current session
optional parameter with default
value: "interactive"
the mode in which the CLI
handles command input

Released

59

3- Alarm Configuration Commands

3.1 Alarm Configuration Command Tree


3.2 Alarm Log Configuration Command
3.3 Alarm Entry Configuration Command
3.4 Alarm Delta Log Configuration Command
3.5 SHub Alarm Configuration Command
3.6 Customizable Alarm Profile Configuration Command
3.7 Alarm Filter Configuration Command

60

Released

3-61
3-63
3-65
3-83
3-85
3-88
3-93

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.1 Alarm Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Alarm Configuration Commands".

Command Tree
----configure
----alarm
- log-sev-level
- log-full-action
- non-itf-rep-sev-level
----entry
- (index)
- [no] severity
- [no] service-affecting
- [no] reporting
- [no] logging
----delta-log
- indet-log-full-action
- warn-log-full-action
- minor-log-full-action
- major-log-full-action
- crit-log-full-act
----shub
----entry
- (index)
- severity
- [no] service-affecting
- [no] reporting
----[no] custom-profile
- (name)
- [no] mnemonic1
- [no] description1
- [no] visible1
- [no] audible1
- [no] polarity1
- [no] severity1
- [no] mnemonic2
- [no] description2
- [no] visible2
- [no] audible2
- [no] polarity2
- [no] severity2
- [no] mnemonic3
- [no] description3
- [no] visible3
- [no] audible3
- [no] polarity3
- [no] severity3
- [no] mnemonic4
- [no] description4

3HH-04416-EBAA-TCZZA 01

Released

61

3 Alarm Configuration Commands

- [no] visible4
- [no] audible4
- [no] polarity4
- [no] severity4
- [no] mnemonic5
- [no] description5
- [no] visible5
- [no] audible5
- [no] polarity5
- [no] severity5
----filter
- (fltr-type)
- filterid
- alarmid
- [no] status
- [no] threshold
- [no] window

62

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.2 Alarm Log Configuration Command


Command Description
This command allows the operator to maintain a log that contains all alarm state changes by enabling the logging
mode and setting the severity level equal to or higher than the severity level that the operator is interested in.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm log-sev-level <Alarm::alarmSeverityReport> log-full-action <Alarm::alarmLogFullAction>
non-itf-rep-sev-level <Alarm::alarmSeverityReport>

Command Parameters
Table 3.2-2 "Alarm Log Configuration Command" Command Parameters
Parameter

Type

Description

log-sev-level

Parameter type: <Alarm::alarmSeverityReport>


Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Parameter type: <Alarm::alarmLogFullAction>
Format:
( wrap
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset
Parameter type: <Alarm::alarmSeverityReport>
Format:
( indeterminate
| warning
| minor
| major

optional parameter
set the lowest severity level to log
alarms

log-full-action

non-itf-rep-sev-level

3HH-04416-EBAA-TCZZA 01

optional parameter
set the action if log buffer is full

optional parameter
set minimum severity level to
report non itf alarms

Released

63

3 Alarm Configuration Commands

Parameter

Type

Description

| critical )
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

64

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.3 Alarm Entry Configuration Command


Command Description
This command allows the operator to manage local alarm entries.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm entry (index) [ no severity | severity <Alarm::alarmSeverity> ] [ [ no ] service-affecting ] [ [ no ]
reporting ] [ [ no ] logging ]

Command Parameters
Table 3.3-1 "Alarm Entry Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los

alarm type

3HH-04416-EBAA-TCZZA 01

Released

65

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail
| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail

66

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7
| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15

3HH-04416-EBAA-TCZZA 01

Released

67

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1
| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg

68

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl
| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk

3HH-04416-EBAA-TCZZA 01

Released

69

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss
| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los

70

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail
| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu

3HH-04416-EBAA-TCZZA 01

Released

71

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus
| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min

72

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- xtca-ne-uas : unavailable seconds in 15 min


- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation
- vectline-corp-errf : corrupted or missing errorf-samples
- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational

3HH-04416-EBAA-TCZZA 01

Released

73

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- sw-rollback : non active oswp,db cannot be operational will rollback


- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal
- vlan-assign-fail : failure to assign VLAN for a user session
- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to

74

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

set up config group


- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6
- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10
- der-temp11 : derived alarm for temporal filter 11
- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20

3HH-04416-EBAA-TCZZA 01

Released

75

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- der-temp21 : derived alarm for temporal filter 21


- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure
- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4
- custextalarm5 : Customizable External Alarm Number 5
- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board

76

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- fibre-conn-mismatch : REM Fibre Connection Mismatch


Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair
- shdsl-c-losw : loss of sync word at the customer side on
each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on

3HH-04416-EBAA-TCZZA 01

Released

77

3 Alarm Configuration Commands

Resource Identifier

Type

Description

each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).
- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch
- dns-lookup-failure : Dns look up failure
- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow

78

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- dwobc-overflow : Downstream load to OBC overflow


- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed
- user-sfp-mismatch : user sfp mismatch the configured type
- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage

3HH-04416-EBAA-TCZZA 01

Released

79

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- dc-a-fail : Local DC A power failure


- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm
from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from
LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm

80

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event
- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received
- cfm-defxconccm : unexpected ccm received
- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status

Table 3.3-2 "Alarm Entry Configuration Command" Command Parameters


Parameter

Type

Description

[no] severity

Parameter type: <Alarm::alarmSeverity>


Format:
( indeterminate
| warning

optional parameter with default


value: "minor"
assign a severity level to this
alarm

3HH-04416-EBAA-TCZZA 01

Released

81

3 Alarm Configuration Commands

Parameter

Type

[no] service-affecting

| minor
| major
| critical
| ignore )
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
- ignore : alarm is not processed by the system
Parameter type: boolean

Description

[no] reporting

Parameter type: boolean

[no] logging

Parameter type: boolean

optional parameter
make this alarm service affecting
optional parameter
enable reporting of this alarm
optional parameter
enable logging of this alarm

Command Output
Table 3.3-3 "Alarm Entry Configuration Command" Display parameters
Specific Information
name
category

82

Released

Type

Description

Parameter type: <Alarm::category>


( communications
| qos
| processing-error
| equipment
| environmental )
Possible values:
- communications : communications related alarms
- qos : QoS related alarms
- processing-error : processing failure related alarms
- equipment : equipment related alarms
- environmental : environmental related alarms

category of an alarm
This element is always shown.

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.4 Alarm Delta Log Configuration Command


Command Description
This command allows the operator to configure the action of the system when the alarm log buffer is full.
If the action is set to wrap, older log records are overwritten by recent records. If the action is set to halt, logging
is stopped until the log buffer is reset.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm delta-log [ indet-log-full-action <Alarm::alarmDeltaLogFullAction> ] [ warn-log-full-action
<Alarm::alarmDeltaLogFullAction> ] [ minor-log-full-action <Alarm::alarmDeltaLogFullAction> ] [
major-log-full-action <Alarm::alarmDeltaLogFullAction> ] [ crit-log-full-act <Alarm::alarmDeltaLogFullAction> ]

Command Parameters
Table 3.4-2 "Alarm Delta Log Configuration Command" Command Parameters
Parameter

Type

Description

indet-log-full-action

Parameter type: <Alarm::alarmDeltaLogFullAction>


Format:
( wrap
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
Parameter type: <Alarm::alarmDeltaLogFullAction>
Format:
( wrap
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
Parameter type: <Alarm::alarmDeltaLogFullAction>
Format:
( wrap
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
Parameter type: <Alarm::alarmDeltaLogFullAction>
Format:
( wrap

optional parameter
set the action when indeterminate
log buffer is full

warn-log-full-action

minor-log-full-action

major-log-full-action

3HH-04416-EBAA-TCZZA 01

optional parameter
set the action when warn delta
log buffer is full

optional parameter
set the action when minor delta
log buffer is full

optional parameter
set action when major delta log
buffer is full

Released

83

3 Alarm Configuration Commands

Parameter

crit-log-full-act

84

Released

Type

Description

| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
Parameter type: <Alarm::alarmDeltaLogFullAction>
Format:
( wrap
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full

optional parameter
set action when critical delta log
buffer is full

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.5 SHub Alarm Configuration Command


Command Description
This command allows the operator to configure the SHub alarm parameters.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm shub entry (index) [ severity <Alarm::alarmSeverity> ] [ [ no ] service-affecting ] [ [ no ]
reporting ]

Command Parameters
Table 3.5-1 "SHub Alarm Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( db-restore
| reboot
| sntp-comm
| eth-link-down
| mac-conflict
| oper-speed-mismatch
| ospf-itf-err
| ospf-auth-err
| ospf-rx-bad-err
| ospf-lsdb-oflow
| ospf-nhbr-statchg
| ospf-itf-statchg
| ospf-ext-lsa-threshold
| ospf-instance-down
| rip-config-err
| rip-auth-fail
| rip-rcv-bad-pkt
| rip-table-treshold
| rip-instance-down
| arp-table-full
| route-tbl-overflow
| uplink-down
| pccp-down
| global-ospf-route
| global-ospf-lsa-tbl
| global-ospf-retrms-tbl

alarm type

3HH-04416-EBAA-TCZZA 01

Released

85

3 Alarm Configuration Commands

Resource Identifier

Type

Description

| global-ospf-lsaovflw
| global-ospf-topology
| global-rip-route-tbl
| global-fwd-arp-tbl
| global-fwd-route-tbl )
Possible values:
- db-restore : shub DB restore
- reboot : shub reboot from emergency boot package
- sntp-comm : shub SNTP communication
- eth-link-down : shub ethernet link down status
- mac-conflict : MAC conflict
- oper-speed-mismatch : mismatch in administrative and
operational speed
- ospf-itf-err : OSPF interface configuration error
- ospf-auth-err : OSPF interface authetication error
- ospf-rx-bad-err : bad packets received on OSPF interface
- ospf-lsdb-oflow : external LSA database reached the
overflow limit
- ospf-nhbr-statchg : OSPF neighbor state change
- ospf-itf-statchg : OSPF interface state change
- ospf-ext-lsa-threshold: OSPF external LSA up threshold
reached
- ospf-instance-down : OSPF instance down
- rip-config-err : RIP interface configuration error
- rip-auth-fail : RIP interface authentication failure
- rip-rcv-bad-pkt : bad packet received on RIP interface
- rip-table-treshold : RIP route table up threshold reached
- rip-instance-down : RIP instance down
- arp-table-full : ARP table full per VRF
- route-tbl-overflow : routing table threshold reached
- uplink-down : uplink group down
- pccp-down : lanx pccp down status
- global-ospf-route : OSPF route table up threshold reached
- global-ospf-lsa-tbl : OSPF LSA table up threshold reached
- global-ospf-retrms-tbl: OSPF retransmission table up
threshold reached
- global-ospf-lsaovflw : OSPF self generated LSA table
overflow
- global-ospf-topology : OSPF area topology too big
- global-rip-route-tbl : RIP global route table up threshold
reached
- global-fwd-arp-tbl : global ARP route table up threshold
reached
- global-fwd-route-tbl : global forwarding table full

Table 3.5-2 "SHub Alarm Configuration Command" Command Parameters


Parameter

Type

Description

severity

Parameter type: <Alarm::alarmSeverity>


Format:
( indeterminate
| warning
| minor
| major
| critical
| ignore )
Possible values:
- indeterminate : not a definite known severity level

optional parameter
assign a severity level to this
alarm

86

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

[no] service-affecting

- warning : just to inform as a warning


- minor : not service affecting
- major : service affecting
- critical : service breaking
- ignore : alarm is not processed by the system
Parameter type: boolean

[no] reporting

Parameter type: boolean

Description

optional parameter
make this alarm service affecting
optional parameter
enable reporting of this alarm

Command Output
Table 3.5-3 "SHub Alarm Configuration Command" Display parameters
Specific Information
name
category

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::category>


( communications
| qos
| processing-error
| equipment
| environmental )
Possible values:
- communications : communications related alarms
- qos : QoS related alarms
- processing-error : processing failure related alarms
- equipment : equipment related alarms
- environmental : environmental related alarms

defines the category of an alarm.


This element is always shown.

Released

87

3 Alarm Configuration Commands

3.6 Customizable Alarm Profile Configuration


Command
Command Description
This command allows the operator to configure the external alarm profile. The profile is made to be assigned to a
remote LT board. The profile reflects a configuration of external alarms parameters that corresponds to a certain
environment where the remote board is located (in an outdoor cabinet, basement cabinet, ...). The use of a profile
avoids the need to specify the parameters for each remote board separately. The alarm profile groups all five
external alarms parameters. The profile contains a description/meaning of each alarm, as well as an indication
that tells us whether or not any alarm outputs are to be triggered if the corresponding external input alarm is
raised. On top of these parameters, a mnemonic (short for the description), the polarity and the severity are
configurable.
Note:
The
Severity
parameters
of
custom
alarm
profile
i.e
(severity1,severity2,severity3,severity4,severity5) are supported for only FD-REM not other shelfs.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm ( no custom-profile (name) ) | ( custom-profile (name) [ no mnemonic1 | mnemonic1
<Alarm::AlarmMnemonic> ] [ no description1 | description1 <Alarm::AlarmDescription> ] [ no visible1 | visible1
<Alarm::VisibleOutput> ] [ no audible1 | audible1 <Alarm::AudibleOutput> ] [ no polarity1 | polarity1
<Alarm::InversePolarity> ] [ no severity1 | severity1 <Alarm::AlarmSeverity> ] [ no mnemonic2 | mnemonic2
<Alarm::AlarmMnemonic> ] [ no description2 | description2 <Alarm::AlarmDescription> ] [ no visible2 | visible2
<Alarm::VisibleOutput> ] [ no audible2 | audible2 <Alarm::AudibleOutput> ] [ no polarity2 | polarity2
<Alarm::InversePolarity> ] [ no severity2 | severity2 <Alarm::AlarmSeverity> ] [ no mnemonic3 | mnemonic3
<Alarm::AlarmMnemonic> ] [ no description3 | description3 <Alarm::AlarmDescription> ] [ no visible3 | visible3
<Alarm::VisibleOutput> ] [ no audible3 | audible3 <Alarm::AudibleOutput> ] [ no polarity3 | polarity3
<Alarm::InversePolarity> ] [ no severity3 | severity3 <Alarm::AlarmSeverity> ] [ no mnemonic4 | mnemonic4
<Alarm::AlarmMnemonic> ] [ no description4 | description4 <Alarm::AlarmDescription> ] [ no visible4 | visible4
<Alarm::VisibleOutput> ] [ no audible4 | audible4 <Alarm::AudibleOutput> ] [ no polarity4 | polarity4
<Alarm::InversePolarity> ] [ no severity4 | severity4 <Alarm::AlarmSeverity> ] [ no mnemonic5 | mnemonic5
<Alarm::AlarmMnemonic> ] [ no description5 | description5 <Alarm::AlarmDescription> ] [ no visible5 | visible5
<Alarm::VisibleOutput> ] [ no audible5 | audible5 <Alarm::AudibleOutput> ] [ no polarity5 | polarity5
<Alarm::InversePolarity> ] [ no severity5 | severity5 <Alarm::AlarmSeverity> ] )

Command Parameters
Table 3.6-1 "Customizable Alarm Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name

custom profile name

88

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Resource Identifier

Type

Description

- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

Table 3.6-2 "Customizable Alarm Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] mnemonic1

Parameter type: <Alarm::AlarmMnemonic>


Format:
- an octet string defining mnemonic of external alarm
- range: [A-Z]
- length: x<=16
Parameter type: <Alarm::AlarmDescription>
Format:
- an octet string defining description of external alarm
- length: x<=40
Parameter type: <Alarm::VisibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
Parameter type: <Alarm::AudibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
Parameter type: <Alarm::InversePolarity>
Format:
( normal
| inverse )
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
Parameter type: <Alarm::AlarmSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : alarm severity is indeterminate
- warning : alarm severity is warning
- minor : alarm severity is minor
- major : alarm severity is major
- critical : alarm severity is critical
Parameter type: <Alarm::AlarmMnemonic>
Format:
- an octet string defining mnemonic of external alarm
- range: [A-Z]
- length: x<=16
Parameter type: <Alarm::AlarmDescription>
Format:
- an octet string defining description of external alarm
- length: x<=40

optional parameter with default


value: "UNDEF"
mnemonic
identifying
the
customizable external alarm 1

[no] description1

[no] visible1

[no] audible1

[no] polarity1

[no] severity1

[no] mnemonic2

[no] description2

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "Undefined"
description of the customizable
external alarm 1
optional parameter with default
value: "disable"
trigger a visible alarm for
external alarm 1

optional parameter with default


value: "disable"
trigger a audible alarm for
external alarm 1

optional parameter with default


value: "normal"
alarm polarity is normal or
inverse for external alarm 1

optional parameter with default


value: "major"
severity level of external alarm 1

optional parameter with default


value: "UNDEF"
mnemonic
identifying
the
customizable external alarm 2
optional parameter with default
value: "Undefined"
description of the customizable
external alarm 2

Released

89

3 Alarm Configuration Commands

Parameter

Type

Description

[no] visible2

Parameter type: <Alarm::VisibleOutput>


Format:
( enable
| disable )
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
Parameter type: <Alarm::AudibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
Parameter type: <Alarm::InversePolarity>
Format:
( normal
| inverse )
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
Parameter type: <Alarm::AlarmSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : alarm severity is indeterminate
- warning : alarm severity is warning
- minor : alarm severity is minor
- major : alarm severity is major
- critical : alarm severity is critical
Parameter type: <Alarm::AlarmMnemonic>
Format:
- an octet string defining mnemonic of external alarm
- range: [A-Z]
- length: x<=16
Parameter type: <Alarm::AlarmDescription>
Format:
- an octet string defining description of external alarm
- length: x<=40
Parameter type: <Alarm::VisibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
Parameter type: <Alarm::AudibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible

optional parameter with default


value: "disable"
trigger a visible alarm for
external alarm 2

[no] audible2

[no] polarity2

[no] severity2

[no] mnemonic3

[no] description3

[no] visible3

[no] audible3

90

Released

optional parameter with default


value: "disable"
trigger a audible alarm for
external alarm 2

optional parameter with default


value: "normal"
alarm polarity is normal or
inverse for external alarm 2

optional parameter with default


value: "major"
severity level of external alarm 2

optional parameter with default


value: "UNDEF"
mnemonic
identifying
the
customizable external alarm 3
optional parameter with default
value: "Undefined"
description of the customizable
external alarm 3
optional parameter with default
value: "disable"
trigger a visible alarm for
external alarm 3

optional parameter with default


value: "disable"
trigger a audible alarm for
external alarm 3

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

[no] polarity3

Parameter type: <Alarm::InversePolarity>


Format:
( normal
| inverse )
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
Parameter type: <Alarm::AlarmSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : alarm severity is indeterminate
- warning : alarm severity is warning
- minor : alarm severity is minor
- major : alarm severity is major
- critical : alarm severity is critical
Parameter type: <Alarm::AlarmMnemonic>
Format:
- an octet string defining mnemonic of external alarm
- range: [A-Z]
- length: x<=16
Parameter type: <Alarm::AlarmDescription>
Format:
- an octet string defining description of external alarm
- length: x<=40
Parameter type: <Alarm::VisibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
Parameter type: <Alarm::AudibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
Parameter type: <Alarm::InversePolarity>
Format:
( normal
| inverse )
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
Parameter type: <Alarm::AlarmSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical )

optional parameter with default


value: "normal"
alarm polarity is normal or
inverse for external alarm 3

[no] severity3

[no] mnemonic4

[no] description4

[no] visible4

[no] audible4

[no] polarity4

[no] severity4

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "major"
severity level of external alarm 3

optional parameter with default


value: "UNDEF"
mnemonic
identifying
the
customizable external alarm 4
optional parameter with default
value: "Undefined"
description of the customizable
external alarm 4
optional parameter with default
value: "disable"
trigger a visible alarm for
external alarm 4

optional parameter with default


value: "disable"
trigger a audible alarm for
external alarm 4

optional parameter with default


value: "normal"
alarm polarity is normal or
inverse for external alarm 4

optional parameter with default


value: "major"
severity level of external alarm 4

Released

91

3 Alarm Configuration Commands

Parameter

Type

[no] mnemonic5

[no] description5

[no] visible5

[no] audible5

[no] polarity5

[no] severity5

92

Description

Possible values:
- indeterminate : alarm severity is indeterminate
- warning : alarm severity is warning
- minor : alarm severity is minor
- major : alarm severity is major
- critical : alarm severity is critical
Parameter type: <Alarm::AlarmMnemonic>
Format:
- an octet string defining mnemonic of external alarm
- range: [A-Z]
- length: x<=16
Parameter type: <Alarm::AlarmDescription>
Format:
- an octet string defining description of external alarm
- length: x<=40
Parameter type: <Alarm::VisibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
Parameter type: <Alarm::AudibleOutput>
Format:
( enable
| disable )
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
Parameter type: <Alarm::InversePolarity>
Format:
( normal
| inverse )
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
Parameter type: <Alarm::AlarmSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : alarm severity is indeterminate
- warning : alarm severity is warning
- minor : alarm severity is minor
- major : alarm severity is major
- critical : alarm severity is critical

Released

optional parameter with default


value: "UNDEF"
mnemonic
identifying
the
customizable external alarm 5
optional parameter with default
value: "Undefined"
description of the customizable
external alarm 5
optional parameter with default
value: "disable"
trigger a visible alarm for
external alarm 5

optional parameter with default


value: "disable"
trigger a audible alarm for
external alarm 5

optional parameter with default


value: "normal"
alarm polarity is normal or
inverse for external alarm 5

optional parameter with default


value: "major"
severity level of external alarm 5

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

3.7 Alarm Filter Configuration Command


Command Description
This command allows the operator to configure Alarm filter parameters.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm filter (fltr-type) filterid <Alarm::fltrId> [ alarmid <Alarm::alarmIndex> ] [ no status | status
<Alarm::fltrStatus> ] [ no threshold | threshold <Alarm::fltrThreshold> ] [ no window | window
<Alarm::fltrWindow> ]

Command Parameters
Table 3.7-1 "Alarm Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(fltr-type)

Format:
( temporal
| spatial )
Possible values:
- temporal : the temporal alarm filter
- spatial : the spatial alarm filter
Parameter type: <Alarm::fltrId>
Format:
- unique filter number
- range: [1...31]

the type of the considered alarm


filter

filterid

unique filter number

Table 3.7-2 "Alarm Filter Configuration Command" Command Parameters


Parameter

Type

Description

alarmid

Parameter type: <Alarm::alarmIndex>


Format:
( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses

optional parameter
alarmType

3HH-04416-EBAA-TCZZA 01

Released

93

3 Alarm Configuration Commands

Parameter

Type

Description

| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power

94

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail
| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail

3HH-04416-EBAA-TCZZA 01

Released

95

3 Alarm Configuration Commands

Parameter

Type

Description

| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7
| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26

96

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1
| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr

3HH-04416-EBAA-TCZZA 01

Released

97

3 Alarm Configuration Commands

Parameter

Type

Description

| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl
| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch

98

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss
| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn

3HH-04416-EBAA-TCZZA 01

Released

99

3 Alarm Configuration Commands

Parameter

Type

Description

| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail
| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca

100

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus
| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation

3HH-04416-EBAA-TCZZA 01

Released

101

3 Alarm Configuration Commands

Parameter

Type

Description

- xdsl-fe-lcd : loss of cell delineation


- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation
- vectline-corp-errf : corrupted or missing errorf-samples
- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning

102

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

- board-init : board initialisation failure


- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal
- vlan-assign-fail : failure to assign VLAN for a user session
- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5

3HH-04416-EBAA-TCZZA 01

Released

103

3 Alarm Configuration Commands

Parameter

Type

Description

- der-temp6 : derived alarm for temporal filter 6


- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10
- der-temp11 : derived alarm for temporal filter 11
- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31

104

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

- apsf-alarm : Applique Power Supply Failure


- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4
- custextalarm5 : Customizable External Alarm Number 5
- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed

3HH-04416-EBAA-TCZZA 01

Released

105

3 Alarm Configuration Commands

Parameter

Type

Description

threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair
- shdsl-c-losw : loss of sync word at the customer side on
each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).

106

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

- subs-auth : Subscribe failure (authentication).


- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch
- dns-lookup-failure : Dns look up failure
- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day

3HH-04416-EBAA-TCZZA 01

Released

107

3 Alarm Configuration Commands

Parameter

Type

Description

- user-sfp-los : user sfp loss of signal


- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed
- user-sfp-mismatch : user sfp mismatch the configured type
- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU

108

Released

3HH-04416-EBAA-TCZZA

01

3 Alarm Configuration Commands

Parameter

Type

Description

- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm


from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from
LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp

3HH-04416-EBAA-TCZZA 01

Released

109

3 Alarm Configuration Commands

Parameter

Type

[no] status

[no] threshold

[no] window

110

Description

- efm-oam-cpecrevt : EFM-OAM CPE critical event


- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received
- cfm-defxconccm : unexpected ccm received
- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::fltrStatus>
Format:
( not-used
| used )
Possible values:
- not-used : deactivate the configured alarm filter
- used : activate the configured alarm filter
Parameter type: <Alarm::fltrThreshold>
Format:
- the threshold value of the considered alarm filter
- range: [2...65535]
Parameter type: <Alarm::fltrWindow>
Format:
- the duration of the filter window
- range: [1...65535]

Released

optional parameter with default


value: "not-used"
filter status

optional parameter with default


value: "2"
the threshold value of the
considered alarm filter
optional parameter with default
value: "60"
the duration of the filter window,
only applicable for temporal type

3HH-04416-EBAA-TCZZA

01

4- Trap Configuration Commands

4.1 Trap Configuration Command Tree


4.2 Trap Definition Configuration Command
4.3 Trap Manager Configuration Command

3HH-04416-EBAA-TCZZA 01

4-112
4-114
4-116

Released

111

4 Trap Configuration Commands

4.1 Trap Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Trap Configuration Commands".

Command Tree
----configure
----trap
----definition
- (name)
- priority
----[no] manager
- (address)
- [no] priority
- [no] cold-start-trap
- [no] link-down-trap
- [no] link-up-trap
- [no] auth-fail-trap
- [no] change-trap
- [no] line-test-trap
- [no] init-started-trap
- [no] lic-key-chg-occr
- [no] topology-chg
- [no] selt-state-chg
- [no] dhcp-sess-pre
- [no] alarm-chg-trap
- [no] phys-line-trap
- [no] eqpt-change-trap
- [no] success-set-trap
- [no] other-alarm-trap
- [no] warning-trap
- [no] minor-trap
- [no] major-trap
- [no] critical-trap
- [no] redundancy-trap
- [no] eqpt-prot-trap
- [no] craft-login-trap
- [no] restart-trap
- [no] ntr-trap
- [no] rad-srvr-fail
- [no] login-occr-trap
- [no] logout-occr-trap
- [no] trapmngr-chg-trap
- [no] mst-genral
- [no] mst-error
- [no] mst-protocol-mig
- [no] mst-inv-bpdu-rx
- [no] mst-reg-conf-chg
- [no] max-per-window
- [no] window-size
- [no] max-queue-size

112

Released

3HH-04416-EBAA-TCZZA

01

4 Trap Configuration Commands

- [no] min-interval
- [no] min-severity

3HH-04416-EBAA-TCZZA 01

Released

113

4 Trap Configuration Commands

4.2 Trap Definition Configuration Command


Command Description
This command allows the operator to define the priority of a given trap.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure trap definition (name) [ priority <Trap::Priority> ]

Command Parameters
Table 4.2-1 "Trap Definition Configuration Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
the name of the trap
( cold-start
| link-down
| link-up
| auth-failure
| change-occured
| line-test-report
| init-started
| lic-key-chg-occr
| topology-chg
| selt-state-chg
| dhcp-sess-pre
| radius-server-failure
| login-occured
| logout-occured
| trapmngr-chg-occr
| mst-genral
| mst-error
| mst-protocol-mig
| mst-inv-bpdu-rx
| mst-reg-conf-chg )
Possible values:
- cold-start : the node is reinitializing
- link-down : one of the communication links of the node
has failed
- link-up : one of the communication links of the node
became operational
- auth-failure : authentication failure

114

Released

Description

3HH-04416-EBAA-TCZZA

01

4 Trap Configuration Commands

Resource Identifier

Type

Description

- change-occured : a configuration or operational change


occurred
- line-test-report : line test result available
- init-started : the node is initializing, IP connectivity is
established
- lic-key-chg-occr : the number of license keys changed
- topology-chg : topology changed (scope of cluster
management)
- selt-state-chg : selt test finished and results available
- dhcp-sess-pre : dhcp session preempted
- radius-server-failure : radius server failed
- login-occured : login occured
- logout-occured : logout occured
- trapmngr-chg-occr : trap manager change occured
- mst-genral : mstp general events
- mst-error : mstp error events
- mst-protocol-mig : mstp port protocol migration
- mst-inv-bpdu-rx : mstp invalid packet received
- mst-reg-conf-chg : mstp region configuration change

Table 4.2-2 "Trap Definition Configuration Command" Command Parameters


Parameter

Type

Description

priority

Parameter type: <Trap::Priority>


Format:
( urgent
| high
| medium
| low )
Possible values:
- urgent : urgent - needs to be informed immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap

optional parameter
the trap priority

3HH-04416-EBAA-TCZZA 01

Released

115

4 Trap Configuration Commands

4.3 Trap Manager Configuration Command


Command Description
This command allows the operator to configure an SNMP manager, which will receive traps when an event occurs
in the system.
The SNMP manager can easily be flooded by events if something happens to the system. This command allows the
operator to specify which traps the manager is interested in (trap filtering) and how the traps must be distributed in
time (trap shaping).
Traps that cannot be delivered will be dropped.
The Following traps will be sent as a part of changeOccuredTrap alarm-chg-trap, phys-line-trap,
eqpt-change-trap, success-set-trap, other-alarm-trap, warning-trap, minor-trap, major-trap, critical-trap,
redundancy-trap, eqpt-prot-trap, craft-login-trap, restart-trap, ntr-trap.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure trap ( no manager (address) ) | ( manager (address) [ no priority | priority <Trap::Priority> ] [ [ no ]
cold-start-trap ] [ [ no ] link-down-trap ] [ [ no ] link-up-trap ] [ [ no ] auth-fail-trap ] [ [ no ] change-trap ] [ [ no ]
line-test-trap ] [ [ no ] init-started-trap ] [ [ no ] lic-key-chg-occr ] [ [ no ] topology-chg ] [ [ no ] selt-state-chg ] [ [
no ] dhcp-sess-pre ] [ [ no ] alarm-chg-trap ] [ [ no ] phys-line-trap ] [ [ no ] eqpt-change-trap ] [ [ no ]
success-set-trap ] [ [ no ] other-alarm-trap ] [ [ no ] warning-trap ] [ [ no ] minor-trap ] [ [ no ] major-trap ] [ [ no ]
critical-trap ] [ [ no ] redundancy-trap ] [ [ no ] eqpt-prot-trap ] [ [ no ] craft-login-trap ] [ [ no ] restart-trap ] [ [ no ]
ntr-trap ] [ [ no ] rad-srvr-fail ] [ [ no ] login-occr-trap ] [ [ no ] logout-occr-trap ] [ [ no ] trapmngr-chg-trap ] [ [ no
] mst-genral ] [ [ no ] mst-error ] [ [ no ] mst-protocol-mig ] [ [ no ] mst-inv-bpdu-rx ] [ [ no ] mst-reg-conf-chg ] [
no max-per-window | max-per-window <Trap::WindowCount> ] [ no window-size | window-size
<Trap::WindowSize> ] [ no max-queue-size | max-queue-size <Trap::QueueSize> ] [ no min-interval | min-interval
<Trap::Interval> ] [ no min-severity | min-severity <Alarm::alarmSeverityReport> ] )

Command Parameters
Table 4.3-1 "Trap Manager Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]

the address of the manager

Table 4.3-2 "Trap Manager Configuration Command" Command Parameters

116

Released

3HH-04416-EBAA-TCZZA

01

4 Trap Configuration Commands

Parameter

Type

Description

[no] priority

optional parameter with default


value: "medium"
lowest priority a trap should have
to be reported

[no] cold-start-trap

Parameter type: <Trap::Priority>


Format:
( urgent
| high
| medium
| low )
Possible values:
- urgent : urgent - needs to be informed immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap
Parameter type: boolean

[no] link-down-trap

Parameter type: boolean

[no] link-up-trap

Parameter type: boolean

[no] auth-fail-trap

Parameter type: boolean

[no] change-trap

Parameter type: boolean

[no] line-test-trap

Parameter type: boolean

[no] init-started-trap

Parameter type: boolean

[no] lic-key-chg-occr

Parameter type: boolean

[no] topology-chg

Parameter type: boolean

[no] selt-state-chg

Parameter type: boolean

[no] dhcp-sess-pre

Parameter type: boolean

[no] alarm-chg-trap

Parameter type: boolean

[no] phys-line-trap

Parameter type: boolean

[no] eqpt-change-trap

Parameter type: boolean

[no] success-set-trap

Parameter type: boolean

[no] other-alarm-trap

Parameter type: boolean

[no] warning-trap

Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

optional parameter
enable sending cold start trap
optional parameter
enable sending link down trap
optional parameter
enable sending of link up trap
optional parameter
enable sending authentication
failure trap
optional parameter
enable sending of change occured
trap
optional parameter
enable line test report trap
optional parameter
enable sending init started trap
optional parameter
enable sending licence key
changed occured trap
optional parameter
enable sending topology changed
occured trap
optional parameter
enable sending selt state change
trap
optional parameter
enable sending DHCP session
preempted trap
optional parameter
enable snd nbr alrm chg(part of
changeOccurredTrap)
optional parameter
enable snd phys line chg(part of
changeOccurredTrap)
optional parameter
enable snd eqpt nbr chg(part of
changeOccurredTrap)
optional parameter
enable snd nbr of sets chg(part of
changeOccurredTrap)
optional parameter
enable snd nbr indeterminate
chg(part of changeOccurredTrap)
optional parameter
enable snd nbr warning chg(part
of changeOccurredTrap)

Released

117

4 Trap Configuration Commands

Parameter

Type

Description

[no] minor-trap

Parameter type: boolean

[no] major-trap

Parameter type: boolean

[no] critical-trap

Parameter type: boolean

[no] redundancy-trap

Parameter type: boolean

[no] eqpt-prot-trap

Parameter type: boolean

[no] craft-login-trap

Parameter type: boolean

[no] restart-trap

Parameter type: boolean

[no] ntr-trap

Parameter type: boolean

[no] rad-srvr-fail

Parameter type: boolean

[no] login-occr-trap

Parameter type: boolean

[no] logout-occr-trap

Parameter type: boolean

[no] trapmngr-chg-trap

Parameter type: boolean

[no] mst-genral
[no] mst-error

Parameter type: boolean


Parameter type: boolean

[no] mst-protocol-mig

Parameter type: boolean

[no] mst-inv-bpdu-rx

Parameter type: boolean

[no] mst-reg-conf-chg

Parameter type: boolean

[no] max-per-window

Parameter type: <Trap::WindowCount>


Format:
- maximum allowed number of traps per window
- unit: traps
- range: [1...20]
Parameter type: <Trap::WindowSize>
Format:
- the size of a time window for traps
- unit: s
- range: [0...3600]

optional parameter
enable snd nbr minor chg(part of
changeOccurredTrap)
optional parameter
enable snd nbr major chg(part of
changeOccurredTrap)
optional parameter
enable snd nbr critical chg(part of
changeOccurredTrap)
optional parameter
enable snd nbr redundancy
chg(part of changeOccurredTrap)
optional parameter
enable snd nbr eqpt prot chg(part
of changeOccurredTrap)
optional parameter
enable snd craft login chg(part of
changeOccurredTrap)
optional parameter
enable restart trap(part of
changeOccurredTrap)
optional parameter
enable ntr changes trap(part of
changeOccurredTrap)
optional parameter
enable sending radius server
failure trap
optional parameter
enable sending login occured trap
optional parameter
enable sending logout occured
trap
optional parameter
enable sending trap manager
change occured trap
optional parameter
optional parameter
enable mstp error events trap
optional parameter
enable mstp port protocol
migration trap
optional parameter
enable mstp invalid packet
received trap
optional parameter
enable mstp region configuration
change trap
optional parameter with default
value: 2
maximum allowed number of
traps per window

[no] window-size

118

Released

optional parameter with default


value: 60
the size of a time window for
traps in seconds

3HH-04416-EBAA-TCZZA

01

4 Trap Configuration Commands

Parameter

Type

Description

[no] max-queue-size

Parameter type: <Trap::QueueSize>


Format:
- maximum number of traps that can be queued
- unit: traps
- range: [1...20]
Parameter type: <Trap::Interval>
Format:
- minimum time interval between two traps
- unit: s
- range: [0...3600]
Parameter type: <Alarm::alarmSeverityReport>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

optional parameter with default


value: 10
maximum number of traps that
can be queued

[no] min-interval

[no] min-severity

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 30
the minimum time between two
traps
optional parameter with default
value: "major"
lowest severity an alarm must
have, to be reported

Released

119

5- Equipment Configuration Commands

5.1 Equipment Configuration Command Tree


5.2 Rack Configuration Command
5.3 Shelf Configuration Command
5.4 Slot Configuration Command
5.5 Applique Configuration Command
5.6 Protection Group Configuration Command
5.7 Protection Element Configuration Command
5.8 External-link-host Configuration Commands
5.9 Host Shelf SFP Configuration Commands
5.10 2xE1/DS1 CLOCK configuration Command
5.11 2xE1/DS1 Pseudo Wire TDM Interface configuration
Command
5.12 2xE1/DS1 Pseudo Wire TDM SFP configuration
Command
5.13 2xE1/DS1 Framer configuration Command
5.14 2xE1/DS1 Line Interface Unit SFP configuration
Command
5.15 NE Configuration Command
5.16 Environment Monitoring Configuration Command
5.17 Configure Fan Tray parameters

120

Released

5-121
5-123
5-124
5-126
5-128
5-130
5-131
5-133
5-135
5-137
5-139
5-141
5-144
5-148
5-151
5-152
5-153

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.1 Equipment Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Equipment Configuration Commands".

Command Tree
----configure
----equipment
----rack
- (index)
- [no] description
----shelf
- (index)
- [no] class
- [no] planned-type
X [no] unlock
- [no] lock
X [no] extended-lt-slots
- [no] mode
- [no] description
----slot
- (index)
- [no] planned-type
- [no] power-down
- [no] unlock
- [no] alarm-profile
- capab-profile
- dual-host-ip
- dual-host-loc
----applique
- (index)
- [no] planned-type
- [no] applique-profile
----protection-group
- (prot-group-id)
- [no] admin-status
- [no] eps-quenchfactor
----protection-element
- (index)
- [no] redcy-ctrl-status
----external-link-host
- (faceplate-number)
- [no] direction
----external-link-assign
- (faceplate-number)
- [no] remote
----[no] sfpe1t1
----[no] clock
- (position)
- [no] clocksource
----tdmintf

3HH-04416-EBAA-TCZZA 01

Released

121

5 Equipment Configuration Commands

- (position)
- [no] window-number
- [no] window-length
----[no] pwtdm
- (position)
- channel
- packet-length
- jitter-buff-size
- vlanid
- priority
- conseq-number
- ecid-rx
- ecid-tx
- source-mac
- dest-mac
----framer
- (position)
- [no] frame-mode
- [no] iwf-on-liu
- [no] liu-on-liu
- [no] pm-to-iwf
- [no] ais-to-iwf
- [no] rai-to-iwf
- [no] rei-to-iwf
- [no] pm-to-liu
- [no] ais-to-liu
- [no] rai-to-liu
- [no] rei-to-liu
----liu
- (position)
- [no] distance
- [no] cable-impedance
----isam
- [no] description
----envbox
- [no] enable-supervise
----fan-tray
- fanmode

122

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.2 Rack Configuration Command


Command Description
This command allows the operator to configure the rack. The operator can configure the following parameter:
description: text that describes the location of the rack.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment rack (index) [ no description | description <Description-127> ]

Command Parameters
Table 5.2-1 "Rack Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
<Eqpt::RackId>
Field type <Eqpt::RackId>
- the rack number

the physcial position of the rack

Table 5.2-2 "Rack Configuration Command" Command Parameters


Parameter

Type

Description

[no] description

Parameter type: <Description-127>


Format:
- description to help the operator to identify the object
- length: x<=127

optional parameter with default


value: ""
any description to be used by the
operator

3HH-04416-EBAA-TCZZA 01

Released

123

5 Equipment Configuration Commands

5.3 Shelf Configuration Command


Command Description
This command allows the operator to configure the shelf. The operator can configure the following parameters:
class: the classification of the shelf. The following shelf classes are supported:
- main-ethernet: supports Ethernet-based traffic. Shelves in this class can contain NT and LT units. There
must be at least one shelf of this class in the system.
- ext-ethernet: supports Ethernet-based traffic. Shelves in this class can only contain LT units.

planned-type: the type planned for this shelf. The not-planned parameter indicates that a shelf will not be
inserted at this position.
unlock: locks or unlocks the shelf.
shelf-mode: the shelf mode,applicable to NEP only, and when the shelf mode was changed successfully,the NE
will reboot automatically.
description: text that describes the location of the shelf.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment shelf (index) [ no class | class <Equipm::ShelfClass> ] [ no planned-type | planned-type
<Equipm::ShelfType> ] [ [ no ] unlock ] [ [ no ] lock ] [ [ no ] extended-lt-slots ] [ no mode | mode
<Equipm::HolderMode> ] [ no description | description <Description-127> ]

Command Parameters
Table 5.3-1 "Shelf Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

the physical identification of the


shelf

Table 5.3-2 "Shelf Configuration Command" Command Parameters


Parameter

Type

Description

[no] class

Parameter type: <Equipm::ShelfClass>


Format:
( main-ethernet
| ext-ethernet )
Possible values:
- main-ethernet : main shelf - supports ethernet-based traffic

optional parameter with default


value: "main-ethernet"
the class to which the shelf
belongs

124

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Parameter

Type

Description

[no] unlock

- ext-ethernet : extension shelf - supports ethernet-based


traffic
Parameter type: <Equipm::ShelfType>
Format:
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: boolean

[no] lock

Parameter type: boolean

[no] extended-lt-slots

Parameter type: boolean

[no] mode

Parameter type: <Equipm::HolderMode>


Format:
( no-extended-lt-slots
| extended-lt-slots
| no-ntb-slot
| no-ntio-slots )
Possible values:
- no-extended-lt-slots : no extended lt slots
- extended-lt-slots : change to extended lt slots
- no-ntb-slot : use ntb slot as lt slot
- no-ntio-slots : not changeable
Parameter type: <Description-127>
Format:
- description to help the operator to identify the object
- length: x<=127

[no] planned-type

[no] description

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "not-planned"
the planned type of the shelf

obsolete parameter replaced by


parameter "lock"
the holder is unlocked
optional parameter
the holder is locked
obsolete parameter replaced by
parameter "mode"
change to extended lt slots
optional parameter with default
value: "no-extended-lt-slots"
change the shelf mode,applicable
to NEP and ARAM-E only

optional parameter with default


value: ""
any description to be used by the
operator

Released

125

5 Equipment Configuration Commands

5.4 Slot Configuration Command


Command Description
This command allows the operator to configure a slot.
The slot is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameters can be configured for the slot:
planned-type: the unit type that will be inserted into the slot. The not-planned parameter indicates that a unit
will not be inserted into that slot.
power-down: the operator can power-up or power-down slots. This is only applicable to LSM.
unlock: the operator can lock or unlock a unit. A unit in the locked state cannot be used. This attribute is only
supported for the NT (the system will refuse to lock the NT of a simplex system), EXT, and a managed LSM.
alarm-profile: the operator can assign a customizable alarm profile to a remote LT board. This is only
applicable for REM and SEM boards
capab-profile:This parameter only applies to LSMs,NTIOs and mini-NT NRNT-A.For BCM based LSM boards
default capab-profile is "default" for Intel based LSM boards it is "8vc_default".

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment slot (index) [ no planned-type | planned-type <Equipm::BoardType> ] [ [ no ] power-down ]
[ [ no ] unlock ] [ no alarm-profile | alarm-profile <Equipm::AlarmProf> ] [ capab-profile
<Equipm::CapabilityProfile> ] [ dual-host-ip <Ip::V4Address> ] [ dual-host-loc <Equipm::Dualhost> ]

Command Parameters
Table 5.4-1 "Slot Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot

the physical number of the slot

126

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Resource Identifier

Type

Description

- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Table 5.4-2 "Slot Configuration Command" Command Parameters


Parameter

Type

Description

[no] planned-type

optional parameter with default


value: "not-planned"
type of board intended to be in
this position

[no] power-down

Parameter type: <Equipm::BoardType>


Format:
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: boolean

[no] unlock

Parameter type: boolean

[no] alarm-profile

Parameter type: <Equipm::AlarmProf>


Format:
( none
| name : <PrintableString-0-32> )
Possible values:
- none : no profile name to associate
- name : profile name
Field type <PrintableString-0-32>
- a printable string
- length: x<=32
Parameter type: <Equipm::CapabilityProfile>
Format:
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Equipm::Dualhost>
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId>
| none )
Possible values:
- none : no host lsm location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

capab-profile

dual-host-ip
dual-host-loc

3HH-04416-EBAA-TCZZA 01

optional parameter
power down the board
optional parameter
unlock the board
optional parameter with default
value: "none"
customized
alarm
profile
assigned to this board

optional parameter
capability profile assigned to a
line board

optional parameter
dual host ip
optional parameter
dual host lsm location

Released

127

5 Equipment Configuration Commands

5.5 Applique Configuration Command


Command Description
This command allows the operator to configure an applique.
The applique is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameter can be configured for the slot:
planned-type: the applique type to be inserted into the slot. The not-planned parameter indicates that an
applique will not be inserted into that slot.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment applique (index) [ no planned-type | planned-type <Equipm::AppliqueType> ] [ no
applique-profile | applique-profile <Equipm::CapabilityProfile> ]

Command Parameters
Table 5.5-1 "Applique Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
the physical number of the
( iont : <Eqpt::RackId> / <Eqpt::ShelfId>
applique
|
<Eqpt::RackId>
/
<Eqpt::ShelfId>
/
<Eqpt::AppliqueSlotId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
/
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::AppliqueSlotId>
- the applique slot number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number

128

Released

Description

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Table 5.5-2 "Applique Configuration Command" Command Parameters


Parameter

Type

Description

[no] planned-type

Parameter type: <Equipm::AppliqueType>


Format:
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::CapabilityProfile>
Format:
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

optional parameter with default


value: "not-planned"
type of applique intended to be in
this position

[no] applique-profile

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "not_applicable"
capability profile assigned to the
applique board

Released

129

5 Equipment Configuration Commands

5.6 Protection Group Configuration Command


Command Description
This command allows the operator to configure a protection group.
The protection group is identified by the eqptProtGroupId attribute (index). The value 1 is reserved for extension
chain protection group which is always present and cannot be deleted.
The protection group(s) are created implicitly by the system as part of the default configuration. Use "show
equipment protection-group" to display the valid protection group identifier(s). Note that the default admin-status
for protection-group 1 at system level is locked where it is always unlocked at cli level.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment protection-group (prot-group-id) [ no admin-status | admin-status
<Equipm::PortGroupAdminStatus> ] [ no eps-quenchfactor | eps-quenchfactor <Equipm::TimeTicks> ]

Command Parameters
Table 5.6-1 "Protection Group Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(prot-group-id)

Format:
- index of protection group

Index in eqpt Prot Group Table

Table 5.6-2 "Protection Group Configuration Command" Command Parameters


Parameter

Type

Description

[no] admin-status

Parameter type: <Equipm::PortGroupAdminStatus>


Format:
( unlock
| lock )
Possible values:
- unlock : unlock
- lock : lock
Parameter type: <Equipm::TimeTicks>
Format:
- timer value for quench mechanish
- unit: 1/100 sec

optional parameter with default


value: "unlock"
changes the administrative-status
to lock or unlock

[no] eps-quenchfactor

130

Released

optional parameter with default


value: "1440000"
timervalue
of
quenching
mechanism, 0 is valid value

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.7 Protection Element Configuration Command


Command Description
This command allows the operator to configure a protection element.
The protection group is identified by the eqptProtGroupId attribute. The value 1 to 9 are reserved for the extension
chain protection group which are always present and cannot be deleted. Group 1 corresponding with NT 1+1
group, and Group 2-9 corresponding with possible 8 LT 1+1 groups.
The redcy-ctrl-status parameter is used to force a switchover between elements of a protection group or to keep one
of the elements active. The forced-active parameter indicates that the NTA or NTB slot or LT slot is configured as
active.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment protection-element
<Equipm::ProtElementRedcyCtrlStatus> ]

(index)

no

redcy-ctrl-status

redcy-ctrl-status

Command Parameters
Table 5.7-1 "Protection Element Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Index in eqpt Prot Element Table

Table 5.7-2 "Protection Element Configuration Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

131

5 Equipment Configuration Commands

Parameter

Type

Description

[no] redcy-ctrl-status

Parameter type: <Equipm::ProtElementRedcyCtrlStatus>


Format:
( normal
| forced_active )
Possible values:
- normal : enables redundancy (active or standby)
- forced_active : forces the element to be active

optional parameter with default


value: "normal"
changes the redundancy control
status

132

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.8 External-link-host Configuration Commands


Command Description
This command allows the operator to configure the traffic direction of the configurable external-links on the host
expansion card. The configurable parameters are:
direction: The traffic direction. Two directions are supported:
- network (default): the direction is configured to allow the trafic from the network
- remote-lt : the direction is configured to allow the trafic to the remote line termination card

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
>
configure
equipment
external-link-host
<Equipm::ExternalLinkConfigType> ]

(faceplate-number)

no

direction

direction

Command Parameters
Table 5.8-1 "External-link-host Configuration Commands" Resource Parameters
Resource Identifier

Type

(faceplate-number)

Format:
the faceplate number of the
( <Eqpt::ExtLinkConfigurableDeviceIndex>
configurable external-link
| nt : sfp : <Eqpt::ExtLinkHostPortIndex>
| ntio-1 : sfp : <Eqpt::ExtLinkHostPortIndex>
| ntio-2 : sfp : <Eqpt::ExtLinkHostPortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::ExtLinkHostPortIndex>
- host port number
Field type <Eqpt::ExtLinkConfigurableDeviceIndex>
- the faceplate number of the configurable external link

Description

Table 5.8-2 "External-link-host Configuration Commands" Command Parameters


Parameter

Type

Description

[no] direction

Parameter type: <Equipm::ExternalLinkConfigType>


Format:
( network

optional parameter with default


value: "network"
the external-link traffic direction

3HH-04416-EBAA-TCZZA 01

Released

133

5 Equipment Configuration Commands

Parameter

Type

Description

| remote-lt )
Possible values:
- network : the connection direction is from the network
- remote-lt : the connection direction is to the remote line
termination card

134

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.9 Host Shelf SFP Configuration Commands


Command Description
This command allows the operator to configure the association between a host shelf SFP/XFP and a remote LT.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
>
configure
equipment
external-link-assign
<Equipm::ExpansionSlotIndex> ]

(faceplate-number)

no

remote

remote

Command Parameters
Table 5.9-1 "Host Shelf SFP Configuration Commands" Resource Parameters
Resource Identifier

Type

(faceplate-number)

Format:
host shelf SFP/XFP number on
( <Eqpt::SfpFaceplateNumber>
the faceplate
| nt : sfp : <Eqpt::ExtLinkHostToRemotePortIndex>
| ntio-1 : sfp : <Eqpt::ExtLinkHostToRemotePortIndex>
| ntio-2 : sfp : <Eqpt::ExtLinkHostToRemotePortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
Field type <Eqpt::ExtLinkHostToRemotePortIndex>
- a host port connected to remote LT
Field type <Eqpt::SfpFaceplateNumber>
- host SFP faceplate number

Description

Table 5.9-2 "Host Shelf SFP Configuration Commands" Command Parameters


Parameter

Type

[no] remote

Parameter type: <Equipm::ExpansionSlotIndex>


optional parameter with default
Format:
value: "0/0/0"
<Eqpt::ExpRack> / <Eqpt::ExpShelf> / <Eqpt::ExpSlot>
the expansion shelf LSM
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote

3HH-04416-EBAA-TCZZA 01

Description

Released

135

5 Equipment Configuration Commands

Parameter

Type

Description

Field type <Eqpt::ExpSlot>


- the physical number of the slot within expansion shelf, 0
stands for no remote

136

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.10 2xE1/DS1 CLOCK configuration Command


Command Description
This command allows the operator to configure clock source on the 2xE1/DS1 sfp:

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 ( no clock (position) ) | ( clock (position) [ no clocksource | clocksource
<Eqpt::ClockSource> ] )

Command Parameters
Table 5.10-1 "2xE1/DS1 CLOCK configuration Command" Resource Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf>
<Eqpt::E1dsx1SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::E1dsx1SfpCageNumber>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot

3HH-04416-EBAA-TCZZA 01

Description
the physical sfp cage position
/
/
:
/

Released

137

5 Equipment Configuration Commands

Resource Identifier

Type

Description

- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf


- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::E1dsx1SfpCageNumber>
- the SFP cage number range NELT-B [1,3..35],
NCNC-B/C/D [2..7]

Table 5.10-2 "2xE1/DS1 CLOCK configuration Command" Command Parameters


Parameter

Type

Description

[no] clocksource

Parameter type: <Eqpt::ClockSource>


Format:
( tributary1
| tributary2
| serdes )
Possible values:
- tributary1 : clock source is from tributary 1
- tributary2 : clock source is from tributary 2
- serdes : clock source is from serdes

optional parameter with default


value: "serdes"
Clock source can be tributary1 or
tributary2 or serdes

138

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.11 2xE1/DS1 Pseudo Wire TDM Interface


configuration Command
Command Description
This command allows the operator to configure PWTDM interface parameters on the 2xE1/DS1 sfp:

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 tdmintf (position) [ no window-number | window-number <Eqpt::WindowNumber>
] [ no window-length | window-length <Eqpt::Windowlength> ]

Command Parameters
Table 5.11-1 "2xE1/DS1 Pseudo Wire TDM Interface configuration Command" Resource
Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf>
<Eqpt::E1dsx1SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::E1dsx1SfpCageNumber>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> )
Possible values:
- acu : acu slot

3HH-04416-EBAA-TCZZA 01

Description
the physical sfp cage position
/
/
:
/

Released

139

5 Equipment Configuration Commands

Resource Identifier

Type

Description

- iont : an nt applique slot


- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::E1dsx1SfpCageNumber>
- the SFP cage number range NELT-B [1,3..35],
NCNC-B/C/D [2..7]

Table 5.11-2 "2xE1/DS1 Pseudo Wire TDM Interface configuration Command" Command
Parameters
Parameter

Type

Description

[no] window-number

Parameter type: <Eqpt::WindowNumber>


Format:
- window-number range
- range: [0...255]

[no] window-length

Parameter type: <Eqpt::Windowlength>


Format:
- window-length range
- range: [0...255]

optional parameter with default


value: "20"
window
number
can
be
configured from 0 to 255,
selecting value 0 sets default
value
optional parameter with default
value: "10"
window
number
can
be
configured from 0 to 255,
selecting value 0 sets default
value, units multiple of 10
milliseconds

140

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.12 2xE1/DS1 Pseudo Wire TDM SFP configuration


Command
Command Description
This command allows the operator to configure pseudowire TDM parameters on the 2xE1/DS1 sfp:

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 ( no pwtdm (position) ) | ( pwtdm (position) channel <Eqpt::Channel> packet-length
<Eqpt::Packetlength> jitter-buff-size <Eqpt::JitBufSize> vlanid <Eqpt::VlanId> priority <Eqpt::Priority>
conseq-number
<Eqpt::ConseqNo>
ecid-rx
<Eqpt::ECID>
ecid-tx
<Eqpt::ECID>
source-mac
<Eqpt::PhysicalAddress> dest-mac <Eqpt::PhysicalAddress> )

Command Parameters
Table 5.12-1 "2xE1/DS1 Pseudo Wire TDM SFP configuration Command" Resource Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>

3HH-04416-EBAA-TCZZA 01

Description
the physical sfp cage position
/
/
:
/
:
:
/
:
:
:
:

Released

141

5 Equipment Configuration Commands

Resource Identifier

Type

Description

<Eqpt::TributaryIndex>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::E1dsx1SfpCageNumber>
- the SFP cage number range NELT-B [1,3..35],
NCNC-B/C/D [2..7]
Field type <Eqpt::TributaryIndex>
- tributary index
- range: [1...3]

Table 5.12-2 "2xE1/DS1 Pseudo Wire TDM SFP configuration Command" Command Parameters
Parameter

Type

Description

channel

Parameter type: <Eqpt::Channel>


Format:
( close
| open )
Possible values:
- close : close channel
- open : open channel
Parameter type: <Eqpt::Packetlength>
Format:
- packet length range
- range: [0...16382]
Parameter type: <Eqpt::JitBufSize>

mandatory parameter
open or close the channel

packet-length

jitter-buff-size

142

Released

mandatory parameter
packet length can be configured
from 0 to 16382, packet length
for MEF8 is 256 bytes
mandatory parameter

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Parameter

vlanid

priority

conseq-number

ecid-rx

ecid-tx

source-mac

dest-mac

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
jitter buffer size can be
- jitter buffer size
configured from 0 to 1023,units
- range: [0...1023]
in number of MEF8 packets
Parameter type: <Eqpt::VlanId>
mandatory parameter
Format:
vlan id can be configured from 0
- vlan index
to 4095
- range: [0...4095]
Parameter type: <Eqpt::Priority>
mandatory parameter
Format:
802.1p priority range 0 to 7
- priority range 0 to 7
- range: [0...7]
Parameter type: <Eqpt::ConseqNo>
mandatory parameter
Format:
consequence number range 0 to 7
- consequence range 0 to 7,0: no control, 1-6:number of
packets out of sequence
- range: [0...7]
Parameter type: <Eqpt::ECID>
mandatory parameter
Format:
receive emulated circuit identifier
- Emulated circuit identifierrange 0 to 1048575
range 0 to 1048575
- range: [0...1048575]
Parameter type: <Eqpt::ECID>
mandatory parameter
Format:
transmit
emulated
circuit
- Emulated circuit identifierrange 0 to 1048575
identifier range 0 to 1048575
- range: [0...1048575]
Parameter type: <Eqpt::PhysicalAddress>
mandatory parameter
Format:
source mac address
- media dependent physical address
- length: 6
Parameter type: <Eqpt::PhysicalAddress>
mandatory parameter
Format:
destination mac address
- media dependent physical address
- length: 6

Released

143

5 Equipment Configuration Commands

5.13 2xE1/DS1 Framer configuration Command


Command Description
This command allows the operator to configure Framer parameters on the 2xE1/DS1 sfp:

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 framer (position) [ no frame-mode | frame-mode <Eqpt::Framermode> ] [ no
iwf-on-liu | iwf-on-liu <Eqpt::IwfOnLiu> ] [ no liu-on-liu | liu-on-liu <Eqpt::LiuOnliu> ] [ no pm-to-iwf |
pm-to-iwf <Eqpt::PmToiwf> ] [ no ais-to-iwf | ais-to-iwf <Eqpt::AisToiwf> ] [ no rai-to-iwf | rai-to-iwf
<Eqpt::RaiToiwf> ] [ no rei-to-iwf | rei-to-iwf <Eqpt::ReiToiwf> ] [ no pm-to-liu | pm-to-liu <Eqpt::PmToliu> ] [
no ais-to-liu | ais-to-liu <Eqpt::AisToliu> ] [ no rai-to-liu | rai-to-liu <Eqpt::RaiToliu> ] [ no rei-to-liu | rei-to-liu
<Eqpt::ReiToliu> ]

Command Parameters
Table 5.13-1 "2xE1/DS1 Framer configuration Command" Resource Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>

144

Released

Description
the physical sfp cage position
/
/
:
/
:
:
/
:
:
:
:

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Resource Identifier

Type

Description

| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber> :


<Eqpt::TributaryIndex>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::E1dsx1SfpCageNumber>
- the SFP cage number range NELT-B [1,3..35],
NCNC-B/C/D [2..7]
Field type <Eqpt::TributaryIndex>
- tributary index
- range: [1...3]

Table 5.13-2 "2xE1/DS1 Framer configuration Command" Command Parameters


Parameter

Type

Description

[no] frame-mode

Parameter type: <Eqpt::Framermode>


Format:
( framed
| unframed )
Possible values:
- framed : selects framed tdm packet
- unframed : selects unframed tdm packet
Parameter type: <Eqpt::IwfOnLiu>
Format:
( enable
| disable )
Possible values:
- enable : enable loop towards iwf on liu

optional parameter with default


value: "unframed"
select line framing mode

[no] iwf-on-liu

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "disable"
enable loop towards iwf on liu

Released

145

5 Equipment Configuration Commands

Parameter

Type

[no] liu-on-liu

[no] pm-to-iwf

[no] ais-to-iwf

[no] rai-to-iwf

[no] rei-to-iwf

[no] pm-to-liu

[no] ais-to-liu

[no] rai-to-liu

146

Description

- disable : disable loop towards iwf on liu


Parameter type: <Eqpt::LiuOnliu>
Format:
( enable
| disable )
Possible values:
- enable : enable loop towards liu on liu
- disable : disable loop towards liu on liu
Parameter type: <Eqpt::PmToiwf>
Format:
( enable
| disable )
Possible values:
- enable : enable performance monitoring towards iwf
- disable : disable performance monitoring towards iwf
Parameter type: <Eqpt::AisToiwf>
Format:
( enable
| disable )
Possible values:
- enable : enable ais towards iwf
- disable : disable ais towards iwf
Parameter type: <Eqpt::RaiToiwf>
Format:
( enable
| disable )
Possible values:
- enable : enable rai towards iwf
- disable : disable rai towards iwf
Parameter type: <Eqpt::ReiToiwf>
Format:
( enable
| disable )
Possible values:
- enable : enable rei towards iwf
- disable : disable rei towards iwf
Parameter type: <Eqpt::PmToliu>
Format:
( enable
| disable )
Possible values:
- enable : enable performance monitoring towards liu
- disable : disable performance monitoring towards liu
Parameter type: <Eqpt::AisToliu>
Format:
( enable
| disable )
Possible values:
- enable : enable ais towards liu
- disable : disable ais towards liu
Parameter type: <Eqpt::RaiToliu>
Format:
( enable
| disable )
Possible values:
- enable : enable rai towards liu
- disable : disable rai towards liu

Released

optional parameter with default


value: "disable"
enable loop towards liu on liu

optional parameter with default


value: "disable"
enable performance monitoring
towards iwf

optional parameter with default


value: "disable"
enable ais alarm towards iwf

optional parameter with default


value: "disable"
enable rai alarm towards iwf

optional parameter with default


value: "disable"
enable rei alarm towards iwf

optional parameter with default


value: "disable"
enable performance monitoring
towards liu

optional parameter with default


value: "disable"
enable ais alarm towards liu

optional parameter with default


value: "disable"
enable rai alarm towards liu

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Parameter

Type

Description

[no] rei-to-liu

Parameter type: <Eqpt::ReiToliu>


Format:
( enable
| disable )
Possible values:
- enable : enable rei towards liu
- disable : disable rei towards liu

optional parameter with default


value: "disable"
enable rei alarm towards liu

3HH-04416-EBAA-TCZZA 01

Released

147

5 Equipment Configuration Commands

5.14 2xE1/DS1 Line Interface Unit SFP


configuration Command
Command Description
This command allows the operator to configure distance and cable impedance on the 2xE1/DS1 sfp:

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment sfpe1t1 liu (position) [ no distance | distance <Eqpt::distance> ] [ no cable-impedance |
cable-impedance <Eqpt::CableImpedance> ]

Command Parameters
Table 5.14-1 "2xE1/DS1 Line Interface Unit SFP configuration Command" Resource Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| nt : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| nt : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::E1dsx1SfpCageNumber> : <Eqpt::TributaryIndex>
| ntio-1 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-1 : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : sfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| ntio-2 : xfp : <Eqpt::E1dsx1SfpCageNumber>
<Eqpt::TributaryIndex>
| nt-a : sfp : <Eqpt::E1dsx1SfpCageNumber>

148

Released

Description
the physical sfp cage position
/
/
:
/
:
:
/
:
:
:
:
:

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

Resource Identifier

Type

Description

<Eqpt::TributaryIndex>
| nt-a : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : sfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex>
| nt-b : xfp : <Eqpt::E1dsx1SfpCageNumber> :
<Eqpt::TributaryIndex> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::E1dsx1SfpCageNumber>
- the SFP cage number range NELT-B [1,3..35],
NCNC-B/C/D [2..7]
Field type <Eqpt::TributaryIndex>
- tributary index
- range: [1...3]

Table 5.14-2 "2xE1/DS1 Line Interface Unit SFP configuration Command" Command Parameters
Parameter

Type

Description

[no] distance

Parameter type: <Eqpt::distance>


Format:
( shorthaul
| longhaul )
Possible values:
- shorthaul : distance shorthaul
- longhaul : distance longhaul
Parameter type: <Eqpt::CableImpedance>
Format:
( 75ohms
| 120ohms )
Possible values:
- 75ohms : cable impedance 75 ohms
- 120ohms : cable impedance 120 ohms

optional parameter with default


value: "shorthaul"
distance can be configured as
shorthaul or longhaul

[no] cable-impedance

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "120ohms"
cable
impedance
can
be
configured 75ohms or 120ohms

Released

149

5 Equipment Configuration Commands

150

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.15 NE Configuration Command


Command Description
This command allows the operator to configure the NE. The operator can configure the following parameter:
description: text that describes the location of the ISAM.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment isam [ no description | description <Description-127> ]

Command Parameters
Table 5.15-2 "NE Configuration Command" Command Parameters
Parameter

Type

Description

[no] description

Parameter type: <Description-127>


Format:
- description to help the operator to identify the object
- length: x<=127

optional parameter with default


value: ""
any description to be used by the
operator

3HH-04416-EBAA-TCZZA 01

Released

151

5 Equipment Configuration Commands

5.16 Environment Monitoring Configuration


Command
Command Description
This command allows the operator to configure environment monitoring status to enable/disable the data relay
from an external monitor box connected on the NTIO board of ISAM to the monitor server. The operator can
configure the following parameters:
enable-supervise: enable relay of environment monitoring from an external monitor box.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment envbox [ [ no ] enable-supervise ]

Command Parameters
Table 5.16-2 "Environment Monitoring Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable-supervise

Parameter type: boolean

optional parameter
enable environment monitoring
relay

152

Released

3HH-04416-EBAA-TCZZA

01

5 Equipment Configuration Commands

5.17 Configure Fan Tray parameters


Command Description
This command allows the operator to configure the fan tray parameter fanmode.
The fanmode determines the applied speed of the fan trays. This is effective only if intelligent fan packs are
installed. Traditional fan packs (A-fans) do not support speed change, the 'classic' mode applies.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment fan-tray [ fanmode <Eqpt::FanMode> ]

Command Parameters
Table 5.17-2 "Configure Fan Tray parameters" Command Parameters
Parameter

Type

fanmode

Parameter type: <Eqpt::FanMode>


optional parameter
Format:
Fan Tray mode
( auto
| eco
| protect
| classic )
Possible values:
- auto : runs in average mode; fan speeds determined by
predefined thermal margins
- eco : runs in 'green' mode; minimal thermal margins
- protect : runs in protected mode; wider thermal settings wrt
auto
- classic : fixed fan speed; no SW control

3HH-04416-EBAA-TCZZA 01

Description

Released

153

6- Port Protection Configuration Commands

6.1 Port Protection Configuration Command Tree


6.2 Port Protection Configuration Command

154

Released

6-155
6-156

3HH-04416-EBAA-TCZZA

01

6 Port Protection Configuration Commands

6.1 Port Protection Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Port Protection Configuration Commands".

Command Tree
----configure
----[no] port-protection
- (port)
- paired-port

3HH-04416-EBAA-TCZZA 01

Released

155

6 Port Protection Configuration Commands

6.2 Port Protection Configuration Command


Command Description
This command allows the operator to configure a protection group on two ports which will then operate in
redundancy. The system will decide which port of the two becomes active. In case of failure of one port the other
port will take over. A forced switchover can also be triggered manually by the operator.
The port protection group is identified by the first port in the group that is intended to be protected. The following
parameters can be configured for the protection group :
paired-port: the paired port that will ensure the protection of the first one.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure port-protection (port) paired-port <RedPort::PairedPortIndex>

Command Parameters
Table 6.2-1 "Port Protection Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
the port identifier of the first port
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / in the protection group
<Eqpt::PonId>
Possible values:
- pon : pon-aid
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier

Description

Table 6.2-2 "Port Protection Configuration Command" Command Parameters


Parameter

Type

paired-port

Parameter type: <RedPort::PairedPortIndex>


mandatory parameter
Format:
the port identifier of the paired
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port in the protection group
<Eqpt::PonId>
Possible values:
- pon : pon-aid

156

Released

Description

3HH-04416-EBAA-TCZZA

01

6 Port Protection Configuration Commands

Parameter

Type

Description

Field type <Eqpt::RackId>


- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier

3HH-04416-EBAA-TCZZA 01

Released

157

7- xDSL Configuration Commands

7.1 xDSL Configuration Command Tree


7.2 xDSL Common Service Profile Configuration
Command
7.3 xDSL Common Spectrum Profile Configuration
Command
7.4 xDSL Artificial Noise Downstream Configuration
Command
7.5 xDSL Spectrum Profile for ADSL/ADSL2 Configuration
Command
7.6 xDSL Spectrum Profile for RE-ADSL2 Configuration
Command
7.7 xDSL Spectrum Profile for ADSL2 Plus Configuration
Command
7.8 ADSL2-plus Custom PSD shape Configuration
Command
7.9 xDSL Spectrum Profile for VDSL Configuration
Command
7.10 VDSL Ghs Tones Transmission Power Control
Configuration Command
7.11 VDSL Custom PSD shape Downstream Configuration
Command
7.12 VDSL Custom RX PSD shape Upstream Configuration
Command
7.13 VDSL Power Back Off Configuration Command
7.14 xDSL Spectrum Profile for VDSL2 Configuration
Command
7.15 VDSL2 Custom PSD shape Downstream
Configuration Command
7.16 VDSL2 Custom PSD shape Upstream Configuration
Command
7.17 VDSL2 Custom RX PSD shape Upstream
Configuration Command
7.18 VDSL2 Virtual Noise Downstream Configuration
Command
7.19 VDSL2 Virtual Noise Upstream Configuration
Command
7.20 VDSL2 Power Back Off Configuration Command
7.21 xDSL DPBO Profile Configuration Command
7.22 xDSL DPBO Mode Independent Custom PSD Mask
Configuration Command
7.23 xDSL DPBO Exchange PSD Mask Configuration
Command
7.24 xDSL RTX Profile Configuration Command
7.25 xDSL Vectoring Profile Configuration Command
7.26 xDSL Vectoring Control Entity Profile Configuration
Command
7.27 xDSL Board Configuration Command
7.28 xDSL Board Vectoring Fallback Configuration
Command
7.29 xDSL Vectoring Processing Board Configuration

158

Released

7-160
7-168
7-172
7-178
7-180
7-183
7-185
7-189
7-191
7-198
7-200
7-202
7-204
7-205
7-211
7-213
7-215
7-217
7-219
7-221
7-223
7-225
7-227
7-229
7-233
7-236
7-239
7-242
7-245

3HH-04416-EBAA-TCZZA

01

Command
7.30 xDSL Line Configuration Command
7.31 xDSL Line TCA Threshold Configuration Command
7.32 xDSL Per Line Overrule Configuration Command
7.33 xDSL Overrule Noise Psd Shape Downstream
Configuration Command
7.34 xDSL Overrule Noise Psd Shape Upstream
Configuration Command
7.35 xDSL INS Near End Configuration Command
7.36 xDSL INS Far End Configuration Command

3HH-04416-EBAA-TCZZA 01

7-247
7-252
7-255
7-262
7-264
7-266
7-268

Released

159

7 xDSL Configuration Commands

7.1 xDSL Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "xDSL Configuration Commands".

Command Tree
----configure
----xdsl
----[no] service-profile
- (index)
- name
X (scope)
- version
- [no] ra-mode-down
- [no] ra-mode-up
- [no] min-bitrate-down
- [no] min-bitrate-up
- [no] plan-bitrate-down
- [no] plan-bitrate-up
- [no] max-bitrate-down
- [no] max-bitrate-up
- [no] max-delay-down
- [no] max-delay-up
- [no] max-delay-var-dn
- [no] max-delay-var-up
- [no] memory-down
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] inp-wo-erasure-dn
- [no] inp-wo-erasure-up
- [no] min-l2-br-down
- [no] active
----[no] spectrum-profile
- (index)
- name
X (scope)
- version
- [no] dis-ansi-t1413
- [no] dis-etsi-dts
- [no] dis-g992-1-a
- [no] dis-g992-1-b
- [no] dis-g992-2-a
- [no] dis-g992-3-a
- [no] dis-g992-3-b
- [no] g992-3-aj
- [no] g992-3-l1
- [no] g992-3-l2
- [no] g992-3-am
- [no] g992-5-a
- [no] g992-5-b
- [no] ansi-t1.424

160

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

- [no] dis-etsi-ts
- [no] itu-g993-1
- [no] ieee-802.3ah
- [no] g992-5-aj
- [no] g992-5-am
- [no] g993-2-8a
- [no] g993-2-8b
- [no] g993-2-8c
- [no] g993-2-8d
- [no] g993-2-12a
- [no] g993-2-12b
- [no] g993-2-17a
- [no] g993-2-30a
- [no] min-noise-down
- [no] min-noise-up
- [no] trgt-noise-down
- [no] trgt-noise-up
- [no] max-noise-down
- [no] max-noise-up
- [no] carrier-mask-down
- [no] carrier-mask-up
- [no] rf-band-list
- [no] power_mgnt_mode
- [no] l0-time
- [no] l2-time
- [no] l2-agpow-red-tx
- [no] modification
- [no] active
- [no] rau-noise-down
- [no] rau-noise-up
- [no] rau-time-down
- [no] rau-time-up
- [no] rad-noise-down
- [no] rad-noise-up
- [no] rad-time-down
- [no] rad-time-up
- [no] l2-agpw-to-red-tx
----artificial-noise-down
- (psd-point)
- [no] frequency
- [no] psd
----adsl-adsl2
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up
- [no] pbo-mode-up
- [no] max-recv-power-up
- [no] psd-mask-up
----re-adsl
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up

3HH-04416-EBAA-TCZZA 01

Released

161

7 xDSL Configuration Commands

- [no] pbo-mode-up
- [no] max-recv-power-up
----adsl2-plus
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up
- [no] psd-shape-down
- [no] pbo-mode-up
- [no] max-recv-power-up
- [no] psd-mask-up
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----vdsl
X [no] proprietary-feat
- [no] propr-feat-value
- [no] vdsl-band-plan
- [no] optional-band
- [no] optional-endfreq
- [no] adsl-band
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] psd-shape-down
- [no] psd-shape-up
X [no] pbo-mode-down
- [no] pbo-mode
- [no] rx-psd-shape-up
- [no] ghstones-pwr-mode
- [no] max-band
- [no] max-freq
- [no] m-psd-level-down
- [no] m-psd-level-up
- [no] psd-pbo-par-a-up
- [no] psd-pbo-par-b-up
- [no] cust-psd-sc-down
- [no] cust-psd-ty-down
- [no] cust-rx-psd-sc-up
- [no] cust-rx-psd-ty-up
- [no] opt-startfreq
----ghstone-set-pwr-ctrl
- [no] a43
- [no] b43
- [no] a43c
- [no] v43
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----cust-rx-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----pbo
- (band)
- [no] param-a

162

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

- [no] param-b
----vdsl2
X [no] proprietary-feat
- [no] propr-feat-value
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] psd-shape-down
- [no] cs-psd-shape-dn
- [no] cs-psd-shape-up
- [no] psd-shape-up
- [no] rx-psd-shape-up
- [no] psd-pbo-e-len-up
- [no] m-psd-level-down
- [no] m-psd-level-up
- [no] psd-pbo-par-a-up
- [no] psd-pbo-par-b-up
- [no] v-noise-snr-down
- [no] v-noise-snr-up
- [no] v-noise-psd-down
- [no] v-noise-psd-up
- [no] cust-psd-sc-down
- [no] cust-psd-ty-down
- [no] cust-psd-sc-up
- [no] cust-psd-ty-up
- [no] cust-rx-psd-sc-up
- [no] cust-rx-psd-ty-up
- [no] upbo-aele-mode
- [no] upboaele-min-thrs
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----cust-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----cust-rx-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----v-noise-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----v-noise-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----pbo
- (band)
- [no] equal-fext
- [no] param-a
- [no] param-b
----[no] dpbo-profile
- (index)
- name
- [no] es-elect-length
- [no] es-cable-model-a
- [no] es-cable-model-b

3HH-04416-EBAA-TCZZA 01

Released

163

7 xDSL Configuration Commands

- [no] es-cable-model-c
- [no] min-usable-signal
- [no] min-frequency
- [no] max-frequency
- [no] rs-elect-length
- [no] muf-control
- [no] offset
- [no] active
- [no] modification
----micpsd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----epsd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----[no] rtx-profile
- (index)
- name
- version
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] min-exp-thrpt-dn
- [no] min-exp-thrpt-up
- [no] plan-exp-thrpt-dn
- [no] plan-exp-thrpt-up
- [no] max-exp-thrpt-dn
- [no] max-exp-thrpt-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] max-delay-dn
- [no] max-delay-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] int-arr-time-dn
- [no] int-arr-time-up
- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] active
- [no] modification
----[no] vect-profile
- (index)
- name
- version
- [no] fext-cancel-up
- [no] fext-cancel-dn
- [no] leg-can-dn-m1
- [no] leg-can-dn-m2
- [no] dis-gvect-cpe
- [no] gvecfriend-cpe
- [no] gvecfriend-dn-cpe

164

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

- [no] legacy-cpe
- [no] band-control-up
- [no] band-control-dn
- [no] vect-leav-thresh
- [no] vect-feat-bitmap
- [no] active
- [no] modification
----[no] vce-profile
- (index)
- name
- version
- [no] vce-gain-mode
- [no] vce-join-timeout
- [no] vce-min-par-join
- [no] vce-hist-pcoder
- [no] vce-band-plan
- [no] active
- [no] modification
----board
- (board-index)
- [no] dpbo-profile
- [no] vce-profile
- [no] vplt-autodiscover
- [no] vce-capacity-mode
----vect-fallback
- [no] fb-vplt-com-fail
- [no] fb-cpe-cap-mism
- [no] fb-conf-not-feas
- [no] spectrum-profile
- [no] service-profile
- [no] dpbo-profile
- [no] rtx-profile
----vp-board
- (board-index)
- vp-link
- [no] lt-expect
----line
- (if-index)
- [no] service-profile
- [no] spectrum-profile
- [no] dpbo-profile
- [no] rtx-profile
- [no] vect-profile
- [no] ansi-t1413
- [no] etsi-dts
- [no] g992-1-a
- [no] g992-1-b
- [no] g992-2-a
- [no] g992-3-a
- [no] g992-3-b
- [no] g992-3-aj
- [no] g992-3-l1
- [no] g992-3-l2
- [no] g992-3-am
- [no] g992-5-a
- [no] g992-5-b
- [no] ansi-t1.424
- [no] etsi-ts

3HH-04416-EBAA-TCZZA 01

Released

165

7 xDSL Configuration Commands

- [no] itu-g993-1
- [no] ieee-802.3ah
- [no] g992-5-aj
- [no] g992-5-am
- [no] g993-2-8a
- [no] g993-2-8b
- [no] g993-2-8c
- [no] g993-2-8d
- [no] g993-2-12a
- [no] g993-2-12b
- [no] g993-2-17a
- [no] g993-2-30a
- [no] carrier-data-mode
- [no] admin-up
X bonding-mode
- [no] transfer-mode
- [no] imp-noise-sensor
- [no] vect-qln-mode
- [no] auto-switch
----tca-line-threshold
- [no] enable
- [no] es-nearend
- [no] ses-nearend
- [no] uas-nearend
- [no] leftr-nearend
- [no] leftr-day-nearend
- [no] es-day-nearend
- [no] ses-day-nearend
- [no] uas-day-nearend
- [no] es-farend
- [no] ses-farend
- [no] uas-farend
- [no] es-day-farend
- [no] ses-day-farend
- [no] uas-day-farend
- [no] leftr-farend
- [no] leftr-day-farend
----[no] overrule-data
- (if-index)
- [no] max-bitrate-down
- [no] max-bitrate-up
- [no] max-delay-down
- [no] max-delay-up
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] trgt-noise-down
- [no] trgt-noise-up
- [no] max-psd-down
- [no] max-psd-up
- [no] carrier-mask-down
- [no] carrier-mask-up
- [no] noise-psd-mode-dn
- [no] noise-psd-mode-up
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] max-exp-thrpt-dn

166

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

- [no] max-exp-thrpt-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] rtx-max-delay-dn
- [no] rtx-max-delay-up
- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] memory-down
- [no] modification
- [no] active
----noise-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----noise-psd-pt-up
- (psd-point)
- [no] frequency
- [no] psd
----imp-noise-sensor
----near-end
- (if-index)
- [no] inm-mode
- [no] inm-eq-inp-mode
- [no] ins-sensitivity
- [no] inm-cluster-cont
- [no] inm-iat-offset
- [no] inm-iat-step
----far-end
- (if-index)
- [no] inm-mode
- [no] inm-eq-inp-mode
- [no] ins-sensitivity
- [no] inm-cluster-cont
- [no] inm-iat-offset
- [no] inm-iat-step

3HH-04416-EBAA-TCZZA 01

Released

167

7 xDSL Configuration Commands

7.2 xDSL Common Service Profile Configuration


Command
Command Description
This command allows the operator to manage the DSL service profile. The service profile groups all parameters on
DSL service level (data rates, Rate Adaption mode, delay, ...). The service parameters are common for all DSL
flavors.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profile must be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.
DESCRIPTION FOR THE COMMAND PARAMETER max-delay-down and max-delay-up:The delay is expressed
in milliseconds.Range: 1 to 63 ms in steps of 1 ms with 1 as special value.The value 1 is used to specify that fast or
pseudo fast latency (i.e. no interleaving).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no service-profile (index) ) | ( service-profile (index) name <AsamProfileName> [ (scope) ] [
version <SignedInteger> ] [ no ra-mode-down | ra-mode-down <Xdsl::RAModeDownType> ] [ no ra-mode-up |
ra-mode-up <Xdsl::RAModeUpType> ] [ no min-bitrate-down | min-bitrate-down <Xdsl::BitRate> ] [ no
min-bitrate-up | min-bitrate-up <Xdsl::BitRate> ] [ no plan-bitrate-down | plan-bitrate-down <Xdsl::BitRate> ] [ no
plan-bitrate-up | plan-bitrate-up <Xdsl::BitRate> ] [ no max-bitrate-down | max-bitrate-down <Xdsl::BitRate> ] [
no max-bitrate-up | max-bitrate-up <Xdsl::BitRate> ] [ no max-delay-down | max-delay-down
<Xdsl::InterleavingDelay> ] [ no max-delay-up | max-delay-up <Xdsl::InterleavingDelay> ] [ no max-delay-var-dn
| max-delay-var-dn <Xdsl::VariationDelay> ] [ no max-delay-var-up | max-delay-var-up <Xdsl::VariationDelay> ]
[ no memory-down | memory-down <Xdsl::DownstreamMemory> ] [ no imp-noise-prot-dn | imp-noise-prot-dn
<Xdsl::ImpNoiseProtection> ] [ no imp-noise-prot-up | imp-noise-prot-up <Xdsl::ImpNoiseProtection> ] [ [ no ]
inp-wo-erasure-dn ] [ [ no ] inp-wo-erasure-up ] [ no min-l2-br-down | min-l2-br-down <Xdsl::BitRate> ] [ [ no ]
active ] )

Command Parameters
Table 7.2-1 "xDSL Common Service Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...1024]

index of the profile

Table 7.2-2 "xDSL Common Service Profile Configuration Command" Command Parameters

168

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
local-profile
Possible values:
- local-profile : the local profile
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: <Xdsl::RAModeDownType>
Format:
( operator-ctrld
| automatic
| dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode
downstream
- automatic : automatic rate adaptive mode at startup
downstream
- dynamic : dynamic rate adaptive mode at startup and
showtime in downstream
Parameter type: <Xdsl::RAModeUpType>
Format:
( operator-ctrld
| automatic
| dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode
upstream
- automatic : automatic rate adaptive mode at startup
upstream
- dynamic : dynamic rate adaptive mode at startup and
showtime in upstream
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>

mandatory parameter
profile name

(scope)

version
[no] ra-mode-down

[no] ra-mode-up

[no] min-bitrate-down

[no] min-bitrate-up

[no] plan-bitrate-down

[no] plan-bitrate-up

[no] max-bitrate-down

3HH-04416-EBAA-TCZZA 01

obsolete parameter that will be


ignored
scope of the profile
optional parameter
version maintained by manager,
usually 1 for new profile
optional parameter with default
value: "automatic"
rate adaptation mode for down
stream
in
in
at
optional parameter with default
value: "automatic"
rate adaptation mode for up
stream
in
in
at
optional parameter with default
value: 1024
minimum downstream bit rate to
be maintained
optional parameter with default
value: 64
minimum upstream bit rate to be
maintained
optional parameter with default
value: 1536
planned bitrate in downstream
optional parameter with default
value: 128
planned bitrate in upstream
optional parameter with default

Released

169

7 xDSL Configuration Commands

Parameter

[no] max-bitrate-up

[no] max-delay-down

[no] max-delay-up

[no] max-delay-var-dn

[no] max-delay-var-up

[no] memory-down

[no] imp-noise-prot-dn

Type

Description

Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::InterleavingDelay>
Format:
- a delay time period
- unit: msec
- range: [1...63]
Parameter type: <Xdsl::InterleavingDelay>
Format:
- a delay time period
- unit: msec
- range: [1...63]
Parameter type: <Xdsl::VariationDelay>
Format:
- a delay time period
- unit: 1/10msec
- range: [1...255]
Parameter type: <Xdsl::VariationDelay>
Format:
- a delay time period
- unit: 1/10msec
- range: [1...255]
Parameter type: <Xdsl::DownstreamMemory>
Format:
- configurable downstream memory
- unit: 1/100
- range: [0...100,255]

value: 6144
maximum bitrate in downstream

[no] inp-wo-erasure-dn

Parameter type: <Xdsl::ImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: 1/10 symbols
- range: [0...160]
Parameter type: <Xdsl::ImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: 1/10 symbols
- range: [0...160]
Parameter type: boolean

[no] inp-wo-erasure-up

Parameter type: boolean

[no] min-l2-br-down

Parameter type: <Xdsl::BitRate>


Format:
- a bit rate value

[no] imp-noise-prot-up

170

Released

optional parameter with default


value: 640
maximum bitrate in upstream
optional parameter with default
value: 16
maximum delay for interleaving
function in downstream
optional parameter with default
value: 16
maximum delay for interleaving
function in upstream
optional parameter with default
value: 255
maximum delay variation in
downstream
optional parameter with default
value: 255
maximum delay variation in
upstream
optional parameter with default
value: 255
configurable
memory
for
downstream.Value 0-100 express
the % of memory to be allocated
to the downstream direction and
special value 255 means the
vendor discretionary algorithm
shall be used.
optional parameter with default
value: 0
minimum
impulse
noise
protection in downstream
optional parameter with default
value: 0
minimum
impulse
noise
protection in upstream
optional parameter
min-inp even without erasure
detection
optional parameter
min-inp even without erasure
detection
optional parameter with default
value: 128
minimum downstream bitrate to

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description
be maintained during L2

[no] active

- unit: kbps
- range: [0...262143]
Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

optional parameter
The parameter is not visible
during creation.
to activate the profile

Released

171

7 xDSL Configuration Commands

7.3 xDSL Common Spectrum Profile Configuration


Command
Command Description
This command allows the operator to manage the DSL spectrum profile. The spectrum profiles groups all
parameters on DSL on physical level. These parameters are mainly related to the environmental conditions of the
line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL,VDSL2).
The specific values depending on the DSL flavor can be configured via:
configure xdsl spectrum-profile adsl-adsl2
configure xdsl spectrum-profile re-adsl
configure xdsl spectrum-profile adsl2-plus
configure xdsl spectrum-profile vdsl
configure xdsl spectrum-profile vdsl2
The actual selected operating mode determines which set of DSL specific parameters is used. In case a common
parameter is not supported for a specific DSL flavor, this parameter will be ignored for that flavor.
When all the DSL specific flavors are configured the complete profile has to be activated.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profilemust be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no spectrum-profile (index) ) | ( spectrum-profile (index) name <AsamProfileName> [ (scope) ] [
version <SignedInteger> ] [ [ no ] dis-ansi-t1413 ] [ [ no ] dis-etsi-dts ] [ [ no ] dis-g992-1-a ] [ [ no ] dis-g992-1-b ]
[ [ no ] dis-g992-2-a ] [ [ no ] dis-g992-3-a ] [ [ no ] dis-g992-3-b ] [ [ no ] g992-3-aj ] [ [ no ] g992-3-l1 ] [ [ no ]
g992-3-l2 ] [ [ no ] g992-3-am ] [ [ no ] g992-5-a ] [ [ no ] g992-5-b ] [ [ no ] ansi-t1.424 ] [ [ no ] dis-etsi-ts ] [ [ no
] itu-g993-1 ] [ [ no ] ieee-802.3ah ] [ [ no ] g992-5-aj ] [ [ no ] g992-5-am ] [ [ no ] g993-2-8a ] [ [ no ] g993-2-8b ]
[ [ no ] g993-2-8c ] [ [ no ] g993-2-8d ] [ [ no ] g993-2-12a ] [ [ no ] g993-2-12b ] [ [ no ] g993-2-17a ] [ [ no ]
g993-2-30a ] [ no min-noise-down | min-noise-down <Xdsl::NoiseMargin> ] [ no min-noise-up | min-noise-up
<Xdsl::NoiseMargin> ] [ no trgt-noise-down | trgt-noise-down <Xdsl::NoiseMargin> ] [ no trgt-noise-up |
trgt-noise-up <Xdsl::NoiseMargin> ] [ no max-noise-down | max-noise-down <Xdsl::NoiseMarginPlus> ] [ no
max-noise-up | max-noise-up <Xdsl::NoiseMarginPlus> ] [ no carrier-mask-down | carrier-mask-down
<Xdsl::CarrierMaskDown> ] [ no carrier-mask-up | carrier-mask-up <Xdsl::CarrierMaskUp> ] [ no rf-band-list |
rf-band-list
<Xdsl::RFBandOrNotUsed>
]
[
no
power_mgnt_mode
|
power_mgnt_mode
<Xdsl::LinePowerMgtMode> ] [ no l0-time | l0-time <Xdsl::LineL0Time> ] [ no l2-time | l2-time

172

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

<Xdsl::LineL2Time> ] [ no l2-agpow-red-tx | l2-agpow-red-tx <Xdsl::LineL2Atpr> ] [ no modification |


modification <Xdsl::ModifyStatus> ] [ [ no ] active ] [ no rau-noise-down | rau-noise-down <Xdsl::NoiseMargin> ]
[ no rau-noise-up | rau-noise-up <Xdsl::NoiseMargin> ] [ no rau-time-down | rau-time-down <Xdsl::RaTime> ] [
no rau-time-up | rau-time-up <Xdsl::RaTime> ] [ no rad-noise-down | rad-noise-down <Xdsl::NoiseMargin> ] [ no
rad-noise-up | rad-noise-up <Xdsl::NoiseMargin> ] [ no rad-time-down | rad-time-down <Xdsl::RaTime> ] [ no
rad-time-up | rad-time-up <Xdsl::RaTime> ] [ no l2-agpw-to-red-tx | l2-agpw-to-red-tx <Xdsl::LineL2AtprT> ] )

Command Parameters
Table 7.3-1 "xDSL Common Spectrum Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.3-2 "xDSL Common Spectrum Profile Configuration Command" Command Parameters
Parameter

Type

Description

name

mandatory parameter
profile name

[no] dis-ansi-t1413

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
local-profile
Possible values:
- local-profile : the local profile
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: boolean

[no] dis-etsi-dts

Parameter type: boolean

[no] dis-g992-1-a

Parameter type: boolean

[no] dis-g992-1-b

Parameter type: boolean

[no] dis-g992-2-a

Parameter type: boolean

[no] dis-g992-3-a

Parameter type: boolean

[no] dis-g992-3-b

Parameter type: boolean

[no] g992-3-aj

Parameter type: boolean

[no] g992-3-l1

Parameter type: boolean

[no] g992-3-l2

Parameter type: boolean

(scope)

version

3HH-04416-EBAA-TCZZA 01

obsolete parameter that will be


ignored
scope of the profile
optional parameter
version maintained by manager,
usually 1 for new profile
optional parameter
disable ANSI T1.413-1998
optional parameter
disable ETSI DTS/TM06006
optional parameter
disable
G.992.1
POTS
non-overlapped spectrum
optional parameter
disable
G.992.1
ISDN
non-overlapped spectrum
optional parameter
disable
G.992.2
POTS
non-overlapped spectrum
optional parameter
disable
G.992.3
POTS
non-overlapped spectrum
optional parameter
disable
G.992.3
ISDN
non-overlapped spectrum
optional parameter
G.992.3
all
digital
mode
non-overlapped spectrum
optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 1
optional parameter

Released

173

7 xDSL Configuration Commands

Parameter

Type

[no] g992-3-am

Parameter type: boolean

[no] g992-5-a

Parameter type: boolean

[no] g992-5-b

Parameter type: boolean

[no] ansi-t1.424

Parameter type: boolean

[no] dis-etsi-ts

Parameter type: boolean

[no] itu-g993-1

Parameter type: boolean

[no] ieee-802.3ah

Parameter type: boolean

[no] g992-5-aj

Parameter type: boolean

[no] g992-5-am

Parameter type: boolean

[no] g993-2-8a

Parameter type: boolean

[no] g993-2-8b

Parameter type: boolean

[no] g993-2-8c

Parameter type: boolean

[no] g993-2-8d

Parameter type: boolean

[no] g993-2-12a

Parameter type: boolean

[no] g993-2-12b

Parameter type: boolean

[no] g993-2-17a

Parameter type: boolean

[no] g993-2-30a

Parameter type: boolean

[no] min-noise-down

Parameter type: <Xdsl::NoiseMargin>


Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMargin>
Format:
- a noise margin value

[no] min-noise-up

174

Released

Description
G.992.3 POTS non-overlapped
spectrum US mask 2
optional parameter
G.992.3 extended POTS with
non-overlapped spectrum
optional parameter
G.992.5 POTS non-overlapped
spectrum
optional parameter
G.992.5 ISDN non-overlapped
spectrum
optional parameter
ANSI T1.424
optional parameter
disable ETSI TS
optional parameter
ITU G993-1
optional parameter
IEEE 802.3ah
optional parameter
G.992.5
all
digital
mode
non-overlapped spectrum
optional parameter
G.992.5
extended
POTS
non-overlapped spectrum
optional parameter
G.993.2_8A VDSL-2 with profile
8A
optional parameter
G.993.2_8B VDSL-2 with profile
8B
optional parameter
G.993.2_8C VDSL-2 with profile
8C
optional parameter
G.993.2_8D VDSL-2 with profile
8D
optional parameter
G.993.2_12A VDSL-2 with
profile 12A
optional parameter
G.993.2_12B
VDSL-2
with
profile 12B
optional parameter
G.993.2_17A VDSL-2 with
profile 17A
optional parameter
G.993.2_30A VDSL-2 with
profile 30A
optional parameter with default
value: 0
minimum noise margin in
downstream
optional parameter with default
value: 0
minimum noise margin in

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] trgt-noise-down

[no] trgt-noise-up

[no] max-noise-down

[no] max-noise-up

[no] carrier-mask-down

[no] carrier-mask-up

[no] rf-band-list

[no] power_mgnt_mode

3HH-04416-EBAA-TCZZA 01

Type

Description

- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMargin>
Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMargin>
Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMarginPlus>
Format:
- a normal noise margin value plus special value
- unit: 1/10 db
- range: [0...310,511]
Parameter type: <Xdsl::NoiseMarginPlus>
Format:
- a normal noise margin value plus special value
- unit: 1/10 db
- range: [0...310,511]
Parameter type: <Xdsl::CarrierMaskDown>
Format:
- an octet string bitmask defining carrier mask
- length: 64

upstream

Parameter type: <Xdsl::CarrierMaskUp>


Format:
- an octet string bitmask defining carrier mask
- length: 8
Parameter type: <Xdsl::RFBandOrNotUsed>
Format:
( not-used
| <Xdsl::RFBand> )
Possible values:
- not-used : rfi-band not used
Field type <Xdsl::RFBand>
- a variable lenght octet string defining rf band list
- length: x<=80
Parameter type: <Xdsl::LinePowerMgtMode>
Format:
( none
| l2
| l3
| l2-l3 )
Possible values:
- none : l2 or l3 not supported
- l2 : only l2 supported

optional parameter with default


value: 60
target
noise
margin
in
downstream
optional parameter with default
value: 60
target noise margin in upstream
optional parameter with default
value: 511
maximum noise margin in
downstream
optional parameter with default
value: 511
maximum noise margin in
upstream
optional parameter with default
value: "00 : 00 : 00 : 00 : 00 : 00
: 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00"
the downstream carrier mask
pattern
optional parameter with default
value: "00 : 00 : 00 : 00 : 00 : 00
: 00 : 00"
the upstream carrier mask pattern
optional parameter with default
value: "07 : 12 : 07 : d0 : 19 : 0d
: ac : 0e : d8 : 19 : 1b : 58 : 1b :
bc : 19 : 27 : 74 : 27 : a6 : 19"
list of RF bands

optional parameter with default


value: "none"
permission of power management
states

Released

175

7 xDSL Configuration Commands

Parameter

Type

[no] l0-time

[no] l2-time

[no] l2-agpow-red-tx

[no] modification

[no] active

[no] rau-noise-down

Parameter type: <Xdsl::NoiseMargin>


Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMargin>
Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::RaTime>
Format:
- a data rate value
- unit: sec
- range: [0...16383]
Parameter type: <Xdsl::RaTime>
Format:
- a data rate value
- unit: sec
- range: [0...16383]
Parameter type: <Xdsl::NoiseMargin>
Format:
- a noise margin value
- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::NoiseMargin>
Format:

[no] rau-noise-up

[no] rau-time-down

[no] rau-time-up

[no] rad-noise-down

[no] rad-noise-up

176

Released

Description

- l3 : only l3 supported
- l2-l3 : l2 and l3 supported
Parameter type: <Xdsl::LineL0Time>
Format:
- min time in a state before transitting into another
- unit: sec
- range: [0...1800]
Parameter type: <Xdsl::LineL2Time>
Format:
- min time in a state before transitting into another
- unit: sec
- range: [0...1800]
Parameter type: <Xdsl::LineL2Atpr>
Format:
- the maximum aggregate transmit power reduction
- unit: db
- range: [0...31]
Parameter type: <Xdsl::ModifyStatus>
Format:
( start
| cancel
| complete )
Possible values:
- start : to start modifying the profile
- cancel : to cancel the modifications done
- complete : to complete the modifications
Parameter type: boolean

optional parameter with default


value: 255
min time between exit from and
entry in l2 state
optional parameter with default
value: 60
min time between entry in l2 and
first power trim
optional parameter with default
value: 3
the maximum aggregate transmit
power reduction for l2
optional parameter with default
value: "complete"
to modify the profile

optional parameter
The parameter is not visible
during creation.
to activate the profile
optional parameter with default
value: 70
downstream upshift noise margin
for rate adaptation
optional parameter with default
value: 70
upstream upshift noise margin for
rate adaptation
optional parameter with default
value: 300
downstream minimum upshift
rate adaptation interval
optional parameter with default
value: 300
upstream minimum upshift rate
adaptation interval
optional parameter with default
value: 20
downstream downshift noise
margin for rate adaptation
optional parameter with default
value: 20

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] rad-time-down

[no] rad-time-up

[no] l2-agpw-to-red-tx

3HH-04416-EBAA-TCZZA 01

Type

Description

- a noise margin value


- unit: 1/10 db
- range: [0...310]
Parameter type: <Xdsl::RaTime>
Format:
- a data rate value
- unit: sec
- range: [0...16383]
Parameter type: <Xdsl::RaTime>
Format:
- a data rate value
- unit: sec
- range: [0...16383]
Parameter type: <Xdsl::LineL2AtprT>
Format:
- the total maximum aggregate transmit power reduction
- unit: db
- range: [0...31]

upstream downshift noise margin


for rate adaptation
optional parameter with default
value: 30
downstream minimum downshift
rate adaptation interval
optional parameter with default
value: 30
upstream minimum downshift
rate adaptation interval
optional parameter with default
value: 31
total
maximum
aggregate
transmit power reduction for L2

Released

177

7 xDSL Configuration Commands

7.4 xDSL Artificial Noise Downstream


Configuration Command
Command Description
This command allows the operator to configure artificial noise in Downstream
This command allows to specify the transmitter-referred artificial noise level to be used as additional noise source
at the downstream transmitter.
Artificial Noise PSD points are defined in the range -140dBm/Hz..-40 dBm/Hz. These values must be manually
converted to the range 0..200 using the formula -2*(40 + PSD level).
A special value (-167,5 dBm/Hz) (entered value: 255) states no artificial noise has to be applied.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) artificial-noise-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsd> ]

Command Parameters
Table 7.4-1 "xDSL Artificial Noise Downstream Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...32]

index of the profile.

(psd-point)

psd-point

Table 7.4-2 "xDSL Artificial Noise Downstream Configuration Command" Command Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:

optional parameter with default


value: 0

178

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] psd

3HH-04416-EBAA-TCZZA 01

Type

Description

- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::CustPsd>
Format:
- psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

psd frequency
optional parameter with default
value: 0
psd level

Released

179

7 xDSL Configuration Commands

7.5 xDSL Spectrum Profile for ADSL/ADSL2


Configuration Command
Command Description
This command allows the operator to manage the ADSL and ADSL2 specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration Profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL-ADSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl-adsl2 [ [ no ] proprietary-feat ] [ no propr-feat-value |
propr-feat-value <Xdsl::ProprFeatValue> ] [ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ]
[ no max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ] [ no max-psd-down | max-psd-down
<Xdsl::Adsl2PowerSpectralDensityDown>
]
[
no
max-psd-up
|
max-psd-up
<Xdsl::Adsl2PowerSpectralDensityUp> ] [ [ no ] pbo-mode-up ] [ no max-recv-power-up | max-recv-power-up
<Xdsl::RxPowerLevel> ] [ no psd-mask-up | psd-mask-up <Xdsl::Adsl2PsdMaskUp> ]

Command Parameters
Table 7.5-1 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.5-2 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter

Type

Description

[no] proprietary-feat

Parameter type: boolean

obsolete parameter that will be


ignored
enable proprietary features of the
modem

180

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description

[no] propr-feat-value

Parameter type: <Xdsl::ProprFeatValue>


Format:
- Proprietary feature
- range: [0...4294967295]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter type: <Xdsl::Adsl2PowerSpectralDensityDown>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-400]
Parameter type: <Xdsl::Adsl2PowerSpectralDensityUp>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-380]
Parameter type: boolean

optional parameter with default


value: 1
proprietary feature

[no] max-agpowlev-down

[no] max-agpowlev-up

[no] max-psd-down

[no] max-psd-up

[no] pbo-mode-up
[no] max-recv-power-up

[no] psd-mask-up

3HH-04416-EBAA-TCZZA 01

Parameter type: <Xdsl::RxPowerLevel>


Format:
- a received power level value
- unit: 1/10 * dBm
- range: [-255...255]
Parameter type: <Xdsl::Adsl2PsdMaskUp>
Format:
( default
| adlu32-eu32
| adlu36-eu36
| adlu40-eu40
| adlu44-eu44
| adlu48-eu48
| adlu52-eu52
| adlu56-eu56
| adlu60-eu60
| adlu64-eu64 )
Possible values:
- default : the default mask which is equivalent
adlu56-eu56
- adlu32-eu32 : mask eu-32 for annex-m and adlu-32
annex-j
- adlu36-eu36 : mask eu-36 for annex-m and adlu-36
annex-j
- adlu40-eu40 : mask eu-40 for annex-m and adlu-40
annex-j
- adlu44-eu44 : mask eu-44 for annex-m and adlu-44
annex-j
- adlu48-eu48 : mask eu-48 for annex-m and adlu-48
annex-j

optional parameter with default


value: 255
maximum
aggregate
power
allowed in downstream
optional parameter with default
value: 255
maximum
aggregate
power
allowed in upstream
optional parameter with default
value: -400
maximum power spectral density
allowed in downstream
optional parameter with default
value: -380
maximum power spectral density
allowed in upstream
optional parameter
upstream power backoff mode
ON
optional parameter with default
value: 255
the maximum receive power
allowed in upstream
optional parameter with default
value: "default"
power spectral density mask in
upstream

to
for
for
for
for
for

Released

181

7 xDSL Configuration Commands

Parameter

Type
- adlu52-eu52
annex-j
- adlu56-eu56
annex-j
- adlu60-eu60
annex-j
- adlu64-eu64
annex-j

182

Released

Description
: mask eu-52 for annex-m and adlu-52 for
: mask eu-56 for annex-m and adlu-56 for
: mask eu-60 for annex-m and adlu-60 for
: mask eu-64 for annex-m and adlu-64 for

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.6 xDSL Spectrum Profile for RE-ADSL2


Configuration Command
Command Description
This command allows the operator to manage the Reach Extented ADSL2 specific part of the DSL spectrum profile.
The spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the Reach Extended DSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) re-adsl [ [ no ] proprietary-feat ] [ no propr-feat-value | propr-feat-value
<Xdsl::ProprFeatValue> ] [ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ] [ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ] [ no max-psd-down | max-psd-down
<Xdsl::ReAdsl2PowerSpectralDensityDown>
]
[
no
max-psd-up
|
max-psd-up
<Xdsl::ReAdsl2PowerSpectralDensityUp> ] [ [ no ] pbo-mode-up ] [ no max-recv-power-up | max-recv-power-up
<Xdsl::RxPowerLevel> ]

Command Parameters
Table 7.6-1 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.6-2 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter

Type

Description

[no] proprietary-feat

Parameter type: boolean

obsolete parameter that will be


ignored
enable proprietary features of the
modem

3HH-04416-EBAA-TCZZA 01

Released

183

7 xDSL Configuration Commands

Parameter

Type

Description

[no] propr-feat-value

Parameter type: <Xdsl::ProprFeatValue>


Format:
- Proprietary feature
- range: [0...4294967295]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter
type:
<Xdsl::ReAdsl2PowerSpectralDensityDown>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-370]
Parameter type: <Xdsl::ReAdsl2PowerSpectralDensityUp>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-329]
Parameter type: boolean

optional parameter with default


value: 1
proprietary feature

[no] max-agpowlev-down

[no] max-agpowlev-up

[no] max-psd-down

[no] max-psd-up

[no] pbo-mode-up
[no] max-recv-power-up

184

Released

Parameter type: <Xdsl::RxPowerLevel>


Format:
- a received power level value
- unit: 1/10 * dBm
- range: [-255...255]

optional parameter with default


value: 255
maximum
aggregate
power
allowed in downstream
optional parameter with default
value: 255
maximum
aggregate
power
allowed in upstream
optional parameter with default
value: -370
maximum power spectral density
allowed in downstream
optional parameter with default
value: -329
maximum power spectral density
allowed in upstream
optional parameter
upstream power backoff mode
ON
optional parameter with default
value: 255
the maximum receive power
allowed in upstream

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.7 xDSL Spectrum Profile for ADSL2 Plus


Configuration Command
Command Description
This command allows the operator to manage the ADSL2-plus specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL2-plus flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl2-plus [ [ no ] proprietary-feat ] [ no propr-feat-value |
propr-feat-value <Xdsl::ProprFeatValue> ] [ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ]
[ no max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ] [ no max-psd-down | max-psd-down
<Xdsl::Adsl2PlusPowerSpectralDensityDown>
]
[
no
max-psd-up
|
max-psd-up
<Xdsl::Adsl2PlusPowerSpectralDensityUp>
]
[
no
psd-shape-down
|
psd-shape-down
<Xdsl::Adsl2PlusPsdShapeDown> ] [ [ no ] pbo-mode-up ] [ no max-recv-power-up | max-recv-power-up
<Xdsl::RxPowerLevel> ] [ no psd-mask-up | psd-mask-up <Xdsl::Adsl2PlusPsdMaskUp> ]

Command Parameters
Table 7.7-1 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.7-2 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter

Type

Description

[no] proprietary-feat

Parameter type: boolean

obsolete parameter that will be


ignored
enable proprietary features of the

3HH-04416-EBAA-TCZZA 01

Released

185

7 xDSL Configuration Commands

Parameter

Type

[no] propr-feat-value

Parameter type: <Xdsl::ProprFeatValue>


Format:
- Proprietary feature
- range: [0...4294967295]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter type: <Xdsl::PowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [0...255]
Parameter
type:
<Xdsl::Adsl2PlusPowerSpectralDensityDown>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-400]
Parameter type: <Xdsl::Adsl2PlusPowerSpectralDensityUp>
Format:
- a power spectral density value
- unit: 1/10 * dBm/Hz
- range: [-600...-380]
Parameter type: <Xdsl::Adsl2PlusPsdShapeDown>
Format:
( custom-psd-down
| std-psd-down
| ca100-psd-down
| ca110-psd-down
| ca120-psd-down
| ca130-psd-down
| ca140-psd-down
| ca150-psd-down
| ca160-psd-down
| ca170-psd-down
| ca180-psd-down
| ca190-psd-down
| ca200-psd-down
| ca210-psd-down
| ca220-psd-down
| ca230-psd-down
| ca240-psd-down
| ca250-psd-down
| ca260-psd-down
| ca270-psd-down
| ca280-psd-down
| cust-psd-down : <Xdsl::Adsl2PlusCustPsdShape> )
Possible values:
- cust-psd-down : custom psd shape in downstream in octet
string format
- custom-psd-down : custom psd shape in downstream
- std-psd-down : standard psd mask downstream
- ca100-psd-down : psd mask downstream with cut-off 100
- ca110-psd-down : psd mask downstream with cut-off 110

[no] max-agpowlev-down

[no] max-agpowlev-up

[no] max-psd-down

[no] max-psd-up

[no] psd-shape-down

186

Released

Description
modem
optional parameter with default
value: 1
proprietary feature
optional parameter with default
value: 255
maximum
aggregate
power
allowed in downstream
optional parameter with default
value: 255
maximum
aggregate
power
allowed in upstream
optional parameter with default
value: -400
maximum power spectral density
allowed in downstream
optional parameter with default
value: -380
maximum power spectral density
allowed in upstream
optional parameter with default
value: "std-psd-down"
power spectral density shape in
downstream

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

[no] pbo-mode-up

- ca120-psd-down : psd mask downstream with cut-off 120


- ca130-psd-down : psd mask downstream with cut-off 130
- ca140-psd-down : psd mask downstream with cut-off 140
- ca150-psd-down : psd mask downstream with cut-off 150
- ca160-psd-down : psd mask downstream with cut-off 160
- ca170-psd-down : psd mask downstream with cut-off 170
- ca180-psd-down : psd mask downstream with cut-off 180
- ca190-psd-down : psd mask downstream with cut-off 190
- ca200-psd-down : psd mask downstream with cut-off 200
- ca210-psd-down : psd mask downstream with cut-off 210
- ca220-psd-down : psd mask downstream with cut-off 220
- ca230-psd-down : psd mask downstream with cut-off 230
- ca240-psd-down : psd mask downstream with cut-off 240
- ca250-psd-down : psd mask downstream with cut-off 250
- ca260-psd-down : psd mask downstream with cut-off 260
- ca270-psd-down : psd mask downstream with cut-off 270
- ca280-psd-down : psd mask downstream with cut-off 280
Field type <Xdsl::Adsl2PlusCustPsdShape>
- an octet string defining custom psd shape
- length: x<=61
Parameter type: boolean

[no] max-recv-power-up

[no] psd-mask-up

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Xdsl::RxPowerLevel>


Format:
- a received power level value
- unit: 1/10 * dBm
- range: [-255...255]
Parameter type: <Xdsl::Adsl2PlusPsdMaskUp>
Format:
( default
| adlu32-eu32
| adlu36-eu36
| adlu40-eu40
| adlu44-eu44
| adlu48-eu48
| adlu52-eu52
| adlu56-eu56
| adlu60-eu60
| adlu64-eu64 )
Possible values:
- default : the default mask which is equivalent
adlu56-eu56
- adlu32-eu32 : mask eu-32 for annex-m and adlu-32
annex-j
- adlu36-eu36 : mask eu-36 for annex-m and adlu-36
annex-j
- adlu40-eu40 : mask eu-40 for annex-m and adlu-40
annex-j
- adlu44-eu44 : mask eu-44 for annex-m and adlu-44
annex-j
- adlu48-eu48 : mask eu-48 for annex-m and adlu-48
annex-j
- adlu52-eu52 : mask eu-52 for annex-m and adlu-52
annex-j
- adlu56-eu56 : mask eu-56 for annex-m and adlu-56
annex-j

optional parameter
upstream power backoff mode
ON
optional parameter with default
value: 255
the maximum receive power
allowed in upstream
optional parameter with default
value: "default"
power spectral density mask in
upstream

to
for
for
for
for
for
for
for

Released

187

7 xDSL Configuration Commands

Parameter

Type

Description

- adlu60-eu60 : mask eu-60 for annex-m and adlu-60 for


annex-j
- adlu64-eu64 : mask eu-64 for annex-m and adlu-64 for
annex-j

188

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.8 ADSL2-plus Custom PSD shape Configuration


Command
Command Description
This command allows the operator to configure the ADSL2-plus custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl2-plus cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFrqAdsl2> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.8-1 "ADSL2-plus Custom PSD shape Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...20]

index of the profile.

(psd-point)

psd point

Table 7.8-2 "ADSL2-plus Custom PSD shape Configuration Command" Command Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFrqAdsl2>


Format:
- frequency
- unit: khz
- range: [0...2208]
Parameter type: <Xdsl::PsdLevel>

optional parameter with default


value: 0
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

189

7 xDSL Configuration Commands

Parameter

190

Released

Type

Description

Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.9 xDSL Spectrum Profile for VDSL Configuration


Command
Command Description
This command allows the operator to manage the VDSL specific part of the DSL spectrum profile. The spectrum
profiles groups all parameters on DSL on physical level. These parameters are mainly related to the environmental
conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the VDSL flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile. The configured
cust-psd-sc-down/cust-psd-ty-down, cust-rx-psd-sc-up/ cust-rx-psd-ty-up are ignored by the system after activation
of the profile if no corresponding breakpoints are configured before the activation.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl [ [ no ] proprietary-feat ] [ no propr-feat-value | propr-feat-value
<Xdsl::ProprFeatValue> ] [ no vdsl-band-plan | vdsl-band-plan <Xdsl::VdslBandPlan> ] [ no optional-band |
optional-band
<Xdsl::OptionalBandUsage>
]
[
no
optional-endfreq
|
optional-endfreq
<Xdsl::OptionalBandEndFreq> ] [ no adsl-band | adsl-band <Xdsl::AdslBandUsage> ] [ no max-agpowlev-down |
max-agpowlev-down
<Xdsl::VdslPowerLevel>
]
[
no
max-agpowlev-up
|
max-agpowlev-up
<Xdsl::VdslPowerLevel> ] [ no psd-shape-down | psd-shape-down <Xdsl::VdslPsdShapeDown> ] [ no
psd-shape-up | psd-shape-up <Xdsl::VdslPsdShapeUp> ] [ [ no ] pbo-mode-down ] [ no pbo-mode | pbo-mode
<Xdsl::PboModeVdsl> ] [ no rx-psd-shape-up | rx-psd-shape-up <Xdsl::RxVdslPsdShapeUp> ] [ no
ghstones-pwr-mode | ghstones-pwr-mode <Xdsl::GhsTonesTxPwr> ] [ no max-band | max-band
<Xdsl::VdslMaxBandNum> ] [ no max-freq | max-freq <Xdsl::VdslMaxFrequency> ] [ no m-psd-level-down |
m-psd-level-down <Xdsl::MaxPsdDown> ] [ no m-psd-level-up | m-psd-level-up <Xdsl::MaxPsdUp> ] [ no
psd-pbo-par-a-up | psd-pbo-par-a-up <Xdsl::ABParamType> ] [ no psd-pbo-par-b-up | psd-pbo-par-b-up
<Xdsl::ABParamType> ] [ no cust-psd-sc-down | cust-psd-sc-down <Xdsl::PsdScaleBit> ] [ no cust-psd-ty-down |
cust-psd-ty-down <Xdsl::PsdTypeBit> ] [ no cust-rx-psd-sc-up | cust-rx-psd-sc-up <Xdsl::PsdScaleBit> ] [ no
cust-rx-psd-ty-up | cust-rx-psd-ty-up <Xdsl::PsdTypeBit> ] [ no opt-startfreq | opt-startfreq
<Xdsl::OptionalBandStartFreq> ]

Command Parameters
Table 7.9-1 "xDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters

3HH-04416-EBAA-TCZZA 01

Released

191

7 xDSL Configuration Commands

Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.9-2 "xDSL Spectrum Profile for VDSL Configuration Command" Command Parameters
Parameter

Type

Description

[no] proprietary-feat

Parameter type: boolean

[no] propr-feat-value

Parameter type: <Xdsl::ProprFeatValue>


Format:
- Proprietary feature
- range: [0...4294967295]
Parameter type: <Xdsl::VdslBandPlan>
Format:
( band-plan-a4
| band-plan-a3
| band-plan-a2
| band-plan-b4
| band-plan-b3
| band-plan-b2
| band-plan-c4
| band-plan-c3
| band-plan-c2
| annex-a
| annex-b-998e
| annex-b-997e
| annex-b-998ade
| annex-b-hpe
| annex-c )
Possible values:
- band-plan-a4 : 4 bands of frequency 998 (ITU-T)
- band-plan-a3 : 3 bands of frequency 998
- band-plan-a2 : 2 bands of frequency 998
- band-plan-b4 : 4 bands of frequency 997 (ITU-T)
- band-plan-b3 : 3 bands of frequency 997
- band-plan-b2 : 2 bands of frequency 997
- band-plan-c4 : 4 bands of specified frequency
- band-plan-c3 : 3 bands of specified frequency
- band-plan-c2 : 2 bands of specified frequency
- annex-a : ITU-T G.993.2 VDSL2 Annex A (extended)
band plan
- annex-b-998e : ITU-T G.993.2 VDSL2 Annex B band plan
type 998E
- annex-b-997e : ITU-T G.993.2 VDSL2 Annex B band plan
type 997E
- annex-b-998ade : ITU-T G.993.2 VDSL2 Annex B band
plan type 998ADE
- annex-b-hpe : ITU-T G.993.2 VDSL2 Annex B band plan
type HPE
- annex-c : ITU-T G.993.2 VDSL2 Annex C band plan
Parameter type: <Xdsl::OptionalBandUsage>
Format:
( off
| up
| down )

obsolete parameter that will be


ignored
enable proprietary features of the
modem
optional parameter with default
value: 1
proprietary feature

[no] vdsl-band-plan

[no] optional-band

192

Released

optional parameter with default


value: "band-plan-a4"
the VDSL band plan

optional parameter with default


value: "off"
optional band Usage

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] optional-endfreq

[no] adsl-band

[no] max-agpowlev-down

[no] max-agpowlev-up

[no] psd-shape-down

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- off : usage of optional band is not allowed
- up : optional band can be used for upstream
- down : optional band can be used for downstream
Parameter type: <Xdsl::OptionalBandEndFreq>
Format:
- an end frequency of the VDSL optional band
- unit: KHz
- range: [0,138...552]
Parameter type: <Xdsl::AdslBandUsage>
Format:
( allow-adsl
| excl-adsl
| excl-adsl2plus
| excl-adsl-upto : <Xdsl::AdslBandEndFreq> )
Possible values:
- allow-adsl : usage of adsl spectrum is allowed
- excl-adsl : usage of adsl spectrum is not allowed
- excl-adsl2plus : usage of adsl2plus spectrum is not allowed
- excl-adsl-upto : usage of adsl spectrum with end frequency
Field type <Xdsl::AdslBandEndFreq>
- end frequency of the ADSL band
- unit: KHz
- range: [276...2208]
Parameter type: <Xdsl::VdslPowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [-310...255]
Parameter type: <Xdsl::VdslPowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [-310...255]
Parameter type: <Xdsl::VdslPsdShapeDown>
Format:
( custom-psd-down
| ansi-ftt-ex-m1
| ansi-ftt-ex-m2
| ansi-ftt-cab-m1
| ansi-ftt-cab-m2
| etsi-p-ex-p1-m1
| etsi-p-ex-p1-m2
| etsi-p-ex-p2-m1
| etsi-p-ex-p2-m2
| etsi-p-cab-m1
| etsi-p-cab-m2
| ansi-ftt-m1-adsl
| ansi-ftt-m2-adsl
| ansi-ftt-m1-adsl-2plus
| ansi-ftt-m2-adsl-2plus
| etsi-p-x-m1-adsl
| etsi-p-x-m2-adsl
| etsi-p-m1-adsl-2plus
| etsi-p-m2-adsl-2plus
| cust-psd-down : <Xdsl::VdslCustPsdShapeDwnStream> )
Possible values:

optional parameter with default


value: 0
optional band end frequency
optional parameter with default
value: "excl-adsl"
adsl band Usage

optional parameter with default


value: 255
max power allowed on the line in
downstream
optional parameter with default
value: 255
max power allowed on the line in
upstream
optional parameter with default
value: "etsi-p-cab-m1"
power spectral density shape in
downstream

Released

193

7 xDSL Configuration Commands

Parameter

Type

[no] psd-shape-up

194

Description

- cust-psd-down : custom psd shape in downstream in octet


string format
- custom-psd-down : custom psd shape in downstream
- ansi-ftt-ex-m1 : ANSI standard spectral density in
downstream
- ansi-ftt-ex-m2 : ANSI standard spectral density in
downstream
- ansi-ftt-cab-m1 : ANSI standard spectral density in
downstream
- ansi-ftt-cab-m2 : ANSI standard spectral density in
downstream
- etsi-p-ex-p1-m1 : ETSI standard spectral density in
downstream
- etsi-p-ex-p1-m2 : ETSI standard spectral density in
downstream
- etsi-p-ex-p2-m1 : ETSI standard spectral density in
downstream
- etsi-p-ex-p2-m2 : ETSI standard spectral density in
downstream
- etsi-p-cab-m1 : ETSI standard spectral density in
downstream
- etsi-p-cab-m2 : ETSI standard spectral density in
downstream
- ansi-ftt-m1-adsl : ANSI standard spectral density in
downstream
- ansi-ftt-m2-adsl : ANSI standard spectral density in
downstream
- ansi-ftt-m1-adsl-2plus: ANSI standard spectral density in
downstream
- ansi-ftt-m2-adsl-2plus: ANSI standard spectral density in
downstream
- etsi-p-x-m1-adsl : ETSI standard spectral density in
downstream
- etsi-p-x-m2-adsl : ETSI standard spectral density in
downstream
- etsi-p-m1-adsl-2plus : ETSI standard spectral density in
downstream
- etsi-p-m2-adsl-2plus : ETSI standard spectral density in
downstream
Field type <Xdsl::VdslCustPsdShapeDwnStream>
- an octet string defining custom psd shape
- length: x<=97
Parameter type: <Xdsl::VdslPsdShapeUp>
Format:
( ansi-ftt-ex-m1
| ansi-ftt-ex-m2
| ansi-ftt-cab-m1
| ansi-ftt-cab-m2
| etsi-p-m1
| etsi-p-m2 )
Possible values:
- ansi-ftt-ex-m1 : ANSI standard spectral density in
upstream
- ansi-ftt-ex-m2 : ANSI standard spectral density in
upstream
- ansi-ftt-cab-m1 : ANSI standard spectral density in
upstream

Released

optional parameter with default


value: "etsi-p-m1"
power spectral density shape in
upstream

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] pbo-mode-down

[no] pbo-mode

[no] rx-psd-shape-up

3HH-04416-EBAA-TCZZA 01

Type

Description

- ansi-ftt-cab-m2 : ANSI standard spectral density in


upstream
- etsi-p-m1 : ETSI standard spectral density in upstream
- etsi-p-m2 : ETSI standard spectral density in upstream
Parameter type: boolean
obsolete parameter replaced by
parameter "pbo-mode"
upstream power backoff mode
OFF
Parameter type: <Xdsl::PboModeVdsl>
optional parameter with default
Format:
value: "pbo-mode-up"
( pbo-mode-down
upstream power backoff mode
| pbo-mode-up
| pbo-up-pol-sd
| pbo-up-pol-us0
| pbo-up-pol-pass )
Possible values:
- pbo-mode-down : upstream power backoff mode OFF
- pbo-mode-up : upstream power backoff mode ON
- pbo-up-pol-sd : pbo mode ON policing shutdown
- pbo-up-pol-us0 : pbo mode ON policing US0 only
- pbo-up-pol-pass : pbo mode ON policing passive
Parameter type: <Xdsl::RxVdslPsdShapeUp>
optional parameter with default
Format:
value: "etsi-a"
( custom-rx-psd-up
the reference RX PSD shape for
| ansi-a
upstream
| ansi-f
| ansi-custom-ex
| ansi-custom-cab
| etsi-a
| etsi-b
| etsi-c
| etsi-d
| etsi-e
| etsi-f
| etsi-custom-ex
| etsi-custom-cab
| ab-param
| cust-rx-psd-up : <Xdsl::VdslCustPsdShape> )
Possible values:
- cust-rx-psd-up : custom receive psd in upstream in octet
string format
- custom-rx-psd-up : custom receive psd in upstream
- ansi-a : ansi standard spectral density shape in upstream
- ansi-f : ansi standard spectral density shape in upstream
- ansi-custom-ex : ansi custom spectral density shape in
upstream
- ansi-custom-cab : ansi custom spectral density shape in
upstream
- etsi-a : etsi standard spectral density shape in upstream
- etsi-b : etsi standard spectral density shape in upstream
- etsi-c : etsi standard spectral density shape in upstream
- etsi-d : etsi standard spectral density shape in upstream
- etsi-e : etsi standard spectral density shape in upstream
- etsi-f : etsi standard spectral density shape in upstream
- etsi-custom-ex : etsi custom spectral density shape in
upstream
- etsi-custom-cab : etsi custom standard spectral density

Released

195

7 xDSL Configuration Commands

Parameter

Type

[no] ghstones-pwr-mode

[no] max-band

[no] max-freq

[no] m-psd-level-down

[no] m-psd-level-up

[no] psd-pbo-par-a-up

196

Released

Description

shape in upstream
- ab-param : ABParameter spectral density shape in
upstream
Field type <Xdsl::VdslCustPsdShape>
- an octet string defining custom psd shape
- length: x<=61
Parameter type: <Xdsl::GhsTonesTxPwr>
Format:
( standard
| auto
| per-tone-set )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- per-tone-set : choose from the tone sets
Parameter type: <Xdsl::VdslMaxBandNum>
Format:
( unrestricted
| <Xdsl::VdslMaxBandNum> )
Possible values:
- unrestricted : unrestricted bands
Field type <Xdsl::VdslMaxBandNum>
- number of upstream and downstream bands
- range: [0,2...8]
Parameter type: <Xdsl::VdslMaxFrequency>
Format:
( ulimited
| <Xdsl::VdslMaxFrequency> )
Possible values:
- ulimited : unlimited frequency
Field type <Xdsl::VdslMaxFrequency>
- maximum frequency that can be used during showtime
- unit: KHz
- range: [1104...30000]
Parameter type: <Xdsl::MaxPsdDown>
Format:
( no-constraint
| <Xdsl::MaxPsdLevelType> )
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
Parameter type: <Xdsl::MaxPsdUp>
Format:
( no-constraint
| <Xdsl::MaxPsdLevelType> )
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
Parameter type: <Xdsl::ABParamType>
Format:

optional parameter with default


value: "standard"
the Tx power control of the G.hs
tones

optional parameter with default


value: "unrestricted"
max number of bands to be used
from specified band plan

optional parameter with default


value: "ulimited"
max frequency that can be used
during showtime

optional parameter with default


value: "no-constraint"
max PSD level for downstream

optional parameter with default


value: "no-constraint"
max PSD level for upstream

optional parameter with default


value: "0f : a0 : 12 : 7a : 15 : 18

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description

- binary string
- length: 10

: 15 : 18 : 15 : 18"
parmtr A val for each band to
compute PSD ref for US PBO
optional parameter with default
value: "00 : 00 : 07 : b9 : 06 : 29
: 04 : 35 : 03 : af"
parmtr B val for each band to
compute PSD ref for US PBO
optional parameter with default
value: "linear"
psd scale

[no] psd-pbo-par-b-up

Parameter type: <Xdsl::ABParamType>


Format:
- binary string
- length: 10

[no] cust-psd-sc-down

Parameter type: <Xdsl::PsdScaleBit>


Format:
( linear
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
Parameter type: <Xdsl::PsdTypeBit>
Format:
( mask
| template )
Possible values:
- mask : PSD mask
- template : PSD template
Parameter type: <Xdsl::PsdScaleBit>
Format:
( linear
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
Parameter type: <Xdsl::PsdTypeBit>
Format:
( mask
| template )
Possible values:
- mask : PSD mask
- template : PSD template
Parameter type: <Xdsl::OptionalBandStartFreq>
Format:
- a start frequency of the VDSL optional band
- unit: KHz
- range: [0...138]

[no] cust-psd-ty-down

[no] cust-rx-psd-sc-up

[no] cust-rx-psd-ty-up

[no] opt-startfreq

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "mask"
psd type

optional parameter with default


value: "linear"
psd scale

optional parameter with default


value: "mask"
psd type

optional parameter with default


value: 0
optional band end frequency

Released

197

7 xDSL Configuration Commands

7.10 VDSL Ghs Tones Transmission Power Control


Configuration Command
Command Description
This command allows the operator to configure transmission power of the G.hs tones in VDSL environment.G.hs is
intended to be a robust mechanism for activating a multiplicity of xDSL. Activation of regional standards or legacy
devices can be handled by implicit (escape) or explicit (non-standard facilities) mechanisms.
The parameters defined are used for control of the transmission power.There are various tone sets defined for the
control of the transmission power, viz., A43,B43,A43C and V43.The power of each tone of the set shall be
equivalent to the given PSD value integrated in a total bandwidth of 4.3125 kHz

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl ghstone-set-pwr-ctrl [ no a43 | a43 <Xdsl::GhsTonesTxPwrCtrl> ] [
no b43 | b43 <Xdsl::GhsTonesTxPwrCtrl> ] [ no a43c | a43c <Xdsl::GhsTonesTxPwrCtrl> ] [ no v43 | v43
<Xdsl::GhsTonesTxPwrCtrl> ]

Command Parameters
Table 7.10-1 "VDSL Ghs Tones Transmission Power Control Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.10-2 "VDSL Ghs Tones Transmission Power Control Configuration Command" Command
Parameters
Parameter

Type

Description

[no] a43

Parameter type: <Xdsl::GhsTonesTxPwrCtrl>


Format:
( standard
| auto
| manual : <Xdsl::GhsTonesTxPwrLvl> )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- manual : custom max Tx power level

optional parameter with default


value: "standard"
power control of the ghstones for
tones set a43

198

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] b43

[no] a43c

[no] v43

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Xdsl::GhsTonesTxPwrLvl>


- power of each DS tone
- unit: 1/2 * dBm/Hz
- range: [-198...-80]
Parameter type: <Xdsl::GhsTonesTxPwrCtrl>
Format:
( standard
| auto
| manual : <Xdsl::GhsTonesTxPwrLvl> )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- manual : custom max Tx power level
Field type <Xdsl::GhsTonesTxPwrLvl>
- power of each DS tone
- unit: 1/2 * dBm/Hz
- range: [-198...-80]
Parameter type: <Xdsl::GhsTonesTxPwrCtrl>
Format:
( standard
| auto
| manual : <Xdsl::GhsTonesTxPwrLvl> )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- manual : custom max Tx power level
Field type <Xdsl::GhsTonesTxPwrLvl>
- power of each DS tone
- unit: 1/2 * dBm/Hz
- range: [-198...-80]
Parameter type: <Xdsl::GhsTonesTxPwrCtrl>
Format:
( standard
| auto
| manual : <Xdsl::GhsTonesTxPwrLvl> )
Possible values:
- standard : the max power as per G994.1 standard definition
- auto : the max Tx power level is derived from
psd-shape-down
- manual : custom max Tx power level
Field type <Xdsl::GhsTonesTxPwrLvl>
- power of each DS tone
- unit: 1/2 * dBm/Hz
- range: [-198...-80]

optional parameter with default


value: "standard"
power control of the ghs tones for
tones set b43

optional parameter with default


value: "standard"
power control of the ghs tones for
tones set a43c

optional parameter with default


value: "standard"
power control of the ghs tones for
tones set v43

Released

199

7 xDSL Configuration Commands

7.11 VDSL Custom PSD shape Downstream


Configuration Command
Command Description
This command allows the operator to configure the VDSL custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.11-1 "VDSL Custom PSD shape Downstream Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...32]

index of the profile.

(psd-point)

psd point

Table 7.11-2 "VDSL Custom PSD shape Downstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency

optional parameter with default


value: 0
psd frequency

200

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] psd

3HH-04416-EBAA-TCZZA 01

Type

Description

- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::PsdLevel>
Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

optional parameter with default


value: 0
psd level

Released

201

7 xDSL Configuration Commands

7.12 VDSL Custom RX PSD shape Upstream


Configuration Command
Command Description
This command allows the operator to configure the VDSL custom rx-psd shape in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl cust-rx-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.12-1 "VDSL Custom RX PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...20]

index of the profile.

(psd-point)

psd point

Table 7.12-2 "VDSL Custom RX PSD shape Upstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency

optional parameter with default


value: 0
psd frequency

202

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] psd

3HH-04416-EBAA-TCZZA 01

Type

Description

- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::PsdLevel>
Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

optional parameter with default


value: 0
psd level

Released

203

7 xDSL Configuration Commands

7.13 VDSL Power Back Off Configuration


Command
Command Description
This command can be used to specify the power back off parameters for each upstream band.
Parameter A and B can be used for computing the PSD reference for US PBO for each band (including optional
band). The range of parameter A for each band is 40..80.95 dBm/Hz in steps of 0.01 dBm/Hz. And the range of
parameter B is 0..40.95 dBm/Hz in steps of 0.01 dBm/Hz.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl pbo (band) [ no param-a | param-a <Xdsl::PboParamA> ] [ no
param-b | param-b <Xdsl::PboParamB> ]

Command Parameters
Table 7.13-1 "VDSL Power Back Off Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- equal fext band
- range: [1...5]

index of the profile.

(band)

band index

Table 7.13-2 "VDSL Power Back Off Configuration Command" Command Parameters
Parameter

Type

Description

[no] param-a

Parameter type: <Xdsl::PboParamA>


Format:
- pbo param A
- unit: 0.01 dBm/Hz
- range: [0,4000...8095]
Parameter type: <Xdsl::PboParamB>
Format:
- pbo param B
- unit: 0.01 dBm/Hz
- range: [0...4095]

optional parameter with default


value: 0L
parameter A value

[no] param-b

204

Released

optional parameter with default


value: 0L
parameter B value

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.14 xDSL Spectrum Profile for VDSL2


Configuration Command
Command Description
This command allows the operator to manage the VDSL2 specific part of the DSL spectrum profile. The spectrum
profiles groups all parameters on DSL on physical level. These parameters are mainly related to the environmental
conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL,VDSL2).
This chapter contains the VDSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile. The configured
cust-psd-sc-down/cust-psd-ty-down, cust-psd-sc-up/ cust-psd-ty-up, cust-rx-psd-sc-up/cust-rx-psd-ty-up are ignored
by the system after activation of the profile if no corresponding breakpoints are configured before the activation.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 [ [ no ] proprietary-feat ] [ no propr-feat-value | propr-feat-value
<Xdsl::ProprFeatValue> ] [ no max-agpowlev-down | max-agpowlev-down <Xdsl::VdslPowerLevel> ] [ no
max-agpowlev-up | max-agpowlev-up <Xdsl::VdslPowerLevel> ] [ no psd-shape-down | psd-shape-down
<Xdsl::Vdsl2PsdShapeDown> ] [ no cs-psd-shape-dn | cs-psd-shape-dn <Xdsl::VdslCustPsdShapeDwnStream> ] [
no cs-psd-shape-up | cs-psd-shape-up <Xdsl::Vdsl2CustPsdShape> ] [ no psd-shape-up | psd-shape-up
<Xdsl::Vdsl2PsdShapeUp> ] [ no rx-psd-shape-up | rx-psd-shape-up <Xdsl::RxVdsl2PsdShapeUp> ] [ no
psd-pbo-e-len-up | psd-pbo-e-len-up <Xdsl::PsdPboElectrLength> ] [ no m-psd-level-down | m-psd-level-down
<Xdsl::MaxPsdDown> ] [ no m-psd-level-up | m-psd-level-up <Xdsl::MaxPsdUp> ] [ no psd-pbo-par-a-up |
psd-pbo-par-a-up <Xdsl::ABParamType> ] [ no psd-pbo-par-b-up | psd-pbo-par-b-up <Xdsl::ABParamType> ] [ no
v-noise-snr-down | v-noise-snr-down <Xdsl::SnrmMode> ] [ no v-noise-snr-up | v-noise-snr-up
<Xdsl::SnrmModeUp> ] [ no v-noise-psd-down | v-noise-psd-down <Xdsl::VirtualNoisePsdDownType> ] [ no
v-noise-psd-up | v-noise-psd-up <Xdsl::VirtualNoisePsdUpType> ] [ no cust-psd-sc-down | cust-psd-sc-down
<Xdsl::PsdScaleBit> ] [ no cust-psd-ty-down | cust-psd-ty-down <Xdsl::PsdTypeBit> ] [ no cust-psd-sc-up |
cust-psd-sc-up <Xdsl::PsdScaleBit> ] [ no cust-psd-ty-up | cust-psd-ty-up <Xdsl::PsdTypeBit> ] [ no
cust-rx-psd-sc-up | cust-rx-psd-sc-up <Xdsl::PsdScaleBit> ] [ no cust-rx-psd-ty-up | cust-rx-psd-ty-up
<Xdsl::PsdTypeBit> ] [ no upbo-aele-mode | upbo-aele-mode <Xdsl::UpboAeleMode> ] [ no upboaele-min-thrs |
upboaele-min-thrs <Xdsl::UpboAeleMinThresh> ]

Command Parameters
Table 7.14-1 "xDSL Spectrum Profile for VDSL2 Configuration Command" Resource Parameters

3HH-04416-EBAA-TCZZA 01

Released

205

7 xDSL Configuration Commands

Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]

index of the profile.

Table 7.14-2 "xDSL Spectrum Profile for VDSL2 Configuration Command" Command Parameters
Parameter

Type

Description

[no] proprietary-feat

Parameter type: boolean

[no] propr-feat-value

Parameter type: <Xdsl::ProprFeatValue>


Format:
- Proprietary feature
- range: [0...4294967295]
Parameter type: <Xdsl::VdslPowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [-310...255]
Parameter type: <Xdsl::VdslPowerLevel>
Format:
- a power level value
- unit: 1/10 * dBm
- range: [-310...255]
Parameter type: <Xdsl::Vdsl2PsdShapeDown>
Format:
( cust-psd-down
| regiona-psd-down
| regionbm1-psd-down
| regionbm2-psd-down
| regionc-psd-down
| custom-psd-down : <Xdsl::VdslCustPsdShapeDwnStream>
)
Possible values:
- custom-psd-down : custom psd shape in downstream in
octet string format
- cust-psd-down : custom psd shape in downstream
- regiona-psd-down : Region A spectral density in
downstream
- regionbm1-psd-down : Region BM1 spectral density in
downstream
- regionbm2-psd-down : Region BM2 spectral density in
downstream
- regionc-psd-down : RegionC spectral density in
downstream
Field type <Xdsl::VdslCustPsdShapeDwnStream>
- an octet string defining custom psd shape
- length: x<=97
Parameter type: <Xdsl::VdslCustPsdShapeDwnStream>
Format:
- an octet string defining custom psd shape
- length: x<=97
Parameter type: <Xdsl::Vdsl2CustPsdShape>
Format:
- an octet string defining custom psd shape
- length: x<=61
Parameter type: <Xdsl::Vdsl2PsdShapeUp>

obsolete parameter that will be


ignored
enable proprietary features of the
modem
optional parameter with default
value: 1
proprietary feature

[no] max-agpowlev-down

[no] max-agpowlev-up

[no] psd-shape-down

[no] cs-psd-shape-dn

[no] cs-psd-shape-up

[no] psd-shape-up

206

Released

optional parameter with default


value: 255
maximum power allowed on the
line in downstream
optional parameter with default
value: 255
maximum power allowed on the
line in upstream
optional parameter with default
value: "regionbm1-psd-down"
power spectral density shape in
downstream

optional parameter with default


value: ""
(deprecated)power
spectral
density shape in downstream
optional parameter with default
value: ""
(deprecated)power
spectral
density shape in upstream
optional parameter with default

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] rx-psd-shape-up

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( regiona-psd-up
| regionbm1-psd-up
| regionbm2-psd-up
| regionc-psd-up
| custom-psd-up )
Possible values:
- custom-psd-up : custom psd shape in upstream
- regiona-psd-up : Region A spectral density in upstream
- regionbm1-psd-up : Region BM1 spectral density in
upstream
- regionbm2-psd-up : Region BM2 spectral density in
upstream
- regionc-psd-up : RegionC spectral density in upstream
Parameter type: <Xdsl::RxVdsl2PsdShapeUp>
Format:
( custom-rx-psd-up
| ansi-a
| ansi-f
| ansi-custom-ex
| ansi-custom-cab
| etsi-a
| etsi-b
| etsi-c
| etsi-d
| etsi-e
| etsi-f
| etsi-custom-ex
| etsi-custom-cab
| ab-param
| equal-fext
| cust-rx-psd-up : <Xdsl::VdslCustPsdShape> )
Possible values:
- cust-rx-psd-up : custom recieve psd in upstream
- custom-rx-psd-up : custom recieve psd in upstream
- ansi-a : ansi standard spectral density shape in upstream
- ansi-f : ansi standard spectral density shape in upstream
- ansi-custom-ex : ansi custom spectral density shape in
upstream
- ansi-custom-cab : ansi custom spectral density shape in
upstream
- etsi-a : etsi standard spectral density shape in upstream
- etsi-b : etsi standard spectral density shape in upstream
- etsi-c : etsi standard spectral density shape in upstream
- etsi-d : etsi standard spectral density shape in upstream
- etsi-e : etsi standard spectral density shape in upstream
- etsi-f : etsi standard spectral density shape in upstream
- etsi-custom-ex : etsi custom spectral density shape in
upstream
- etsi-custom-cab : etsi custom standard spectral density
shape in upstream
- ab-param : ABParameter spectral density shape in
upstream
- equal-fext : equal fext in upstream
Field type <Xdsl::VdslCustPsdShape>
- an octet string defining custom psd shape
- length: x<=61

value: "regionbm1-psd-up"
power spectral density shape in
upstream

optional parameter with default


value: "etsi-a"
the reference RX PSD shape for
upstream

Released

207

7 xDSL Configuration Commands

Parameter

Type

Description

[no] psd-pbo-e-len-up

Parameter type: <Xdsl::PsdPboElectrLength>


Format:
( estimated
| <Xdsl::PsdPboLength> )
Possible values:
- estimated : estimated electrical length
Field type <Xdsl::PsdPboLength>
- electrical parameter AB range
- unit: 1/2 * dB
- range: [0...255]
Parameter type: <Xdsl::MaxPsdDown>
Format:
( no-constraint
| <Xdsl::MaxPsdLevelType> )
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
Parameter type: <Xdsl::MaxPsdUp>
Format:
( no-constraint
| <Xdsl::MaxPsdLevelType> )
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
Parameter type: <Xdsl::ABParamType>
Format:
- binary string
- length: 10

optional parameter with default


value: "estimated"
the electrical length to be used
with the AB parameters

[no] m-psd-level-down

[no] m-psd-level-up

[no] psd-pbo-par-a-up

optional parameter with default


value: "no-constraint"
maximum
PSD
level
for
downstream

optional parameter with default


value: "no-constraint"
maximum
PSD
level
for
upstream

[no] psd-pbo-par-b-up

Parameter type: <Xdsl::ABParamType>


Format:
- binary string
- length: 10

[no] v-noise-snr-down

Parameter type: <Xdsl::SnrmMode>


Format:
( mode-1
| mode-2
| mode-3 )
Possible values:
- mode-1 : virtual noise disabled
- mode-2 : Tx referred virtual noise enabled
- mode-3 : Rx referred virtual noise enabled(not supported)
Parameter type: <Xdsl::SnrmModeUp>
Format:
( mode-1
| mode-2
| mode-3 )
Possible values:
- mode-1 : virtual noise disabled
- mode-2 : Tx referred virtual noise enabled

[no] v-noise-snr-up

208

Released

optional parameter with default


value: "0f : a0 : 12 : 7a : 15 : 18
: 15 : 18 : 15 : 18"
par A value for computing the
PSD reference for US PBO
optional parameter with default
value: "00 : 00 : 07 : b9 : 06 : 29
: 04 : 35 : 03 : af"
par B value for computing the
PSD reference for US PBO
optional parameter with default
value: "mode-1"
downstream mode of virtual
noise SNR margin

optional parameter with default


value: "mode-1"
upstream mode of virtual noise
SNR Margin

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] v-noise-psd-down

Type
- mode-3 : Rx referred virtual noise enabled
Parameter type: <Xdsl::VirtualNoisePsdDownType>
Format:
- binary string
- length: x<=97

Description
optional parameter with default
value: ""
(deprecated)virtual noise level for
determining the SNR margin in
downstream bands
optional parameter with default
value: ""
(deprecated)virtual noise level for
determining the SNR margin in
upstream bands
optional parameter with default
value: "linear"
psd scale

[no] v-noise-psd-up

Parameter type: <Xdsl::VirtualNoisePsdUpType>


Format:
- binary string
- length: x<=49

[no] cust-psd-sc-down

Parameter type: <Xdsl::PsdScaleBit>


Format:
( linear
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
Parameter type: <Xdsl::PsdTypeBit>
optional parameter with default
Format:
value: "mask"
( mask
psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
Parameter type: <Xdsl::PsdScaleBit>
optional parameter with default
Format:
value: "linear"
( linear
psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
Parameter type: <Xdsl::PsdTypeBit>
optional parameter with default
Format:
value: "mask"
( mask
psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
Parameter type: <Xdsl::PsdScaleBit>
optional parameter with default
Format:
value: "linear"
( linear
psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
Parameter type: <Xdsl::PsdTypeBit>
optional parameter with default
Format:
value: "mask"
( mask
psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
Parameter type: <Xdsl::UpboAeleMode>
optional parameter with default
Format:
value: 0
- the electrical length estimation mode to be used in Aele the electrical length estimation
Method
mode to be used in the

[no] cust-psd-ty-down

[no] cust-psd-sc-up

[no] cust-psd-ty-up

[no] cust-rx-psd-sc-up

[no] cust-rx-psd-ty-up

[no] upbo-aele-mode

3HH-04416-EBAA-TCZZA 01

Released

209

7 xDSL Configuration Commands

Parameter

Type

Description

- range: [0...3]
[no] upboaele-min-thrs

210

Released

Alternative Electrical Length


Method
Parameter type: <Xdsl::UpboAeleMinThresh>
optional parameter with default
Format:
value: 10
- the electrical length minimum threshold to be used in Aele the electrical length minimum
Method
threshold value to be used in the
- unit: percent
Alternative Electrical Length
- range: [0...15]
Method

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.15 VDSL2 Custom PSD shape Downstream


Configuration Command
Command Description
This command allows the operator to configure the VDSL2 custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.15-1 "VDSL2 Custom PSD shape Downstream Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...32]

index of the profile.

(psd-point)

psd point

Table 7.15-2 "VDSL2 Custom PSD shape Downstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency

optional parameter with default


value: 0
psd frequency

3HH-04416-EBAA-TCZZA 01

Released

211

7 xDSL Configuration Commands

Parameter
[no] psd

212

Released

Type

Description

- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::PsdLevel>
Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

optional parameter with default


value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.16 VDSL2 Custom PSD shape Upstream


Configuration Command
Command Description
This command allows the operator to configure the VDSL2 custom psd shape in downstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.16-1 "VDSL2 Custom PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...20]

index of the profile.

(psd-point)

psd point

Table 7.16-2 "VDSL2 Custom PSD shape Upstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency

optional parameter with default


value: 0
psd frequency

3HH-04416-EBAA-TCZZA 01

Released

213

7 xDSL Configuration Commands

Parameter
[no] psd

214

Released

Type

Description

- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::PsdLevel>
Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

optional parameter with default


value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.17 VDSL2 Custom RX PSD shape Upstream


Configuration Command
Command Description
This command allows the operator to configure the VDSL2 custom rx-psd shape in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets the operator can
enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the frequency scale and the psd
shape type will also be reset to the default value. When any other breakpoint is set to default values, all points
following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 cust-rx-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::PsdLevel> ]

Command Parameters
Table 7.17-1 "VDSL2 Custom RX PSD shape Upstream Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...20]

index of the profile.

(psd-point)

psd point

Table 7.17-2 "VDSL2 Custom RX PSD shape Upstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency

optional parameter with default


value: 0
psd frequency

3HH-04416-EBAA-TCZZA 01

Released

215

7 xDSL Configuration Commands

Parameter
[no] psd

216

Released

Type

Description

- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::PsdLevel>
Format:
- psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

optional parameter with default


value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.18 VDSL2 Virtual Noise Downstream


Configuration Command
Command Description
This command allows the operator to configure VDSL2 virtual noise in downstream direction.
It helps operator to enter the virtual noise in a user-friendly way. Instead of entering octets, as was the case with
the earlier command, the operator can enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 v-noise-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsdVdsl2VtNoise> ]

Command Parameters
Table 7.18-1 "VDSL2 Virtual Noise Downstream Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd point
- range: [1...32]

index of the profile.

(psd-point)

psd point

Table 7.18-2 "VDSL2 Virtual Noise Downstream Configuration Command" Command Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::CustPsdVdsl2VtNoise>

optional parameter with default


value: 0
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

217

7 xDSL Configuration Commands

Parameter

218

Released

Type

Description

Format:
- psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.19 VDSL2 Virtual Noise Upstream Configuration


Command
Command Description
This command allows the operator to configure VDSL2 virtual noise in upstream direction.
It helps operator to enter the custom psd shape in a user-friendly way. Instead of entering octets, as was the case
with the earlier command, the operator can enter numbers corresponding to frequency and psd.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 v-noise-psd-pt-up (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsdVdsl2VtNoise> ]

Command Parameters
Table 7.19-1 "VDSL2 Virtual Noise Upstream Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- psd level
- range: [1...16]

index of the profile.

(psd-point)

psd point

Table 7.19-2 "VDSL2 Virtual Noise Upstream Configuration Command" Command Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::CustPsdVdsl2VtNoise>

optional parameter with default


value: 0
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

219

7 xDSL Configuration Commands

Parameter

220

Released

Type

Description

Format:
- psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

value: 0
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.20 VDSL2 Power Back Off Configuration


Command
Command Description
This command can be used to specify the power back off parameters for each upstream band.
The equal FEXT reference electrical length parameter value for each band (including optional band) can be used
for computing the PSD reference for US equal FEXT PBO. The range of this parameter for each band is 1.8 dB to
63 dB in steps of 0.1 dB. The special value 0 dB indicates that the modem has to use dedicated mechanism to
optimally apply the equal FEXT without providing any manual setting for this parameter. The special value 1.8 dB
disables equal FEXT UPBO in the respective upstream band.
Parameter A and B can be used for computing the PSD reference for US PBO for each band (including optional
band). The range of parameter A for each band is 40..80.95 dBm/Hz in steps of 0.01 dBm/Hz. And the range of
parameter B is 0..40.95 dBm/Hz in steps of 0.01 dBm/Hz.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl2 pbo (band) [ no equal-fext | equal-fext
<Xdsl::EqualFextUpstreamParam> ] [ no param-a | param-a <Xdsl::PboParamA> ] [ no param-b | param-b
<Xdsl::PboParamB> ]

Command Parameters
Table 7.20-1 "VDSL2 Power Back Off Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...256]
Format:
- equal fext band
- range: [1...5]

index of the profile.

(band)

band index

Table 7.20-2 "VDSL2 Power Back Off Configuration Command" Command Parameters
Parameter

Type

Description

[no] equal-fext

Parameter type: <Xdsl::EqualFextUpstreamParam>


Format:
- pbo equal fext upstream
- unit: 0.1 dB
- range: [0,18...630]
Parameter type: <Xdsl::PboParamA>

optional parameter with default


value: 0L
equal fext upstream param

[no] param-a

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

221

7 xDSL Configuration Commands

Parameter

Type

Description
value: 0L
parameter A value

[no] param-b

Format:
- pbo param A
- unit: 0.01 dBm/Hz
- range: [0,4000...8095]
Parameter type: <Xdsl::PboParamB>
Format:
- pbo param B
- unit: 0.01 dBm/Hz
- range: [0...4095]

222

Released

optional parameter with default


value: 0L
parameter B value

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.21 xDSL DPBO Profile Configuration Command


Command Description
Downstream power back off profile to configure the modem for a physical line.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no dpbo-profile (index) ) | ( dpbo-profile (index) name <AsamProfileName> [ no es-elect-length
| es-elect-length <Xdsl::ElectricalLength> ] [ no es-cable-model-a | es-cable-model-a <Xdsl::CableModelA> ] [ no
es-cable-model-b | es-cable-model-b <Xdsl::CableModelB> ] [ no es-cable-model-c | es-cable-model-c
<Xdsl::CableModelC> ] [ no min-usable-signal | min-usable-signal <Xdsl::MinUsableSignalLevel> ] [ no
min-frequency | min-frequency <Xdsl::MinFrequency> ] [ no max-frequency | max-frequency
<Xdsl::MaxFrequency> ] [ no rs-elect-length | rs-elect-length <Xdsl::RemoteSideElectricalLength> ] [ no
muf-control | muf-control <Xdsl::MaxUsableFrequencyControl> ] [ no offset | offset <Xdsl::DpboOffset> ] [ [ no ]
active ] [ no modification | modification <Xdsl::ModifyStatus> ] )

Command Parameters
Table 7.21-1 "xDSL DPBO Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...50]

index of profile

Table 7.21-2 "xDSL DPBO Profile Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Xdsl::ElectricalLength>
Format:
- electrical length (1/10 * electrical-length)
- unit: 0,1 dB
- range: [0...2559]
Parameter type: <Xdsl::CableModelA>
Format:
- cable model param (2^-8 * cable-model)
- unit: 2^-8
- range: [-256...384]
Parameter type: <Xdsl::CableModelB>

mandatory parameter
name of profile

[no] es-elect-length

[no] es-cable-model-a

[no] es-cable-model-b

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0L
exchange side electrical length
optional parameter with default
value: 0L
cable model a
optional parameter with default

Released

223

7 xDSL Configuration Commands

Parameter

[no] es-cable-model-c

[no] min-usable-signal

[no] min-frequency

[no] max-frequency

[no] rs-elect-length

[no] muf-control

[no] offset

[no] active
[no] modification

224

Type

Description

Format:
- cable model param (2^-8 * cable-model)
- unit: 2^-8 Hz^-0.5
- range: [-256...384]
Parameter type: <Xdsl::CableModelC>
Format:
- cable model param (2^-8 * cable-model)
- unit: 2^-8 Hz^-1
- range: [-256...384]
Parameter type: <Xdsl::MinUsableSignalLevel>
Format:
- minimum usable signal (1/10 * min-usable-signal)
- unit: 0,1 dB
- range: [-1400...0]
Parameter type: <Xdsl::MinFrequency>
Format:
- minimum frequency
- unit: kHz
- range: [0...30000]
Parameter type: <Xdsl::MaxFrequency>
Format:
- maximum frequency
- unit: kHz
- range: [0...30000]
Parameter type: <Xdsl::RemoteSideElectricalLength>
Format:
- remote side electrical length (1/100 * rs-elect-length)
- unit: 0,01 dB
- range: [0...25599]
Parameter type: <Xdsl::MaxUsableFrequencyControl>
Format:
- maximum usable frequency (1/10 * muf-control)
- unit: 0,1 dB
- range: [0...2559,3000]
Parameter type: <Xdsl::DpboOffset>
Format:
- dpbo offset (1/10 * offset)
- unit: 0,1 dB
- range: [-2560...2559]
Parameter type: boolean

value: 0L
cable model b

Parameter type: <Xdsl::ModifyStatus>


Format:
( start
| cancel
| complete )
Possible values:
- start : to start modifying the profile
- cancel : to cancel the modifications done
- complete : to complete the modifications

Released

optional parameter with default


value: 0L
cable model c
optional parameter with default
value: -1275L
minimal usable signal level
optional parameter with default
value: 0L
min frequency
optional parameter with default
value: 30000L
max frequency
optional parameter with default
value: 0L
remote side electrical length
optional parameter with default
value: 3000L
maximal usable frequency
optional parameter with default
value: 0L
offset
optional parameter
to activate the profile
optional parameter with default
value: "complete"
modify the profile

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.22 xDSL DPBO Mode Independent Custom PSD


Mask Configuration Command
Command Description
This command specifies PSD breakpoints of DPBO Mode Independent Custom PSD Mask. A number of 2 to 32
PSD breakpoints can be specified. This parameter matches the PSDMASKds parameter described in ITU-T
G.997.1 This set of breakpoints may contain two subsets :
The first sub-set defines the DPBO Custom PSD Mask. It matches the DPBOPSDMASKds parameter described in
ITU-T G.997.1 The second sub-set (if any), defines the DPBO Minimum Override Mask. It matches the DPBOLFO
parameter described in ITU-T G.997.1 The successive PSD points of each sub-set must have increasing (>/=)
frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a same frequency
(brickwall).
The second sub-set starts at the first breakpoint whose frequency is lower than the frequency of the previous
breakpoint.
Only PSD values within the standard range from -95 to 0 dBm/Hz are guaranteed.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl dpbo-profile (index) micpsd-pt-down (psd-point)
<Xdsl::DpboFrequency> ] [ no psd | psd <Xdsl::DpboCustomPsd> ]

no

frequency

frequency

Command Parameters
Table 7.22-1 "xDSL DPBO Mode Independent Custom PSD Mask Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...50]
Format:
- psd point
- range: [1...32]

index of profile

(psd-point)

psd point

Table 7.22-2 "xDSL DPBO Mode Independent Custom PSD Mask Configuration Command"
Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

225

7 xDSL Configuration Commands

Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::DpboFrequency>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::DpboCustomPsd>
Format:
- psd level (-10 * PSD-level)
- unit: -10*dBm/Hz
- range: [0...1275]

optional parameter with default


value: 0L
psd frequency

[no] psd

226

Released

optional parameter with default


value: 0L
psd level

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.23 xDSL DPBO Exchange PSD Mask


Configuration Command
Command Description
This command specifies the Assumed Exchange PSD mask to be protected by the DPBO shaping mechanism at the
remote flexibility point. This parameter matches the DPBOEPSD parameter described in ITU-T G.997.1 A number
of 2 to 16 PSD points can be specified. The successive PSD points must have increasing (>/=) frequencies. It is
allowed that for two successive PSD points, different PSD levels are defined at a same frequency (brickwall).
Only PSD values within the standard range from -95 to 0 dBm/Hz are guaranteed.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. When any other breakpoint is set to default values, all
points following it will also be set to the default values.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl dpbo-profile (index) epsd-pt-down (psd-point) [ no frequency | frequency <Xdsl::DpboFrequency>
] [ no psd | psd <Xdsl::DpboExchangePsd> ]

Command Parameters
Table 7.23-1 "xDSL DPBO Exchange PSD Mask Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...50]
Format:
- psd point
- range: [1...16]

index of profile

(psd-point)

psd point

Table 7.23-2 "xDSL DPBO Exchange PSD Mask Configuration Command" Command Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::DpboFrequency>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::DpboExchangePsd>
Format:
- psd level (-10 * PSD-level)

optional parameter with default


value: 0L
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0L
psd level

Released

227

7 xDSL Configuration Commands

Parameter

Type

Description

- unit: -10*dBm/Hz
- range: [0...1275]

228

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.24 xDSL RTX Profile Configuration Command


Command Description
This command allows the operator to configure the RTX profile which can be used to configure the modem for a
physical Line
RTX downstream/upstream parameters will have effect, only when the retransmission feature in
downstream/upstream is not "forbidden" on the line

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no rtx-profile (index) ) | ( rtx-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no rtx-mode-dn | rtx-mode-dn <Xdsl::RtxMode> ] [ no rtx-mode-up | rtx-mode-up
<Xdsl::RtxMode> ] [ no min-exp-thrpt-dn | min-exp-thrpt-dn <Xdsl::BitRate> ] [ no min-exp-thrpt-up |
min-exp-thrpt-up <Xdsl::BitRate> ] [ no plan-exp-thrpt-dn | plan-exp-thrpt-dn <Xdsl::BitRate> ] [ no
plan-exp-thrpt-up | plan-exp-thrpt-up <Xdsl::BitRate> ] [ no max-exp-thrpt-dn | max-exp-thrpt-dn <Xdsl::BitRate>
] [ no max-exp-thrpt-up | max-exp-thrpt-up <Xdsl::BitRate> ] [ no max-net-rate-dn | max-net-rate-dn
<Xdsl::BitRate> ] [ no max-net-rate-up | max-net-rate-up <Xdsl::BitRate> ] [ no min-delay-dn | min-delay-dn
<Xdsl::RtxMinDelay> ] [ no min-delay-up | min-delay-up <Xdsl::RtxMinDelay> ] [ no max-delay-dn |
max-delay-dn <Xdsl::RtxMaxDelay> ] [ no max-delay-up | max-delay-up <Xdsl::RtxMaxDelay> ] [ no
min-inp-shine-dn | min-inp-shine-dn <Xdsl::ShineImpNoiseProtection> ] [ no min-inp-shine-up | min-inp-shine-up
<Xdsl::ShineImpNoiseProtection> ] [ no min-inp-rein-dn | min-inp-rein-dn <Xdsl::ReinImpNoiseProtection> ] [ no
min-inp-rein-up | min-inp-rein-up <Xdsl::ReinImpNoiseProtection> ] [ no int-arr-time-dn | int-arr-time-dn
<Xdsl::RtxInterArrivalTime> ] [ no int-arr-time-up | int-arr-time-up <Xdsl::RtxInterArrivalTime> ] [ no
shine-ratio-dn | shine-ratio-dn <Xdsl::RtxShineRatio> ] [ no shine-ratio-up | shine-ratio-up <Xdsl::RtxShineRatio>
] [ no leftr-thresh-dn | leftr-thresh-dn <Xdsl::RtxLeftrThreshold> ] [ no leftr-thresh-up | leftr-thresh-up
<Xdsl::RtxLeftrThreshold> ] [ [ no ] active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )

Command Parameters
Table 7.24-1 "xDSL RTX Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...128]

index of the profile

Table 7.24-2 "xDSL RTX Profile Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]

mandatory parameter
profile name

3HH-04416-EBAA-TCZZA 01

Released

229

7 xDSL Configuration Commands

Parameter

Type

version
[no] rtx-mode-dn

[no] rtx-mode-up

[no] min-exp-thrpt-dn

[no] min-exp-thrpt-up

[no] plan-exp-thrpt-dn

[no] plan-exp-thrpt-up

[no] max-exp-thrpt-dn

[no] max-exp-thrpt-up

[no] max-net-rate-dn

230

Released

Description

- length: 1<=x<=32
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: <Xdsl::RtxMode>
Format:
( forbidden
| preferred
| forced
| testmode )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
Parameter type: <Xdsl::RtxMode>
Format:
( forbidden
| preferred
| forced
| testmode )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>

optional parameter
version maintained by manager,
usually 1 for new profile
optional parameter with default
value: "preferred"
retransmission
mode
in
downstream

optional parameter with default


value: "preferred"
retransmission mode in upstream

optional parameter with default


value: 64
minimum expected throughput
for downstream direction
optional parameter with default
value: 64
minimum expected throughput
for upstream direction
optional parameter with default
value: 128
planned expected throughput for
downstream direction
optional parameter with default
value: 128
planned expected throughput for
upstream direction
optional parameter with default
value: 262143
maximum expected throughput
for downstream direction
optional parameter with default
value: 262143
maximum expected throughput
for upstream direction
optional parameter with default

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] max-net-rate-up

[no] min-delay-dn

Type

Description

Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
Format:
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::RtxMinDelay>
Format:
- a delay time period
- unit: msec
- range: [0...63]

value: 262143
maximum net data
downstream direction

[no] min-delay-up

Parameter type: <Xdsl::RtxMinDelay>


Format:
- a delay time period
- unit: msec
- range: [0...63]

[no] max-delay-dn

Parameter type: <Xdsl::RtxMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [2...63]

[no] max-delay-up

Parameter type: <Xdsl::RtxMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [2...63]

[no] min-inp-shine-dn

Parameter type: <Xdsl::ShineImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...63]
Parameter type: <Xdsl::ShineImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...63]
Parameter type: <Xdsl::ReinImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...7]
Parameter type: <Xdsl::ReinImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...7]
Parameter type: <Xdsl::RtxInterArrivalTime>
Format:

[no] min-inp-shine-up

[no] min-inp-rein-dn

[no] min-inp-rein-up

[no] int-arr-time-dn

3HH-04416-EBAA-TCZZA 01

rate

for

optional parameter with default


value: 262143
maximum net data rate for
upstream direction
optional parameter with default
value: 0
minimum instantaneous delay
allowed (due to the effect of
retransmission) for downstream
direction
optional parameter with default
value: 0
minimum instantaneous delay
allowed (due to the effect of
retransmission) for upstream
direction
optional parameter with default
value: 12
maximum instantaneous delay
allowed(due to the effect of
retransmission) for downstream
direction Special value 0 means
no delay bounds
optional parameter with default
value: 12
maximum instantaneous delay
allowed (due to the effect of
retransmission) for upstream
direction Special value 0 means
no delay bounds
optional parameter with default
value: 8
minimum
impulse
noise
protection against shine for
downstream direction
optional parameter with default
value: 8
minimum
impulse
noise
protection against shine for
upstream direction
optional parameter with default
value: 0
minimum
impulse
noise
protection against rein for
downstream direction
optional parameter with default
value: 0
minimum
impulse
noise
protection against rein for
upstream direction
optional parameter with default
value: "derivedfrom100hz"

Released

231

7 xDSL Configuration Commands

Parameter

[no] int-arr-time-up

[no] shine-ratio-dn

[no] shine-ratio-up

[no] leftr-thresh-dn

[no] leftr-thresh-up

[no] active
[no] modification

232

Type

Description

( derivedfrom100hz
| derivedfrom120hz )
Possible values:
- derivedfrom100hz : inter-arrival time derived from 100hz
- derivedfrom120hz : inter-arrival time derived from 120hz
Parameter type: <Xdsl::RtxInterArrivalTime>
Format:
( derivedfrom100hz
| derivedfrom120hz )
Possible values:
- derivedfrom100hz : inter-arrival time derived from 100hz
- derivedfrom120hz : inter-arrival time derived from 120hz
Parameter type: <Xdsl::RtxShineRatio>
Format:
- shine ratio
- unit: 1/1000
- range: [0...100]
Parameter type: <Xdsl::RtxShineRatio>
Format:
- shine ratio
- unit: 1/1000
- range: [0...100]
Parameter type: <Xdsl::RtxLeftrThreshold>
Format:
- near-end defect threshold
- unit: 1/100
- range: [0,1...99]
Parameter type: <Xdsl::RtxLeftrThreshold>
Format:
- near-end defect threshold
- unit: 1/100
- range: [0,1...99]
Parameter type: boolean

assumed inter-arrival time for


rein protection for downstream
direction

Parameter type: <Xdsl::RtxModifyStatus>


Format:
( start
| cancel
| complete )
Possible values:
- start : enable profile modifications
- cancel : stop profile modifications and cancel the changes
done
- complete : activate the changes and disable profile
modifications (other than name, version)

Released

optional parameter with default


value: "derivedfrom100hz"
assumed inter-arrival time for
rein protection for upstream
direction
optional parameter with default
value: 10
shine ratio for downstream
direction
optional parameter with default
value: 10
shine ratio for upstream direction
optional parameter with default
value: 0
threshold for declaring a near-end
defect in downstream direction
optional parameter with default
value: 0
threshold for declaring a near-end
defect in upstream direction
optional parameter
to activate the profile
optional parameter with default
value: "complete"
profile modification status of an
already created profile

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.25 xDSL Vectoring Profile Configuration


Command
Command Description
This command allows the operator to configure the vectoring profile which can be used for far end crosstalk
cancellation. The profile contains vectoring related parameters of the modem.
band-control-up/dn : are the values pairs of begin- and end-subcarriers. Maximum 8 bands can be specified. The
successive subcarriers must have increasing (>/=) values. Spectrum bands can be controlled per direction. When a
specified spectrum band overlaps both directions, the actual band control will be restricted to the configured
bandplan for the specified direction.
By default, the whole spectrum shall be used for crosstalk cancellation.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no vect-profile (index) ) | ( vect-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no fext-cancel-up | fext-cancel-up <Xdsl::VectEnable> ] [ no fext-cancel-dn | fext-cancel-dn
<Xdsl::VectEnable> ] [ [ no ] leg-can-dn-m1 ] [ [ no ] leg-can-dn-m2 ] [ [ no ] dis-gvect-cpe ] [ [ no ]
gvecfriend-cpe ] [ [ no ] gvecfriend-dn-cpe ] [ [ no ] legacy-cpe ] [ no band-control-up | band-control-up
<Xdsl::VectBandControl> ] [ no band-control-dn | band-control-dn <Xdsl::VectBandControl> ] [ no
vect-leav-thresh | vect-leav-thresh <Xdsl::VectLeavThresh> ] [ no vect-feat-bitmap | vect-feat-bitmap
<Xdsl::VectFeatValue> ] [ [ no ] active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )

Command Parameters
Table 7.25-1 "xDSL Vectoring Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...25]

index of the profile

Table 7.25-2 "xDSL Vectoring Profile Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <SignedInteger>
Format:

mandatory parameter
profile name

version

3HH-04416-EBAA-TCZZA 01

optional parameter
version maintained by manager,

Released

233

7 xDSL Configuration Commands

Parameter
[no] fext-cancel-up

[no] fext-cancel-dn

[no] leg-can-dn-m1
[no] leg-can-dn-m2

[no] dis-gvect-cpe
[no] gvecfriend-cpe
[no] gvecfriend-dn-cpe
[no] legacy-cpe
[no] band-control-up

[no] band-control-dn

[no] vect-leav-thresh

234

Released

Type

Description

- a signed integer
Parameter type: <Xdsl::VectEnable>
Format:
( enable
| disable
| full-disable )
Possible values:
- enable : enable vectoring gain and protection of other
vectored lines
- disable : disable vectoring gain and enable protection of
other vectored lines
- full-disable : disable vectoring gain and protection of other
vectored lines
Parameter type: <Xdsl::VectEnable>
Format:
( enable
| disable
| full-disable )
Possible values:
- enable : enable vectoring gain and protection of other
vectored lines
- disable : disable vectoring gain and enable protection of
other vectored lines
- full-disable : disable vectoring gain and protection of other
vectored lines
Parameter type: boolean

usually 1 for new profile


optional parameter with default
value: "enable"
enable/disable far end xtalk
cancellation in upstream direction

optional parameter with default


value: "enable"
enable/disable far end xtalk
cancellation
in
downstream
direction

optional parameter
enable method 1
Parameter type: boolean
optional parameter
enable method 2, cannot be
enabled without first enabling
method 1
Parameter type: boolean
optional parameter
disable g.vector capable cpe type
Parameter type: boolean
optional parameter
full vector friendly cpe type
(dn/up)
Parameter type: boolean
optional parameter
vector
friendly
cpe
type
downstream
Parameter type: boolean
optional parameter
legacy cpe type
Parameter type: <Xdsl::VectBandControl>
optional parameter with default
Format:
value: ""
- specify as start1:stop1:start2:stop2... with max 8 pairs of defines the upstream spectrum in
start:stop subcarriers, incrementing values within the which xtalk cancellation is not
range[0...4096] (variable string)
allowed
- length: x<=16
Parameter type: <Xdsl::VectBandControl>
optional parameter with default
Format:
value: ""
- specify as start1:stop1:start2:stop2... with max 8 pairs of defines the downstream spectrum
start:stop subcarriers, incrementing values within the in which xtalk cancellation is not
range[0...4096] (variable string)
allowed
- length: x<=16
Parameter type: <Xdsl::VectLeavThresh>
optional parameter with default
Format:
value: "8"
- specify the disorderly leaving threshold
the time between observed loss of
- unit: DMT symbols
US signal and forced cutoff of the

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] vect-feat-bitmap

[no] active
[no] modification

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [0...40000]

DS signal, expressed in DMT


symbols
optional parameter with default
value: 0
enable or disable specific
vectoring features at line level
optional parameter
to activate the profile
optional parameter with default
value: "complete"
profile modification status of an
already created profile

Parameter type: <Xdsl::VectFeatValue>


Format:
- vectoring features
- range: [0...4294967295]
Parameter type: boolean
Parameter type: <Xdsl::RtxModifyStatus>
Format:
( start
| cancel
| complete )
Possible values:
- start : enable profile modifications
- cancel : stop profile modifications and cancel the changes
done
- complete : activate the changes and disable profile
modifications (other than name, version)

Released

235

7 xDSL Configuration Commands

7.26 xDSL Vectoring Control Entity Profile


Configuration Command
Command Description
This command allows the operator to configure the vectoring control entity profile. The profile contains vectoring
processing related parameters.
vce-min-par-join: Specifies the supported amount of lines for a group joining, with the intention to avoid impact on
active lines. The system should reserve room to guarantee that at least the specified number of lines can join in
parallel. At the moment multiple lines are joining, this is achieved by not canceling the same number of disturbers
which normally could be canceled in the system.
vce-band-plan: The bandplan needs to cover the widest bandplan up to the highest possible frequency that could be
configured via the spectrum profiles to the individual vectored lines. The goal is to force same upstream and
downstream band edges for all lines controlled by the vector control entity, except for differences in US0 frequency
limits (TypeA, TypeB, TypeM). When changing this parameter, all lines connected to this vectoring control entity
need to be re-initialized.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no vce-profile (index) ) | ( vce-profile (index) name <AsamProfileName> [ version
<SignedInteger> ] [ no vce-gain-mode | vce-gain-mode <Xdsl::VectGainAchievedMode> ] [ no vce-join-timeout |
vce-join-timeout <Xdsl::VectJoinTime> ] [ no vce-min-par-join | vce-min-par-join <Xdsl::VectMinParallelJoins> ]
[ no vce-hist-pcoder | vce-hist-pcoder <Xdsl::VectHistPrePostCoder> ] [ no vce-band-plan | vce-band-plan
<Xdsl::VectBandPlan> ] [ [ no ] active ] [ no modification | modification <Xdsl::RtxModifyStatus> ] )

Command Parameters
Table 7.26-1 "xDSL Vectoring Control Entity Profile Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...25]

index of the profile

Table 7.26-2 "xDSL Vectoring Control Entity Profile Configuration Command" Command
Parameters
Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name

mandatory parameter
profile name

236

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
version
[no] vce-gain-mode

[no] vce-join-timeout

[no] vce-min-par-join

[no] vce-hist-pcoder

[no] vce-band-plan

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: <Xdsl::VectGainAchievedMode>
Format:
( at-init
| after-reset
| during-showtime )
Possible values:
- at-init : gain achieved at init
- after-reset : gain achieved in showtime only after board
reset, in all other cases gain achieved at init
- during-showtime : gain achieved during showtime
(tracking)
Parameter type: <Xdsl::VectJoinTime>
Format:
( auto
| <Xdsl::VectJoinTimeout> )
Possible values:
- auto : waiting time selected by the system
Field type <Xdsl::VectJoinTimeout>
- specify the queuing time
- unit: sec
- range: [0,1...40]
Parameter type: <Xdsl::VectMinParallelJoins>
Format:
( not-specified
| <Xdsl::VectParallelJoins> )
Possible values:
- not-specified : amount of lines for group joining is not
specified
Field type <Xdsl::VectParallelJoins>
- specify the supported amount of lines for a group joining
- unit: lines
- range: [1...48]
Parameter type: <Xdsl::VectHistPrePostCoder>
Format:
( disable
| enable1-2
| enable2 )
Possible values:
- disable : historical pre-/postcoder disabled
- enable1-2 : historical pre-/postcoder enabled in phase1-2
- enable2 : historical pre-/postcoder enabled in phase2
Parameter type: <Xdsl::VectBandPlan>
Format:
( annex-a
| annex-b-997e
| annex-b-998e
| annex-b-998ade
| annex-b-hpe )
Possible values:
- annex-a : ITU-T G.993.2 VDSL2 Annex A (extended)
band plan
- annex-b-997e : ITU-T G.993.2 VDSL2 Annex B band plan

optional parameter
version maintained by manager,
usually 1 for new profile
optional parameter with default
value: "at-init"
vectoring control entity gain
achieved mode

optional parameter with default


value: "15"
vectoring control entity join
timeout

optional parameter with default


value: "8"
vectoring control entity min
parallel joinings

optional parameter with default


value: "disable"
vectoring control entity historical
pre/post coder

optional parameter with default


value: "annex-b-998ade"
vectoring control entity band plan

Released

237

7 xDSL Configuration Commands

Parameter

Type

[no] active
[no] modification

238

Description

type 997E
- annex-b-998e : ITU-T G.993.2 VDSL2 Annex B band plan
type 998E
- annex-b-998ade : ITU-T G.993.2 VDSL2 Annex B band
plan type 998ADE
- annex-b-hpe : ITU-T G.993.2 VDSL2 Annex B band plan
type HPE
Parameter type: boolean
optional parameter
to activate the profile
Parameter type: <Xdsl::RtxModifyStatus>
optional parameter with default
Format:
value: "complete"
( start
profile modification status of an
| cancel
already created profile
| complete )
Possible values:
- start : enable profile modifications
- cancel : stop profile modifications and cancel the changes
done
- complete : activate the changes and disable profile
modifications (other than name, version)

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.27 xDSL Board Configuration Command


Command Description
This command allows the operator to configure xdsl parameters related with a specific board.
An already existing Downstream-Power-Back-Off(DPBO)-profile can be attached to a board.
All lines on this board will use this DPBO-profile unless a line-specific DPBO-profile is configured.
To deconfigure the DBPO-profile, it has to be put to 0.
An already existing Vectoring-Control-Entity(VCE)-profile can be attached to a Board-Level-Vectoring(BLV)-LT
or to a System-Level-Vectoring(SLV)-VP board. The VCE-profile is applicable for vectoring cancellation of all the
physical lines which can be vectored by the board. Note that a physical line can only be vectored if also an xDSL
Vectoring profile has been assigned to the line.
The auto detect functions of the LT-VP connection can be enabled or disabled on SLV LT boards and VP boards. It
should be enabled for 7363 systems.
The vce-capacity-mode is specific for 7363 systems. It only applies to VP boards, not to LT boards. The xDSL-lines
of the SLV-LTs, which are positioned in the 3 highest lt-slots, can only be vectored when the vectoring capacity
mode is extended.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl board (board-index) [ no dpbo-profile | dpbo-profile <Xdsl::LineDpboProfile> ] [ no vce-profile |
vce-profile <Xdsl::BoardVceProfile> ] [ no vplt-autodiscover | vplt-autodiscover <Xdsl::autoDiscoverState> ] [ no
vce-capacity-mode | vce-capacity-mode <Xdsl::vceCapacityMode> ]

Command Parameters
Table 7.27-1 "xDSL Board Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

board index

3HH-04416-EBAA-TCZZA 01

Released

239

7 xDSL Configuration Commands

Table 7.27-2 "xDSL Board Configuration Command" Command Parameters


Parameter

Type

Description

[no] dpbo-profile

Parameter type: <Xdsl::LineDpboProfile>


Format:
( none
| <Xdsl::DpboProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::DpboProfilePointer>
- profile index
- range: [0...50]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::BoardVceProfile>
Format:
( none
| <Xdsl::VceProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::VceProfilePointer>
- profile index
- range: [0...25]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::autoDiscoverState>
Format:
( disable
| enable )
Possible values:
- disable : disable auto discovery
- enable : enable auto discovery
Parameter type: <Xdsl::vceCapacityMode>
Format:
( normal
| extended )
Possible values:
- normal : de-activate the extended vectoring capacity OR
indicates normal behavior for boards which do not support
extended goring capacity
- extended : activate the extended vectoring capacity

optional parameter with default


value: "none"
dpbo profile index

[no] vce-profile

[no] vplt-autodiscover

[no] vce-capacity-mode

optional parameter with default


value: "none"
vce profile index

optional parameter with default


value: "disable"
enable or disable the VPLT auto
discovery function

optional parameter with default


value: "normal"
activate/de-activate
extended
vectoring capacity mode

Command Output
Table 7.27-3 "xDSL Board Configuration Command" Display parameters
Specific Information
name

Type

Description

dpbo-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

vce-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

name of the dpbo profile


This element is only shown in
detail mode.
name of the vectoring control
entity profile
This element is only shown in

240

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

name

Type

Description
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

241

7 xDSL Configuration Commands

7.28 xDSL Board Vectoring Fallback Configuration


Command
Command Description
This command allows the operator to configure per board the profile selection in case the line enters the vectoring
fallback mode.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl board (board-index) vect-fallback [ [ no ] fb-vplt-com-fail ] [ [ no ] fb-cpe-cap-mism ] [ [ no ]
fb-conf-not-feas ] [ no spectrum-profile | spectrum-profile <Xdsl::VectFbSpectrumProfile> ] [ no service-profile |
service-profile <Xdsl::VectFbServiceProfile> ] [ no dpbo-profile | dpbo-profile <Xdsl::VectFbDpboProfile> ] [ no
rtx-profile | rtx-profile <Xdsl::VectFbRtxProfile> ]

Command Parameters
Table 7.28-1 "xDSL Board Vectoring Fallback Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

board index

Table 7.28-2 "xDSL Board Vectoring Fallback Configuration Command" Command Parameters
Parameter

Type

Description

[no] fb-vplt-com-fail

Parameter type: boolean

[no] fb-cpe-cap-mism

Parameter type: boolean

[no] fb-conf-not-feas

Parameter type: boolean

optional parameter
allow fallback mode for vplt
communication failure
optional parameter
allow fallback mode for cpe
capability mismatch
optional parameter
allow
fallback
mode
for

242

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

[no] spectrum-profile

Parameter type: <Xdsl::VectFbSpectrumProfile>


Format:
( line-level
| <Xdsl::VectFbSpectrumProfilePointer>
| name : <PrintableString> )
Possible values:
- line-level : use the original line spectrum profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbSpectrumProfilePointer>
- a profile index value
- range: [1...256]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::VectFbServiceProfile>
Format:
( line-level
| <Xdsl::VectFbServiceProfilePointer>
| name : <PrintableString> )
Possible values:
- line-level : use the original line service profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbServiceProfilePointer>
- a profile index value
- range: [1...1024]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::VectFbDpboProfile>
Format:
( none
| line-level
| <Xdsl::VectFbDpboProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no fallback profile to associate
- line-level : use the original line dpbo profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbDpboProfilePointer>
- a profile index value
- range: [0...50]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::VectFbRtxProfile>
Format:
( none
| line-level
| <Xdsl::VectFbRtxProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no fallback profile to associate
- line-level : use the original line rtx profile in fallback mode
- name : profile name
Field type <Xdsl::VectFbRtxProfilePointer>
- a profile index value

[no] service-profile

[no] dpbo-profile

[no] rtx-profile

3HH-04416-EBAA-TCZZA 01

Description
configuration not feasable
optional parameter with default
value: "line-level"
spectrum profile index

optional parameter with default


value: "line-level"
service profile index

optional parameter with default


value: "line-level"
dpbo profile index

optional parameter with default


value: "line-level"
rtx profile index

Released

243

7 xDSL Configuration Commands

Parameter

Type

Description

- range: [0...128]
Field type <PrintableString>
- printable string

Command Output
Table 7.28-3 "xDSL Board Vectoring Fallback Configuration Command" Display parameters
Specific Information
name

Type

Description

spectrum-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

service-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

dpbo-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

rtx-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

name of the spectrum profile


This element is only shown in
detail mode.
name of the service profile
This element is only shown in
detail mode.
name of the dpbo profile
This element is only shown in
detail mode.
name of the vectoring control
entity profile
This element is only shown in
detail mode.

244

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.29 xDSL Vectoring Processing Board


Configuration Command
Command Description
This command allows the operator to configure which LTs should be connected to the vp-board. The lines on these
LTs are expected to be vectored.
Configuring the links bewteen a vp-board and its LTs is only allowed as long as the VPLT auto dicovery feature is
disabled for the vp-board.
Configuring is not allowed for 7363 systems.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl vp-board
<Xdsl::LsmBoardOrZero> ]

(board-index)

vp-link

<Xdsl::VectVpLink>

no

lt-expect

lt-expect

Command Parameters
Table 7.29-1 "xDSL Vectoring Processing Board Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Xdsl::VectVpLink>
Format:
- specifies the vp-link or the soft-link on the vp-board
- range: [1...8]

vp board index

vp-link

the link on the vp board

Table 7.29-2 "xDSL Vectoring Processing Board Configuration Command" Command Parameters
Parameter

Type

Description

[no] lt-expect

Parameter type: <Xdsl::LsmBoardOrZero>


Format:

optional parameter with default


value: "none"

3HH-04416-EBAA-TCZZA 01

Released

245

7 xDSL Configuration Commands

Parameter

246

Released

Type

Description

( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>


| none )
Possible values:
- none : lt board not specified
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

expected lt board slot index

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.30 xDSL Line Configuration Command


Command Description
This command allows the operator to configure the xDSL line. For the configuration one should associate a
spectrum, a service, a downstream power backoff and a retransmission profile to the line.
In case the operator wants to have crosstalk cancellation, a non-null vectoring profile should be associated to a
VDSL2 line. Any vectoring profile assigned to a line running in ADSLx mode will be ignored. The vectoring license
counter is incremented when a vectoring profile is assigned to an installed xdsl line, independent of its running
mode.
Note: Vectoring Control Engine parameters should be configured via a vce-profile. The vce-profile is applicable
for vectoring cancellation of all the physical lines which can be vectored by the board to which the vce-profile has
been attached.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) [ no service-profile | service-profile <Xdsl::LineServiceProfile> ] [ no
spectrum-profile | spectrum-profile <Xdsl::LineSpectrumProfile> ] [ no dpbo-profile | dpbo-profile
<Xdsl::LineDpboProfile> ] [ no rtx-profile | rtx-profile <Xdsl::LineRtxProfile> ] [ no vect-profile | vect-profile
<Xdsl::LineVectProfile> ] [ [ no ] ansi-t1413 ] [ [ no ] etsi-dts ] [ [ no ] g992-1-a ] [ [ no ] g992-1-b ] [ [ no ]
g992-2-a ] [ [ no ] g992-3-a ] [ [ no ] g992-3-b ] [ [ no ] g992-3-aj ] [ [ no ] g992-3-l1 ] [ [ no ] g992-3-l2 ] [ [ no ]
g992-3-am ] [ [ no ] g992-5-a ] [ [ no ] g992-5-b ] [ [ no ] ansi-t1.424 ] [ [ no ] etsi-ts ] [ [ no ] itu-g993-1 ] [ [ no ]
ieee-802.3ah ] [ [ no ] g992-5-aj ] [ [ no ] g992-5-am ] [ [ no ] g993-2-8a ] [ [ no ] g993-2-8b ] [ [ no ] g993-2-8c ] [
[ no ] g993-2-8d ] [ [ no ] g993-2-12a ] [ [ no ] g993-2-12b ] [ [ no ] g993-2-17a ] [ [ no ] g993-2-30a ] [ no
carrier-data-mode | carrier-data-mode <Xdsl::CarrierDataMode> ] [ [ no ] admin-up ] [ bonding-mode
<Xdsl::BondingMode> ] [ no transfer-mode | transfer-mode <Xdsl::TpsTcMode> ] [ [ no ] imp-noise-sensor ] [ no
vect-qln-mode | vect-qln-mode <Xdsl::QLNmode> ] [ [ no ] auto-switch ]

Command Parameters
Table 7.30-1 "xDSL Line Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>

3HH-04416-EBAA-TCZZA 01

Description

Released

247

7 xDSL Configuration Commands

Resource Identifier

Type

Description

- the port number

Table 7.30-2 "xDSL Line Configuration Command" Command Parameters


Parameter

Type

Description

[no] service-profile

Parameter type: <Xdsl::LineServiceProfile>


Format:
( none
| <Xdsl::SrvcProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::SrvcProfilePointer>
- profile index
- range: [0...1024]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::LineSpectrumProfile>
Format:
( none
| <Xdsl::ProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::ProfilePointer>
- profile index
- range: [0...256]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::LineDpboProfile>
Format:
( none
| <Xdsl::DpboProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::DpboProfilePointer>
- profile index
- range: [0...50]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::LineRtxProfile>
Format:
( none
| <Xdsl::RtxProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::RtxProfilePointer>
- profile index
- range: [0...128]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::LineVectProfile>

optional parameter with default


value: "none"
service profile to be configured
on this port

[no] spectrum-profile

[no] dpbo-profile

[no] rtx-profile

[no] vect-profile

248

Released

optional parameter with default


value: "none"
spectrum profile to be configured
on this port

optional parameter with default


value: "none"
dpbo profile to be configured on
this port

optional parameter with default


value: "none"
rtx profile to be configured on
this line

optional parameter with default

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description
value: "none"
vectoring profile to be configured
on this line

[no] ansi-t1413

Format:
( none
| <Xdsl::VectProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::VectProfilePointer>
- profile index
- range: [0...25]
Field type <PrintableString>
- printable string
Parameter type: boolean

[no] etsi-dts

Parameter type: boolean

[no] g992-1-a

Parameter type: boolean

[no] g992-1-b

Parameter type: boolean

[no] g992-2-a

Parameter type: boolean

[no] g992-3-a

Parameter type: boolean

[no] g992-3-b

Parameter type: boolean

[no] g992-3-aj

Parameter type: boolean

[no] g992-3-l1

Parameter type: boolean

[no] g992-3-l2

Parameter type: boolean

[no] g992-3-am

Parameter type: boolean

[no] g992-5-a

Parameter type: boolean

[no] g992-5-b

Parameter type: boolean

[no] ansi-t1.424

Parameter type: boolean

[no] etsi-ts

Parameter type: boolean

[no] itu-g993-1

Parameter type: boolean

[no] ieee-802.3ah

Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

optional parameter
ANSI T1.413-1998
optional parameter
ETSI DTS/TM06006
optional parameter
G.992.1 POTS non-overlapped
spectrum
optional parameter
G.992.1 ISDN non-overlapped
spectrum
optional parameter
G.992.2 POTS non-overlapped
spectrum
optional parameter
G.992.3 POTS non-overlapped
spectrum
optional parameter
G.992.3 ISDN non-overlapped
spectrum
optional parameter
G.992.3
all
digital
mode
non-overlapped spectrum
optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 1
optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 2
optional parameter
G.992.3 extended POTS with
non-overlapped spectrum
optional parameter
G.992.5 POTS non-overlapped
spectrum
optional parameter
G.992.5 ISDN non-overlapped
spectrum
optional parameter
ANSI T1.424
optional parameter
ETSI TS
optional parameter
ITU G993-1
optional parameter
IEEE 802.3ah

Released

249

7 xDSL Configuration Commands

Parameter

Type

Description

[no] g992-5-aj

Parameter type: boolean

[no] g992-5-am

Parameter type: boolean

[no] g993-2-8a

Parameter type: boolean

[no] g993-2-8b

Parameter type: boolean

[no] g993-2-8c

Parameter type: boolean

[no] g993-2-8d

Parameter type: boolean

[no] g993-2-12a

Parameter type: boolean

[no] g993-2-12b

Parameter type: boolean

[no] g993-2-17a

Parameter type: boolean

[no] g993-2-30a

Parameter type: boolean

[no] carrier-data-mode

Parameter type: <Xdsl::CarrierDataMode>


Format:
( off
| on
| on-init )
Possible values:
- off : disable the collection
- on : enable the collection
- on-init : enable and re-initialize the line
Parameter type: boolean

optional parameter
G.992.5
all
digital
mode
non-overlapped spectrum
optional parameter
G.992.5
extended
POTS
non-overlapped spectrum
optional parameter
G.993.2_8A VDSL-2 with profile
8A
optional parameter
G.993.2_8B VDSL-2 with profile
8B
optional parameter
G.993.2_8C VDSL-2 with profile
8C
optional parameter
G.993.2_8D VDSL-2 with profile
8D
optional parameter
G.993.2_12A VDSL-2 with
profile 12A
optional parameter
G.993.2_12B
VDSL-2
with
profile 12B
optional parameter
G.993.2_17A VDSL-2 with
profile 17A
optional parameter
G.993.2_30A VDSL-2 with
profile 30A
optional parameter with default
value: "off"
carrier
data
measurement
collection

[no] admin-up
bonding-mode

Parameter type: <Xdsl::BondingMode>


Format:
( native
| atm-bonding
| bonding )
Possible values:
- native : (deprecated)native mode for channel-1
- atm-bonding : (deprecated)atm bonding mode for
channel-1
obsolete alternative replaced by bonding
- bonding : (deprecated)bonding mode for channel-1
Parameter type: <Xdsl::TpsTcMode>
optional parameter with default
Format:
value: "system-default"
( atm
tps tc mode
| ptm

[no] transfer-mode

250

optional parameter
set the admin-state of the line to
up
obsolete parameter that will be
ignored
channel-1 bonding mode

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

[no] imp-noise-sensor
[no] vect-qln-mode

[no] auto-switch

Description

| system-default )
Possible values:
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type
Parameter type: boolean
optional parameter
disable impulse noise monitoring
on this xdsl line
Parameter type: <Xdsl::QLNmode>
optional parameter with default
Format:
value: "without-cancel"
( without-cancel
specify the quiet line noise
| with-cancel )
reporting mode
Possible values:
- without-cancel : without cancellation
- with-cancel : with cancellation
Parameter type: boolean
optional parameter
enable auto-switch feature on
xdsl line

Command Output
Table 7.30-3 "xDSL Line Configuration Command" Display parameters
Specific Information
name

Type

Description

service-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

spectrum-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

dpbo-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

rtx-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

vect-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

overrule-state

Parameter type: <Xdsl::OverruleState>


( not-created
| created-no-overrules
| created-overrules )
Possible values:
- not-created : not created
- created-no-overrules : created no overrules
- created-overrules : created overrules

name of the service profile


This element is only shown in
detail mode.
name of the spectrum profile
This element is only shown in
detail mode.
name of the dpbo profile
This element is only shown in
detail mode.
name of the rtx profile
This element is only shown in
detail mode.
name of the vectoring profile
This element is only shown in
detail mode.
indicates whether an overrule
record is configured and if it are
not all 'no-overrules'
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

251

7 xDSL Configuration Commands

7.31 xDSL Line TCA Threshold Configuration


Command
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per xdsl line.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) tca-line-threshold [ [ no ] enable ] [ no es-nearend | es-nearend
<Xdsl::IntervalTcaThreshold> ] [ no ses-nearend | ses-nearend <Xdsl::IntervalTcaThreshold> ] [ no uas-nearend |
uas-nearend <Xdsl::IntervalTcaThreshold> ] [ no leftr-nearend | leftr-nearend <Xdsl::IntervalTcaThreshold> ] [ no
leftr-day-nearend | leftr-day-nearend <Xdsl::DayTcaThreshold> ] [ no es-day-nearend | es-day-nearend
<Xdsl::DayTcaThreshold> ] [ no ses-day-nearend | ses-day-nearend <Xdsl::DayTcaThreshold> ] [ no
uas-day-nearend | uas-day-nearend <Xdsl::DayTcaThreshold> ] [ no es-farend | es-farend
<Xdsl::IntervalTcaThreshold> ] [ no ses-farend | ses-farend <Xdsl::IntervalTcaThreshold> ] [ no uas-farend |
uas-farend <Xdsl::IntervalTcaThreshold> ] [ no es-day-farend | es-day-farend <Xdsl::DayTcaThreshold> ] [ no
ses-day-farend | ses-day-farend <Xdsl::DayTcaThreshold> ] [ no uas-day-farend | uas-day-farend
<Xdsl::DayTcaThreshold> ] [ no leftr-farend | leftr-farend <Xdsl::IntervalTcaThreshold> ] [ no leftr-day-farend |
leftr-day-farend <Xdsl::DayTcaThreshold> ]

Command Parameters
Table 7.31-1 "xDSL Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 7.31-2 "xDSL Line TCA Threshold Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

optional parameter

252

Released

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter
[no] es-nearend

[no] ses-nearend

[no] uas-nearend

[no] leftr-nearend

[no] leftr-day-nearend

[no] es-day-nearend

[no] ses-day-nearend

[no] uas-day-nearend

[no] es-farend

[no] ses-farend

[no] uas-farend

[no] es-day-farend

[no] ses-day-farend

[no] uas-day-farend

3HH-04416-EBAA-TCZZA 01

Type
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable

Description
enable the reporting of TCA's for
this XDSL line
optional parameter with default
value: 0
errored seconds at the near end
optional parameter with default
value: 0
severely errored seconds at the
near end
optional parameter with default
value: 0
unavailable seconds at the near
end
optional parameter with default
value: 0
leftr seconds at the near end
optional parameter with default
value: 0
leftr seconds at the near end for a
day
optional parameter with default
value: 0
errored seconds at the near end
for a day
optional parameter with default
value: 0
severely errored seconds at the
near end for a day
optional parameter with default
value: 0
unavailable seconds at the near
end for a day
optional parameter with default
value: 0
errored seconds at the far end
optional parameter with default
value: 0
severely errored seconds at the
far end
optional parameter with default
value: 0
unavailable seconds at the far end
optional parameter with default
value: 0
errored seconds at the far end for
a day
optional parameter with default
value: 0
severely errored seconds at the
far end for a day
optional parameter with default
value: 0
unavailable seconds at the far end

Released

253

7 xDSL Configuration Commands

Parameter
[no] leftr-farend

[no] leftr-day-farend

254

Released

Type

Description

- range: [0...86400]
Parameter type: <Xdsl::IntervalTcaThreshold>
Format:
- the tca threshold for errored second, 0 - disable
- range: [0...900]
Parameter type: <Xdsl::DayTcaThreshold>
Format:
- the tca threshold for a day errored second, 0 - disable
- range: [0...86400]

for a day
optional parameter with default
value: 0
leftr seconds at the far end
optional parameter with default
value: 0
leftr seconds at the far end for a
day

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

7.32 xDSL Per Line Overrule Configuration


Command
Command Description
This command allows the operator to manage part of the DSL OverruleData. The OverruleData parameters give
the ability to the operator to overrule per-line parameters defined in service/spectrum / retransmission profiles.
RTX downstream/upstream parameters will be overruled when the retransmission feature in downstream/upstream
is different from "forbidden" value on the line. As long as the RTX downstream/upstream feature has not been
enabled, the other RTX downstream/upstream parameters will have no effect on the line.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl ( no overrule-data (if-index) ) | ( overrule-data (if-index) [ no max-bitrate-down |
max-bitrate-down <Xdsl::OverruleBitRate> ] [ no max-bitrate-up | max-bitrate-up <Xdsl::OverruleBitRate> ] [ no
max-delay-down | max-delay-down <Xdsl::OverruleInterleavingDelay> ] [ no max-delay-up | max-delay-up
<Xdsl::OverruleInterleavingDelay>
]
[
no
imp-noise-prot-dn
|
imp-noise-prot-dn
<Xdsl::OverruleImpNoiseProtection>
]
[
no
imp-noise-prot-up
|
imp-noise-prot-up
<Xdsl::OverruleImpNoiseProtection>
]
[
no
trgt-noise-down
|
trgt-noise-down
<Xdsl::OverruleTargetNoiseMargin> ] [ no trgt-noise-up | trgt-noise-up <Xdsl::OverruleTargetNoiseMargin> ] [ no
max-psd-down | max-psd-down <Xdsl::OverrulePsdLevel> ] [ no max-psd-up | max-psd-up
<Xdsl::OverrulePsdLevel> ] [ no carrier-mask-down | carrier-mask-down <Xdsl::OverruleCarrierMaskDown> ] [
no carrier-mask-up | carrier-mask-up <Xdsl::OverruleCarrierMaskUp> ] [ no noise-psd-mode-dn |
noise-psd-mode-dn <Xdsl::OverruleNoiseModeDown> ] [ no noise-psd-mode-up | noise-psd-mode-up
<Xdsl::OverruleNoiseModeUp> ] [ no rtx-mode-dn | rtx-mode-dn <Xdsl::RtxOverruleMode> ] [ no rtx-mode-up |
rtx-mode-up <Xdsl::RtxOverruleMode> ] [ no max-net-rate-dn | max-net-rate-dn <Xdsl::RtxRate> ] [ no
max-net-rate-up | max-net-rate-up <Xdsl::RtxRate> ] [ no max-exp-thrpt-dn | max-exp-thrpt-dn <Xdsl::RtxRate> ] [
no max-exp-thrpt-up | max-exp-thrpt-up <Xdsl::RtxRate> ] [ no min-inp-shine-dn | min-inp-shine-dn
<Xdsl::RtxShineImpNoiseProtection>
]
[
no
min-inp-shine-up
|
min-inp-shine-up
<Xdsl::RtxShineImpNoiseProtection>
]
[
no
min-inp-rein-dn
|
min-inp-rein-dn
<Xdsl::RtxReinImpNoiseProtection> ] [ no min-inp-rein-up | min-inp-rein-up <Xdsl::RtxReinImpNoiseProtection>
] [ no min-delay-dn | min-delay-dn <Xdsl::RtxOverruleMinDelay> ] [ no min-delay-up | min-delay-up
<Xdsl::RtxOverruleMinDelay> ] [ no rtx-max-delay-dn | rtx-max-delay-dn <Xdsl::RtxOverruleMaxDelay> ] [ no
rtx-max-delay-up | rtx-max-delay-up <Xdsl::RtxOverruleMaxDelay> ] [ no shine-ratio-dn | shine-ratio-dn
<Xdsl::RtxOverruleShineRatio> ] [ no shine-ratio-up | shine-ratio-up <Xdsl::RtxOverruleShineRatio> ] [ no
leftr-thresh-dn | leftr-thresh-dn <Xdsl::RtxOverruleLeftrThreshold> ] [ no leftr-thresh-up | leftr-thresh-up
<Xdsl::RtxOverruleLeftrThreshold> ] [ no memory-down | memory-down <Xdsl::OverruleMemoryDownstream> ]
[ no modification | modification <Xdsl::ModifyStatus> ] [ [ no ] active ] )

Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

255

7 xDSL Configuration Commands

Table 7.32-1 "xDSL Per Line Overrule Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 7.32-2 "xDSL Per Line Overrule Configuration Command" Command Parameters
Parameter

Type

Description

[no] max-bitrate-down

Parameter type: <Xdsl::OverruleBitRate>


Format:
( no-overrule
| <Xdsl::OverruleBitRate> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleBitRate>
- bitrate
- unit: kbit/s
- range: [0...262143]
Parameter type: <Xdsl::OverruleBitRate>
Format:
( no-overrule
| <Xdsl::OverruleBitRate> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleBitRate>
- bitrate
- unit: kbit/s
- range: [0...262143]
Parameter type: <Xdsl::OverruleInterleavingDelay>
Format:
( no-overrule
| <Xdsl::OverruleInterleavingDelay> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleInterleavingDelay>
- maximum interleaving delay
- unit: ms
- range: [1...63]
Parameter type: <Xdsl::OverruleInterleavingDelay>
Format:
( no-overrule
| <Xdsl::OverruleInterleavingDelay> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleInterleavingDelay>
- maximum interleaving delay
- unit: ms
- range: [1...63]
Parameter type: <Xdsl::OverruleImpNoiseProtection>

optional parameter with default


value: "no-overrule"
maximum bitrate down

[no] max-bitrate-up

[no] max-delay-down

[no] max-delay-up

[no] imp-noise-prot-dn

256

Released

optional parameter with default


value: "no-overrule"
maximum bitrate up

optional parameter with default


value: "no-overrule"
maximum interleaving delay
down

optional parameter with default


value: "no-overrule"
maximum interleaving delay up

optional parameter with default

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] imp-noise-prot-up

[no] trgt-noise-down

[no] trgt-noise-up

[no] max-psd-down

[no] max-psd-up

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( no-overrule
| <Xdsl::OverruleImpNoiseProtection> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleImpNoiseProtection>
- minimum impulse noise protection
- unit: 0.1 symbols
- range: [0...160]
Parameter type: <Xdsl::OverruleImpNoiseProtection>
Format:
( no-overrule
| <Xdsl::OverruleImpNoiseProtection> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleImpNoiseProtection>
- minimum impulse noise protection
- unit: 0.1 symbols
- range: [0...160]
Parameter type: <Xdsl::OverruleTargetNoiseMargin>
Format:
( no-overrule
| <Xdsl::OverruleTargetNoiseMargin> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleTargetNoiseMargin>
- target noise margin
- unit: dB / 10
- range: [0...310]
Parameter type: <Xdsl::OverruleTargetNoiseMargin>
Format:
( no-overrule
| <Xdsl::OverruleTargetNoiseMargin> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleTargetNoiseMargin>
- target noise margin
- unit: dB / 10
- range: [0...310]
Parameter type: <Xdsl::OverrulePsdLevel>
Format:
( no-overrule
| no-constraint
| <Xdsl::OverrulePsdLevel> )
Possible values:
- no-overrule : no overrule
- no-constraint : no overrule
Field type <Xdsl::OverrulePsdLevel>
- overrule psd level
- unit: dBm/Hz * 1/10
- range: [-955...0]
Parameter type: <Xdsl::OverrulePsdLevel>
Format:
( no-overrule
| no-constraint
| <Xdsl::OverrulePsdLevel> )
Possible values:

value: "no-overrule"
minimum
impulse
protection down

noise

optional parameter with default


value: "no-overrule"
minimum
impulse
noise
protection up

optional parameter with default


value: "no-overrule"
target noise margin down

optional parameter with default


value: "no-overrule"
target noise margin up

optional parameter with default


value: "no-overrule"
maximum psd level down

optional parameter with default


value: "no-overrule"
maximum psd level up

Released

257

7 xDSL Configuration Commands

Parameter

Type

[no] carrier-mask-down

[no] carrier-mask-up

[no] noise-psd-mode-dn

[no] noise-psd-mode-up

[no] rtx-mode-dn

[no] rtx-mode-up

258

Released

Description

- no-overrule : no overrule
- no-constraint : no overrule
Field type <Xdsl::OverrulePsdLevel>
- overrule psd level
- unit: dBm/Hz * 1/10
- range: [-955...0]
Parameter type: <Xdsl::OverruleCarrierMaskDown>
Format:
( no-overrule
| <Xdsl::OverruleCarrierMaskDown> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleCarrierMaskDown>
- overrule carrier mask down
- length: 64
Parameter type: <Xdsl::OverruleCarrierMaskUp>
Format:
( no-overrule
| <Xdsl::OverruleCarrierMaskUp> )
Possible values:
- no-overrule : no overrule
Field type <Xdsl::OverruleCarrierMaskUp>
- overrule carrier mask up
- length: 8
Parameter type: <Xdsl::OverruleNoiseModeDown>
Format:
( no-overrule
| virtual
| artificial )
Possible values:
- no-overrule : no overrule
- virtual : overrule Tx referred virtual noise
- artificial : overrule artificial noise
Parameter type: <Xdsl::OverruleNoiseModeUp>
Format:
( no-overrule
| virtual
| virtual-rx )
Possible values:
- no-overrule : no overrule
- virtual : overrule Tx referred virtual noise
- virtual-rx : overrule Rx referred virtual noise
Parameter type: <Xdsl::RtxOverruleMode>
Format:
( forbidden
| preferred
| forced
| testmode
| nooverrule )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
- nooverrule : retransmission nooverrule in down/upstream
Parameter type: <Xdsl::RtxOverruleMode>
Format:

optional parameter with default


value: "no-overrule"
overrule carrier mask down

optional parameter with default


value: "no-overrule"
overrule carrier mask up

optional parameter with default


value: "no-overrule"
noise overrule mode

optional parameter with default


value: "no-overrule"
noise overrule mode

optional parameter with default


value: "nooverrule"
overrule retransmission mode in
downstream on lines

optional parameter with default


value: "nooverrule"

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] max-net-rate-dn

Type

Description

( forbidden
| preferred
| forced
| testmode
| nooverrule )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
- nooverrule : retransmission nooverrule in down/upstream
Parameter type: <Xdsl::RtxRate>
Format:
- a data rate value
- unit: kbit/s
- range: [-1,0...262143]

overrule retransmission mode in


upstream on lines

[no] max-net-rate-up

Parameter type: <Xdsl::RtxRate>


Format:
- a data rate value
- unit: kbit/s
- range: [-1,0...262143]

[no] max-exp-thrpt-dn

Parameter type: <Xdsl::RtxRate>


Format:
- a data rate value
- unit: kbit/s
- range: [-1,0...262143]

[no] max-exp-thrpt-up

Parameter type: <Xdsl::RtxRate>


Format:
- a data rate value
- unit: kbit/s
- range: [-1,0...262143]

[no] min-inp-shine-dn

Parameter type: <Xdsl::RtxShineImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [-1,0...63]

[no] min-inp-shine-up

Parameter type: <Xdsl::RtxShineImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [-1,0...63]

[no] min-inp-rein-dn

Parameter type: <Xdsl::RtxReinImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [-1,0...7]

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: -1
overrule maximum net data rate
for downstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule maximum net data rate
for upstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule maximum expected
throughput
for
downstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule maximum expected
throughput
for
upstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule minimum impulse noise
protection against shine for
downstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule minimum impulse noise
protection against shine for
upstream direction, special value
-1 means the rtxprofile parameter
will not be overruled
optional parameter with default
value: -1
overrule minimum impulse noise
protection against rein for
downstream direction, special
value -1 means the rtxprofile

Released

259

7 xDSL Configuration Commands

Parameter

Type

[no] min-inp-rein-up

Parameter type: <Xdsl::RtxReinImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [-1,0...7]

[no] min-delay-dn

Parameter type: <Xdsl::RtxOverruleMinDelay>


Format:
- a delay time period
- unit: msec
- range: [-1,0...63]

[no] min-delay-up

Parameter type: <Xdsl::RtxOverruleMinDelay>


Format:
- a delay time period
- unit: msec
- range: [-1,0...63]

[no] rtx-max-delay-dn

Parameter type: <Xdsl::RtxOverruleMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [-1,2...63]

[no] rtx-max-delay-up

Parameter type: <Xdsl::RtxOverruleMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [-1,2...63]

[no] shine-ratio-dn

Parameter type: <Xdsl::RtxOverruleShineRatio>


Format:
- shine ratio
- unit: 1/1000
- range: [-1,0...100]

[no] shine-ratio-up

Parameter type: <Xdsl::RtxOverruleShineRatio>


Format:
- shine ratio
- unit: 1/1000
- range: [-1,0...100]

[no] leftr-thresh-dn

Parameter type: <Xdsl::RtxOverruleLeftrThreshold>


Format:
- near-end defect threshold
- unit: 1/100
- range: [-1,0,1...99]

260

Released

Description
parameter will not be overruled
optional parameter with default
value: -1
overrule minimum impulse noise
protection against rein for
upstream direction, special value
-1 means the rtxprofile parameter
will not be overruled
optional parameter with default
value: -1
overrule minimum instantaneous
delay allowed (due to the effect
of
retransmission)
for
downstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule minimum instantaneous
delay allowed (due to the effect
of retransmission) for upstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule maximum instantaneous
delay allowed (due to the effect
of
retransmission)
for
downstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule maximum instantaneous
delay allowed (due to the effect
of retransmission) for upstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule
shine
ratio
for
downstream direction, special
value -1 means the rtxprofile
parameter will not be overruled
optional parameter with default
value: -1
overrule shine ratio for upstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule threshold for declaring a
near-end defect in downstream
direction, special value -1 means

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

Type

Description

[no] leftr-thresh-up

Parameter type: <Xdsl::RtxOverruleLeftrThreshold>


Format:
- near-end defect threshold
- unit: 1/100
- range: [-1,0,1...99]

[no] memory-down

Parameter type: <Xdsl::OverruleMemoryDownstream>


Format:
- overrule the configured interleaver memory downstream
- unit: 1/100
- range: [-1,255,0...100]
Parameter type: <Xdsl::ModifyStatus>
Format:
( start
| cancel
| complete )
Possible values:
- start : to start modifying the profile
- cancel : to cancel the modifications done
- complete : to complete the modifications
Parameter type: boolean

[no] modification

[no] active

3HH-04416-EBAA-TCZZA 01

the rtxprofile parameter will not


be overruled
optional parameter with default
value: -1
overrule threshold for declaring a
far-end defect in upstream
direction, special value -1 means
the rtxprofile parameter will not
be overruled
optional parameter with default
value: -1
overrule
configurable
downstream memory
optional parameter with default
value: "complete"
modify the profile

optional parameter
The parameter is not visible
during creation.
to activate the profile

Released

261

7 xDSL Configuration Commands

7.33 xDSL Overrule Noise Psd Shape Downstream


Configuration Command
Command Description
This command allows the operator to configure the virtual/artificial noise in downstream direction.
It helps operator to enter the virtual/artificial noise psd shape in a user-friendly way. The operator can enter
numbers corresponding to frequency and psd level.
The downstream overrule noise PSD shape overrules the downstream virtual or artificial noise PSD shape
configured in the profile,according to the setting of noise-psd-mode-dn
no-overrule:overrule noise PSD is ignored
virtual:overrule noise PSD overrules the virtual noise PSD in the profile.
In case no overrule noise PSD is specified (empty),v-noise-snr-down is set to mode-1,otherwise v-noise-snr-down is
set to mode-2.
artificial: overrule noise PSD overrules the artificial noise PSD in the profile
When all the (needed) parameters are configured, the complete Overrule Data has to be activated.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the psd shape mode will also be
reset to the default value. When any other breakpoint is set to default values, all points following it will also be set
to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl overrule-data (if-index) noise-psd-pt-down (psd-point) [ no frequency | frequency
<Xdsl::CustFreq> ] [ no psd | psd <Xdsl::CustPsd> ]

Command Parameters
Table 7.33-1 "xDSL Overrule Noise Psd Shape Downstream Configuration Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>

262

Released

Description

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Resource Identifier

(psd-point)

Type
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
- psd point
- range: [1...32]

Description

psd point

Table 7.33-2 "xDSL Overrule Noise Psd Shape Downstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::CustPsd>
Format:
- psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

optional parameter with default


value: 0L
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0L
psd level

Released

263

7 xDSL Configuration Commands

7.34 xDSL Overrule Noise Psd Shape Upstream


Configuration Command
Command Description
This command allows the operator to configure the virtual noise in upstream direction.
It helps operator to enter the virtual noise psd shape in a user-friendly way. The operator can enter numbers
corresponding to frequency and psd level.
When all the (needed) parameters are configured, the complete Overrule Data has to be activated.
When all break points are set to default values (frequency 0, psd 0), the psd shape is cleared. To clear the entire
shape at once, set the first two breakpoints to default values. Using this method, the psd shape mode will also be
reset to the default value. When any other breakpoint is set to default values, all points following it will also be set
to the default values.
When defining a PSD shape, a minimum of 2 PSD points should be specified. The successive PSD points must have
increasing (>/=) frequencies. It is allowed that for two successive PSD points, different PSD levels are defined at a
same frequency (brickwall).
The upstream overrule noise PSD shape overrules the upstream virtual or artificial noise PSD shape configured in
the profile, according to the setting of noise-psd-mode-up:
no-overrule:overrule noise PSD is ignored.
virtual:overrule noise PSD overrules the virtual noise PSD in the profile.In case no overrule noise PSD is
specified (empty), v-noise-snr-up is set to mode-1,otherwise v-noise-snr-up is set to mode-2.
virtual-rx:overrule noise PSD overrules the virtual noise PSD in the profile.In case no overrule noise PSD is
specified (empty), v-noise-snr-up is set to mode-1, otherwise v-noise-snr-up is set to mode-3.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl overrule-data (if-index) noise-psd-pt-up (psd-point) [ no frequency | frequency <Xdsl::CustFreq> ]
[ no psd | psd <Xdsl::CustPsd> ]

Command Parameters
Table 7.34-1 "xDSL Overrule Noise Psd Shape Upstream Configuration Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>

264

Released

Description

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Resource Identifier

(psd-point)

Type
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
- psd point
- range: [1...16]

Description

psd point

Table 7.34-2 "xDSL Overrule Noise Psd Shape Upstream Configuration Command" Command
Parameters
Parameter

Type

Description

[no] frequency

Parameter type: <Xdsl::CustFreq>


Format:
- frequency
- unit: khz
- range: [0...30000]
Parameter type: <Xdsl::CustPsd>
Format:
- psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

optional parameter with default


value: 0L
psd frequency

[no] psd

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0L
psd level

Released

265

7 xDSL Configuration Commands

7.35 xDSL INS Near End Configuration Command


Command Description
This command allows the operator to configure the Impulse-Noise-Sensor parameters for the near-end side.
The InmMode must be enabled first to be able to start monitoring. To stop monitoring on the line this InmMode
must be disabled.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl imp-noise-sensor near-end (if-index) [ no inm-mode | inm-mode <Xdsl::InmMode> ] [ no
inm-eq-inp-mode | inm-eq-inp-mode <Xdsl::InmEquivInpMode> ] [ no ins-sensitivity | ins-sensitivity
<Xdsl::InsSensitivity> ] [ no inm-cluster-cont | inm-cluster-cont <Xdsl::ClusterContinuation> ] [ no inm-iat-offset |
inm-iat-offset <Xdsl::InterArrivalTimeOffset> ] [ no inm-iat-step | inm-iat-step <Xdsl::InterArrivalTimeStep> ]

Command Parameters
Table 7.35-1 "xDSL INS Near End Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 7.35-2 "xDSL INS Near End Configuration Command" Command Parameters
Parameter

Type

Description

[no] inm-mode

Parameter type: <Xdsl::InmMode>


Format:
( disable
| enable )
Possible values:
- disable : disable impulse noise monitoring stats collection
- enable : enable impulse noise monitoring stats collection
Parameter type: <Xdsl::InmEquivInpMode>
Format:

optional parameter with default


value: "disable"
enable upstr impulse noise
monitoring stats collection

[no] inm-eq-inp-mode

266

Released

optional parameter with default


value: "mode-0"

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] ins-sensitivity

[no] inm-cluster-cont

[no] inm-iat-offset

[no] inm-iat-step

3HH-04416-EBAA-TCZZA 01

Type

Description

( mode-0
| mode-1
| mode-2
| mode-3 )
Possible values:
- mode-0 : impulse length
- mode-1 : cluster length
- mode-2 : sum of impulse length in cluster
- mode-3 : gap compensated impulse length in cluster
Parameter type: <Xdsl::InsSensitivity>
Format:
- impulse noise sensitivity
- unit: dB / 10
- range: [-128...127]
Parameter type: <Xdsl::ClusterContinuation>
Format:
( disabled
| <Xdsl::ClusterContinuation> )
Possible values:
- disabled : disable cluster continuation
Field type <Xdsl::ClusterContinuation>
- impulse noise cluster continuation
- unit: DMT Symbol
- range: [0...64]
Parameter type: <Xdsl::InterArrivalTimeOffset>
Format:
- inter arrival time offset
- unit: DMT Symbol
- range: [3...511]
Parameter type: <Xdsl::InterArrivalTimeStep>
Format:
- inter arrival time step
- range: [0...7]

equivalent INP mode used for the


construction
of
the
INM
equivalent INP histograms

optional parameter with default


value: 0L
upstream impulse noise sensor
sensitivity
optional parameter with default
value: "disabled"
upstream impulse noise cluster
continuation

optional parameter with default


value: 3L
interval
offset
of
upstr
inter-arrival time histograms
optional parameter with default
value: 0L
interval
width
of
upstr
inter-arrival time histograms

Released

267

7 xDSL Configuration Commands

7.36 xDSL INS Far End Configuration Command


Command Description
This command allows the operator to configure the Impulse-Noise-Sensor parameters for the far-end side.
The InmMode must be enabled first to be able to start monitoring. To stop monitoring on the line this InmMode
must be disabled.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl imp-noise-sensor far-end (if-index) [ no inm-mode | inm-mode <Xdsl::InmMode> ] [ no
inm-eq-inp-mode | inm-eq-inp-mode <Xdsl::InmEquivInpMode> ] [ no ins-sensitivity | ins-sensitivity
<Xdsl::InsSensitivity> ] [ no inm-cluster-cont | inm-cluster-cont <Xdsl::ClusterContinuation> ] [ no inm-iat-offset |
inm-iat-offset <Xdsl::InterArrivalTimeOffset> ] [ no inm-iat-step | inm-iat-step <Xdsl::InterArrivalTimeStep> ]

Command Parameters
Table 7.36-1 "xDSL INS Far End Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 7.36-2 "xDSL INS Far End Configuration Command" Command Parameters
Parameter

Type

Description

[no] inm-mode

Parameter type: <Xdsl::InmMode>


Format:
( disable
| enable )
Possible values:
- disable : disable impulse noise monitoring stats collection
- enable : enable impulse noise monitoring stats collection
Parameter type: <Xdsl::InmEquivInpMode>
Format:

optional parameter with default


value: "disable"
enable downstr impulse noise
monitoring stats collection

[no] inm-eq-inp-mode

268

Released

optional parameter with default


value: "mode-0"

3HH-04416-EBAA-TCZZA

01

7 xDSL Configuration Commands

Parameter

[no] ins-sensitivity

[no] inm-cluster-cont

[no] inm-iat-offset

[no] inm-iat-step

3HH-04416-EBAA-TCZZA 01

Type

Description

( mode-0
| mode-1
| mode-2
| mode-3 )
Possible values:
- mode-0 : impulse length
- mode-1 : cluster length
- mode-2 : sum of impulse length in cluster
- mode-3 : gap compensated impulse length in cluster
Parameter type: <Xdsl::InsSensitivity>
Format:
- impulse noise sensitivity
- unit: dB / 10
- range: [-128...127]
Parameter type: <Xdsl::ClusterContinuation>
Format:
( disabled
| <Xdsl::ClusterContinuation> )
Possible values:
- disabled : disable cluster continuation
Field type <Xdsl::ClusterContinuation>
- impulse noise cluster continuation
- unit: DMT Symbol
- range: [0...64]
Parameter type: <Xdsl::InterArrivalTimeOffset>
Format:
- inter arrival time offset
- unit: DMT Symbol
- range: [3...511]
Parameter type: <Xdsl::InterArrivalTimeStep>
Format:
- inter arrival time step
- range: [0...7]

equivalent INP mode used for the


construction
of
the
INM
equivalent INP histograms

optional parameter with default


value: 0L
downstream impulse noise sensor
sensitivity
optional parameter with default
value: "disabled"
downstream impulse noise cluster
continuation

optional parameter with default


value: 3L
interval
offset
of
dwnstr
inter-arrival time histograms
optional parameter with default
value: 0L
interval
width
of
dwnstr
inter-arrival time histograms

Released

269

8- ATM Configuration Commands

8.1 ATM Configuration Command Tree


8.2 ATM PVC Configuration Command
8.3 IPOA X-connect L2 interworking port Configuration
Command

270

Released

8-271
8-272
8-274

3HH-04416-EBAA-TCZZA

01

8 ATM Configuration Commands

8.1 ATM Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "ATM Configuration Commands".

Command Tree
----configure
----atm
----[no] pvc
- (port-index)
- [no] admin-down
- [no] aal5-encap-type
----X [no] ip-cross-connect
- (interworking-port)
- cpe
- next-hop

3HH-04416-EBAA-TCZZA 01

Released

271

8 ATM Configuration Commands

8.2 ATM PVC Configuration Command


Command Description
This command allows the operator to configure an ATM PVC.
The admin status allows or disallows traffic on the PVC.
The encapsulation type configures the way higher-layer traffic is encapsulated in the AAL5 container.
The LLC Encapsulation method allows the multiplexing of multiple protocols over a single ATM VC. The protocol
type of each PDU is identified by a prefixed IEEE 802.2 LLC header.
In the VC Multiplexing method, each ATM VC carries PDUs of exactly one protocol type. When multiple protocols
must be transported, there is a separate VC for each protocol type.
Use of the encapsulations:
llc-snap and vc-mux-bridged-8023 can be used for cross-connects, ibridge, PPPoE, and IPoE
llc-snap-routed and vc-mux-routed can be used for IPoA
llc-nlpid and vc-mux-pppoa can be used for PPPoA
none can be used for ATM pseudowire
It is also possible to automatically detect the used encapsulation type on the link.
automatic:ip is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-snap-routed, and
vc-mux-routed; ipoe and ipoa dataframes are accepted;
automatic:ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid, and vc-mux-pppoa;
pppoa and pppoe dataframes are accepted;
automatic:pppoa is used for auto-detection between llc-nlpid and vc-mux-pppoa, only pppoa dataframes are
accepted;
automatic:ipoe-ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid and
vc-mux-pppoa; ipoe, pppoa and pppoe dataframes are accepted;
The only encapsulation type supported on L2 LTs is llc-snap.

User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> configure atm ( no pvc (port-index) ) | ( pvc (port-index) [ [ no ] admin-down ] [ no aal5-encap-type |
aal5-encap-type <Atm::VccEncapType> ] )

Command Parameters
Table 8.2-1 "ATM PVC Configuration Command" Resource Parameters
Resource Identifier

Type

(port-index)

Format:
the atm static Interface with vpi
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / and vci

272

Released

Description

3HH-04416-EBAA-TCZZA

01

8 ATM Configuration Commands

Resource Identifier

Type
<Eqpt::PortId>
:
<Eqpt::VpiMandatoryId>
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

Description
:

Table 8.2-2 "ATM PVC Configuration Command" Command Parameters


Parameter

Type

Description

[no] admin-down

Parameter type: boolean

[no] aal5-encap-type

Parameter type: <Atm::VccEncapType>


Format:
( llc-snap
| llc-snap-routed
| llc-nlpid
| vc-mux-bridged-8023
| vc-mux-routed
| vc-mux-pppoa
| none
| automatic : ip
| automatic : ppp
| automatic : pppoa
| automatic : ipoe-ppp )
Possible values:
- llc-snap : logical link control encapsulation bridged
protocol
- llc-snap-routed : logical link control encapsulation routed
protocol
- llc-nlpid : logical link control encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel multiplex bridged
protocol
- vc-mux-routed : virtual channel multiplex routed protocol
- vc-mux-pppoa : virtual channel multiplex pppoa protocol
- automatic : automatic detection of encapsulation type
- none : no encapsulation type
Possible values:
- ip : autodetection of the used ip encapsulation
- ppp : autodetection of the used ppp encapsulation
- pppoa : autodetection of the used pppoa encapsulation
- ipoe-ppp : autodetection of the used ip or ppp
encapsulation

optional parameter
disable traffic flow
optional parameter with default
value: "llc-snap"
The parameter is not visible
during modification.
encapsulation method for traffic
in an AAL5 container

3HH-04416-EBAA-TCZZA 01

Released

273

8 ATM Configuration Commands

8.3 IPOA X-connect L2 interworking port


Configuration Command
Command Description
Obsolete command, replaced by configure ipoa/e-iw.
This command allows the operator to configure the parameter on the IPOA X-connect L2 interworking port level

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure atm ( no ip-cross-connect (interworking-port) ) | ( ip-cross-connect (interworking-port) [ cpe
<Ip::V4AddressHex> ] next-hop <Ip::V4AddressHex> )
Obsolete command, replaced by configure ipoa/e-iw.

Command Parameters
Table 8.3-1 "IPOA X-connect L2 interworking port Configuration Command" Resource
Parameters
Resource Identifier

Type

(interworking-port)

Format:
index
of
rack/shelf/slot/port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-bridgeport
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Table 8.3-2 "IPOA X-connect L2 interworking port Configuration Command" Command


Parameters

274

Released

3HH-04416-EBAA-TCZZA

01

8 ATM Configuration Commands

Parameter

Type

Description

cpe

Parameter type: <Ip::V4AddressHex>


Format:
- IPv4-address
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

optional parameter
IP address for cpe

next-hop

3HH-04416-EBAA-TCZZA 01

mandatory parameter
IP address for next hop

Released

275

9- Interface Management Configuration Commands

9.1 Interface Management Configuration Command Tree


9.2 Network Interface Configuration Command
9.3 Extend Interface Configuration Command
9.4 Interface Alarm Configuration Command
9.5 SHub Management Interface Configuration Command
9.6 SHub IP Configuration Command
9.7 SHub ICMP Configuration Command
9.8 SHub Multi-Network Configuration Command
9.9 SHub Unnumbered Interface Configuration Command
9.10 SHub External Voice forwarding Configuration
Command
9.11 SHub Port Control Configuration Command
9.12 SHub Interface Uplink Group Configuration Command
9.13 SHub Interface Uplink Group Portlist Configuration
Command
9.14 SHub System Port Mirroring Configuration Command
9.15 SHub External-Traffic-Mirroring Configuration
Command
9.16 SHub Internal-Traffic-Mirroring Configuration
Command
9.17 SHub System Voice Traffic Mirroring Configuration
Command
9.18 Ingress Port List Configuration Command
9.19 Egress Port List Configuration Command

276

Released

9-277
9-279
9-283
9-284
9-286
9-287
9-288
9-289
9-290
9-291
9-292
9-294
9-295
9-296
9-297
9-299
9-301
9-303
9-304

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.1 Interface Management Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Interface Management Configuration Commands".

Command Tree
----configure
----interface
----port
- (port)
- [no] admin-up
X [no] link-state-trap
- [no] link-updown-trap
- [no] user
- [no] severity
----atm-pvc
- (pvc-index)
- [no] customer-id
----alarm
- (index)
- [no] default-severity
----shub
----[no] vlan-id
- (vlan-id)
- [no] mtu
- [no] admin-status
----ip
- (vlan-id)
- [no] vrf-id
----icmp
- [no] err-msg-suppress
- [no] ping-msg-suppress
----[no] ip-addr
- (ip-addr)
- [no] local-arp-proxy
----[no] unnumbered-as
- (borrowed-index)
----extfwd
- [no] device-ip
----port
- (network-port)
- [no] mode
- [no] port-type
- [no] admin-status
- [no] mc-flooding
----[no] group
- (group-id)
- [no] threshold

3HH-04416-EBAA-TCZZA 01

Released

277

9 Interface Management Configuration Commands

----[no] port
- (port)
----mirror
- [no] enable
- [no] to-port
----port
- (mirror-port)
----external
- [no] ingress
- [no] egress
----internal
- [no] ingress
- [no] egress
----mirror-voice-traffic
- [no] enable
- [no] loopback-port
----[no] ingress-port
- (port)
----[no] egress-port
- (port)

278

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.2 Network Interface Configuration Command


Command Description
This command allows the operator to configure interface management parameters.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface port (port) [ [ no ] admin-up ] [ no link-state-trap | link-state-trap <Itf::ifLinkUpDownTrap> ]
[ [ no ] link-updown-trap ] [ no user | user <Itf::asamIfExtCustomerId> ] [ no severity | severity
<Itf::asamIfExtAlmReportingSeverity> ]

Command Parameters
Table 9.2-1 "Network Interface Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
the interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

279

9 Interface Management Configuration Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId>
| ima-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>

280

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

Resource Identifier

Type

Description

| euni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::EontSlotId> /
<Eqpt::EontPortId> )
Possible values:
- xdsl-line : a static xdsl line interface
- ethernet-line : a static ethernet line interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a shdsl line interface
- ima-group : an ima group interface
- vlan-port : vlan port
- pon : pon
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- euni : euni
- la-group : link aggregation group
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::EontSlotId>
- Epon Ont Slot
Field type <Eqpt::EontPortId>
- Epon Ont Port
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity

3HH-04416-EBAA-TCZZA 01

Released

281

9 Interface Management Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VrfId>
- VRF id

Table 9.2-2 "Network Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] admin-up

Parameter type: boolean

[no] link-state-trap

Parameter type: <Itf::ifLinkUpDownTrap>


Format:
( enable
| disable
| no-value )
Possible values:
- enable : enable link-up/link-down traps
- disable : disable link-up/link-down traps
- no-value : no valid value
Parameter type: boolean

optional parameter
admin status is up
obsolete parameter replaced by
parameter "link-updown-trap"
indicates if link-up/link-down
traps should be generated

[no] link-updown-trap
[no] user

Parameter type: <Itf::asamIfExtCustomerId>


Format:
- a string identifying the customer or user
- length: x<=64
Parameter type: <Itf::asamIfExtAlmReportingSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical
| no-alarms
| default
| no-value )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
- no-alarms : do not report alarm
- default : take default as specified via Interface Alarm
Configuration command
- no-value : no entry in the table

[no] severity

282

Released

optional parameter
enable link-up/link-down traps
optional parameter with default
value: "available"
description of the user connected
to this interface
optional parameter with default
value: "default"
set minimum severity for alarm
to be reported,If ima is the only
interface for which this parameter
is not supported

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.3 Extend Interface Configuration Command


Command Description
This command allows the operator to configure extended interface management parameters.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface atm-pvc (pvc-index) [ no customer-id | customer-id <Itf::asamIfExtCustomerId> ]

Command Parameters
Table 9.3-1 "Extend Interface Configuration Command" Resource Parameters
Resource Identifier

Type

(pvc-index)

Format:
the ATM PVC interface index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Table 9.3-2 "Extend Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] customer-id

Parameter type: <Itf::asamIfExtCustomerId>


Format:
- a string identifying the customer or user
- length: x<=64

optional parameter with default


value: "available"
Config the customerId per PVC

3HH-04416-EBAA-TCZZA 01

Released

283

9 Interface Management Configuration Commands

9.4 Interface Alarm Configuration Command


Command Description
This command allows the operator to configure the default severity for an alarm on this type of interface.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
>
configure
interface
alarm
(index)
<Itf::asamIfExtAlmReportingSeverityDefault> ]

no

default-severity

default-severity

Command Parameters
Table 9.4-1 "Interface Alarm Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( xdsl-line
| ethernet-line
| shdsl-line
| voicefxs
| pon
| ont
| uni
| epon
| eont
| euni
| ellid
| lag )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
- voicefxs : voicefxs
- pon : pon interface
- ont : ont interface
- uni : uni interface
- epon : epon interface
- eont : epon ont interface
- euni : epon uni interface
- ellid : epon llid interface
- lag : link aggregation group

index of the IANA ifType

284

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

Table 9.4-2 "Interface Alarm Configuration Command" Command Parameters


Parameter

Type

[no] default-severity

Parameter
<Itf::asamIfExtAlmReportingSeverityDefault>
Format:
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

3HH-04416-EBAA-TCZZA 01

Description
type: optional parameter with default
value: "major"
default severity to be reported

Released

285

9 Interface Management Configuration Commands

9.5 SHub Management Interface Configuration


Command
Command Description
This command allows the operator to configure parameters related to SHub interface management.
The parameter mtu is applicable only for control-plane traffic only

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ( no vlan-id (vlan-id) ) | ( vlan-id (vlan-id) [ no mtu | mtu <Shub::ifMainMtu> ] [ no
admin-status | admin-status <Shub::AdminStatus> ] )

Command Parameters
Table 9.5-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 9.5-2 "SHub Management Interface Configuration Command" Command Parameters


Parameter

Type

[no] mtu

Parameter type: <Shub::ifMainMtu>


optional parameter with default
Format:
value: 1500
- This configuration is not applicable for L3 user-data MTU for the vlan interface
traffic.It is applicable only for control-plane traffic
- range: [90...2026]
Parameter type: <Shub::AdminStatus>
optional parameter with default
Format:
value: "down"
( up
administrative state of the vlan
| down
interface
| auto-up )
Possible values:
- up : up
- down : down
- auto-up : autoup

[no] admin-status

286

Released

Description

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.6 SHub IP Configuration Command


Command Description
This command allows the operator to configure IP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) [ no vrf-id | vrf-id <Vrf::ShubVrfID> ]

Command Parameters
Table 9.6-1 "SHub IP Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 9.6-2 "SHub IP Configuration Command" Command Parameters


Parameter

Type

Description

[no] vrf-id

Parameter type: <Vrf::ShubVrfID>


Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

optional parameter with default


value: 0
the VRF instance to which this
interface is associated

3HH-04416-EBAA-TCZZA 01

Released

287

9 Interface Management Configuration Commands

9.7 SHub ICMP Configuration Command


Command Description
This command allows the operator to configure ICMP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) icmp [ [ no ] err-msg-suppress ] [ [ no ] ping-msg-suppress ]

Command Parameters
Table 9.7-1 "SHub ICMP Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 9.7-2 "SHub ICMP Configuration Command" Command Parameters


Parameter

Type

Description

[no] err-msg-suppress

Parameter type: boolean

[no] ping-msg-suppress

Parameter type: boolean

optional parameter
suppress the sending of ICMP err
msgs
optional parameter
suppress ping packets

288

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.8 SHub Multi-Network Configuration Command


Command Description
This command allows the operator to configure multinet IP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) ( no ip-addr (ip-addr) ) | ( ip-addr (ip-addr) [ [ no ] local-arp-proxy ] )

Command Parameters
Table 9.8-1 "SHub Multi-Network Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

vlan id

(ip-addr)

ip-address

Table 9.8-2 "SHub Multi-Network Configuration Command" Command Parameters


Parameter

Type

Description

[no] local-arp-proxy

Parameter type: boolean

optional parameter
enable local arp-proxy

3HH-04416-EBAA-TCZZA 01

Released

289

9 Interface Management Configuration Commands

9.9 SHub Unnumbered Interface Configuration


Command
Command Description
This command allows the operator to configure an unnumber interfaces related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) ( no unnumbered-as (borrowed-index) ) | ( unnumbered-as (borrowed-index)
)

Command Parameters
Table 9.9-1 "SHub Unnumbered Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Format:
- vlan id
- range: [1...4093]

vlan id

(borrowed-index)

290

Released

vlan-id
of
the
numbered interface

3HH-04416-EBAA-TCZZA

associated

01

9 Interface Management Configuration Commands

9.10 SHub External Voice forwarding Configuration


Command
Command Description
This command allows the operator to configure the SHub external voice forwarding IP related parameter.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) extfwd [ no device-ip | device-ip <Ip::V4Address> ]

Command Parameters
Table 9.10-1 "SHub External Voice forwarding Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 9.10-2 "SHub External Voice forwarding Configuration Command" Command Parameters
Parameter

Type

Description

[no] device-ip

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

optional parameter with default


value: "0.0.0.0"
external voice forwarding ip

3HH-04416-EBAA-TCZZA 01

Released

291

9 Interface Management Configuration Commands

9.11 SHub Port Control Configuration Command


Command Description
This command allows the operator to configure parameters related to port control configuration of an SHub
interface.
NOTE:
Due to IEEE 802.3 limitation, some special configuration rules for 1Gbps ports should be considered when doing
configuration:
For 1Gbps electrical port , auto-negotiation is mandatory for both sides.
For 1Gbps optical port, both sides should be auto-negotiation or both sides should be fixed.
Detail limitation please refer to IEEE 802.3-2002 section 40.5.1 and 28.2.3.1

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub port (network-port) [ no mode | mode <Sys::PortCtrlMode> ] [ no port-type | port-type
<Sys::Type> ] [ no admin-status | admin-status <Shub::AdminStatus> ] [ [ no ] mc-flooding ]

Command Parameters
Table 9.11-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

identifier of the port interface

Table 9.11-2 "SHub Port Control Configuration Command" Command Parameters

292

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

Parameter

Type

Description

[no] mode

Parameter type: <Sys::PortCtrlMode>


Format:
( automatic
| 10mbps : full
| 10mbps : half
| 100mbps : full
| 100mbps : half
| 1gbps : full
| 1gbps : half
| 10gbps : full
| 2.5gbps : full )
Possible values:
- automatic : determine the parameters of interface
automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
- 10gbps : mode for interface is 10Gbps
- 2.5gbps : mode for interface is 2.5Gbps
Possible values:
- full : data transfer in full duplex
- half : data transfer in half duplex
Parameter type: <Sys::Type>
Format:
( user
| subtending
| network
| unused
| outband-mngt )
Possible values:
- user : port to a directly connected user
- subtending : port to a subtended ISAM
- network : port to the service provider (ISP)
- unused : port is not in use
- outband-mngt : port is used for outband-management
Parameter type: <Shub::AdminStatus>
Format:
( up
| down
| auto-up )
Possible values:
- up : up
- down : down
- auto-up : autoup
Parameter type: boolean

optional parameter with default


value: "automatic"
negotiation mode of the port
interface parameters

[no] port-type

[no] admin-status

[no] mc-flooding

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "unused"
the type of port interface

optional parameter with default


value: "down"
administrative state of the port

optional parameter
enable multicast flooding

Released

293

9 Interface Management Configuration Commands

9.12 SHub Interface Uplink Group Configuration


Command
Command Description
This command allows the user to configure parameters related to uplink group configuration of an interface.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ( no group (group-id) ) | ( group (group-id) [ no threshold | threshold <Itf::Threshold> ] )

Command Parameters
Table 9.12-1 "SHub Interface Uplink Group Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(group-id)

Format:
- the number of uplink group
- range: [1...7]

A unique number for each logical


uplink group

Table 9.12-2 "SHub Interface Uplink Group Configuration Command" Command Parameters
Parameter

Type

Description

[no] threshold

Parameter type: <Itf::Threshold>


Format:
- the min nbr of links to be operational UP in grp
- range: [0...7]

optional parameter with default


value: 0L
the min nbr of links to be
operational UP in grp

294

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.13 SHub Interface Uplink Group Portlist


Configuration Command
Command Description
This command allows the user to configure parameters related to uplink group portlist configuration of an
interface.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub group (group-id) ( no port (port) ) | ( port (port) )

Command Parameters
Table 9.13-1 "SHub Interface Uplink Group Portlist Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(group-id)

Format:
- the number of uplink group
- range: [1...7]
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

A unique number for each logical


uplink group

(port)

3HH-04416-EBAA-TCZZA 01

the port

Released

295

9 Interface Management Configuration Commands

9.14 SHub System Port Mirroring Configuration


Command
Command Description
This command is used to control the system for the port mirroring feature.
The mirror-to-port should not be effectively connected to a network, subtending system or user, it is typically
connected to an analysing device.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror [ [ no ] enable ] [ no to-port | to-port <Sys::NetworkPort> ]

Command Parameters
Table 9.14-2 "SHub System Port Mirroring Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] to-port

Parameter type: <Sys::NetworkPort>


Format:
( <Shub::NetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- none : no to-port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

optional parameter
enable port mirroring status
optional parameter with default
value: "none"
port in which mirror traffic in the
system can be copied

296

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.15 SHub External-Traffic-Mirroring Configuration


Command
Command Description
This command is used for enabling/disabling of ingress and/or egress mirroring of traffic forwarded on the
interface to the mirrored-to port, without service interruption for the normal traffic. External egress mirrored
traffic includes only traffic originated from other ports, sent on the interface. It does not include traffic originated
from CPU; to mirror traffic from CPU, use the command Shub Internal-Traffic-Mirroring-Configuration.
External ingress mirrored traffic includes all traffic, received on the interface.
This configuration is effective in case port mirroring is enabled and the mirrored-to-port is set.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror port (mirror-port) external [ [ no ] ingress ] [ [ no ] egress ]

Command Parameters
Table 9.15-1 "SHub External-Traffic-Mirroring Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(mirror-port)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>

identifier of the mirror port


interface

3HH-04416-EBAA-TCZZA 01

Released

297

9 Interface Management Configuration Commands

Resource Identifier

Type

Description

- the egress lt slot


Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

Table 9.15-2 "SHub External-Traffic-Mirroring Configuration Command" Command Parameters


Parameter

Type

Description

[no] ingress

Parameter type: boolean

[no] egress

Parameter type: boolean

optional parameter
enable ingress external-mirroring
status
optional parameter
enable egress external-mirroring
status

298

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.16 SHub Internal-Traffic-Mirroring Configuration


Command
Command Description
This command is used for enabling/disabling of ingress and/or egress mirroring of traffic to/from the CPU on the
interface to the mirror-to-port,without service interruption for the normal traffic.
This configuration is effective in case port mirroring is enabled and the mirrored-to-port is set.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror port (mirror-port) internal [ [ no ] ingress ] [ [ no ] egress ]

Command Parameters
Table 9.16-1 "SHub Internal-Traffic-Mirroring Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(mirror-port)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub

identifier of the mirror port


interface

3HH-04416-EBAA-TCZZA 01

Released

299

9 Interface Management Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::PortIndex>


- the faceplate port number

Table 9.16-2 "SHub Internal-Traffic-Mirroring Configuration Command" Command Parameters


Parameter

Type

Description

[no] ingress

Parameter type: boolean

[no] egress

Parameter type: boolean

optional parameter
enable ingress internal-mirroring
status
optional parameter
enable egress internal-mirroring
status

300

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.17 SHub System Voice Traffic Mirroring


Configuration Command
Command Description
This command is used to configure the system for the voice traffic mirroring feature.
When voice traffic mirroring feature is enabled, the loopback port will be autonomously associated to the s-vlan
and the s-vlan id will be assigned as pvid.
A port configured as loopback port will become unused and will lose all existing configurations. To re-use the port
again for normal purposes, the loopback port should be set to zero.
Ingress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the upsteam
direction. Only ASAM ports can be members of ingress port list.
Egress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the downsteam
direction. Only ASAM ports can be members of the egress port list.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror-voice-traffic [ [ no ] enable ] [ no loopback-port | loopback-port
<Sys::MirrorLoopbackPort> ]

Command Parameters
Table 9.17-2 "SHub System Voice Traffic Mirroring Configuration Command" Command
Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] loopback-port

Parameter type: <Sys::MirrorLoopbackPort>


Format:
( <Shub::NetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- none : no loopback port
- nt : active nt slot
Possible values:

optional parameter
enable the voice traffic mirroring
optional parameter with default
value: "none"
configure the loopback port

3HH-04416-EBAA-TCZZA 01

Released

301

9 Interface Management Configuration Commands

Parameter

Type

Description

- sfp : sfp port


- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

302

Released

3HH-04416-EBAA-TCZZA

01

9 Interface Management Configuration Commands

9.18 Ingress Port List Configuration Command


Command Description
This command is used to configure the egress port list.
Ingress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the upsteam
direction. Only ASAM ports can be members of ingress port list.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror-voice-traffic ( no ingress-port (port) ) | ( ingress-port (port) )

Command Parameters
Table 9.18-1 "Ingress Port List Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> )
Possible values:
- lt : line board
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

port list for ingress port(s)

3HH-04416-EBAA-TCZZA 01

Released

303

9 Interface Management Configuration Commands

9.19 Egress Port List Configuration Command


Command Description
This command is used to configure the egress port list.
Egress port list stored the set of port(s) that need to be mirrored for traffic transmitted on it in the downsteam
direction. Only ASAM ports can be members of the egress port list.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub mirror-voice-traffic ( no egress-port (port) ) | ( egress-port (port) )

Command Parameters
Table 9.19-1 "Egress Port List Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId> )
Possible values:
- lt : line board
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

port list for egress port(s)

304

Released

3HH-04416-EBAA-TCZZA

01

10- Error Configuration Commands

10.1 Error Configuration Command Tree


10.2 Error Log Configuration Command

3HH-04416-EBAA-TCZZA 01

10-306
10-307

Released

305

10 Error Configuration Commands

10.1 Error Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Error Configuration Commands".

Command Tree
----configure
----error
- [no] log-full-action

306

Released

3HH-04416-EBAA-TCZZA

01

10 Error Configuration Commands

10.2 Error Log Configuration Command


Command Description
This command allows the operator to configure parameters related to the error log.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure error [ no log-full-action | log-full-action <Error::errorLogFullAction> ]

Command Parameters
Table 10.2-2 "Error Log Configuration Command" Command Parameters
Parameter

Type

Description

[no] log-full-action

Parameter type: <Error::errorLogFullAction>


Format:
( wrap
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset

optional parameter with default


value: "wrap"
set the action when error log
buffer is full

3HH-04416-EBAA-TCZZA 01

Released

307

11- System Configuration Commands

11.1 System Configuration Command Tree


11.2 System Configuration Command
11.3 System Management IP related Configuration
Command
11.4 System Management Vlan Host IP-Address
Configuration Command
11.5 System Management Default Route Configuration
Command
11.6 System SNTP Configuration Command
11.7 System SNTP Server Table Configuration Command
11.8 System Loop ID Syntax Configuration Command
11.9 SHub System ICMP Filter Configuration Command
11.10 SHub System ICMP Filter In Port List Configuration
Command
11.11 SHub System ICMP Filter Out Port List Configuration
Command
11.12 SHub System TCP Filter Configuration Command
11.13 SHub System TCP Filter In Port List Configuration
Command
11.14 SHub System TCP Filter Out Port List Configuration
Command
11.15 SHub System UDP Filter Configuration Command
11.16 SHub System UDP Filter In Port List Configuration
Command
11.17 SHub System UDP Filter Out Port List Configuration
Command
11.18 SHub System Other Protocol Filter Configuration
Command
11.19 SHub System Other Protocol Filter In Port List
Configuration Command
11.20 SHub System Other Protocol Filter Out Port List
Configuration Command
11.21 SHub System Other Protocol Filter Ip-filter In-port
Configuration Command
11.22 SHub System Other Protocol Filter Ip-filter Out-port
Configuration Command
11.23 SHub System ID Configuration Command
11.24 SHub System VLAN Group Configuration Command
11.25 SHub System ICMP Configuration Command
11.26 System Clock Configuration Command
11.27 System Synchronous Interface Timing Clock
Configuration Command
11.28 System Clock Bits Mode Configuration Command
11.29 System Clock Source Priority Configuration
Command
11.30 System Clock Synchronous Status Message
Configuration Command
11.31 System Clock Synchronous Source port
Configuration Command
11.32 System Clock Force Reference Configuration

308

Released

11-310
11-313
11-316
11-317
11-318
11-319
11-320
11-321
11-323
11-326
11-327
11-329
11-332
11-333
11-335
11-338
11-339
11-341
11-344
11-345
11-347
11-350
11-353
11-354
11-355
11-356
11-358
11-361
11-362
11-363
11-366
11-368

3HH-04416-EBAA-TCZZA

01

Command
11.33 SSMOut Configuration Command for synce ports
11.34 SSMOut Configuration Command for XDSL ports
11.35 Maximum Lt Link Speed Configuration Command
11.36 ALS State Configuration Command
11.37 Configure system auto-switch

3HH-04416-EBAA-TCZZA 01

11-369
11-371
11-373
11-374
11-375

Released

309

11 System Configuration Commands

11.1 System Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "System Configuration Commands".

Command Tree
----configure
----system
- [no] id
- name
- location
- [no] access-oper-id
- contact-person
- [no] en-snmp-auth-trap
- mgnt-vlan-id
- [no] periph-mgnt-vlan
- system-mac
- [no] port-num-in-proto
- [no] user2user-hairpin
- [no] ntr-ssmout-vlan
- [no] voiceoswp
----management
- host-ip-address
- default-ttl
----[no] vlan
- (vlan)
- host-ip-address
----[no] default-route
- (default-route)
----sntp
- server-ip-addr
- [no] server-port
- [no] polling-rate
- [no] enable
- [no] timezone-offset
----server-table
----[no] ip-address
- (ip-addr)
- [no] port
- priority
----loop-id-syntax
- [no] atm-based-dsl
- [no] efm-based-dsl
- [no] efm-based-pon
- [no] efm-based-epon
----shub
----filter
----ip-filter
----[no] icmp
- (index-num)
- [no] action-drop

310

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

- [no] dst-ip-addr
- [no] src-ip-addr
- [no] msg-type
- [no] msg-code
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----[no] tcp
- (index-num)
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] min-dst-port
- [no] max-dst-port
- [no] min-src-port
- [no] max-src-port
- [no] ack
- [no] rst
- [no] tos
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----[no] udp
- (index-num)
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] min-dst-port
- [no] max-dst-port
- [no] min-src-port
- [no] max-src-port
- [no] direction
- [no] vlan-id
----[no] in-port
- (port)
----[no] out-port
- (port)
----X [no] port-filter
- (filter-rule)
- [no] protocol
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] direction
- [no] vlan-id
----X [no] in-port
- (port)
----X [no] out-port
- (port)
----[no] in-port
- (filter-rule)
- port
- [no] protocol

3HH-04416-EBAA-TCZZA 01

Released

311

11 System Configuration Commands

- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] vlan-id
----[no] out-port
- (filter-rule)
- port
- [no] protocol
- [no] action-drop
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] vlan-id
----entry
----id
- [no] contact
- [no] location
----vlan
- ext-vlan-id
----icmp
- [no] time-stamp-reply
----clock-mgmt
- [no] priority-scheme
- [no] ext-source
- [no] ais-sensitivity
----sync-if-timing
- [no] revert
- [no] wait-time
- [no] output-ql-thresh
- [no] ssmout-ceiling
----bits
- (interface-type)
----ref-order
- (index)
- (priority)
----ssm
- (index)
- [no] ssmenable
- [no] default-ql
- [no] target-ql
----synce
- (index)
- (port)
----force-reference
- (force-reference)
----ssmout-synce
- (index)
- [no] ssmout-enable
----[no] ssmout-ltport
- (index)
- [no] ssmout-enable
----max-lt-link-speed
- [no] link-speed
----auto-laser-shutdown
- [no] action
----auto-switch
- [no] xdsl-atm-ptm
- [no] xdsl-stepup-delay

312

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.2 System Configuration Command


Command Description
This command displays the ID that represents the SID (System ID) of the NE and is used to identify the NE in TL1
messages. The System ID includes all printable ASCII characters except white-space, and must be unique for each
NE in a managed network. The name is an administratively assigned name for this managed node. By convention,
this is the node's fully qualified domain name. The location is the physical location of this node. The textual
identification of the contact person for this managed node, together with information on how to contact this person,
is given by contact-person.
This command displays the ID that represents the SID (System ID) of the NE and is used to identify the NE in TL1
messages. The System ID may only include letters, digits, and hyphens, and must be unique for each NE in a
managed network. The name is an administratively assigned name for this managed node. By convention, this is the
node's fully qualified domain name. The accessOperatorID is an identifier randomly generated by Alcatel-Lucent
and assigned to an operator. The Customer Depenedent Engineering features are enabled based on the
accessOperatorID. The location is the physical location of this node. The textual identification of the contact
person for this managed node, together with information on how to contact this person, is given by contact-person.
The snmp-auth-traps indicates whether the SNMP agent process is permitted to generate authentication-failure
traps. The ether-shape-rate indicates the Ethernet frame shaping rate in kb/s.
The system-mac is used to configure the system MAC address in ISAM. The systemMacAddr is the MAC address of
the LANX interface on the NT board. The lanxBaseMacAddr is the first MAC address of the consecutive MAC
addresses used by the LANX. The lanxRangeMac is the number of MAC addresses supported in LANX.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system [ no id | id <Sys::systemId> ] name <Transport::sysName> location <Transport::sysLocation> [
no access-oper-id | access-oper-id <Sys::accessOperatorId> ] contact-person <Transport::sysContact> [ [ no ]
en-snmp-auth-trap ] mgnt-vlan-id <Vlan::VlanId> [ no periph-mgnt-vlan | periph-mgnt-vlan <Sys::PortVlanId> ]
system-mac <Sys::systemMac> [ no port-num-in-proto | port-num-in-proto <Sys::PortNumberInprotocol> ] [ no
user2user-hairpin | user2user-hairpin <Shub::UserToUserHairPin> ] [ no ntr-ssmout-vlan | ntr-ssmout-vlan
<Ntr::SSMOutVlanId> ] [ no voiceoswp | voiceoswp <Sys::sysVoiceOswp> ]

Command Parameters
Table 11.2-2 "System Configuration Command" Command Parameters
Parameter

Type

Description

[no] id

Parameter type: <Sys::systemId>


Format:
- system ID
- range: printable string (no white-spaces)
- length: x<=64
Parameter type: <Transport::sysName>

optional parameter with default


value: """"
the system ID of the NE

name

3HH-04416-EBAA-TCZZA 01

optional parameter

Released

313

11 System Configuration Commands

Parameter

location

[no] access-oper-id

contact-person

[no] en-snmp-auth-trap
mgnt-vlan-id

[no] periph-mgnt-vlan

system-mac

[no] port-num-in-proto

[no] user2user-hairpin

314

Released

Type

Description

Format:
- a printable string
- length: x<=255
Parameter type: <Transport::sysLocation>
Format:
- a printable string
- length: x<=255
Parameter type: <Sys::accessOperatorId>
Format:
- unique access operator id
- range: [0...65535]
Parameter type: <Transport::sysContact>
Format:
- a printable string
- length: x<=255
Parameter type: boolean

fully-qualified domain name of


the system
optional parameter
location of this system
optional parameter with default
value: 0
unique access operator id
assigned by ALU
optional parameter
info about the contact person for
this system

Parameter type: <Vlan::VlanId>


Format:
- vlan id
- range: [1...4093]
Parameter type: <Sys::PortVlanId>
Format:
- vlan id
- range: [0...4093]
Parameter type: <Sys::systemMac>
Format:
<Sys::MacAddr> / <Sys::LanxMacAddr> / <Sys::Range>
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Sys::LanxMacAddr>
- a lanx-mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Sys::Range>
- range of the shub
- range: [0...65535]
Parameter type: <Sys::PortNumberInprotocol>
Format:
( log-slot-num
| position-based
| type-based
| legacy-num )
Possible values:
- log-slot-num : a system defined, predetermined and unique
number
- position-based : flat-numbering independent of slot-type
- type-based : flat-numbering per slot-type(tl1-like)
- legacy-num : numbering used since the early
days(position-based-like)
Parameter type: <Shub::UserToUserHairPin>
Format:
( enabled
| disabled )
Possible values:
- enabled : enabled hairpinning on the user2user

optional parameter
enable
the
generation
of
authentication-failure traps
optional parameter
configure management vlan id

optional parameter with default


value: 0
configure
the
peripheral
management vlan
optional parameter
sys
mac
addr
in
sysMacAddr/lanxBaseMacAddr/lanxRan

optional parameter with default


value: "log-slot-num"
numbering scheme for the Line
ID field (all protocols)

optional parameter with default


value: "disabled"
the administrative status of
hair-pinning
on
all
the
user-to-user
communication
enabled vlans

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

[no] ntr-ssmout-vlan

[no] voiceoswp

3HH-04416-EBAA-TCZZA 01

Type

Description

communication enabled vlans


- disabled : disabled hairpinning on the user2user
communication enabled vlans
Parameter type: <Ntr::SSMOutVlanId>
optional parameter with default
Format:
value: 4088
- ssm out vlan id
ssm out vlan id
- range: [0...4093]
Parameter type: <Sys::sysVoiceOswp>
optional parameter with default
Format:
value: "sip"
( novoice
the voice software when system
| h248
startup
| sip )
Possible values:
- novoice : no voice software
- h248 : h248 software
- sip : sip software

Released

315

11 System Configuration Commands

11.3 System Management IP related Configuration


Command
Command Description
This command allows the operator to configure the IP address to be used to manage the system.
This command also allows the operator to configure the default-TTL. The default-TTL is the value to be inserted in
the Time-To-Live field of the IP header of datagrams originated at this entity, whenever a TTL value is not supplied
by the transport layer protocol.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system management [ host-ip-address <Ip::ExternalAddress> ] [ default-ttl <Ip::TTL> ]

Command Parameters
Table 11.3-2 "System Management IP related Configuration Command" Command Parameters
Parameter

Type

Description

host-ip-address

Parameter type: <Ip::ExternalAddress>


Format:
( bootp
| manual : <Ip::V4Address> / <Ip::PrefixLengthHost> )
Possible values:
- bootp : use bootp to get ip-address
- manual : set ip-address manually
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthHost>
- IP address prefix length
- range: [8...30,32]
Parameter type: <Ip::TTL>
Format:
- time-to-live value of IP-header
- range: [1...255]

optional parameter
the host ip-address specification

default-ttl

316

Released

optional parameter
default value for time-to-live
field of IP header

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.4 System Management Vlan Host IP-Address


Configuration Command
Command Description
This command allows the operator to configure the IP-address of the system.

User Level
none

Command Syntax
The command has the following syntax:
> configure system management ( no vlan (vlan) ) | ( vlan (vlan) host-ip-address <Sys::ExternalAddress> )

Command Parameters
Table 11.4-1 "System Management Vlan Host IP-Address Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(vlan)

Format:
- vlan id
- range: [6]

the management vlan

Table 11.4-2 "System Management Vlan Host IP-Address Configuration Command" Command
Parameters
Parameter

Type

Description

host-ip-address

Parameter type: <Sys::ExternalAddress>


Format:
( bootp
| manual : <Ip::V4Address> / <Ip::PrefixLengthHost> )
Possible values:
- bootp : use bootp to get ip-address
- manual : set ip-address manually
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthHost>
- IP address prefix length
- range: [8...30,32]

mandatory parameter
the host ip-address specification

3HH-04416-EBAA-TCZZA 01

Released

317

11 System Configuration Commands

11.5 System Management Default Route


Configuration Command
Command Description
This command allows the operator to configure the default route of the system. Before the default route can be
configured, the IP address of the system must be set.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure system management ( no default-route ) | ( default-route (default-route) )

Command Parameters
Table 11.5-2 "System Management Default Route Configuration Command" Command Parameters
Parameter

Type

Description

(default-route)

Format:
- IPv4-address

mandatory parameter
IP-address of the default-route

318

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.6 System SNTP Configuration Command


Command Description
This command allows the operator to configure the SNTP and its related parameters.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sntp [ server-ip-addr <Ip::V4Address> ] [ no server-port | server-port <Sys::portNumber> ] [ no
polling-rate | polling-rate <Sys::pollingRate> ] [ [ no ] enable ] [ no timezone-offset | timezone-offset
<Sys::timeZoneOffset> ]

Command Parameters
Table 11.6-2 "System SNTP Configuration Command" Command Parameters
Parameter

Type

Description

server-ip-addr

Parameter type: <Ip::V4Address>


Format:
- IPv4-address
Parameter type: <Sys::portNumber>
Format:
- index number
- range: [0...65535]
Parameter type: <Sys::pollingRate>
Format:
- polling rate in second
- unit: seconds
- range: [60...864000]
Parameter type: boolean

optional parameter
configure the ip address of the
sntp server
optional parameter with default
value: 123
configure the port number of the
sntp server
optional parameter with default
value: 3600
configure polling rate for the sntp
agent

[no] server-port

[no] polling-rate

[no] enable
[no] timezone-offset

3HH-04416-EBAA-TCZZA 01

Parameter type: <Sys::timeZoneOffset>


Format:
- specify the offset for timezone from GMT/UTC
- unit: minutes
- range: [-780...780]

optional parameter
sntp application in the NE is
enabled
optional parameter with default
value: 0
set the offset of the local
timezone from GMT/UTC

Released

319

11 System Configuration Commands

11.7 System SNTP Server Table Configuration


Command
Command Description
This command allows the operator to configure SNTP Server Table and its related parameters.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sntp server-table ( no ip-address (ip-addr) ) | ( ip-address (ip-addr) [ no port | port
<Sys::ServerPortNumber> ] [ priority <Sys::priority> ] )

Command Parameters
Table 11.7-1 "System SNTP Server Table Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

configure the ip-address of the


sntp server

Table 11.7-2 "System SNTP Server Table Configuration Command" Command Parameters
Parameter

Type

Description

[no] port

Parameter type: <Sys::ServerPortNumber>


Format:
- port number
- range: [0...65535]
Parameter type: <Sys::priority>
Format:
- sntp server priority(1 - high)
- range: [1...3]

optional parameter with default


value: 123
configure the port number of the
sntp server
optional parameter
configure the priority number of
the sntp server

priority

320

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.8 System Loop ID Syntax Configuration


Command
Command Description
This command allows the operator to configure the system loop ID syntax. For atm-based-dsl, default value is
"Access_Node_ID atm Rack/Frame/Slot/Port:VPI.VCI". For efm-based-dsl, default value is "Access_Node_ID eth
Rack/Frame/Slot/Port".
For
efm-based-pon,
default
value
is
"Access_Node_ID
eth
Rack/Frame/Slot/Port/ONU/OnuSlt/UNI".For
efm-based-epon,
default
value
is
"Bras
Access_Node_ID/Rack/Frame/Slot/Subslot/Port/ONT Oft".
The system loop ID syntax is a concatenation of keywords, separators and free text strings.
The operator can use the following predefined keywords to construct the system loop ID :
Bras to specify the Bras identifier.
Access_Node_ID to specify the system id.
Rack to specify the rack number.
Frame to specify the shelf number.
Slot to specify the slot number.
Subslot to specify the slot number in ONT.
ShSlt to specify the slot number without leading zero.
Port to specify the port number.
ShPrt to specify the port number without leading zero.
VPI to specify the vpi.
VCI to specify the vci.
Q-VID to specify the vlan identifier.
LzQVID to specify the vlan identifier with leading zero.
DUVID to specify that user untagged vlan identifier is not added in string.
U-VID to specify that user untagged vlan identifier is not added in string.When it is the last keyword and the
value is null, it removes all non-keywords before it.
I-VID to specify the user side inner vlan identifier.
ONT to specify the ONT id which connecting to OLT. Here using the ONUs MAC as id. it is represented with
12 ASCII characters.
ONU to specify the number of the ONU without leading zero.
LzOnu to specify the number of the ONU with leading zero.
OnuSlt to specify the slot number on the ONU without leading zero.
UNI to specify the number of UNI on the ONU without leading zero.
N-VID to specify the network VLAN identifier.
LzNVID to specify the network VLAN identifier with leading zeros (should not be used on GPON/EPON,
neither for DHCPv6/ANCP).
Oft to specify the ONU format. It is a string.
OnuSN to specify the ONU with the serial number.
OnuLD to specify the ONU with logial authentication ID.
Note : the ONT and ONU related keywords are relevant only for the pon and epon syntax.
Note : according to Broadband Forum TR-156, the ONT always adds a VLAN tag before sending the traffic to the
OLT. In such case, the OLT not longer knows if traffic arrived at the ONT untagged or tagged. Therefore for
GPON, the keywords "DUVID" and "U-VID" will have the same behavior as "Q-VID".

User Level

3HH-04416-EBAA-TCZZA 01

Released

321

11 System Configuration Commands

The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system loop-id-syntax [ no atm-based-dsl | atm-based-dsl <PrintableString-0-80> ] [ no efm-based-dsl |
efm-based-dsl <PrintableString-0-80> ] [ no efm-based-pon | efm-based-pon <PrintableString-0-80> ] [ no
efm-based-epon | efm-based-epon <PrintableString-0-80> ]

Command Parameters
Table 11.8-2 "System Loop ID Syntax Configuration Command" Command Parameters
Parameter

Type

Description

[no] atm-based-dsl

Parameter type: <PrintableString-0-80>


Format:
- a printable string
- length: x<=80

[no] efm-based-dsl

Parameter type: <PrintableString-0-80>


Format:
- a printable string
- length: x<=80

[no] efm-based-pon

Parameter type: <PrintableString-0-80>


Format:
- a printable string
- length: x<=80

[no] efm-based-epon

Parameter type: <PrintableString-0-80>


Format:
- a printable string
- length: x<=80

optional parameter with default


value: "Access_Node_ID atm
Rack/Frame/Slot/Port : VPI.VCI"
define the syntax of loop Id for
atm based dsl lines
optional parameter with default
value: "Access_Node_ID eth
Rack/Frame/Slot/Port"
defines the syntax of loop Id for
efm based dsl lines
optional parameter with default
value: "Access_Node_ID eth
Rack/Frame/Slot/Port/ONU/OnuSlt/UNI
defines the syntax of loop Id for
efm based pon lines
optional parameter with default
value:
"Bras
Access_Node_ID/Rack/Frame/Slot/Subsl
Oft"
defines the syntax of loop Id for
efm based epon lines,suggest
OntMAC for dpoe

322

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.9 SHub System ICMP Filter Configuration


Command
Command Description
This command allows the operator to configure an ICMP filter on the SHub. The ICMP filter takes into account
source and/or destination IP addresses; either or both must be specified. Optionally the ICMP message type and/or
the ICMP message code can be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 ICMP filter, please
check if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire L3 ICMP filter.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no icmp (index-num) ) | ( icmp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr
|
dst-ip-addr
<Ip::AddressAndIpMaskFull>
]
[
no
src-ip-addr
|
src-ip-addr
<Ip::AddressAndIpMaskFull> ] [ no msg-type | msg-type <Sys::MsgType> ] [ no msg-code | msg-code
<Sys::MsgCode> ] [ no direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )

Command Parameters
Table 11.9-1 "SHub System ICMP Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]

L3 Filter rule number

Table 11.9-2 "SHub System ICMP Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] action-drop

Parameter type: boolean

[no] dst-ip-addr

Parameter type: <Ip::AddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>

optional parameter
the packet will be discarded
optional parameter with default
value: "0.0.0.0/0"
destination IP address to be

3HH-04416-EBAA-TCZZA 01

Released

323

11 System Configuration Commands

Parameter

[no] src-ip-addr

[no] msg-type

[no] msg-code

324

Released

Type

Description

Field type <Ip::V4Address>


- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::AddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Sys::MsgType>
Format:
( echo-reply
| dest-unreach
| src-quench
| redirect
| echo-request
| time-exceeded
| param-prob
| time-stamp-req
| time-stamp-reply
| infor-req
| infor-reply
| addr-mask-req
| addr-mask-reply
| no-icmp-type )
Possible values:
- echo-reply : echo reply
- dest-unreach : destination unreachable
- src-quench : source quench
- redirect : redirect
- echo-request : echo request
- time-exceeded : time exceeded message
- param-prob : parameter problem
- time-stamp-req : timestamp request message
- time-stamp-reply : timestamp reply messages
- infor-req : information request
- infor-reply : information reply
- addr-mask-req : address mask request
- addr-mask-reply : address mask reply
- no-icmp-type : message type is not icmp
Parameter type: <Sys::MsgCode>
Format:
( network-unreach
| host-unreach
| protocol-unreach
| port-unreach
| fragment-need
| src-route-fail
| dest-nwk-unknown
| dest-host-unknown
| src-host-isolated
| dest-nwk-prohibit
| dest-host-prohibit

matched with the packet

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: "no-icmp-type"
message type to be checked
against the packet

optional parameter with default


value: "no-icmp-code"
message code to be checked
against the packet

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

[no] direction

[no] vlan-id

Type

Description

| nwk-unreach-tos
| host-unreach-tos
| no-icmp-code )
Possible values:
- network-unreach : network unreachable
- host-unreach : host unreachable
- protocol-unreach : protocol unreachable
- port-unreach : port unreachable
- fragment-need : fragmentation needed
- src-route-fail : source route failed
- dest-nwk-unknown : destination network unknown
- dest-host-unknown : destination host unknown
- src-host-isolated : source host isolated
- dest-nwk-prohibit : destination network administratively
prohibited
- dest-host-prohibit : destination host administratively
prohibited
- nwk-unreach-tos : network unreachable for type of service
- host-unreach-tos : host unreachable for type of service
- no-icmp-code : message type is not icmp
Parameter type: <Sys::Direction>
Format:
( in
| out )
Possible values:
- in : incoming packets
- out : outgoing packets
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

optional parameter with default


value: "in"
specifies in which direction the
filters are applied

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.9-3 "SHub System ICMP Filter Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::WaitRowStatusICMP>


( valid
| corrupted
| corrupted )
Possible values:
- valid : ICMP filter configuration is ok
- corrupted : ICMP filter configuration
operational(not-in-service)
- corrupted : ICMP filter configuration
operational(not-ready)

the status of L3 ICMP filter


This element is only shown in
detail mode.

is

not

is

not

Released

325

11 System Configuration Commands

11.10 SHub System ICMP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) ( no in-port (port) ) | ( in-port (port) )

Command Parameters
Table 11.10-1 "SHub System ICMP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

L3 Filter rule number

(port)

326

Released

the network port

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.11 SHub System ICMP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) ( no out-port (port) ) | ( out-port (port) )

Command Parameters
Table 11.11-1 "SHub System ICMP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

L3 Filter rule number

(port)

3HH-04416-EBAA-TCZZA 01

the port

Released

327

11 System Configuration Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

328

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.12 SHub System TCP Filter Configuration


Command
Command Description
This command allows the operator to configure a TCP filter on the SHub. The TCP filter takes into account source
and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
separate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 TCP filter, please check
if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
TCP filter.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no tcp (index-num) ) | ( tcp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no min-dst-port | min-dst-port <Sys::Port> ] [ no max-dst-port |
max-dst-port <Sys::Port> ] [ no min-src-port | min-src-port <Sys::Port> ] [ no max-src-port | max-src-port
<Sys::Port> ] [ no ack | ack <Sys::AckBit> ] [ no rst | rst <Sys::RstBit> ] [ no tos | tos <Sys::Tos> ] [ no direction |
direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )

Command Parameters
Table 11.12-1 "SHub System TCP Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]

L3 Filter rule number

Table 11.12-2 "SHub System TCP Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] action-drop

Parameter type: boolean

optional parameter

3HH-04416-EBAA-TCZZA 01

Released

329

11 System Configuration Commands

Parameter

Type

[no] dst-ip-addr

Parameter type: <Ip::NetworkAddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NetworkAddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::AckBit>
Format:
( establish
| not-establish
| any )
Possible values:
- establish : establish the bit
- not-establish : not establish the bit
- any : default value
Parameter type: <Sys::RstBit>
Format:
( set
| not-set
| any )
Possible values:
- set : set the bit
- not-set : not set the bit
- any : default value
Parameter type: <Sys::Tos>
Format:
( not-applicable
| best-effort
| high-reliable
| high-throughput

[no] src-ip-addr

[no] min-dst-port

[no] max-dst-port

[no] min-src-port

[no] max-src-port

[no] ack

[no] rst

[no] tos

330

Released

Description
the packet will be discarded
optional parameter with default
value: "0.0.0.0/0"
destination IP address to be
matched with the packet

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: 0
min port in destination port
range(TCP/UDP ports)
optional parameter with default
value: 65535
maximum port in the destination
port range
optional parameter with default
value: 0
minimum port in the source port
range
optional parameter with default
value: 65535
maximum port in the source port
range
optional parameter with default
value: "any"
tcp ACK bit to be checked
against the packet

optional parameter with default


value: "any"
tcp RST bit to be checked against
the packet

optional parameter with default


value: "any"
IP TOS bit to be checked against
the packet

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

[no] direction

[no] vlan-id

Type

Description

| high-relia-thro
| low-delay
| low-delay-high-relai
| low-delay-high-thro
| best-tos
| any )
Possible values:
- not-applicable : tos is don't care
obsolete alternative replaced by best-effort
- best-effort : best-effort
- high-reliable : high reliable
- high-throughput : high through put
- high-relia-thro : high reliable and through put
- low-delay : low delay
- low-delay-high-relai : low delay and high reliability
- low-delay-high-thro : low delay and high through put
- best-tos : low delay, high reliability and through put
- any : any tos value
Parameter type: <Sys::Direction>
Format:
( in
| out )
Possible values:
- in : incoming packets
- out : outgoing packets
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

optional parameter with default


value: "in"
specifies direction in which filters
are applied

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.12-3 "SHub System TCP Filter Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::WaitRowStatusTCP>


( valid
| corrupted
| corrupted )
Possible values:
- valid : TCP filter configuration is ok
- corrupted : TCP filter configuration
operational(not-in-service)
- corrupted : TCP filter configuration
operational(not-ready)

the status of L3 TCP filter


This element is only shown in
detail mode.

is

not

is

not

Released

331

11 System Configuration Commands

11.13 SHub System TCP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) ( no in-port (port) ) | ( in-port (port) )

Command Parameters
Table 11.13-1 "SHub System TCP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

L3 Filter rule number

(port)

332

Released

the network port

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.14 SHub System TCP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) ( no out-port (port) ) | ( out-port (port) )

Command Parameters
Table 11.14-1 "SHub System TCP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

L3 Filter rule number

(port)

3HH-04416-EBAA-TCZZA 01

the port

Released

333

11 System Configuration Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

334

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.15 SHub System UDP Filter Configuration


Command
Command Description
This command allows the operator to configure a UDP filter on the SHub. The UDP filter takes into account
source and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
separate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 UDP filter, please
check if the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire UDP filter.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no udp (index-num) ) | ( udp (index-num) [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no min-dst-port | min-dst-port <Sys::Port> ] [ no max-dst-port |
max-dst-port <Sys::Port> ] [ no min-src-port | min-src-port <Sys::Port> ] [ no max-src-port | max-src-port
<Sys::Port> ] [ no direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )

Command Parameters
Table 11.15-1 "SHub System UDP Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]

L3 Filter rule number

Table 11.15-2 "SHub System UDP Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] action-drop

Parameter type: boolean

optional parameter
the packet will be discarded

3HH-04416-EBAA-TCZZA 01

Released

335

11 System Configuration Commands

Parameter

Type

Description

[no] dst-ip-addr

Parameter type: <Ip::NetworkAddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NetworkAddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Port>
Format:
- port number
- range: [0...65535]
Parameter type: <Sys::Direction>
Format:
( in
| out )
Possible values:
- in : incoming packets
- out : outgoing packets
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

optional parameter with default


value: "0.0.0.0/0"
destination IP address to be
matched with the packet

[no] src-ip-addr

[no] min-dst-port

[no] max-dst-port

[no] min-src-port

[no] max-src-port

[no] direction

[no] vlan-id

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: 0
min port in the destination port
range(TCP/UDP ports)
optional parameter with default
value: 65535
maximum port in the destination
port range
optional parameter with default
value: 0
minimum port in the source port
range
optional parameter with default
value: 65535
maximum port in the source port
range
optional parameter with default
value: "in"
specifies in which direction the
filters are applied

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.15-3 "SHub System UDP Filter Configuration Command" Display parameters
Specific Information
name
entry-status

336

Released

Type

Description

Parameter type: <Sys::WaitRowStatusUDP>


( valid

the status of L3 UDP filter


This element is only shown in

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

| corrupted
| corrupted )
Possible values:
- valid : UDP filter configuration is ok
- corrupted : UDP filter configuration
operational(not-in-service)
- corrupted : UDP filter configuration
operational(not-ready)

detail mode.

is

not

is

not

Released

337

11 System Configuration Commands

11.16 SHub System UDP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) ( no in-port (port) ) | ( in-port (port) )

Command Parameters
Table 11.16-1 "SHub System UDP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

L3 Filter rule number

(port)

338

Released

the network port

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.17 SHub System UDP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) ( no out-port (port) ) | ( out-port (port) )

Command Parameters
Table 11.17-1 "SHub System UDP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

L3 Filter rule number

(port)

3HH-04416-EBAA-TCZZA 01

the port

Released

339

11 System Configuration Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

340

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.18 SHub System Other Protocol Filter


Configuration Command
Command Description
Obsolete command, replaced by two commands 1.configure system shub filter ip-filter in-port 2.configure
system shub filter ip-filter out-port.
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no port-filter (filter-rule) ) | ( port-filter (filter-rule) [ no protocol | protocol
<Sys::RestrictedProtocol>
]
[
[
no
]
action-drop
]
[
no
dst-ip-addr
|
dst-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no
direction | direction <Sys::Direction> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )
Obsolete command, replaced by two commands 1.configure system shub filter ip-filter in-port 2.configure
system shub filter ip-filter out-port.

Command Parameters
Table 11.18-1 "SHub System Other Protocol Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(filter-rule)

Format:
- Filter rule number

L3 filter rule number

3HH-04416-EBAA-TCZZA 01

Released

341

11 System Configuration Commands

Resource Identifier

Type

Description

- range: [1...65535]

Table 11.18-2 "SHub System Other Protocol Filter Configuration Command" Command
Parameters
Parameter

Type

Description

[no] protocol

Parameter type: <Sys::RestrictedProtocol>


Format:
( igmp
| ggp
| ip
| egp
| igp
| nvp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
Parameter type: boolean

optional parameter with default


value: "any"
type of protocol to be checked
against the packet

[no] action-drop
[no] dst-ip-addr

Parameter type: <Ip::NetworkAddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NetworkAddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Sys::Direction>
Format:
( in
| out )
Possible values:

[no] src-ip-addr

[no] direction

342

Released

optional parameter
the packet will be discarded
optional parameter with default
value: "0.0.0.0/0"
destination IP address to be
matched with the packet

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: "in"
specifies in which direction the
Filters are applied

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter
[no] vlan-id

Type

Description

- in : incoming packets
- out : outgoing packets
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.18-3 "SHub System Other Protocol Filter Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::WaitRowStatusPortList>


( valid
| corrupted
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration
operational(not-in-service)
- corrupted : IP filter configuration
operational(not-ready)

the status of L3 IP filter


This element is only shown in
detail mode.

is

not

is

not

Released

343

11 System Configuration Commands

11.19 SHub System Other Protocol Filter In Port


List Configuration Command
Command Description
Obsolete command, replaced by configure system shub filter ip-filter in-port.
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) ( no in-port (port) ) | ( in-port (port) )
Obsolete command, replaced by configure system shub filter ip-filter in-port.

Command Parameters
Table 11.19-1 "SHub System Other Protocol Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(filter-rule)

Format:
- Filter rule number
- range: [1...65535]
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

L3 filter rule number

(port)

344

Released

the network port

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.20 SHub System Other Protocol Filter Out Port


List Configuration Command
Command Description
Obsolete command, replaced by configure system shub filter ip-filter out-port.
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) ( no out-port (port) ) | ( out-port (port) )
Obsolete command, replaced by configure system shub filter ip-filter out-port.

Command Parameters
Table 11.20-1 "SHub System Other Protocol Filter Out Port List Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(filter-rule)

Format:
- Filter rule number
- range: [1...65535]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)

L3 filter rule number

(port)

3HH-04416-EBAA-TCZZA 01

the port

Released

345

11 System Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::RackId>


- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

346

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.21 SHub System Other Protocol Filter Ip-filter


In-port Configuration Command
Command Description
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no in-port (filter-rule) port <Shub::InNetworkPort> ) | ( in-port (filter-rule)
port <Shub::InNetworkPort> [ no protocol | protocol <Sys::RestrictedProtocol> ] [ [ no ] action-drop ] [ no
dst-ip-addr | dst-ip-addr <Ip::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )

Command Parameters
Table 11.21-1 "SHub System Other Protocol Filter Ip-filter In-port Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(filter-rule)

Format:
- Filter rule number
- range: [1...65535]
Parameter type: <Shub::InNetworkPort>
Format:

L3 filter rule number

port

3HH-04416-EBAA-TCZZA 01

the network port

Released

347

11 System Configuration Commands

Resource Identifier

Type

Description

( network : <Shub::NetworkPort>
| all
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- network : network port
- nt : active nt slot
- all : apply to all ports
Field type <Shub::NetworkPort>
- network port on Shub
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number

Table 11.21-2 "SHub System Other Protocol Filter Ip-filter In-port Configuration Command"
Command Parameters
Parameter

Type

Description

[no] protocol

Parameter type: <Sys::RestrictedProtocol>


Format:
( igmp
| ggp
| ip
| egp
| igp
| nvp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
Parameter type: boolean

optional parameter with default


value: "any"
type of protocol to be checked
against the packet

[no] action-drop
[no] dst-ip-addr

348

Parameter type: <Ip::NetworkAddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address

Released

optional parameter
the packet will be discarded
optional parameter with default
value: "0.0.0.0/0"
destination IP address to be
matched with the packet

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

[no] src-ip-addr

[no] vlan-id

Type

Description

Field type <Ip::PrefixLengthFull>


- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NetworkAddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.21-3 "SHub System Other Protocol Filter Ip-filter In-port Configuration Command"
Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::WaitRowStatusPortList>


( valid
| corrupted
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration
operational(not-in-service)
- corrupted : IP filter configuration
operational(not-ready)

the status of L3 IP filter


This element is only shown in
detail mode.

is

not

is

not

Released

349

11 System Configuration Commands

11.22 SHub System Other Protocol Filter Ip-filter


Out-port Configuration Command
Command Description
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.
action-drop : this configuration is not supported for outgoing traffic (direction out).
Clarification regarding 'entry-status': If a failure occurs during the configuration of the L3 IP filter, please check if
the filter was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire IP
filter.
Clarification regarding duplicate filters : If the same filter is configured for both in-port and out-port, then the
second filter overrides the first filter. Only one filter will be existing under this scenario,as the filter row gets
created on basis of the filter rule
If a filter rule is configured on a particular port , then operator is not allowed to configure another filter rule on
the same port.Though internally this filter entry will be corrupted.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter ( no out-port (filter-rule) port <Shub::OutPort> ) | ( out-port (filter-rule) port
<Shub::OutPort> [ no protocol | protocol <Sys::RestrictedProtocol> ] [ [ no ] action-drop ] [ no dst-ip-addr |
dst-ip-addr
<Ip::NetworkAddressAndIpMaskFull>
]
[
no
src-ip-addr
|
src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ no vlan-id | vlan-id <Vlan::VlanFilterIndex> ] )

Command Parameters
Table 11.22-1 "SHub System Other Protocol Filter Ip-filter Out-port Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(filter-rule)

Format:
- Filter rule number
- range: [1...65535]
Parameter type: <Shub::OutPort>
Format:

L3 filter rule number

port

350

Released

the port

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Resource Identifier

Type

Description

( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>


| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| all
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- all : apply to all ports
- nt : active nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Shub::NoExtLink>
- unassigned external SFP port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number

Table 11.22-2 "SHub System Other Protocol Filter Ip-filter Out-port Configuration Command"
Command Parameters
Parameter

Type

Description

[no] protocol

Parameter type: <Sys::RestrictedProtocol>


Format:
( igmp
| ggp
| ip
| egp
| igp
| nvp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp

optional parameter with default


value: "any"
type of protocol to be checked
against the packet

3HH-04416-EBAA-TCZZA 01

Released

351

11 System Configuration Commands

Parameter

Type

[no] action-drop

- irtp : check the packet for irtp


- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
Parameter type: boolean

[no] dst-ip-addr

Description

optional parameter
the packet will be discarded
optional parameter with default
value: "0.0.0.0/0"
destination IP address to be
matched with the packet

Parameter type: <Ip::NetworkAddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NetworkAddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Vlan::VlanFilterIndex>
Format:
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

[no] src-ip-addr

[no] vlan-id

optional parameter with default


value: "0.0.0.0/0"
source IP address to be matched
with the packet

optional parameter with default


value: "any"
vlan to be filtered, zero means
wildcard for vlan

Command Output
Table 11.22-3 "SHub System Other Protocol Filter Ip-filter Out-port Configuration Command"
Display parameters
Specific Information
name
entry-status

352

Released

Type

Description

Parameter type: <Sys::WaitRowStatusPortList>


( valid
| corrupted
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration
operational(not-in-service)
- corrupted : IP filter configuration
operational(not-ready)

the status of L3 IP filter


This element is only shown in
detail mode.

is

not

is

not

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.23 SHub System ID Configuration Command


Command Description
This command allows the operator to configure information regarding the location and contact person for the
node.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry id [ no contact | contact <Sys::IssSysContact> ] [ no location | location
<Sys::IssSysLocation> ]

Command Parameters
Table 11.23-2 "SHub System ID Configuration Command" Command Parameters
Parameter

Type

Description

[no] contact

Parameter type: <Sys::IssSysContact>


Format:
- textual identification of the contact person
- length: x<=50
Parameter type: <Sys::IssSysLocation>
Format:
- physical location of this node
- length: x<=50

optional parameter with default


value: """"
textual identification of the
contact person
optional parameter with default
value: """"
physical location of this node

[no] location

3HH-04416-EBAA-TCZZA 01

Released

353

11 System Configuration Commands

11.24 SHub System VLAN Group Configuration


Command
Command Description
This command allows the operator to configure the SHub system VLAN group.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry vlan [ ext-vlan-id <Vlan::ExtVlanIndex> ]

Command Parameters
Table 11.24-2 "SHub System VLAN Group Configuration Command" Command Parameters
Parameter

Type

Description

ext-vlan-id

Parameter type: <Vlan::ExtVlanIndex>


Format:
- external vlan id
- range: [2...4093]

optional parameter
External Vlan id

354

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.25 SHub System ICMP Configuration Command


Command Description
This command allows the operator to configure ICMP related parameters. Currently this command is used to
enable ICMP timestamp reply.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub icmp [ no time-stamp-reply | time-stamp-reply <Sys::TsReply> ]

Command Parameters
Table 11.25-2 "SHub System ICMP Configuration Command" Command Parameters
Parameter

Type

Description

[no] time-stamp-reply

Parameter type: <Sys::TsReply>


Format:
( enable
| disable )
Possible values:
- enable : allow sending ICMP time stamp reply message
- disable : disable ICMP time stamp reply message

optional parameter with default


value: "enable"
allow sending icmp time stamp
reply Message

3HH-04416-EBAA-TCZZA 01

Released

355

11 System Configuration Commands

11.26 System Clock Configuration Command


Command Description
This command allows the operator to configure the clock source priority scheme.
This command allows the operator to configure the external clock source as E1 or DS1, or 2048Khz
ext-source parameter is ignored when priority-scheme is selected local for Non-BITS card.
The system takes default ds1 for ANSI markets and e1 for ETSI markets.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure system clock-mgmt [ no priority-scheme | priority-scheme <Sys::SysClkSrcPriorityScheme> ] [ no
ext-source | ext-source <Sys::SysClkExtSource> ] [ no ais-sensitivity | ais-sensitivity <Sys::SysClkAisSensitivity>
]

Command Parameters
Table 11.26-2 "System Clock Configuration Command" Command Parameters
Parameter

Type

Description

[no] priority-scheme

Parameter type: <Sys::SysClkSrcPriorityScheme>


Format:
( autoselect
| local
| external-local )
Possible values:
- autoselect : select based on location
- local : always select local clock
- external-local : external clock > local clock
Parameter type: <Sys::SysClkExtSource>
Format:
( e1
| ds1
| khz2048
| autoselect )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
- autoselect : autoselect Source
Parameter type: <Sys::SysClkAisSensitivity>

optional parameter with default


value: "autoselect"
select the clock priority cheme

[no] ext-source

[no] ais-sensitivity

356

Released

optional parameter with default


value: "autoselect"
select the BITS mode for the
external clock source: E1 or DS1
or 2048Khz

optional parameter with default

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( enable
| disable )
Possible values:
- enable : enable AIS sensitivity as BITS failure detection
- disable : disable AIS sensitivity as BITS failure detection

value: "disable"
configure the clock system to
react on AIS detection and use it
as BITS input failure

Released

357

11 System Configuration Commands

11.27 System Synchronous Interface Timing Clock


Configuration Command
Command Description
This command allows the operator to configure all the Clock Synchronization (NTR) characteristics of the ISAM
node.
The underlying commands and parameters are applicable for the NT's supporting Enhanced Clock Management.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing [ [ no ] revert ] [ no wait-time | wait-time <Sys::SysClkWaitTime> ] [ no
output-ql-thresh | output-ql-thresh <Ntr::SysClkSrcQL> ] [ no ssmout-ceiling | ssmout-ceiling
<Ntr::DefSysClkSrcQL> ]

Command Parameters
Table 11.27-2 "System Synchronous Interface Timing Clock Configuration Command" Command
Parameters
Parameter

Type

Description

[no] revert

Parameter type: boolean

[no] wait-time

Parameter type: <Sys::SysClkWaitTime>


Format:
- time to wait on the reference switchover
- unit: seconds
- range: [0...720]
Parameter type: <Ntr::SysClkSrcQL>
Format:
( clk-ql-stu
| clk-ql-prs
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6
| clk-ql-st2

optional parameter
configure system clock to
revertive or non-revertive
optional parameter with default
value: 10
configure time to wait on the
reference switchover

[no] output-ql-thresh

358

Released

optional parameter with default


value: "clk-ql-dnu-dus"
configure system threshold of
BITS output QL

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

[no] ssmout-ceiling

3HH-04416-EBAA-TCZZA 01

Type

Description

| clk-ql-ssu-b
| clk-ql-inv9
| clk-ql-st3
| clk-ql-sec
| clk-ql-smc
| clk-ql-st3e
| clk-ql-prov
| clk-ql-dnu-dus
| clk-ql-dnu
| clk-ql-dus )
Possible values:
- clk-ql-stu : Synchronized-Traceability Unknown
- clk-ql-prs : Primary Reference Source
- clk-ql-prc : Primary Reference Clock
- clk-ql-inv3 : Quality Level unallocated
- clk-ql-ssu-a-tnc : Traced to Sync Supply Unit-A/Transmit
Node Clock
- clk-ql-ssu-a : Traced to Sync Supply Unit-A(ETSI)
- clk-ql-tnc : Traced to Transmit Node Clock(ANSI)
- clk-ql-inv5 : Quality Level unallocated
- clk-ql-inv6 : Quality Level unallocated
- clk-ql-st2 : Traceable to Stratum 2
- clk-ql-ssu-b : Traced to Sync Supply Unit-B
- clk-ql-inv9 : Quality Level unallocated
- clk-ql-st3 : Traceable to Stratum 3
- clk-ql-sec : Traceable to SDH Equipment Clock
- clk-ql-smc : Traceable to SONET Clock SelfTimed
- clk-ql-st3e : Traceable to Stratum 3E
- clk-ql-prov : Operator Provisionned
- clk-ql-dnu-dus : Signal should not be used for sync
- clk-ql-dnu : Signal should not be used for sync(ETSI)
- clk-ql-dus : Signal should not be used for sync(ANSI)
Parameter type: <Ntr::DefSysClkSrcQL>
Format:
( clk-ql-stu
| clk-ql-prs
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6
| clk-ql-st2
| clk-ql-ssu-b
| clk-ql-inv9
| clk-ql-st3
| clk-ql-sec
| clk-ql-smc
| clk-ql-st3e
| clk-ql-prov
| clk-ql-dnu-dus
| clk-ql-dnu
| clk-ql-dus
| clk-ql-sys-def )
Possible values:
- clk-ql-stu : Synchronized-Traceability Unknown

optional parameter with default


value: "clk-ql-sys-def"
configure system threshold of
BITS and Synce output QL

Released

359

11 System Configuration Commands

Parameter

Type

Description

- clk-ql-prs : Primary Reference Source


- clk-ql-prc : Primary Reference Clock
- clk-ql-inv3 : Quality Level unallocated
- clk-ql-ssu-a-tnc : Traced to Sync Supply Unit-A/Transmit
Node Clock
- clk-ql-ssu-a : Traced to Sync Supply Unit-A(ETSI)
- clk-ql-tnc : Traced to Transmit Node Clock(ANSI)
- clk-ql-inv5 : Quality Level unallocated
- clk-ql-inv6 : Quality Level unallocated
- clk-ql-st2 : Traceable to Stratum 2
- clk-ql-ssu-b : Traced to Sync Supply Unit-B
- clk-ql-inv9 : Quality Level unallocated
- clk-ql-st3 : Traceable to Stratum 3
- clk-ql-sec : Traceable to SDH Equipment Clock
- clk-ql-smc : Traceable to SONET Clock SelfTimed
- clk-ql-st3e : Traceable to Stratum 3E
- clk-ql-prov : Operator Provisionned
- clk-ql-dnu-dus : Signal should not be used for sync
- clk-ql-dnu : Signal should not be used for sync(ETSI)
- clk-ql-dus : Signal should not be used for sync(ANSI)
- clk-ql-sys-def : System default value based on region type

360

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.28 System Clock Bits Mode Configuration


Command
Command Description
This command allows the operator to configure the clock bits mode. This command allow the operator to configure
the BITS clock source based on the Network Timing Reference used as a BITS source. The operator can configure
the values: E1, Ds1, 2048Khz or autoselect. When "autoselect" is configured, the system takes the default values:
ds1 for NTs with CLOCK capability=T1.
e1 for NTs with CLOCK capability=E1.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing bits [ (interface-type) ]

Command Parameters
Table 11.28-2 "System Clock Bits Mode Configuration Command" Command Parameters
Parameter

Type

Description

(interface-type)

Format:
( e1
| ds1
| khz2048
| autoselect )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
- autoselect : autoselect Source

optional parameter
select the external clock type E1
or DS1 or 2048Khz

3HH-04416-EBAA-TCZZA 01

Released

361

11 System Configuration Commands

11.29 System Clock Source Priority Configuration


Command
Command Description
This command allows the operator to configure the clock source priority.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing ref-order (index) [ (priority) ]

Command Parameters
Table 11.29-1 "System Clock Source Priority Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( prio1
| prio2 )
Possible values:
- prio1 : configure primary clock source
- prio2 : configure secondary clock source

clock priority index

Table 11.29-2 "System Clock Source Priority Configuration Command" Command Parameters
Parameter

Type

Description

(priority)

Format:
( bits-a
| bits-b
| synce-1
| synce-2
| ieee1588-a
| ieee1588-b
| none )
Possible values:
- bits-a : select BITS-A for this priority
- bits-b : select BITS-B for this priority
- synce-1 : select SyncE reference 1 for this priority
- synce-2 : select SyncE reference 2 for this priority
- ieee1588-a : select IEEE 1588-A clock for this priority
- ieee1588-b : select IEEE 1588-B clock for this priority
- none : remove clock source for this priority

optional parameter
frequency clock priority selection

362

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.30 System Clock Synchronous Status Message


Configuration Command
Command Description
This command allows the operator to configure the support of synchronous status message (SSM) for the
configured clock source.
Note: When the default-ql is unconfigured, the system resets the default QL value as clk-ql-stu or clk-ql-prc based
on the bits mode.All QL Values are applicable to both ETSI/ANSI unless the difference specified in CLI help.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing ssm (index) [ [ no ] ssmenable ] [ no default-ql | default-ql
<Ntr::SysClkSrcQLDef> ] [ no target-ql | target-ql <Ntr::SysClkSrcQL> ]

Command Parameters
Table 11.30-1 "System Clock Synchronous Status Message Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
( bits-a
| bits-b
| synce-1
| synce-2
| ieee1588-a
| ieee1588-b )
Possible values:
- bits-a : configure SSM for bits-a
- bits-b : configure SSM for bits-b
- synce-1 : configure SSM for SyncE reference 1
- synce-2 : configure SSM for SyncE reference 2
- ieee1588-a : configure SSM for ieee1588-a
- ieee1588-b : configure SSM for ieee1588-b

clock
synchronous
message index

Table 11.30-2 "System Clock Synchronous Status Message Configuration Command" Command
Parameters
Parameter

Type

Description

[no] ssmenable

Parameter type: boolean

optional parameter
enable ssm

3HH-04416-EBAA-TCZZA 01

Released

363

status

11 System Configuration Commands

Parameter

Type

Description

[no] default-ql

Parameter type: <Ntr::SysClkSrcQLDef>


Format:
( clk-ql-stu
| clk-ql-prs
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6
| clk-ql-st2
| clk-ql-ssu-b
| clk-ql-inv9
| clk-ql-st3
| clk-ql-sec
| clk-ql-smc
| clk-ql-st3e
| clk-ql-prov
| clk-ql-dnu-dus
| clk-ql-dnu
| clk-ql-dus
| clk-ql-default )
Possible values:
- clk-ql-stu : Synchronized-Traceability Unknown
- clk-ql-prs : Primary Reference Source
- clk-ql-prc : Primary Reference Clock
- clk-ql-inv3 : Quality Level unallocated
- clk-ql-ssu-a-tnc : Traced to Sync Supply Unit-A/Transmit
Node Clock
- clk-ql-ssu-a : Traced to Sync Supply Unit-A(ETSI)
- clk-ql-tnc : Traced to Transmit Node Clock(ANSI)
- clk-ql-inv5 : Quality Level unallocated
- clk-ql-inv6 : Quality Level unallocated
- clk-ql-st2 : Traceable to Stratum 2
- clk-ql-ssu-b : Traced to Sync Supply Unit-B
- clk-ql-inv9 : Quality Level unallocated
- clk-ql-st3 : Traceable to Stratum 3
- clk-ql-sec : Traceable to SDH Equipment Clock
- clk-ql-smc : Traceable to SONET Clock SelfTimed
- clk-ql-st3e : Traceable to Stratum 3E
- clk-ql-prov : Operator Provisionned
- clk-ql-dnu-dus : Signal should not be used for sync
- clk-ql-dnu : Signal should not be used for sync(ETSI)
- clk-ql-dus : Signal should not be used for sync(ANSI)
- clk-ql-default : Special identifier for SSM QL default
Parameter type: <Ntr::SysClkSrcQL>
Format:
( clk-ql-stu
| clk-ql-prs
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6

optional parameter with default


value: "clk-ql-default"
default QL of the clock source

[no] target-ql

364

Released

optional parameter with default


value: "clk-ql-dnu-dus"
target QL of the clock source

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

Type

Description

| clk-ql-st2
| clk-ql-ssu-b
| clk-ql-inv9
| clk-ql-st3
| clk-ql-sec
| clk-ql-smc
| clk-ql-st3e
| clk-ql-prov
| clk-ql-dnu-dus
| clk-ql-dnu
| clk-ql-dus )
Possible values:
- clk-ql-stu : Synchronized-Traceability Unknown
- clk-ql-prs : Primary Reference Source
- clk-ql-prc : Primary Reference Clock
- clk-ql-inv3 : Quality Level unallocated
- clk-ql-ssu-a-tnc : Traced to Sync Supply Unit-A/Transmit
Node Clock
- clk-ql-ssu-a : Traced to Sync Supply Unit-A(ETSI)
- clk-ql-tnc : Traced to Transmit Node Clock(ANSI)
- clk-ql-inv5 : Quality Level unallocated
- clk-ql-inv6 : Quality Level unallocated
- clk-ql-st2 : Traceable to Stratum 2
- clk-ql-ssu-b : Traced to Sync Supply Unit-B
- clk-ql-inv9 : Quality Level unallocated
- clk-ql-st3 : Traceable to Stratum 3
- clk-ql-sec : Traceable to SDH Equipment Clock
- clk-ql-smc : Traceable to SONET Clock SelfTimed
- clk-ql-st3e : Traceable to Stratum 3E
- clk-ql-prov : Operator Provisionned
- clk-ql-dnu-dus : Signal should not be used for sync
- clk-ql-dnu : Signal should not be used for sync(ETSI)
- clk-ql-dus : Signal should not be used for sync(ANSI)

3HH-04416-EBAA-TCZZA 01

Released

365

11 System Configuration Commands

11.31 System Clock Synchronous Source port


Configuration Command
Command Description
This command allows the operator to configure the binding of the syncE reference to the physical port which
provides the clock source for synchronous Ethernet.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing synce (index) [ (port) ]

Command Parameters
Table 11.31-1 "System Clock Synchronous Source port Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
( synce-1
| synce-2 )
Possible values:
- synce-1 : configure port for SyncE reference 1
- synce-2 : configure port for SyncE reference 2

reference number of the port

Table 11.31-2 "System Clock Synchronous Source port Configuration Command" Command
Parameters
Parameter

Type

(port)

Format:
optional parameter
( ntio-1 : sfp : <ClkSys::SfpFaceplateNumber>
port number supporting synce
| ntio-1 : xfp : <ClkSys::SfpFaceplateNumber>
clock source
| ntio-2 : sfp : <ClkSys::SfpFaceplateNumber>
| ntio-2 : xfp : <ClkSys::SfpFaceplateNumber>
| nt-a : xfp : <ClkSys::SfpFaceplateNumber>
| nt-b : xfp : <ClkSys::SfpFaceplateNumber>
| nt : sfp : <ClkSys::SfpFaceplateNumber>
| none )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot

366

Released

Description

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

Parameter

Type

Description

- nt : active nt slot
- none : no port
Possible values:
- nosfp : no SFP/XFP port
- sfp : SFP port
- xfp : XFP port
Field type <ClkSys::SfpFaceplateNumber>
- host SFP faceplate number

3HH-04416-EBAA-TCZZA 01

Released

367

11 System Configuration Commands

11.32 System Clock Force Reference Configuration


Command
Command Description
This command allows the operator to manually select the clock source. Note that the operator must release the
manual clock selection ([none]) to restore the automatic (external) clock source selection.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing force-reference [ (force-reference) ]

Command Parameters
Table 11.32-2 "System Clock Force Reference Configuration Command" Command Parameters
Parameter

Type

Description

(force-reference)

Format:
( local
| none )
Possible values:
- local : select hold over clock
- none : select autonomous clock selection

optional parameter
manually force system clock
source

368

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.33 SSMOut Configuration Command for synce


ports
Command Description
This command allows the operator to enable or disable SSMout for synce ports. This command is applicable to
NT's supporting enhanced clock management

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing ssmout-synce (index) [ [ no ] ssmout-enable ]

Command Parameters
Table 11.33-1 "SSMOut Configuration Command for synce ports" Resource Parameters
Resource Identifier

Type

(index)

Format:
xdsl port supporting synce clock
( ntio-1 : sfp : <ClkSys::SynceOutFaceplateNumber>
source
| ntio-1 : xfp : <ClkSys::SynceOutFaceplateNumber>
| ntio-2 : sfp : <ClkSys::SynceOutFaceplateNumber>
| ntio-2 : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt-a : sfp : <ClkSys::SynceOutFaceplateNumber>
| nt-a : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt-b : sfp : <ClkSys::SynceOutFaceplateNumber>
| nt-b : xfp : <ClkSys::SynceOutFaceplateNumber>
| nt : sfp : <ClkSys::SynceOutFaceplateNumber>
| none )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : active nt slot
- none : no port
Possible values:
- nosfp : no SFP/XFP port
- sfp : SFP port
- xfp : XFP port
Field type <ClkSys::SynceOutFaceplateNumber>
- host SFP faceplate number

3HH-04416-EBAA-TCZZA 01

Description

Released

369

11 System Configuration Commands

Table 11.33-2 "SSMOut Configuration Command for synce ports" Command Parameters
Parameter

Type

Description

[no] ssmout-enable

Parameter type: boolean

optional parameter
enable ssm-out for synce port

370

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.34 SSMOut Configuration Command for XDSL


ports
Command Description
This command allows the operator to enable or disable SSMout for xDSL ports. This command is applicable to
NT's supporting enhanced clock management

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sync-if-timing ( no ssmout-ltport (index) ) | ( ssmout-ltport (index) [ [ no ] ssmout-enable ] )

Command Parameters
Table 11.34-1 "SSMOut Configuration Command for XDSL ports" Resource Parameters
Resource Identifier

Type

(index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description
xdsl port supporting synce clock
/ source
/
/
/
/
/
/

Released

371

11 System Configuration Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 11.34-2 "SSMOut Configuration Command for XDSL ports" Command Parameters
Parameter

Type

Description

[no] ssmout-enable

Parameter type: boolean

optional parameter
enable ssm-out for dsl port

372

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.35 Maximum Lt Link Speed Configuration


Command
Command Description
This command allows the operator to configure the maximum lt link speed.
Note: maxltlinkspeed value 20Gb is not supported on NANT-E, this is only supported on FANT-F.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system max-lt-link-speed [ no link-speed | link-speed <Sys::MaxLtLinkSpeed> ]

Command Parameters
Table 11.35-2 "Maximum Lt Link Speed Configuration Command" Command Parameters
Parameter

Type

Description

[no] link-speed

Parameter type: <Sys::MaxLtLinkSpeed>


Format:
( one-gb
| twodotfive-gb
| ten-gb
| twenty-gb
| forty-gb )
Possible values:
- one-gb : enables max 1 Gbps lt link speed
- twodotfive-gb : enables max 2.5 Gbps lt link speed
- ten-gb : enables max 10 Gbps lt link speed
- twenty-gb : enables max 20 Gbps lt link speed
- forty-gb : enables max 40 Gbps lt link speed

optional parameter with default


value: "one-gb"
the maximum lt link speed

3HH-04416-EBAA-TCZZA 01

Released

373

11 System Configuration Commands

11.36 ALS State Configuration Command


Command Description
This command allows the operator to enable or disable the system wide ALS state.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system auto-laser-shutdown [ no action | action <Sys::AlsState> ]

Command Parameters
Table 11.36-2 "ALS State Configuration Command" Command Parameters
Parameter

Type

Description

[no] action

Parameter type: <Sys::AlsState>


Format:
( enable
| disable )
Possible values:
- enable : enable ALS state
- disable : disable ALS state

optional parameter with default


value: "enable"
system wide ALS handling state

374

Released

3HH-04416-EBAA-TCZZA

01

11 System Configuration Commands

11.37 Configure system auto-switch


Command Description
This command allows the operator to configure system-wide auto-switching parameters.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system auto-switch [ [ no ] xdsl-atm-ptm ] [ no xdsl-stepup-delay | xdsl-stepup-delay
<Sys::AutoSwitchDelayTime> ]

Command Parameters
Table 11.37-2 "Configure system auto-switch" Command Parameters
Parameter

Type

Description

[no] xdsl-atm-ptm

Parameter type: boolean

[no] xdsl-stepup-delay

Parameter type: <Sys::AutoSwitchDelayTime>


Format:
- delay time in seconds
- unit: seconds
- range: [0...65535]

optional parameter
enable
system-wide
auto-switching between ATM
and PTM on XDSL ports.
optional parameter with default
value: 3600
auto-switching step up delay time
(seconds) for PTM service(s).

3HH-04416-EBAA-TCZZA 01

Released

375

12- Security Configuration Commands

12.1 Security Configuration Command Tree


12.2 Security Banner Configuration Commmand
12.3 Operator Configuration Command
12.4 Profile Configuration Command
12.5 Default Profile Configuration Command
12.6 SNMP View Configuration Command
12.7 Security SNMP Community Configuration Command
12.8 Security SNMPv3 Group Configuration Command
12.9 Security SNMPv3 User Configuration Command
12.10 Security SNMPv3 User-Group Configuration
Command
12.11 SNMP Notify View Configuration Command
12.12 Security SNMP Notification Profile Configuration
Command
12.13 Security SNMP Notification Profile Filter
Configuration Command
12.14 Security SNMP Element Manager Configuration
Command
12.15 Security RADIUS Client Configuration Command
12.16 Security RADIUS Authentication Server
Configuration Command
12.17 Security RADIUS Accounting Server Configuration
Command
12.18 Security RADIUS Dynamic Authorization Client
Configuration Command
12.19 Security RADIUS Policy Configuration Command
12.20 Security RADIUS Server Configuration Command
12.21 Security Domain Configuration Command
12.22 Security Connection Profile Configuration Command
12.23 Security Connection Policy Configuration Command
12.24 Security 802.1x PAE System Configuration
Command
12.25 Security 802.1x Port Authentication Configuration
Command
12.26 Security 802.1x Extension, Port Authentication
Configuration Command
12.27 Security 802.1x Port Configuration Command
12.28 Security Password Policy Configuration Commmand
12.29 File Transfer Configure Command
12.30 file Transfer server Configure Commands
12.31 PM File Upload Configure Command
12.32 PM File Upload Configure Command
12.33 MAC Filter Configuration Command

376

Released

12-377
12-382
12-383
12-385
12-392
12-398
12-400
12-402
12-405
12-407
12-409
12-411
12-413
12-415
12-417
12-418
12-420
12-422
12-424
12-426
12-428
12-430
12-431
12-432
12-433
12-436
12-438
12-440
12-442
12-443
12-444
12-445
12-447

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.1 Security Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Security Configuration Commands".

Command Tree
----configure
----system
----security
- [no] login-banner
- [no] welcome-banner
----[no] operator
- (name)
- profile
- password
- [no] prompt
- [no] description
- [no] more
----[no] profile
- (name)
- [no] prompt
- [no] password-timeout
- [no] terminal-timeout
- [no] slot-numbering
- [no] description
- [no] aaa
- [no] atm
- [no] alarm
- [no] dhcp
- [no] equipment
- [no] igmp
- [no] ip
- [no] pppoe
- [no] qos
- [no] software-mngt
- [no] transport
- [no] vlan
- [no] xdsl
- [no] sip
- [no] megaco
- [no] lacp
- [no] mstp
- [no] security
- [no] service
- [no] debug
- [no] debug-mirror
- [no] filter
- [no] link
- [no] log
- [no] oam
- [no] liadmin

3HH-04416-EBAA-TCZZA 01

Released

377

12 Security Configuration Commands

- [no] liuser
- [no] drouter
----default-profile
- [no] prompt
- [no] password-timeout
- [no] terminal-timeout
- [no] slot-numbering
- [no] description
- [no] aaa
- [no] atm
- [no] alarm
- [no] dhcp
- [no] equipment
- [no] igmp
- [no] ip
- [no] pppoe
- [no] qos
- [no] software-mngt
- [no] transport
- [no] vlan
- [no] xdsl
- [no] sip
- [no] megaco
- [no] lacp
- [no] mstp
- [no] security
- [no] service
- [no] debug
- [no] debug-mirror
- [no] filter
- [no] link
- [no] log
- [no] oam
- [no] liadmin
- [no] liuser
- [no] drouter
----snmp
----[no] view
- (notify-view)
- subtree
- type
----[no] community
- (name)
- host-address
- [no] context
- [no] privilege
- [no] read-view
- [no] write-view
- [no] notify-view
----[no] group
- (name)
- security-level
- context
- [no] read-view
- [no] write-view
- [no] notify-view
----[no] user
- (name)
- [no] authentication

378

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

- [no] privacy
- [no] public
----[no] map-user-group
- (name)
- group-name
----[no] notify-view
- (notify-view)
- subtree
- type
----[no] notify-profile
- (name)
- snmp-version
----[no] filter
- notify-view
----[no] manager
- (name)
- destination
- notify-profile
- [no] nt
- [no] shub
- [no] epon
- [no] xvps1
- [no] xvps2
- [no] xvps3
- [no] xvps4
- [no] xvps5
- [no] xvps6
- [no] xvps7
- [no] xvps8
----radius
- [no] relay
- [no] auth-super-user
- [no] operator-policy
- [no] aut-s-unreach-act
----[no] auth-server
- (name)
- vrf-index
- ip-address
- [no] port
- secret
- [no] retry-limit
- [no] timeout-limit
- [no] admin-down
- [no] dead-interval
----[no] acc-server
- (name)
- vrf-index
- ip-address
- [no] port
- secret
- [no] retry-limit
- [no] timeout-limit
- [no] admin-down
- [no] dead-interval
----[no] dyn-auth-client
- (name)
- vrf-index
- ip-address
- secret

3HH-04416-EBAA-TCZZA 01

Released

379

12 Security Configuration Commands

- [no] admin-down
----[no] policy
- (name)
- nas-id
- nas-ip-address
- [no] keep-domain-name
- [no] disable-accnt-msg
- [no] acc-interval
- [no] disable-eap
----[no] servers
- (index)
- auth-server
- vrf-index-auth
- [no] acc-server
- [no] vrf-index-acc
- priority
----[no] domain
- (name)
- vrf-index
- [no] vlan-id
- [no] primary-dns
- [no] second-dns
- [no] primary-nbns
- [no] second-nbns
- [no] sess-timeout
- [no] qos-policy
- authenticator
- [no] admin-down
----[no] conn-profile
- (name)
- version
- [no] reject-no-domain
- [no] reject-inv-domain
- domain-name
----[no] conn-policy
- conn-profile-name
----pae
- [no] port-access
----authenticator
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] re-auth-enabled
- [no] re-auth-period
----ext-authenticator
- (port)
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
----port
- (port)
- [no] initialize
----password
- min-length

380

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

- min-num-numeric-char
- min-num-special-char
- [no] mixed-case
----filetransfer
- [no] protocol
- [no] tftp-rollovr
----[no] server
- (serverid)
- user-name
- password
----pmfile
----[no] upload
- (upload-index)
- pri-server-addr
- upload-path
- [no] upload-username
- [no] upload-password
- interval-type
- [no] auto-upload
- [no] retry-num
- [no] max-delay
----peripheral-mgnt
----mac-filter
- (index-num)
- [no] filter

3HH-04416-EBAA-TCZZA 01

Released

381

12 Security Configuration Commands

12.2 Security Banner Configuration Commmand


Command Description
This command allows the operator to configure the login banner and the welcome banner.
There is a limit to the number of characters that can be entered in a single CLI command. For lengthy banners,
Alcatel-Lucent recommends that the operator enter separate commands to configure the login banner and the
welcome banner.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security [ no login-banner | login-banner <Sec::Banner> ] [ no welcome-banner |
welcome-banner <Sec::Banner> ]

Command Parameters
Table 12.2-2 "Security Banner Configuration Commmand" Command Parameters
Parameter

Type

Description

[no] login-banner

Parameter type: <Sec::Banner>


Format:
- a banner to be shown to the operator Note: up to 2048
length of banner is only supported on FANT-F, 480 for other
NT. If using special and functional characters like pound,
reversed slash,space, the whole banner must be in the
quotation marks. Quotation marks and reversed slash is not
counted in length. A reversed slash followed by 'r' combined
with reversed slash followed by 'n' is used to change line.
- length: x<=2048
Parameter type: <Sec::Banner>
Format:
- a banner to be shown to the operator Note: up to 2048
length of banner is only supported on FANT-F, 480 for other
NT. If using special and functional characters like pound,
reversed slash,space, the whole banner must be in the
quotation marks. Quotation marks and reversed slash is not
counted in length. A reversed slash followed by 'r' combined
with reversed slash followed by 'n' is used to change line.
- length: x<=2048

optional parameter with default


value: ""
banner to be shown before the
operator enters its name

[no] welcome-banner

382

Released

optional parameter with default


value: ""
the banner to be shown when the
operator logged in

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.3 Operator Configuration Command


Command Description
This command allows the operator to specify an operator instance.
After this instance is created, an operator can log in to the system with the specified name and password.
Operators have a profile that determines most of the operator properties. The operator profile must be created
before the operator can be created.
The operator profile is assigned when the operator is created. The profile cannot be changed afterward. If the
operator wants to change the profile, the operator must first delete the operator and then recreate it.
The default values for prompt can be found in configure system security profile profile-name.
The following rules apply to a plain text password.
The password must consist of a minimum of six and a maximum of 20 printable characters.
The password must contain at least one non-alphanumeric character.
A new password must be different from the last three passwords.
Never specify a new password using the encrypted option. You could mistakenly enter any hexadecimal string that
is not necessarily linked to a password, and it is almost impossible to calculate a password from an encrypted
string. The encrypted method of specifying passwords is only intended to restore an existing configuration.
An operator must enter a new password when logging in for the first time after another operator has changed his
or her password.
There is no separate command to change a password. An operator must change the password in the operator's
operator node.
The prompt can be composed with following components :
%n : the name of the current operator.
%s : the current numbering scheme (typ|leg|pos).
%! : the current history number.
% num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.

%% : a %
%c : # if the current node was an existing node or $ if it is newly created.
any other character is just added to the prompt as is.

User Level
The command can be accessed by operators with all,admin privileges, and executed by operators with all
privileges.
The last operator with security write permissions cannot be deleted.
An operator can be deleted when still logged in. The operator instance is only removed after the operator has
logged out or is logged out by the system.
Operators without security read or write permissions cannot see other operators.
Operators without security write permissions cannot create, delete, or modify another operator, but they can enter
the commands to perform these actions. However, these commands always fail when executed.

3HH-04416-EBAA-TCZZA 01

Released

383

12 Security Configuration Commands

Command Syntax
The command has the following syntax:
> configure system security ( no operator (name) ) | ( operator (name) profile <Sec::ProfileName> password
<Sec::Password> [ no prompt | prompt <Sec::Prompt> ] [ no description | description <Sec::OperatorDesc> ] [ [ no
] more ] )

Command Parameters
Table 12.3-1 "Operator Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11

the name of the operator

Table 12.3-2 "Operator Configuration Command" Command Parameters


Parameter

Type

Description

profile

Parameter type: <Sec::ProfileName>


Format:
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11
Parameter type: <Sec::Password>
Format:
( prompt
| plain : <Sec::PlainPassword>
| encrypted : <Sec::EncryptedPassword> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
- encrypted : the hashed password
Field type <Sec::PlainPassword>
- the password in plain text is placed in double quotes when
# or ? is used
- length: 6<=x<=20
Field type <Sec::EncryptedPassword>
- the encrypted password
- length: 20
Parameter type: <Sec::Prompt>
Format:
- a specification of the prompt
- length: x<=28
Parameter type: <Sec::OperatorDesc>
Format:
- any description to be used by the operator
- length: x<=31
Parameter type: boolean

mandatory parameter
The parameter is not visible
during modification.
the name of an operator profile

password

[no] prompt

[no] description

[no] more

384

Released

mandatory parameter
the password needed to log in

optional parameter with default


value: ""
the specification of the prompt
optional parameter with default
value: ""
any description to be used by the
operator
optional parameter
the output is passed via the more
filter

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.4 Profile Configuration Command


Command Description
This command allows the operator to specify an operator profile.
The operator profile determines most of the operator properties.
An operator profile is typically used to limit the commands that a group of operators can execute to those for which
they have the necessary skills and for which they are responsible.
Any change of the attribute slot-numbering will only take effect for new CLI sessions. The slot-numbering of an
active CLI session will never be changed. The actual slot-numbering used for a session can be made visible with
the command show sessions
terminal-timeout: A value of 0 equals an infinite timeout value (i.e. the terminal will never time out).
The prompt can be composed with following components :
%n : the name of the current operator.
%s : the current numbering scheme (typ|leg|pos).
%! : the current history number.
% num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.

%% : a %
%c : # if the current node was an existing node or $ if it is newly created.
any other character is just added to the prompt as is.

User Level
The command can be accessed by operators with all,admin privileges.
The last operator with security write permissions cannot be deleted.
The permissions of a profile cannot be changed as long as one operator belongs to the profile.
Operators without security read or write permissions cannot see other operator profiles.

Command Syntax
The command has the following syntax:
> configure system security ( no profile (name) ) | ( profile (name) [ no prompt | prompt <Sec::Prompt> ] [ no
password-timeout | password-timeout <Sec::PasswordTimeout> ] [ no terminal-timeout | terminal-timeout
<Sec::InactivityTimeout> ] [ no slot-numbering | slot-numbering <Sec::SlotDesc> ] [ no description | description
<Sec::ProfileDesc> ] [ no aaa | aaa <Sec::Aaa> ] [ no atm | atm <Sec::Atm> ] [ no alarm | alarm <Sec::Alarm> ] [
no dhcp | dhcp <Sec::Dhcp> ] [ no equipment | equipment <Sec::Equipment> ] [ no igmp | igmp <Sec::Igmp> ] [ no
ip | ip <Sec::Ip> ] [ no pppoe | pppoe <Sec::Pppoe> ] [ no qos | qos <Sec::Qos> ] [ no software-mngt |
software-mngt <Sec::Sw> ] [ no transport | transport <Sec::Transport> ] [ no vlan | vlan <Sec::Vlan> ] [ no xdsl |
xdsl <Sec::Xdsl> ] [ no sip | sip <Sec::Sip> ] [ no megaco | megaco <Sec::Megaco> ] [ no lacp | lacp <Sec::Lacp> ]
[ no mstp | mstp <Sec::Mstp> ] [ no security | security <Sec::Security> ] [ no service | service <Sec::Service> ] [ no
debug | debug <Sec::Debug> ] [ no debug-mirror | debug-mirror <Sec::DebugMirror> ] [ no filter | filter
<Sec::Filter> ] [ no link | link <Sec::Link> ] [ no log | log <Sec::Log> ] [ no oam | oam <Sec::Oam> ] [ no liadmin |

3HH-04416-EBAA-TCZZA 01

Released

385

12 Security Configuration Commands

liadmin <Sec::Liadmin> ] [ no liuser | liuser <Sec::Liuser> ] [ no drouter | drouter <Sec::Drouter> ] )

Command Parameters
Table 12.4-1 "Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11

the name of the profile

Table 12.4-2 "Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] prompt

Parameter type: <Sec::Prompt>


Format:
- a specification of the prompt
- length: x<=28
Parameter type: <Sec::PasswordTimeout>
Format:
- the maximum time a password may be unchanged
- unit: days
- range: [0...365]
Parameter type: <Sec::InactivityTimeout>
Format:
- specify the inactivity timeout of the terminal
- unit: minutes
- range: [0...120]
Parameter type: <Sec::SlotDesc>
Format:
( type-based
| position-based
| legacy-based )
Possible values:
- type-based : flat-numbering per slot-type (tl1-like)
- position-based : flat-numbering independent of slot-type
- legacy-based : numbering used since the early days
(position-based-like)
Parameter type: <Sec::ProfileDesc>
Format:
- any description to be used by the operator
- length: x<=31
Parameter type: <Sec::Aaa>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Atm>
Format:
( write
| read
| none )
Possible values:

optional parameter with default


value: "\"%s : %n%d%c \""
the specification of the prompt

[no] password-timeout

[no] terminal-timeout

[no] slot-numbering

[no] description

[no] aaa

[no] atm

386

Released

optional parameter with default


value: 0
the maximum time a password
may be unchanged
optional parameter with default
value: 30
specify the inactivity timeout of
the terminal
optional parameter with default
value: "legacy-based"
slot numbering scheme to be used
by the operator

optional parameter with default


value: ""
any description to be used by the
operator
optional parameter with default
value: "none"
the access rights to AAA related
commands

optional parameter with default


value: "none"
the access rights to ATM related
commands

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

[no] alarm

[no] dhcp

[no] equipment

[no] igmp

[no] ip

[no] pppoe

3HH-04416-EBAA-TCZZA 01

Type
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Alarm>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Dhcp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Equipment>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Igmp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Ip>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Pppoe>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

Description

optional parameter with default


value: "none"
the access rights to alarm related
commands

optional parameter with default


value: "none"
the access rights to DHCP related
commands

optional parameter with default


value: "none"
the access rights to equipment
related commands

optional parameter with default


value: "none"
the access rights to IGMP related
commands

optional parameter with default


value: "none"
the access rights to IP related
commands

optional parameter with default


value: "none"
the access rights to PPPOE
related commands

Released

387

12 Security Configuration Commands

Parameter

Type

Description

[no] qos

Parameter type: <Sec::Qos>


Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Sw>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Transport>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Vlan>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Xdsl>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Sip>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Megaco>
Format:
( write

optional parameter with default


value: "none"
the access rights to qos related
commands

[no] software-mngt

[no] transport

[no] vlan

[no] xdsl

[no] sip

[no] megaco

388

Released

optional parameter with default


value: "none"
access
rights
to
software
management related commands

optional parameter with default


value: "none"
the access rights to transport
related commands

optional parameter with default


value: "none"
the access rights to VLAN related
commands

optional parameter with default


value: "none"
the access rights to xDSL related
commands

optional parameter with default


value: "none"
the access rights to sip related
commands

optional parameter with default


value: "none"
the access rights to megaco

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

[no] lacp

[no] mstp

[no] security

[no] service

[no] debug

[no] debug-mirror

3HH-04416-EBAA-TCZZA 01

Type

Description

| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Lacp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Mstp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Security>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Service>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Debug>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::DebugMirror>
Format:
( write
| read
| none )
Possible values:

related commands

optional parameter with default


value: "none"
the access rights to lacp related
commands

optional parameter with default


value: "none"
the access rights to mstp related
commands

optional parameter with default


value: "none"
the access rights to security
related commands

optional parameter with default


value: "none"
the access rights to service and
base router related commands

optional parameter with default


value: "none"
the access rights to debug related
commands

optional parameter with default


value: "none"
the access rights to debug-mirror
related commands

Released

389

12 Security Configuration Commands

Parameter

Type
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Filter>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Link>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Log>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Oam>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Liadmin>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Liuser>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

[no] filter

[no] link

[no] log

[no] oam

[no] liadmin

[no] liuser

390

Released

Description

optional parameter with default


value: "none"
the access rights to filter related
commands

optional parameter with default


value: "none"
the access rights to link related
commands

optional parameter with default


value: "none"
the access rights to log related
commands

optional parameter with default


value: "none"
the access rights to OAM related
commands

optional parameter with default


value: "none"
the access rights to Lawful
Intercept
admin
related
commands

optional parameter with default


value: "none"
the access rights to Lawful
Intercept
session
related
commands

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

[no] drouter

Parameter type: <Sec::Drouter>


Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

optional parameter with default


value: "none"
the access rights to Drouter
related commands

3HH-04416-EBAA-TCZZA 01

Released

391

12 Security Configuration Commands

12.5 Default Profile Configuration Command


Command Description
This command allows the superuser to specify a default operator profile. The default profile is used when an
operator is authenticated via a RADIUS server but the RADIUS server does not support vendor-specific attributes.
The default profile determines most of the operator properties.

User Level
The command can be accessed by operators with all,admin privileges.
Operators without security read or write permissions cannot see the default profile.
Operators withouit security read or write permissions can never see default-profile.

Command Syntax
The command has the following syntax:
> configure system security default-profile [ no prompt | prompt <Sec::Prompt> ] [ no password-timeout |
password-timeout <Sec::PasswordTimeout> ] [ no terminal-timeout | terminal-timeout <Sec::InactivityTimeout> ] [
no slot-numbering | slot-numbering <Sec::SlotDesc> ] [ no description | description <Sec::ProfileDesc> ] [ no aaa |
aaa <Sec::Aaa> ] [ no atm | atm <Sec::Atm> ] [ no alarm | alarm <Sec::Alarm> ] [ no dhcp | dhcp <Sec::Dhcp> ] [
no equipment | equipment <Sec::Equipment> ] [ no igmp | igmp <Sec::Igmp> ] [ no ip | ip <Sec::Ip> ] [ no pppoe |
pppoe <Sec::Pppoe> ] [ no qos | qos <Sec::Qos> ] [ no software-mngt | software-mngt <Sec::Sw> ] [ no transport |
transport <Sec::Transport> ] [ no vlan | vlan <Sec::Vlan> ] [ no xdsl | xdsl <Sec::Xdsl> ] [ no sip | sip <Sec::Sip> ]
[ no megaco | megaco <Sec::Megaco> ] [ no lacp | lacp <Sec::Lacp> ] [ no mstp | mstp <Sec::Mstp> ] [ no security |
security <Sec::Security> ] [ no service | service <Sec::Service> ] [ no debug | debug <Sec::Debug> ] [ no
debug-mirror | debug-mirror <Sec::DebugMirror> ] [ no filter | filter <Sec::Filter> ] [ no link | link <Sec::Link> ] [
no log | log <Sec::Log> ] [ no oam | oam <Sec::Oam> ] [ no liadmin | liadmin <Sec::Liadmin> ] [ no liuser | liuser
<Sec::Liuser> ] [ no drouter | drouter <Sec::Drouter> ]

Command Parameters
Table 12.5-2 "Default Profile Configuration Command" Command Parameters
Parameter

Type

Description

[no] prompt

Parameter type: <Sec::Prompt>


Format:
- a specification of the prompt
- length: x<=28
Parameter type: <Sec::PasswordTimeout>
Format:
- the maximum time a password may be unchanged
- unit: days
- range: [0...365]
Parameter type: <Sec::InactivityTimeout>
Format:
- specify the inactivity timeout of the terminal

optional parameter with default


value: "\"%s : %n%d%c \""
the specification of the prompt

[no] password-timeout

[no] terminal-timeout

392

Released

optional parameter with default


value: 0
the maximum time a password
may be unchanged
optional parameter with default
value: 0
the maximum time a terminal

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter
[no] slot-numbering

[no] description

[no] aaa

[no] atm

[no] alarm

[no] dhcp

[no] equipment

3HH-04416-EBAA-TCZZA 01

Type

Description

- unit: minutes
- range: [0...120]
Parameter type: <Sec::SlotDesc>
Format:
( type-based
| position-based
| legacy-based )
Possible values:
- type-based : flat-numbering per slot-type (tl1-like)
- position-based : flat-numbering independent of slot-type
- legacy-based : numbering used since the early days
(position-based-like)
Parameter type: <Sec::ProfileDesc>
Format:
- any description to be used by the operator
- length: x<=31
Parameter type: <Sec::Aaa>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Atm>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Alarm>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Dhcp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Equipment>
Format:
( write
| read
| none )

may be inactive
optional parameter with default
value: "legacy-based"
slot description to be used by the
operator

optional parameter with default


value: ""
any description to be used by the
operator
optional parameter with default
value: "read"
the access rights to AAA related
commands

optional parameter with default


value: "write"
the access rights to ATM related
commands

optional parameter with default


value: "write"
the access rights to alarm related
commands

optional parameter with default


value: "write"
the access rights to DHCP related
commands

optional parameter with default


value: "write"
the access rights to equipment
related commands

Released

393

12 Security Configuration Commands

Parameter

Type
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Igmp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Ip>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Pppoe>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Qos>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Sw>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Transport>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access

[no] igmp

[no] ip

[no] pppoe

[no] qos

[no] software-mngt

[no] transport

394

Released

Description

optional parameter with default


value: "write"
the access rights to IGMP related
commands

optional parameter with default


value: "write"
the access rights to IP related
commands

optional parameter with default


value: "write"
the access rights to PPOE related
commands

optional parameter with default


value: "write"
the access rights to qos related
commands

optional parameter with default


value: "write"
access
rights
to
software
management related commands

optional parameter with default


value: "write"
the access rights to transport
related commands

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter
[no] vlan

[no] xdsl

[no] sip

[no] megaco

[no] lacp

[no] mstp

[no] security

3HH-04416-EBAA-TCZZA 01

Type
- none : no access
Parameter type: <Sec::Vlan>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Xdsl>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Sip>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Megaco>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Lacp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Mstp>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Security>
Format:

Description
optional parameter with default
value: "write"
the access rights to VLAN related
commands

optional parameter with default


value: "write"
the access rights to xDSL related
commands

optional parameter with default


value: "write"
the access rights to sip related
commands

optional parameter with default


value: "write"
the access rights to megaco
related commands

optional parameter with default


value: "write"
the access rights to lacp related
commands

optional parameter with default


value: "write"
the access rights to mstp related
commands

optional parameter with default


value: "none"

Released

395

12 Security Configuration Commands

Parameter

[no] service

[no] debug

[no] debug-mirror

[no] filter

[no] link

[no] log

396

Released

Type

Description

( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Service>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Debug>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::DebugMirror>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Filter>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Link>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Log>
Format:
( write
| read
| none )

the access rights to security


related commands

optional parameter with default


value: "write"
the access rights to service
related commands

optional parameter with default


value: "write"
the access rights to debug related
commands

optional parameter with default


value: "write"
the access rights to debug-mirror
related commands

optional parameter with default


value: "write"
the access rights to filter related
commands

optional parameter with default


value: "write"
the access rights to link related
commands

optional parameter with default


value: "write"
the access rights to log related
commands

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

[no] oam

[no] liadmin

[no] liuser

[no] drouter

3HH-04416-EBAA-TCZZA 01

Type
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Oam>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Liadmin>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Liuser>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
Parameter type: <Sec::Drouter>
Format:
( write
| read
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

Description

optional parameter with default


value: "write"
the access rights to OAM related
commands

optional parameter with default


value: "write"
the access rights to Lawful
Intercept
admin
related
commands

optional parameter with default


value: "write"
the access rights to Lawful
Intercept
Session
related
commands

optional parameter with default


value: "write"
the access rights to Drouter
related commands

Released

397

12 Security Configuration Commands

12.6 SNMP View Configuration Command


Command Description
This command allows the operator to configure a view.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
A subtree is identified by an object ID, which is a sequence of numbers (example: 1.3.6.1.6.3.12.1.3). This sequence
uniquely identifies a node or a leaf in the MIB tree.
The same subtree can also be addressed using symbolic MIB names (example: snmpTargetParamsTable).
Combinations of symbolic names and numbers are also possible: 1.3.6.1.6.3.12.1.3.1.7.97.97.97 can be written as
snmpTargetParamsTable.1.7.97.97.97 or as snmpTargetParamsRowStatus.97.97.97, ...
For each number, we can indicate that it may be ignored when comparing it with MIB elements, by adding an
asterisk after the number (example: snmpTargetParamsRowStatus.97.97*.97). Because the number is ignored
anyway, we recommend replacing it with a 0. For example, snmpTargetParamsRowStatus.97.0*.97. 0* can be
abbreviated as *. So, the recommended representation is snmpTargetParamsRowStatus.97.*.97.
The system stores a view entry based on the view name and the object ID: snmpTargetParamsRowStatus.97.0*.97
and snmpTargetParamsRowStatus.97.97*.97 are stored in two different locations, but match the same MIB
elements. A consequence of this strategy is that snmpTargetParamsRowStatus.97.97*.97 and
snmpTargetParamsRowStatus.97.97.97 can not exist at the same time.
The most specific filter element takes precedence in the case where more than one filter element matches the same
MIB element.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMP view, please check if
the view was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
SNMP view.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no view (notify-view) subtree <Snmp::ViewSubtree> ) | ( view (notify-view)
subtree <Snmp::ViewSubtree> type <Snmp::FilterType> )

Command Parameters
Table 12.6-1 "SNMP View Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(notify-view)

Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::ViewSubtree>
Format:

the name of the view

subtree

398

Released

the subtree

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Resource Identifier

Type

Description

<Snmp::ViewSubtree>
Field type <Snmp::ViewSubtree>
- specification of view subtree. Eg(vacmAccessTable.*.7)

Table 12.6-2 "SNMP View Configuration Command" Command Parameters


Parameter

Type

Description

type

Parameter type: <Snmp::FilterType>


Format:
( include
| exclude )
Possible values:
- include : include the matching varbinds
- exclude : exclude the matching varbinds

mandatory parameter
the filter type

Command Output
Table 12.6-3 "SNMP View Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Transport::WaitRowStatusVacmFilter>


the status of an SNMP view
( valid
This element is only shown in
| corrupted
detail mode.
| corrupted )
Possible values:
- valid : SNMP view configuration is ok
- corrupted : SNMP view configuration is not
operational(not-in-service)
- corrupted : SNMP view configuration is not
operational(not-ready)

Released

399

12 Security Configuration Commands

12.7 Security SNMP Community Configuration


Command
Command Description
This command allows the operator to configure community names.
An existing community can not be modified.
SNMP uses community names as a kind of password without user name to verify if a request may be executed.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
There must be at least one community with read-write privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no community (name) host-address <Ip::AddressAndIpMaskFull> ) | (
community (name) host-address <Ip::AddressAndIpMaskFull> [ no context | context <Transport::Context> ] [ no
privilege | privilege <Snmp::CommunityPrivilege> ] [ no read-view | read-view <Snmp::ViewName> ] [ no
write-view | write-view <Snmp::ViewName> ] [ no notify-view | notify-view <Snmp::ViewName> ] )

Command Parameters
Table 12.7-1 "Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the community name
- length: x<=32
Parameter type: <Ip::AddressAndIpMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

the name of the community

host-address

the host IP address from where


access is allowed

Table 12.7-2 "Security SNMP Community Configuration Command" Command Parameters


Parameter

Type

Description

[no] context

Parameter type: <Transport::Context>


Format:
( nt

optional parameter with default


value: "nt"
the context allowed for this

400

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

[no] privilege

[no] read-view

[no] write-view

[no] notify-view

3HH-04416-EBAA-TCZZA 01

Type

Description

| shub
| epon
| xvps1
| xvps2
| xvps3
| xvps4
| xvps5
| xvps6
| xvps7
| xvps8 )
Possible values:
- nt : nt context
- shub : shub context
- epon : epon context
- xvps1 : xvps1 context
- xvps2 : xvps2 context
- xvps3 : xvps3 context
- xvps4 : xvps4 context
- xvps5 : xvps5 context
- xvps6 : xvps6 context
- xvps7 : xvps7 context
- xvps8 : xvps8 context
Parameter type: <Snmp::CommunityPrivilege>
Format:
( read-only
| read-write
| write-only )
Possible values:
- read-only : only read privileges
- read-write : read and write privileges
- write-only : only write privileges
Parameter type: <Snmp::ViewName>
Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::ViewName>
Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::ViewName>
Format:
- the name of a view
- length: x<=32

community

optional parameter with default


value: "read-write"
the access privileges we have
when we use this community

optional parameter with default


value: "everything"
the name of the view to be used
for read accesses
optional parameter with default
value: "everything"
the name of the view to be used
for write accesses
optional parameter with default
value: "everything"
the name of the view to filter
notifications

Released

401

12 Security Configuration Commands

12.8 Security SNMPv3 Group Configuration


Command
Command Description
This command allows the operator to configure an SNMPv3 Group.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMPv3 Group, please
check if the group was created and if the corresponding entry-status is valid. If not, please delete and re-create the
entire SNMPv3 Group.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no group (name) security-level <Snmp::SecurityLevel> context
<Snmp::Context> ) | ( group (name) security-level <Snmp::SecurityLevel> context <Snmp::Context> [ no
read-view
|
read-view
<Snmp::AssociatedViewName>
]
[
no
write-view
|
write-view
<Snmp::AssociatedViewName> ] [ no notify-view | notify-view <Snmp::AssociatedViewName> ] )

Command Parameters
Table 12.8-1 "Security SNMPv3 Group Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the snmpv3 group
- length: 1<=x<=32
Parameter type: <Snmp::SecurityLevel>
Format:
( none
| authentication
| privacy-and-auth )
Possible values:
- none : no authentication and no privacy
- authentication : authentication without privacy
- privacy-and-auth : authentication and privacy
Parameter type: <Snmp::Context>
Format:
( single : nt
| single : shub
| single : epon
| single : xvps1

name of snmpV3 group

security-level

context

402

Released

security level for the group

context for the group

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Resource Identifier

Type

Description

| single : xvps2
| single : xvps3
| single : xvps4
| single : xvps5
| single : xvps6
| single : xvps7
| single : xvps8
| single : ihub
| single : ai_nt_1
| single : ai_nta_1
| single : ai_ntb_1
| single : dpoe
| all )
Possible values:
- single : grant access to a specific context
- all : grant access to all contexts
Possible values:
- nt : the nt context
- shub : the shub context
- epon : the epon context
- xvps1 : the xvps1 context
- xvps2 : the xvps2 context
- xvps3 : the xvps3 context
- xvps4 : the xvps4 context
- xvps5 : the xvps5 context
- xvps6 : the xvps6 context
- xvps7 : the xvps7 context
- xvps8 : the xvps8 context
- ihub : the ihub context
- ai_nt_1 : the ai nt context 1
- ai_nta_1 : the ai nt-a context 1
- ai_ntb_1 : the ai nt-b context 1
- dpoe : the dpoe context
- : any context

Table 12.8-2 "Security SNMPv3 Group Configuration Command" Command Parameters


Parameter

Type

Description

[no] read-view

Parameter type: <Snmp::AssociatedViewName>


Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::AssociatedViewName>
Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::AssociatedViewName>
Format:
- the name of a view
- length: x<=32

optional parameter with default


value: "everything"
the name of the view to be used
for read accesses
optional parameter with default
value: "everything"
the name of the view used for
write accesses
optional parameter with default
value: "everything"
the name of the view to filter
notifications

[no] write-view

[no] notify-view

Command Output
Table 12.8-3 "Security SNMPv3 Group Configuration Command" Display parameters
Specific Information
name

Type

Description

entry-status

Parameter type: <Transport::WaitRowStatusconfigGroup>

the status of an SNMPv3 group

3HH-04416-EBAA-TCZZA 01

Released

403

12 Security Configuration Commands

name

Type

Description

( valid
This element is only shown in
| corrupted
detail mode.
| corrupted )
Possible values:
- valid : SNMPv3 group configuration is ok
- corrupted : SNMPv3 group configuration is not
operational(not-in-service)
- corrupted : SNMPv3 group configuration is not
operational(not-ready)

404

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.9 Security SNMPv3 User Configuration


Command
Command Description
This command allows the operator to configure an SNMPv3 user.
Clarification regarding 'entry-status': If a failure occurs during the configuration of an SNMPv3 user, please check
if the user was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
SNMPv3 user.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no user (name) ) | ( user (name) [ no authentication | authentication
<Snmp::AuthType> ] [ no privacy | privacy <Snmp::PrivacyType> ] [ no public | public <Snmp::Identifier> ] )

Command Parameters
Table 12.9-1 "Security SNMPv3 User Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- snmpv3 user name
- length: 1<=x<=32

name of the user

Table 12.9-2 "Security SNMPv3 User Configuration Command" Command Parameters


Parameter

Type

Description

[no] authentication

Parameter type: <Snmp::AuthType>


Format:
( none
| md5 : prompt
| sha1 : prompt
| md5 : plain : <Sec::UsmPlainPassword>
| sha1 : plain : <Sec::UsmPlainPassword>
| md5 : encrypted : <Snmp::AuthEncryptedKey>
| sha1 : encrypted : <Snmp::AuthEncryptedKey> )
Possible values:
- none : no authentication
- md5 : md5 based authentication
- sha1 : sha1 based authentication
Possible values:

optional parameter with default


value: "none"
authentication for the user

3HH-04416-EBAA-TCZZA 01

Released

405

12 Security Configuration Commands

Parameter

Type

Description

- prompt : prompts the operator to enter a password


- plain : enter the password in plain text
- encrypted : enter the encrypted password
Field type <Sec::UsmPlainPassword>
- the password in plain text is placed in double quotes when
# or ? is used
- length: 8<=x<=20
Field type <Snmp::AuthEncryptedKey>
- an encrypted password
- length: 16<=x<=24
Parameter type: <Snmp::PrivacyType>
Format:
( none
| des : prompt
| des : plain : <Sec::UsmPlainPassword>
| des : encrypted : <Snmp::PrivacyEncryptedKey> )
Possible values:
- none : no privacy required
- des : des based privacy
Possible values:
- prompt : prompts the operator for a password
- plain : enter the password in plain text
- encrypted : enter the encrypted password
Field type <Sec::UsmPlainPassword>
- the password in plain text is placed in double quotes when
# or ? is used
- length: 8<=x<=20
Field type <Snmp::PrivacyEncryptedKey>
- an encrypted privacy password
- length: 16
Parameter type: <Snmp::Identifier>
Format:
- a hexadecimal identifier
- length: 1<=x<=32

[no] privacy

[no] public

optional parameter with default


value: "none"
snmp privacy type

optional parameter with default


value: ""
identifier used by scenarios to
change security keys

Command Output
Table 12.9-3 "Security SNMPv3 User Configuration Command" Display parameters
Specific Information
name
entry-status

406

Type

Description

Parameter type: <Transport::WaitRowStatusSnmpUser>


the status of an SNMPv3 user
( valid
This element is only shown in
| corrupted
detail mode.
| corrupted )
Possible values:
- valid : SNMPv3 user configuration is ok
- corrupted : SNMPv3 user configuration is not
operational(not-in-service)
- corrupted : SNMPv3 user configuration is not
operational(not-ready)

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.10 Security SNMPv3 User-Group Configuration


Command
Command Description
This command allows the operator to map an SNMPv3 user to an SNMPv3 group.
Clarification regarding 'entry-status': If a failure occurs during the configuration of mapping an SNMPv3 user to
SNMPv3 user-group , please check if the mapping was done and if the corresponding entry-status is valid. If not,
please delete and re-create the entire configuration of mapping an SNMPv3 user to SNMPv3 user-group.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no map-user-group (name) ) | ( map-user-group (name) group-name
<Snmp::AssociatedGroupName> )

Command Parameters
Table 12.10-1 "Security SNMPv3 User-Group Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- snmpv3 user name
- length: 1<=x<=32

name of the snmpV3 user

Table 12.10-2 "Security SNMPv3 User-Group Configuration Command" Command Parameters


Parameter

Type

Description

group-name

Parameter type: <Snmp::AssociatedGroupName>


Format:
- name of the snmpv3 group
- length: 1<=x<=32

mandatory parameter
name of the snmpV3 group

Command Output
Table 12.10-3 "Security SNMPv3 User-Group Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Transport::WaitRowStatusMapUser>


( valid
| corrupted

the status of mapping an


SNMPv3 user to an SNMPv3
group

Released

407

12 Security Configuration Commands

name

Type

Description

| corrupted )
This element is only shown in
Possible values:
detail mode.
- valid : mapping SNMPv3 user to SNMPv3 group
configuration is ok
- corrupted : mapping SNMPv3 user to SNMPv3 group
configuration is not operational(not-in-service)
- corrupted : mapping SNMPv3 user to SNMPv3 group
configuration is not operational(not-ready)

408

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.11 SNMP Notify View Configuration Command


Command Description
This command allows the operator to configure a Notify View.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
A subtree is identified by an object ID, which is a sequence of numbers (example: 1.3.6.1.6.3.12.1.3). This sequence
uniquely identifies a node or a leaf in the MIB tree.
The same subtree can also be addressed using symbolic MIB names (example: snmpTargetParamsTable).
Combinations of symbolic names and numbers are also possible: 1.3.6.1.6.3.12.1.3.1.7.97.97.97 can be written as
snmpTargetParamsTable.1.7.97.97.97 or as snmpTargetParamsRowStatus.97.97.97, ...
For each number, we can indicate that it may be ignored when comparing it with MIB elements, by adding an
asterisk after the number (example: snmpTargetParamsRowStatus.97.97*.97). Because the number is ignored
anyway, we recommend replacing it with a 0. For example, snmpTargetParamsRowStatus.97.0*.97. 0* can be
abbreviated as *. So, the recommended representation is snmpTargetParamsRowStatus.97.*.97.
The system stores a view entry based on the view name and the object ID: snmpTargetParamsRowStatus.97.0*.97
and snmpTargetParamsRowStatus.97.97*.97 are stored in two different locations, but match the same MIB
elements. A consequence of this strategy is that snmpTargetParamsRowStatus.97.97*.97 and
snmpTargetParamsRowStatus.97.97.97 can not exist at the same time.
The most specific filter element takes precedence in the case where more than one filter element matches the same
MIB element.
Clarification regarding 'entry-status': If a failure occurs during the configuration of a Notify View, please check if
the view was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
Notify View.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no notify-view (notify-view) subtree <Snmp::ViewSubtree> ) | ( notify-view
(notify-view) subtree <Snmp::ViewSubtree> type <Snmp::FilterType> )

Command Parameters
Table 12.11-1 "SNMP Notify View Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(notify-view)

Format:
- the name of a view
- length: x<=32
Parameter type: <Snmp::ViewSubtree>
Format:

the name of the notify view

subtree

3HH-04416-EBAA-TCZZA 01

the subtree

Released

409

12 Security Configuration Commands

Resource Identifier

Type

Description

<Snmp::ViewSubtree>
Field type <Snmp::ViewSubtree>
- specification of view subtree. Eg(vacmAccessTable.*.7)

Table 12.11-2 "SNMP Notify View Configuration Command" Command Parameters


Parameter

Type

Description

type

Parameter type: <Snmp::FilterType>


Format:
( include
| exclude )
Possible values:
- include : include the matching varbinds
- exclude : exclude the matching varbinds

mandatory parameter
the filter type

Command Output
Table 12.11-3 "SNMP Notify View Configuration Command" Display parameters
Specific Information
name
entry-status

410

Released

Type

Description

Parameter type: <Transport::WaitRowStatusNotifyFilter>


( valid
| corrupted
| corrupted )
Possible values:
- valid : SNMP Notify View configuration is ok
- corrupted : SNMP notify view configuration is not
operational(not-in-service)
- corrupted : SNMP notify view configuration is not
operational(not-ready)

the status of an SNMP notify


view
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.12 Security SNMP Notification Profile


Configuration Command
Command Description
This command allows the operator to configure a notification profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP notification profile,
please check if the profile was created and if the corresponding entry-status is valid. If not, please delete and
re-create the entire SNMP notification profile.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no notify-profile (name) ) | ( notify-profile (name) snmp-version
<Snmp::SnmpVersion> )

Command Parameters
Table 12.12-1 "Security SNMP Notification Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- notification-profile name
- length: 1<=x<=32

name of the notification profile

Table 12.12-2 "Security SNMP Notification Profile Configuration Command" Command


Parameters
Parameter

Type

Description

snmp-version

Parameter type: <Snmp::SnmpVersion>


Format:
( v1 : <Snmp::CommunityString>
| v2 : <Snmp::CommunityString>
| v3 : <Snmp::SecurityName> : none
| v3 : <Snmp::SecurityName> : authentication
| v3 : <Snmp::SecurityName> : privacy-and-auth )
Possible values:
- v1 : SNMP version1
- v2 : SNMP version2
- v3 : SNMP version3
Field type <Snmp::CommunityString>
- community string

mandatory parameter
The parameter is not visible
during modification.
snmp-version of the profile

3HH-04416-EBAA-TCZZA 01

Released

411

12 Security Configuration Commands

Parameter

Type

Description

- length: 1<=x<=32
Field type <Snmp::SecurityName>
- snmpv3 user name
- length: 1<=x<=32
Possible values:
- none : no authentication and no privacy
- authentication : authentication only
- privacy-and-auth : authentication and privacy

Command Output
Table 12.12-3 "Security SNMP Notification Profile Configuration Command" Display parameters
Specific Information
name
entry-status

412

Type

Description

Parameter type: <Transport::WaitRowStatusProfile>


the status of notification profile
( valid
This element is only shown in
| corrupted
detail mode.
| corrupted )
Possible values:
- valid : notification profile configuration is ok
- corrupted : notification profile configuration is not
operational(not-in-service)
- corrupted : notification profile configuration is not
operational(not-ready)

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.13 Security SNMP Notification Profile Filter


Configuration Command
Command Description
This command allows the operator to configure a filter for a notification profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of a filter for SNMP notification
profile, please check if the filter was created and if the corresponding entry-status is valid. If not, please delete and
re-create the entire notification profile filter.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp notify-profile (name) ( no filter ) | ( filter notify-view <Snmp::ViewName> )

Command Parameters
Table 12.13-1 "Security SNMP Notification Profile Filter Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- notification-profile name
- length: 1<=x<=32

name of the notification profile

Table 12.13-2 "Security SNMP Notification Profile Filter Configuration Command" Command
Parameters
Parameter

Type

Description

notify-view

Parameter type: <Snmp::ViewName>


Format:
- the name of a view
- length: x<=32

mandatory parameter
view to be accessed

Command Output
Table 12.13-3 "Security SNMP Notification Profile Filter Configuration Command" Display
parameters
Specific Information
name

Type

Description

entry-status

Parameter type: <Transport::WaitRowStatusNotifyView>

the status of notification profile

3HH-04416-EBAA-TCZZA 01

Released

413

12 Security Configuration Commands

name

Type

Description

( valid
filter
| corrupted
This element is only shown in
| corrupted )
detail mode.
Possible values:
- valid : notification profile filter configuration is ok
- corrupted : notification profile filter configuration is not
operational(not-in-service)
- corrupted : notification profile filter configuration is not
operational(not-ready)

414

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.14 Security SNMP Element Manager


Configuration Command
Command Description
This command allows the operator to configure an Element Manager using a Profile.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP element manager,
please check if the element manager was created and if the corresponding entry-status is valid. If not, please delete
and re-create the entire SNMP element manager.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security snmp ( no manager (name) ) | ( manager (name) destination <Snmp::Address>
notify-profile <Snmp::NotifyProfile> [ [ no ] nt ] [ [ no ] shub ] [ [ no ] epon ] [ [ no ] xvps1 ] [ [ no ] xvps2 ] [ [ no
] xvps3 ] [ [ no ] xvps4 ] [ [ no ] xvps5 ] [ [ no ] xvps6 ] [ [ no ] xvps7 ] [ [ no ] xvps8 ] )

Command Parameters
Table 12.14-1 "Security SNMP Element Manager Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- element manager name
- length: 1<=x<=32

name of the element manager

Table 12.14-2 "Security SNMP Element Manager Configuration Command" Command Parameters
Parameter

Type

Description

destination

Parameter type: <Snmp::Address>


Format:
<Snmp::IpAddress> : <Snmp::AddressPort>
Field type <Snmp::IpAddress>
- ip-address for the manager
Field type <Snmp::AddressPort>
- port number for the manager
- range: [1...65535]
Parameter type: <Snmp::NotifyProfile>
Format:
- notification-profile name
- length: 1<=x<=32
Parameter type: boolean

mandatory parameter
The parameter is not visible
during modification.
destination address of the element
manager

notify-profile

[no] nt

3HH-04416-EBAA-TCZZA 01

mandatory parameter
name of the notification profile
optional parameter

Released

415

12 Security Configuration Commands

Parameter

Type

[no] shub

Parameter type: boolean

[no] epon

Parameter type: boolean

[no] xvps1

Parameter type: boolean

[no] xvps2

Parameter type: boolean

[no] xvps3

Parameter type: boolean

[no] xvps4

Parameter type: boolean

[no] xvps5

Parameter type: boolean

[no] xvps6

Parameter type: boolean

[no] xvps7

Parameter type: boolean

[no] xvps8

Parameter type: boolean

Description
enable storing in nt
optional parameter
enable storing in shub
optional parameter
enable storing in epon
optional parameter
enable storing in xvps1
optional parameter
enable storing in xvps2
optional parameter
enable storing in xvps3
optional parameter
enable storing in xvps4
optional parameter
enable storing in xvps5
optional parameter
enable storing in xvps6
optional parameter
enable storing in xvps7
optional parameter
enable storing in xvps8

Command Output
Table 12.14-3 "Security SNMP Element Manager Configuration Command" Display parameters
Specific Information
name
entry-status

416

Released

Type

Description

Parameter type: <Transport::WaitRowStatusconfigManger>


( valid
| corrupted
| corrupted )
Possible values:
- valid : SNMPv3 element manager configuration is ok
- corrupted : SNMPv3 element manager configuration is not
operational(not-in-service)
- corrupted : SNMPv3 element manager configuration is not
operational(not-ready)

the status of an SNMP Element


Manager
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.15 Security RADIUS Client Configuration


Command
Command Description
This command allows to configure generic parameters for when a Radius Client is used. More details can be found
in the description per parameter.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [ [ no ] relay ] [ [ no ] auth-super-user ] [ no operator-policy | operator-policy
<Aaa::RadiusPolicyName> ] [ no aut-s-unreach-act | aut-s-unreach-act <Aaa::RadiusAuthServUnreachAction> ]

Command Parameters
Table 12.15-2 "Security RADIUS Client Configuration Command" Command Parameters
Parameter

Type

Description

[no] relay

Parameter type: boolean

[no] auth-super-user

Parameter type: boolean

[no] operator-policy

Parameter type: <Aaa::RadiusPolicyName>


Format:
( none
| name : <Aaa::IgnoredRadiusPolicyName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Aaa::IgnoredRadiusPolicyName>
- name of the RADIUS policy
- length: 1<=x<=64
Parameter type: <Aaa::RadiusAuthServUnreachAction>
Format:
( reject-all
| accept-all )
Possible values:
- reject-all : All session requests are rejected
- accept-all : All session requests are accepted

optional parameter
enable radius relay
optional parameter
enable
superuser
RADIUS
Authentication
optional parameter with default
value: "none"
name of Radius policy to be
applied to this operator

[no] aut-s-unreach-act

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "reject-all"
action to be taken for 802.1x
users when authentication server
is unreachable

Released

417

12 Security Configuration Commands

12.16 Security RADIUS Authentication Server


Configuration Command
Command Description
This command allows the operator to configure the RADIUS authentication servers. The conceptual table lists the
RADIUS authentication servers with their configurable parameters. If an entry (server) must be deleted, it must not
be associated with any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius ( no auth-server (name) vrf-index <Aaa::VrfIndex> ) | ( auth-server (name)
vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> [ no port | port <Aaa::InetPortNumber> ] secret
<Security::Password3> [ no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ] [ no timeout-limit | timeout-limit
<Aaa::RadiusTimeout> ] [ [ no ] admin-down ] [ no dead-interval | dead-interval <Aaa::RadiusDeadInterval> ] )

Command Parameters
Table 12.16-1 "Security RADIUS Authentication Server Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS auth server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of RADIUS authentication


server

vrf-index

vrf to which this auth server


belongs

Table 12.16-2 "Security RADIUS Authentication Server Configuration Command" Command


Parameters
Parameter

Type

Description

ip-address

Parameter type: <Aaa::InetAddress>


Format:
- IPv4-address
Parameter type: <Aaa::InetPortNumber>
Format:
- UDP port to which RADIUS auth messages should be sent
- range: [0...65535]

mandatory parameter
IP
address
of
RADIUS
authentication server
optional parameter with default
value: 1812
UDP port to which RADIUS auth
messages should be sent

[no] port

418

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

secret

Parameter type: <Security::Password3>


Format:
( prompt
| plain : <Security::PlainPassword3> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Security::PlainPassword3>
- password string hidden from users
- length: 6<=x<=64
Parameter type: <Aaa::RadiusRetryLimit>
Format:
- radius retry limit
- range: [0...100]
Parameter type: <Aaa::RadiusTimeout>
Format:
- radius timeout
- range: [1...60]
Parameter type: boolean

mandatory parameter
secret string used between
RADIUS server and client

[no] retry-limit

[no] timeout-limit

[no] admin-down
[no] dead-interval

3HH-04416-EBAA-TCZZA 01

Parameter type: <Aaa::RadiusDeadInterval>


Format:
- radius dead interval
- range: [0...3600]

optional parameter with default


value: 3
no of times RADIUS server be
tried before giving up
optional parameter with default
value: 3
time
in
sec
between
retransmission to RADIUS server
optional parameter
adminstrative state down
optional parameter with default
value: 600
no of sec before setting oper state
to unknown from down

Released

419

12 Security Configuration Commands

12.17 Security RADIUS Accounting Server


Configuration Command
Command Description
This command allows the operator to configure the RADIUS accounting servers. The conceptual table lists the
RADIUS accounting servers with their configurable parameters. If an entry (server) must be deleted, it must not be
associated with any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius ( no acc-server (name) vrf-index <Aaa::VrfIndex> ) | ( acc-server (name)
vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> [ no port | port <Aaa::InetPortNumber> ] secret
<Security::Password3> [ no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ] [ no timeout-limit | timeout-limit
<Aaa::RadiusTimeout> ] [ [ no ] admin-down ] [ no dead-interval | dead-interval <Aaa::RadiusDeadInterval> ] )

Command Parameters
Table 12.17-1 "Security RADIUS Accounting Server Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS accounting server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of the RADIUS accounting


server

vrf-index

vrf to which the RADIUS Acc


Server belongs

Table 12.17-2 "Security RADIUS Accounting Server Configuration Command" Command


Parameters
Parameter

Type

Description

ip-address

Parameter type: <Aaa::InetAddress>


Format:
- IPv4-address
Parameter type: <Aaa::InetPortNumber>
Format:
- UDP port to which RADIUS auth messages should be sent
- range: [0...65535]

mandatory parameter
IP
address
of
RADIUS
accounting server
optional parameter with default
value: 1813
UDP port to which RADIUS
accounting messages be sent

[no] port

420

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

secret

Parameter type: <Security::Password3>


Format:
( prompt
| plain : <Security::PlainPassword3> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Security::PlainPassword3>
- password string hidden from users
- length: 6<=x<=64
Parameter type: <Aaa::RadiusRetryLimit>
Format:
- radius retry limit
- range: [0...100]
Parameter type: <Aaa::RadiusTimeout>
Format:
- radius timeout
- range: [1...60]
Parameter type: boolean

mandatory parameter
secret string used between
RADIUS server and client

[no] retry-limit

[no] timeout-limit

[no] admin-down
[no] dead-interval

3HH-04416-EBAA-TCZZA 01

Parameter type: <Aaa::RadiusDeadInterval>


Format:
- radius dead interval
- range: [0...3600]

optional parameter with default


value: 10
no of times RADIUS server be
tried before giving up
optional parameter with default
value: 15
time
in
sec
between
retransmission to RADIUS server
optional parameter
adminstrative state down
optional parameter with default
value: 600
no of sec before setting oper state
to unknown from down

Released

421

12 Security Configuration Commands

12.18 Security RADIUS Dynamic Authorization


Client Configuration Command
Command Description
This command allows the operator to configure the RADIUS Dynamic Authorization Clients. The conceptual table
lists the RADIUS Dynamic Authorization Clients with their configurable parameters.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius ( no dyn-auth-client (name) vrf-index <Aaa::VrfIndex> ) | ( dyn-auth-client
(name) vrf-index <Aaa::VrfIndex> ip-address <Aaa::InetAddress> secret <Security::Password3> [ [ no ]
admin-down ] )

Command Parameters
Table 12.18-1 "Security RADIUS Dynamic Authorization Client Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of dynamic auth client name
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of the RADIUS Dynamic


Authorization client

vrf-index

vrf to which the RADIUS Dyn


Auth Client belongs

Table 12.18-2 "Security RADIUS Dynamic Authorization Client Configuration Command"


Command Parameters
Parameter

Type

Description

ip-address

Parameter type: <Aaa::InetAddress>


Format:
- IPv4-address
Parameter type: <Security::Password3>
Format:
( prompt
| plain : <Security::PlainPassword3> )
Possible values:
- prompt : prompts the operator for a password

mandatory parameter
IP
address
of
RADIUS
authentication server
mandatory parameter
secret string used between
RADIUS server and client

secret

422

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

[no] admin-down

- plain : the password in plain text


Field type <Security::PlainPassword3>
- password string hidden from users
- length: 6<=x<=64
Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

Description

optional parameter
adminstrative state down

Released

423

12 Security Configuration Commands

12.19 Security RADIUS Policy Configuration


Command
Command Description
This command allows the operator to configure RADIUS policies. The conceptual table lists the RADIUS policies
with the parameters that apply globally for each RADIUS policy. An entry in this table (policy) can be deleted only
if it is not associated with any of the domains. If this entry is deleted, the corresponding entry in the RADIUS server
is also deleted.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius ( no policy (name) ) | ( policy (name) nas-id <Aaa::NasId> nas-ip-address
<Aaa::InetAddress> [ [ no ] keep-domain-name ] [ [ no ] disable-accnt-msg ] [ no acc-interval | acc-interval
<Aaa::AccInt> ] [ [ no ] disable-eap ] )

Command Parameters
Table 12.19-1 "Security RADIUS Policy Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the radius policy
- length: 1<=x<=64

name of the RADIUS policy

Table 12.19-2 "Security RADIUS Policy Configuration Command" Command Parameters


Parameter

Type

Description

nas-id

mandatory parameter
NAS-Identifier used in messages
towards Radius servers

[no] keep-domain-name

Parameter type: <Aaa::NasId>


Format:
- a binary string of min 0 and max 64
- length: x<=64
Parameter type: <Aaa::InetAddress>
Format:
- IPv4-address
Parameter type: boolean

[no] disable-accnt-msg

Parameter type: boolean

[no] acc-interval

Parameter type: <Aaa::AccInt>


Format:
- radius accnt interval

nas-ip-address

424

Released

mandatory parameter
NAS-IP-Address
used
in
messages towards Radius servers
optional parameter
don't strip domain name when
sending to RADIUS server
optional parameter
disable
optional parameter with default
value: 0
Interim Accounting Interval in

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

[no] disable-eap

- range: [0,60...2147483647]
Parameter type: boolean

seconds
optional parameter
disable

3HH-04416-EBAA-TCZZA 01

Released

425

12 Security Configuration Commands

12.20 Security RADIUS Server Configuration


Command
Command Description
This command allows the operator to configure RADIUS servers. The conceptual table lists the set of RADIUS
servers with the parameters of each set. The servers that are placed in a set using this table must first be defined in
the RADIUS Authenticaion and Accounting server configuration commands. The value returned by the RADIUS
server is used by the management station as the value for the index when a new entry in this table is created.
It is always mandatory to configure acc-server along with vrf-index-acc and auth-server with vrf-index-auth,
otherwise the configuration will not succeed.
Note: the products from the ISAM 7363 and 7367 family support only vrf-index=0.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius policy (name) ( no servers (index) ) | ( servers (index) auth-server
<Aaa::RadAuthServer> vrf-index-auth <Aaa::VrfIndex> [ no acc-server | acc-server <Aaa::RadAccServer> ] [ no
vrf-index-acc | vrf-index-acc <Aaa::IgnoredVrfIndex> ] priority <Aaa::Priority> )

Command Parameters
Table 12.20-1 "Security RADIUS Server Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the radius policy
- length: 1<=x<=64
Format:
- unique nbr identifying a set within a RADIUS profile.
- range: [1...2]

name of the RADIUS policy

(index)

index of RADIUS profile

Table 12.20-2 "Security RADIUS Server Configuration Command" Command Parameters


Parameter

Type

Description

auth-server

Parameter type: <Aaa::RadAuthServer>


Format:
name : <Aaa::RadAuthServerName>
Possible values:
- name : use a radius server for authentication
Field type <Aaa::RadAuthServerName>
- name of the RADIUS auth server
- length: 1<=x<=64

mandatory parameter
the radius authentication server

426

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

vrf-index-auth

Parameter type: <Aaa::VrfIndex>


Format:
- a vrf index
- range: [0...127]
Parameter type: <Aaa::RadAccServer>
Format:
( none
| name : <Aaa::RadAccServerName> )
Possible values:
- none : no radius server for accounting
- name : use a radius server for accounting
Field type <Aaa::RadAccServerName>
- name of the RADIUS accounting server
- length: 1<=x<=64
Parameter type: <Aaa::IgnoredVrfIndex>
Format:
- a vrf index
- range: [0...127]
Parameter type: <Aaa::Priority>
Format:
- priority of the server set
- range: [1...256]

mandatory parameter
vrf to which the RADIUS auth
server belongs

[no] acc-server

[no] vrf-index-acc

priority

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "none"
the radius accounting server

optional parameter with default


value: 0L
vrf to which the RADIUS
accounting server belongs
mandatory parameter
priority of the set of RADIUS
servers

Released

427

12 Security Configuration Commands

12.21 Security Domain Configuration Command


Command Description
This command allows the operator to configure the domain.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security ( no domain (name) ) | ( domain (name) vrf-index <Aaa::DomainVrfIndex> [ no
vlan-id | vlan-id <Vlan::VlanIndexOrZero> ] [ no primary-dns | primary-dns <Aaa::InetAddress> ] [ no second-dns
| second-dns <Aaa::InetAddress> ] [ no primary-nbns | primary-nbns <Aaa::InetAddress> ] [ no second-nbns |
second-nbns <Aaa::InetAddress> ] [ no sess-timeout | sess-timeout <Aaa::DomainSessionTimeout> ] [ no
qos-policy | qos-policy <Aaa::QosProfileName> ] authenticator <Aaa::Authenticator> [ [ no ] admin-down ] )

Command Parameters
Table 12.21-1 "Security Domain Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the domain
- length: 1<=x<=64

name of the domain

Table 12.21-2 "Security Domain Configuration Command" Command Parameters


Parameter

Type

Description

vrf-index

Parameter type: <Aaa::DomainVrfIndex>


Format:
- a vrf index for a domain
- range: [-1,1...127]
Parameter type: <Vlan::VlanIndexOrZero>
Format:
- vlan id
- range: [0...4092]
Parameter type: <Aaa::InetAddress>
Format:
- IPv4-address
Parameter type: <Aaa::InetAddress>
Format:
- IPv4-address

mandatory parameter
valid VRF index

[no] vlan-id

[no] primary-dns
[no] second-dns

[no] primary-nbns

428

Parameter type: <Aaa::InetAddress>


Format:
- IPv4-address

Released

optional parameter with default


value: 0
a vlan id
optional parameter with default
value: "0.0.0.0"
IP address of primary DNS server
optional parameter with default
value: "0.0.0.0"
IP address of secondary DNS
server
optional parameter with default
value: "0.0.0.0"
IP address of primary NBNS
server

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

[no] second-nbns

Parameter type: <Aaa::InetAddress>


Format:
- IPv4-address

[no] sess-timeout

Parameter type: <Aaa::DomainSessionTimeout>


Format:
- maximum lifetime of a session
- range: [0...2147483647]
Parameter type: <Aaa::QosProfileName>
Format:
( none
| name : <Aaa::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Aaa::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
Parameter type: <Aaa::Authenticator>
Format:
( local
| radius : <Aaa::RadPolicyName> )
Possible values:
- local : authenticator type is local
- radius : authenticator type is RADIUS
Field type <Aaa::RadPolicyName>
- name of the radius policy
- length: 1<=x<=64
Parameter type: boolean

optional parameter with default


value: "0.0.0.0"
IP address of secondary NBNS
server
optional parameter with default
value: 0
maximum lifetime of a session

[no] qos-policy

authenticator

[no] admin-down

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "none"
name of the QoS policy to be
applied to this domain

mandatory parameter
type of authenticator

optional parameter
adminstrative state down

Released

429

12 Security Configuration Commands

12.22 Security Connection Profile Configuration


Command
Command Description
This command allows the operator to configure the connection profile parameters.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security ( no conn-profile (name) ) | ( conn-profile (name) version <SignedInteger> [ [ no ]
reject-no-domain ] [ [ no ] reject-inv-domain ] domain-name <Aaa::DomainName> )

Command Parameters
Table 12.22-1 "Security Connection Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

name of connection profile

Table 12.22-2 "Security Connection Profile Configuration Command" Command Parameters


Parameter

Type

Description

version
[no] reject-no-domain

Parameter type: <SignedInteger>


Format:
- a signed integer
Parameter type: boolean

[no] reject-inv-domain

Parameter type: boolean

domain-name

Parameter type: <Aaa::DomainName>


Format:
- name of the domain
- length: 1<=x<=64

mandatory parameter
version number to be associated
to the Profile
optional parameter
reject user session auth if no
domain
optional parameter
reject user session auth if invalid
domain
mandatory parameter
name of the domain

430

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.23 Security Connection Policy Configuration


Command
Command Description
This command allows the operator to configure a connection policy associated with the specified policy. The
operator should specify the index that indicates which connection policy to apply and the profile-index, which
provides the connection profile associated with this policy.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security ( no conn-policy ) | ( conn-policy conn-profile-name <AsamProfileName> )

Command Parameters
Table 12.23-2 "Security Connection Policy Configuration Command" Command Parameters
Parameter

Type

Description

conn-profile-name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

mandatory parameter
connection profile associated
with this policy

3HH-04416-EBAA-TCZZA 01

Released

431

12 Security Configuration Commands

12.24 Security 802.1x PAE System Configuration


Command
Command Description
This command allows the operator to configure the administrative enable and disable state for port access control
in a system.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae [ [ no ] port-access ]

Command Parameters
Table 12.24-2 "Security 802.1x PAE System Configuration Command" Command Parameters
Parameter

Type

Description

[no] port-access

Parameter type: boolean

optional parameter
enable port access control

432

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.25 Security 802.1x Port Authentication


Configuration Command
Command Description
This command allows the operator to configure security 802.1x port authentication.
This command is valid for user ports. If the user port resides on a board that does not support user authentication,
this command will fail.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae authenticator (port) [ no controlled-port | controlled-port
<Aaa::PaeControlledPortControl> ] [ no quiet-period | quiet-period <Aaa::paeQuitTime> ] [ no tx-period | tx-period
<Aaa::paeTime> ] [ no supp-timeout | supp-timeout <Aaa::paeTime> ] [ no server-timeout | server-timeout
<Aaa::paeTime> ] [ no max-req | max-req <Aaa::paeMaxReq> ] [ [ no ] re-auth-enabled ] [ no re-auth-period |
re-auth-period <Aaa::paeReauthPeriod> ]

Command Parameters
Table 12.25-1 "Security 802.1x Port Authentication Configuration Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/

Released

433

12 Security Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::PortId>


- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 12.25-2 "Security 802.1x Port Authentication Configuration Command" Command


Parameters
Parameter

Type

Description

[no] controlled-port

Parameter type: <Aaa::PaeControlledPortControl>


Format:
( force-unauthorized
| auto
| force-authorized )
Possible values:
- force-unauthorized : force unauthorized control
- auto : automatic control
- force-authorized : force authorized control
Parameter type: <Aaa::paeQuitTime>
Format:
- quietPeriod
- range: [0...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeMaxReq>
Format:
- max number of requests
- range: [1...10]
Parameter type: boolean

optional parameter with default


value: "auto"
current value of the controlled
Port

[no] quiet-period

[no] tx-period

[no] supp-timeout

[no] server-timeout

[no] max-req

[no] re-auth-enabled
[no] re-auth-period

434

Parameter type: <Aaa::paeReauthPeriod>


Format:

Released

optional parameter with default


value: 60
quietPeriod constant currently
used, value in seconds
optional parameter with default
value: 30
txPeriod constant currently used,
value in seconds
optional parameter with default
value: 30
suppTimeout constant currently
used, value in seconds
optional parameter with default
value: 30
serverTimeout constant currently
used, value in seconds
optional parameter with default
value: 2
maxReq constant currently used
optional parameter
enable re-authentication
optional parameter with default
value: 3600

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

- re-authentication Period
- range: [1...65535]

the
actual
period

Released

re-authentication

435

12 Security Configuration Commands

12.26 Security 802.1x Extension, Port


Authentication Configuration Command
Command Description
This command allows the operator to configure the security 802.1x extension port authentication.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae ext-authenticator (port) [ [ no ] authentication ] [ [ no ] init-authreq-off ] [ [ no ]
handshake ] [ no handshake-period | handshake-period <Aaa::PortHandShakePeriod> ]

Command Parameters
Table 12.26-1 "Security 802.1x Extension, Port Authentication Configuration Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

436

Released

Description
identification of the port or
/ virtual channel
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::PonId>


- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 12.26-2 "Security 802.1x Extension, Port Authentication Configuration Command"


Command Parameters
Parameter

Type

Description

[no] authentication

Parameter type: boolean

[no] init-authreq-off

Parameter type: boolean

[no] handshake

Parameter type: boolean

[no] handshake-period

Parameter type: <Aaa::PortHandShakePeriod>


Format:
- handshake time interval
- range: [5...90]

optional parameter
enable 802.1x authentication
optional parameter
disable initiate authentication
request to supplicant
optional parameter
enable handshake for this port
optional parameter with default
value: 15
specify the handshake time
interval

3HH-04416-EBAA-TCZZA 01

Released

437

12 Security Configuration Commands

12.27 Security 802.1x Port Configuration Command


Command Description
This command allows the operator to configure the security 802.1x port.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae port (port) [ [ no ] initialize ]

Command Parameters
Table 12.27-1 "Security 802.1x Port Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>

438

Released

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Resource Identifier

Type

Description

- the ONT identifier


Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 12.27-2 "Security 802.1x Port Configuration Command" Command Parameters


Parameter

Type

Description

[no] initialize

Parameter type: boolean

optional parameter
initalize this port

3HH-04416-EBAA-TCZZA 01

Released

439

12 Security Configuration Commands

12.28 Security Password Policy Configuration


Commmand
Command Description
This command allows the operator to configure the password policy.

User Level
The command can be accessed by operators with security,all privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security password [ min-length <Sec::PwdLength> ] [ min-num-numeric-char
<Sec::PwdNumChars> ] [ min-num-special-char <Sec::PwdSpeChars> ] [ no mixed-case | mixed-case
<Sec::MixCase> ]

Command Parameters
Table 12.28-2 "Security Password Policy Configuration Commmand" Command Parameters
Parameter

Type

Description

min-length

Parameter type: <Sec::PwdLength>


Format:
- the minimum length of the password
- unit: characters
- range: [6...20]
Parameter type: <Sec::PwdNumChars>
Format:
- minimum number of numerical characters
- unit: characters
- range: [0...20]
Parameter type: <Sec::PwdSpeChars>
Format:
- minimum number of special character
- unit: characters
- range: [1...20]
Parameter type: <Sec::MixCase>
Format:
( mandatory
| not-mandatory )
Possible values:
- mandatory : both upper and lower case characters must be
present
- not-mandatory : both upper and lower case characters not

optional parameter
the minimum length of the
password

min-num-numeric-char

min-num-special-char

[no] mixed-case

440

Released

optional parameter
minimum number of numerical
characters
optional parameter
minimum number
character

of

special

optional parameter with default


value: "not-mandatory"
both upper and lower case
charactersre must be present

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

Parameter

Type

Description

mandatory

3HH-04416-EBAA-TCZZA 01

Released

441

12 Security Configuration Commands

12.29 File Transfer Configure Command


Command Description
This command configure file transfer states and attributes.
The TFTP server functionality will remain enabled when FTP is selected for file transfer. The TFTP client will
however be disabled when FTP is selected.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security filetransfer [ no protocol | protocol <SwMngt::FileTransferProtocolType> ] [ no
tftp-rollovr | tftp-rollovr <SwMngt::FileTransferRolloverType> ]

Command Parameters
Table 12.29-2 "File Transfer Configure Command" Command Parameters
Parameter

Type

Description

[no] protocol

Parameter type: <SwMngt::FileTransferProtocolType>


Format:
( tftp
| ftp
| sftp )
Possible values:
- tftp : the tftp protocol is selected for file transfer
- ftp : the ftp protocol is selected for file transfer
- sftp : the sftp protocol is selected for file transfer
Parameter type: <SwMngt::FileTransferRolloverType>
Format:
- TFTP Block Number
- range: [0...1]

optional parameter with default


value: "tftp"
the protocol that is to be used for
file transfer

[no] tftp-rollovr

442

Released

optional parameter with default


value: 0
The value with which TFTP
Block number rollover will
happen

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.30 file Transfer server Configure Commands


Command Description
This command configures file transfer server states and attributes.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security filetransfer ( no server (serverid) ) | ( server (serverid) user-name
<SwMngt::UserName> password <Security::Password1> )

Command Parameters
Table 12.30-1 "file Transfer server Configure Commands" Resource Parameters
Resource Identifier

Type

Description

(serverid)

Format:
- IPv4-address

(IP address) of the file transfer


server

Table 12.30-2 "file Transfer server Configure Commands" Command Parameters


Parameter

Type

Description

user-name

Parameter type: <SwMngt::UserName>


Format:
- the username used to access the file server
- length: x<=32
Parameter type: <Security::Password1>
Format:
( prompt
| plain : <Security::PlainPassword1> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Security::PlainPassword1>
- the password used to access the file server
- length: 1<=x<=32

mandatory parameter
the username used to access the
file server

password

3HH-04416-EBAA-TCZZA 01

mandatory parameter
the password used to access the
file server

Released

443

12 Security Configuration Commands

12.31 PM File Upload Configure Command


Command Description
This command configures PM file upload related parameters

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security pmfile

444

Released

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.32 PM File Upload Configure Command


Command Description
This command configures PM file upload related parameters

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security pmfile ( no upload (upload-index) ) | ( upload (upload-index) pri-server-addr
<SwMngt::pmFileUploadPrimaryServerAddr> upload-path <SwMngt::pmFileUploadPath> [ no upload-username |
upload-username <SwMngt::pmFileUploadClientUsername> ] [ no upload-password | upload-password
<Security::Password2> ] interval-type <SwMngt::pmFileUploadIntervalType> [ no auto-upload | auto-upload
<SwMngt::pmFileAutoUpload> ] [ no retry-num | retry-num <SwMngt::pmFileUploadRetryNum> ] [ no
max-delay | max-delay <SwMngt::pmFileUploadMaxDelay> ] )

Command Parameters
Table 12.32-1 "PM File Upload Configure Command" Resource Parameters
Resource Identifier

Type

(upload-index)

Format:
the unique internal identifier of
- the unique internal identifier of PM file upload entry PM file upload entry
(1-VOICE, 2-DSL)
- range: [1...2]

Description

Table 12.32-2 "PM File Upload Configure Command" Command Parameters


Parameter

Type

Description

pri-server-addr

Parameter
type:
<SwMngt::pmFileUploadPrimaryServerAddr>
Format:
- IPv4-address
Parameter type: <SwMngt::pmFileUploadPath>
Format:
- the path to be addressed for PM file upload, must not start
with '/' but must end with a '/'
- length: x<=127
Parameter type: <SwMngt::pmFileUploadClientUsername>
Format:
- the client username for setting up a session with an
external SFTP server
- length: x<=32

mandatory parameter
IP address of the primary SFTP
file server

upload-path

[no] upload-username

[no] upload-password

3HH-04416-EBAA-TCZZA 01

Parameter type: <Security::Password2>

mandatory parameter
the path to be addressed for PM
file upload, must not start with '/'
but must end with a '/'
optional parameter with default
value: "dummy"
the client username for setting up
a session with an external SFTP
server, replaced by filetransfer
table, to be removed
optional parameter with default

Released

445

12 Security Configuration Commands

Parameter

interval-type

[no] auto-upload

[no] retry-num

[no] max-delay

446

Released

Type

Description

Format:
( prompt
| plain : <Security::PlainPassword2> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Security::PlainPassword2>
- the client password for setting up a session with an external
SFTP server
- length: x<=32
Parameter type: <SwMngt::pmFileUploadIntervalType>
Format:
( 15-min
| 24-hour )
Possible values:
- 15-min : PM counters collected based on the 15-min
interval
- 24-hour : PM counters collected based on the 1-day
interval
Parameter type: <SwMngt::pmFileAutoUpload>
Format:
( enable
| disable )
Possible values:
- enable : PM file transfer auto upload enabled
- disable : PM file transfer auto upload disabled
Parameter type: <SwMngt::pmFileUploadRetryNum>
Format:
- the number of PM file upload retries in case the initial PM
file upload failed
- range: [0...5]
Parameter type: <SwMngt::pmFileUploadMaxDelay>
Format:
- the max delay period expressed in seconds for PM file
upload after PM data file ready
- unit: seconds
- range: [0...400]

value: "plain : dummy"


the client password for setting up
a session with an external SFTP
server

mandatory parameter
the type of interval to be used to
transfer the PM counters

optional parameter with default


value: "disable"
whether auto upload function
enabled or not

optional parameter with default


value: "3"
the number of PM file upload
retries in case the initial PM file
upload failed
optional parameter with default
value: "400"
the max delay period expressed
in seconds for PM file upload
after PM data file ready

3HH-04416-EBAA-TCZZA

01

12 Security Configuration Commands

12.33 MAC Filter Configuration Command


Command Description
By using this command, upstream traffic from any peripheral attached to the management port on the FD-REM
will be filtered at mac level.
The filter is implemented using a white-list of 20 MAC ranges, with each begin and end MAC address having the
same OUI. (Original manufacturer Unique Identifier, covering the 3 most significant bytes)

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system security peripheral-mgnt mac-filter (index-num) [ no filter | filter <Sys::PeriphMacFilter> ]

Command Parameters
Table 12.33-1 "MAC Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...20]

filter number

Table 12.33-2 "MAC Filter Configuration Command" Command Parameters


Parameter

Type

Description

[no] filter

Parameter type: <Sys::PeriphMacFilter>


Format:
( any - any
| <Sys::MacAddr> - <Sys::MacAddr> )
Possible values:
- any : all source MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Possible values:
- any : all destination MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6

optional parameter with default


value: "00 : 00 : 00 : 00 : 00 :
00-00 : 00 : 00 : 00 : 00 : 00"
specifies to MAC addresses to be
matched with the packet

3HH-04416-EBAA-TCZZA 01

Released

447

13- Secure Shell Configuration Commands

13.1 Secure Shell Configuration Command Tree


13.2 SSH Server Configuration Command
13.3 Secure Shell User Configuration Command
13.4 Secure Shell Access Configuration Command
13.5 Secure Shell SFTP User Configuration Command

448

Released

13-449
13-450
13-451
13-452
13-454

3HH-04416-EBAA-TCZZA

01

13 Secure Shell Configuration Commands

13.1 Secure Shell Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Secure Shell Configuration Commands".

Command Tree
----configure
----system
----security
----ssh
----server-profile
- [no] server-retries
- [no] idle-timeout
- [no] dis-hmac-sha-1
- [no] dis-hmac-sha-1-96
- [no] dis-aes
- [no] dis-des-3
- [no] dis-blowfish
- [no] dis-des-56
----[no] user
- (name)
- key
----access
- [no] protocol
- [no] cli
- [no] tl1
- [no] debug
----sftp-user
- (username)
- password

3HH-04416-EBAA-TCZZA 01

Released

449

13 Secure Shell Configuration Commands

13.2 SSH Server Configuration Command


Command Description
This command configures the SSH Server parameters like maximum number of server retries, idle timeout,
authentiation and encryption algorithm to be used

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security ssh server-profile [ no server-retries | server-retries <SSH::ServerRetries> ] [ no
idle-timeout | idle-timeout <SSH::ServerIdleTimeOut> ] [ [ no ] dis-hmac-sha-1 ] [ [ no ] dis-hmac-sha-1-96 ] [ [ no
] dis-aes ] [ [ no ] dis-des-3 ] [ [ no ] dis-blowfish ] [ [ no ] dis-des-56 ]

Command Parameters
Table 13.2-2 "SSH Server Configuration Command" Command Parameters
Parameter

Type

Description

[no] server-retries

optional parameter with default


value: 3
maximum number of attempts
can be tried
optional parameter with default
value: 1800
maximum idle time allowed

[no] dis-hmac-sha-1

Parameter type: <SSH::ServerRetries>


Format:
- maximum number of attempts can be tried
- range: [1...3]
Parameter type: <SSH::ServerIdleTimeOut>
Format:
- maximum idle time allowed
- unit: sec
- range: [0...1800]
Parameter type: boolean

[no] dis-hmac-sha-1-96

Parameter type: boolean

[no] dis-aes

Parameter type: boolean

[no] dis-des-3

Parameter type: boolean

[no] dis-blowfish

Parameter type: boolean

[no] dis-des-56

Parameter type: boolean

[no] idle-timeout

450

Released

optional parameter
disable hma-sha-1 authentication
optional parameter
disable
hma-sha-1-96
authentication
optional parameter
disable aes encryption
optional parameter
disable 3des encryption
optional parameter
disable blowfish encryption
optional parameter
disable des-56 encryption

3HH-04416-EBAA-TCZZA

01

13 Secure Shell Configuration Commands

13.3 Secure Shell User Configuration Command


Command Description
This command is used to configure a client (user, operator) who is authorised to manage the system in a secure
way and choosing the public key authentication (as opposed to password authentication)method. A maximum of 10
such users can be configured. As parameters, the command requires a client user name and the corresponding
public key. The public key is generated by the user using e.g. ssh-keygen (Unix), PuTTYgen (PC), etc.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security ssh ( no user (name) ) | ( user (name) [ key <SSH::SshClientPublicKey> ] )

Command Parameters
Table 13.3-1 "Secure Shell User Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- unique index to the table
- length: 1<=x<=11

unique index to the table

Table 13.3-2 "Secure Shell User Configuration Command" Command Parameters


Parameter

Type

Description

key

Parameter type: <SSH::SshClientPublicKey>


Format:
- user public key to be stored
- length: 1<=x<=725

optional parameter
public string of the client

3HH-04416-EBAA-TCZZA 01

Released

451

13 Secure Shell Configuration Commands

13.4 Secure Shell Access Configuration Command


Command Description
This command allows the operator to enable and disable the remote management access channels like TL1,CLI and
debug.
This command allows also configuration of file transfer protocol.
Options for cli
1. ssh - enables only CLI/SSH and disables CLI/TELNET
2. telnet - enables only CLI/TELNET and disables CLI/SSH
3. telnet-ssh - enables both CLI/SSH and CLI/TELNET
Options for file transfer protocol
1. ftp - enables the FTP application
2. sftp - enables the SFTP application
3. tftp - enables the TFTP application
Options for tl1
1. none - disable TL1/SSH, TL1/Telnet, and TL1/UDP
2. ssh - enables only TL1/SSH
3. telnet - enables only TL1/Telnet
4. udp - enables only TL1/UDP
5. udp-ssh - enables both TL1/UDP and TL1/SSH
6. udp-telnet - enables both TL1/UDP and TL1/Telnet
7. ssh-telnet - enables both TL1/SSH and TL1/Telnet
8. udp-ssh-telnet - enables TL1/UDP, TL1/SSH, and TL1/Telnet
Options for debug
1. none - disable debug/UDP
2. udp - enable debug/UDP

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security ssh access [ no protocol | protocol <SwMngt::FileTransferProtocolType> ] [ no cli | cli
<SSH::ChannelCLISSH> ] [ no tl1 | tl1 <SSH::ChannelTL1SSH> ] [ no debug | debug
<SSH::ChannelDebugUDP> ]

Command Parameters
Table 13.4-2 "Secure Shell Access Configuration Command" Command Parameters

452

Released

3HH-04416-EBAA-TCZZA

01

13 Secure Shell Configuration Commands

Parameter

Type

Description

[no] protocol

Parameter type: <SwMngt::FileTransferProtocolType>


Format:
( tftp
| ftp
| sftp )
Possible values:
- tftp : the tftp protocol is selected for file transfer
- ftp : the ftp protocol is selected for file transfer
- sftp : the sftp protocol is selected for file transfer
Parameter type: <SSH::ChannelCLISSH>
Format:
( ssh
| telnet
| telnet-ssh )
Possible values:
- ssh : enable only cli over ssh
- telnet : enable only cli over telnet
- telnet-ssh : enable both cli over ssh and telnet
Parameter type: <SSH::ChannelTL1SSH>
Format:
( none
| ssh
| telnet
| udp
| udp-ssh
| udp-telnet
| ssh-telnet
| udp-ssh-telnet )
Possible values:
- none : disable tl1 over ssh/telnet/udp
- ssh : enable only tl1 over ssh
- telnet : enable only tl1 over telnet
- udp : enable only tl1 over udp
- udp-ssh : enable both tl1 over ssh and udp
- udp-telnet : enable both tl1 over udp and telnet
- ssh-telnet : enable both tl1 over ssh and telnet
- udp-ssh-telnet : enable tl1 over udp, ssh and telnet
Parameter type: <SSH::ChannelDebugUDP>
Format:
( none
| udp )
Possible values:
- none : disable debug over udp
- udp : enable debug over udp

optional parameter with default


value: "tftp"
the protocol that is to be used for
file transfer

[no] cli

[no] tl1

[no] debug

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "telnet-ssh"
enable/disable cli over ssh or
telnet

optional parameter with default


value: "udp-ssh-telnet"
enable/disable tl1 over ssh, telnet,
or udp

optional parameter with default


value: "udp"
enable/disable debug over udp

Released

453

13 Secure Shell Configuration Commands

13.5 Secure Shell SFTP User Configuration


Command
Command Description
The system acts as an SFTP client towards an external SFTP server. This command allows the operator to
configure the user name and password the system should use towards the external SFTP server.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security ssh sftp-user [ (username) ] [ password <SSH::SftpPassword> ]

Command Parameters
Table 13.5-2 "Secure Shell SFTP User Configuration Command" Command Parameters
Parameter

Type

Description

(username)

Format:
- specifies sftp user name to be used
- length: x<=32
Parameter type: <SSH::SftpPassword>
Format:
( prompt
| plain : <SSH::SftpPassword> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <SSH::SftpPassword>
- sftp password
- length: 6<=x<=32

optional parameter
user name used when ISAM acts
as SFTP client
optional parameter
password used when ISAM acts
as SFTP client

password

454

Released

3HH-04416-EBAA-TCZZA

01

14- Transaction Configuration Commands

14.1 Transaction Configuration Command Tree


14.2 Transaction Configuration Command

3HH-04416-EBAA-TCZZA 01

14-456
14-457

Released

455

14 Transaction Configuration Commands

14.1 Transaction Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Transaction Configuration Commands".

Command Tree
----configure
----system
----transaction
- [no] time-out-value
- log-full-action

456

Released

3HH-04416-EBAA-TCZZA

01

14 Transaction Configuration Commands

14.2 Transaction Configuration Command


Command Description
This command allows the operator to configure transaction parameters.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure system transaction [ no time-out-value | time-out-value <Trans::TimeoutValue> ] [ log-full-action
<Trans::logFullaction> ]

Command Parameters
Table 14.2-2 "Transaction Configuration Command" Command Parameters
Parameter

Type

Description

[no] time-out-value

Parameter type: <Trans::TimeoutValue>


Format:
( indefinite
| <Trans::TimeoutValue> )
Possible values:
- indefinite : indefinite timeout value
Field type <Trans::TimeoutValue>
- timeout of the transaction
- unit: 1/100 sec
- range: [6000...360000]
Parameter type: <Trans::logFullaction>
Format:
( wrap
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset

optional parameter with default


value: 6000
set the timeout for transaction

log-full-action

3HH-04416-EBAA-TCZZA 01

optional parameter
set action to be taken when the
log is full

Released

457

15- SYSLOG Configuration Commands

15.1 SYSLOG Configuration Command Tree


15.2 SYSLOG Destination Configuration command
15.3 SYSLOG Route Configuration Command

458

Released

15-459
15-460
15-462

3HH-04416-EBAA-TCZZA

01

15 SYSLOG Configuration Commands

15.1 SYSLOG Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "SYSLOG Configuration Commands".

Command Tree
----configure
----system
----syslog
----[no] destination
- (name)
- type
- [no] disable
- [no] upload-rotate
----[no] route
- (name)
- msg-type
- facility
- [no] emergency
- [no] alert
- [no] critical
- [no] error
- [no] warning
- [no] notice
- [no] information
- [no] debug

3HH-04416-EBAA-TCZZA 01

Released

459

15 SYSLOG Configuration Commands

15.2 SYSLOG Destination Configuration command


Command Description
This command allows the operator to configure a syslog destination. Log messages can be sent to a file or, for
rotated files, to a file on a designated upload server (file:), a remote server (udp:), all logged in CLI-users (all-cli)
or all logged in TL1-users (all-tl1) or both (all-users).

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system syslog ( no destination (name) ) | ( destination (name) type <Sys::ServerType> [ [ no ] disable ]
[ [ no ] upload-rotate ] )

Command Parameters
Table 15.2-1 "SYSLOG Destination Configuration command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

name of the syslog destination

Table 15.2-2 "SYSLOG Destination Configuration command" Command Parameters


Parameter

Type

type

Parameter type: <Sys::ServerType>


mandatory parameter
Format:
destination type
( file : <Sys::ServName> : <Sys::FileSize>
| remote-file : <Ip::V4Address> : <Sys::UploadPathName> :
<Sys::ServName> : <Sys::FileSize>
| udp : <Ip::V4Address> : <Sys::NetworkPort> : unlimited
| udp : <Ip::V4Address> : <Sys::NetworkPort> :
<SYS::MaxRate>
| all-cli
| all-tl1
| all-users )
Possible values:
- file : file in which logs to be stored
- remote-file : remote file in which logs to be stored
- udp : log messages to the destination
- all-cli : cli users terminal logging
- all-tl1 : tl1 users terminal logging
- all-users : all cli and tl1 users

460

Released

Description

3HH-04416-EBAA-TCZZA

01

15 SYSLOG Configuration Commands

Parameter

[no] disable
[no] upload-rotate

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Ip::V4Address>


- IPv4-address
Field type <Sys::UploadPathName>
- an absolute or relative path name (example : /var/log/),
path name must end with slash or backslash depending on
OS of TFTP server used
- length: 1<=x<=64
Field type <Sys::ServName>
- filename in which logs to be stored
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=12
Field type <Sys::FileSize>
- the maximum file size
- range: [0...980000]
Field type <Sys::NetworkPort>
- the network port number
- range: [1...65535]
Possible values:
- unlimited : transfer rate is unlimited
Field type <SYS::MaxRate>
- transfer rate
- range: [1...2147483647]
Parameter type: boolean
optional parameter
disable logging to the destination
Parameter type: boolean
optional parameter
enable upload of rotated files to a
configured path

Released

461

15 SYSLOG Configuration Commands

15.3 SYSLOG Route Configuration Command


Command Description
This command allows an operator to configure which messages must be sent to a given syslog destination and to
assign the appropriate syslog parameters to them.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system syslog ( no route (name) msg-type <Sys::MessageType> ) | ( route (name) msg-type
<Sys::MessageType> facility <Sys::LogFacility> [ [ no ] emergency ] [ [ no ] alert ] [ [ no ] critical ] [ [ no ] error ]
[ [ no ] warning ] [ [ no ] notice ] [ [ no ] information ] [ [ no ] debug ] )

Command Parameters
Table 15.3-1 "SYSLOG Route Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Sys::MessageType>
Format:
( all
| authentication
| cli-config-chgs
| tl1-config-chgs
| cli-msgs
| tl1-msgs
| tracing1
| tracing2
| tracing3
| video-cdr
| eqpt
| li-config-chgs
| omci
| docsis )
Possible values:
- all : messages of any type
- authentication : authentication messages
- cli-config-chgs : cli commands
- tl1-config-chgs : tl1 commands

name of the destination where


messages must be sent to

msg-type

462

Released

type of the message to be routed

3HH-04416-EBAA-TCZZA

01

15 SYSLOG Configuration Commands

Resource Identifier

Type

Description

- cli-msgs : cli messages


- tl1-msgs : tl1 messages
- tracing1 : protocol tracing messages
- tracing2 : protocol tracing messages
- tracing3 : protocol tracing messages
- video-cdr : video cdr messages
- eqpt : equipment event messages
- li-config-chgs : li-config-chgs can only be logged to a
destination = encrypted file
- omci : OMCI events
- docsis : DOCSIS events

Table 15.3-2 "SYSLOG Route Configuration Command" Command Parameters


Parameter

Type

Description

facility

Parameter type: <Sys::LogFacility>


Format:
( kern
| user
| mail
| daemon
| auth
| syslog
| pr
| news
| uucp
| cron
| local0
| local1
| local2
| local3
| local4
| local5
| local6
| local7 )
Possible values:
- kern : kernel facility
- user : user facility
- mail : mail facility
- daemon : daemon facility
- auth : authentication facility
- syslog : syslog facility
- pr : printer facility
- news : news facility
- uucp : uucp facility
- cron : cron facility
- local0 : local0 facility
- local1 : local1 facility
- local2 : local2 facility
- local3 : local3 facility
- local4 : local4 facility
- local5 : local5 facility
- local6 : local6 facility
- local7 : local7 facility
Parameter type: boolean

mandatory parameter
facility to be set in the outgoing
message

[no] emergency
[no] alert

3HH-04416-EBAA-TCZZA 01

Parameter type: boolean

optional parameter
pass messages of
emergency
optional parameter

Released

463

severity

15 SYSLOG Configuration Commands

Parameter

Type

[no] critical

Parameter type: boolean

[no] error

Parameter type: boolean

[no] warning

Parameter type: boolean

[no] notice

Parameter type: boolean

[no] information

Parameter type: boolean

[no] debug

Parameter type: boolean

464

Released

Description
pass messages of severity alert
optional parameter
pass messages of severity critical
optional parameter
pass messages of severity error
optional parameter
pass messages of severity
warning
optional parameter
pass messages of severity notice
optional parameter
pass messages of severity info
optional parameter
pass messages of severity debug

3HH-04416-EBAA-TCZZA

01

16- PCCP Configuration Commands

16.1 PCCP Configuration Command Tree


16.2 SHub PCCP Module Configuration Command
16.3 SHub PCCP Group Entry Configuration Command
16.4 SHub Static network Port for PCCP Group
Configuration Command

3HH-04416-EBAA-TCZZA 01

16-466
16-467
16-468
16-470

Released

465

16 PCCP Configuration Commands

16.1 PCCP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "PCCP Configuration Commands".

Command Tree
----configure
----pccp
- [no] module-status
----[no] group
- (groupid)
- [no] admin-state
- [no] ping-interval
- ping-dest-ipaddr
- [no] switchover
----[no] ports-list
- (port)

466

Released

3HH-04416-EBAA-TCZZA

01

16 PCCP Configuration Commands

16.2 SHub PCCP Module Configuration Command


Command Description
This command allows the operator to enable/disable the Path Connectivity Check Protection feature.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure pccp [ no module-status | module-status <Shub::ModulStatus> ]

Command Parameters
Table 16.2-2 "SHub PCCP Module Configuration Command" Command Parameters
Parameter

Type

Description

[no] module-status

Parameter type: <Shub::ModulStatus>


Format:
( enable
| disable )
Possible values:
- enable : enable the path connectivity check protection
feature
- disable : disable the path connectivity check protection
feature

optional parameter with default


value: "disable"
path
connectivity
check
protection status

3HH-04416-EBAA-TCZZA 01

Released

467

16 PCCP Configuration Commands

16.3 SHub PCCP Group Entry Configuration


Command
Command Description
This command allows the operator to configure the Path Connectivity Check Protection feature parameters.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure pccp ( no group (groupid) ) | ( group (groupid) [ no admin-state | admin-state <Shub::AdminState> ] [
no ping-interval | ping-interval <Shub::PingInterval> ] ping-dest-ipaddr <Ip::V4Address> [ no switchover |
switchover <Shub::SwitchOver> ] )

Command Parameters
Table 16.3-1 "SHub PCCP Group Entry Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(groupid)

Format:
- pccp identifier number
- range: [1...4]

path
connectivity
check
protection group identifier

Table 16.3-2 "SHub PCCP Group Entry Configuration Command" Command Parameters
Parameter

Type

[no] admin-state

Parameter type: <Shub::AdminState>


optional parameter with default
Format:
value: "disable"
( enable
path
connectivity
check
| disable )
protection at group level
Possible values:
- enable : enable the path connectivity check protection at
group level
- disable : disable the path connectivity check protection at
group level
Parameter type: <Shub::PingInterval>
optional parameter with default
Format:
value: "5"
- time interval between 2 pings
time
interval
between
2
- unit: seconds
pings(0...60)
- range: [0...60]
Parameter type: <Ip::V4Address>
mandatory parameter
Format:
destination IP address of the ping
- IPv4-address
check
Parameter type: <Shub::SwitchOver>
optional parameter with default

[no] ping-interval

ping-dest-ipaddr
[no] switchover

468

Released

Description

3HH-04416-EBAA-TCZZA

01

16 PCCP Configuration Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( on
| off )
Possible values:
- on : force to select a new masterlink
- off : no effect within a pccp group

value: "off"
trigger a switchover of pccp

Released

469

16 PCCP Configuration Commands

16.4 SHub Static network Port for PCCP Group


Configuration Command
Command Description
This command allows the operator to specify network ports that should transmit packets for PCCP Group as
untagged.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure pccp group (groupid) ( no ports-list (port) ) | ( ports-list (port) )

Command Parameters
Table 16.4-1 "SHub Static network Port for PCCP Group Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(groupid)

Format:
- pccp identifier number
- range: [1...4]
Format:
network : <Shub::NetworkPort>
Possible values:
- network : network port
Field type <Shub::NetworkPort>
- network port on Shub

path
connectivity
check
protection group identifier

(port)

470

Released

the pccp network port

3HH-04416-EBAA-TCZZA

01

17- Software Management Configuration


Commands

17.1 Software Management Configuration Command Tree


17.2 Software Management Overall Software Package
Configuration Command
17.3 Database Automatic Activation Configure Command

3HH-04416-EBAA-TCZZA 01

17-472
17-473
17-476

Released

471

17 Software Management Configuration Commands

17.1 Software Management Configuration


Command Tree
Description
This chapter gives an overview of nodes that are handled by "Software Management Configuration Commands".

Command Tree
----configure
----software-mngt
----oswp
- (index)
- primary-file-server-id
- second-file-server-id
X download-set
X autofetch
- [no] activate
----database
- [no] activate
- [no] backup
- [no] auto-backup-intvl

472

Released

3HH-04416-EBAA-TCZZA

01

17 Software Management Configuration Commands

17.2 Software Management Overall Software


Package Configuration Command
Introduction
The Overall Software Package (OSWP) can be in any one of the following states: operational, aborting,
downloading, enabled, disabled, activated, and committed. The operator can perform such functions as download
the OSWP or set of files, abort its download, or enable or disable its autofetch property. The operator can also
specify primary and secondary TFTP-server IDs for downloading the database.
The operator can also configure the download set or the set of files that are needed before triggering activation.

Download a new OSWP


To download an OSWP, the system must have only one enabled/active/committed OSWP, the management channel
between the system and the manager must be established, and the system must not be involved in another software
download process.
The manager requests that the system download a new OSWP. The manager specifies the path name of the overall
descriptor file, the TFTP-servers where the overall descriptor files are located, and the set of files the manager
wants to have available on the system before activating the new OSWP.
The system downloads the overall descriptor files and stores them persistently. The system downloads the software
files that are specified in the downloaded SWP descriptor files, on condition that sufficient resources are available
for their persistent storage. The manager can monitor the progress of the download process with granularity.
The download process can be implicitly or explicitly interrupted. The implicit interruption can occur due to reasons
such as the unavailability of enough resources to store SWP files, the system not being able to download or
interpret the overall descriptor file, or the system not being able to download a selected SWP descriptor file. The
explicit interruption can occur when the manager requests that the system abort the ongoing download process.
If there are no exceptions, the system has two OSWPs; the Enabled/Active/Committed OSWP and the new
downloaded OSWP. The state of the new OSWP is Enabled/NotActive/UnCommitted.

Abort an OSWP
The manager can abort an OSWP when the system has two OSWPs. The state of the first OSWP is
Enabled/Active/Committed while the second OSWP is in one of the following three states:
Enabled/NotActive/UnCommitted, Downloading/NotActive/UnCommitted, or Disabled/NotActive/UnCommitted.
The management channel between the system and the manager is established and the system is not involved in any
other software download process.
The manager requests that the system remove the NotActive/UnCommitted OSWP. The system removes all the
persistent stored files and databases not related to the Enabled/Active/Committed OSWP. The state of the OSWP to
be removed is Aborting/NotActive/UnCommitted during the complete removal operation.
After a successful abort, the system has only one OSWP. The state of this OSWP is Enabled/Active/Committed.
Only files and databases related to this OSWP are stored persistently in the system.

Activate a Not-Active OSWP


To activate a not-active OSWP, the system requires two OSWPs. The state of one OSWP is Enabled/Active and the

3HH-04416-EBAA-TCZZA 01

Released

473

17 Software Management Configuration Commands

state of the second OSWP is Enabled/NotActive. The management channel between the system and the manager is
established and the system is not involved in another software download process.
The manager requests that the system activates the Enabled/NotActive OSWP. In case the manager requests to
activate with linked database, the system first selects an available database that is compatible with and linked to the
Enabled/NotActive OSWP. In case the manager requests to activate with default database, the system creates a
default database that is compatible with the Enabled/NotActive OSWP. The system then starts the activation
process of the NotActive OSWP.
The activation can happen on active NT or on standby NT. Activation on standby NT is only possible in case the
redundant NT board is equipped and hot standby and the NT board type supports it. In case the conditions to do the
activation on standby NT are fulfilled, the system will select this option. In case these conditions are not fulfilled
the system will select activation on active NT.
Finally, after the successful activation of the Not-active OSWP, the system has two OSWPs. The previous
Not-active OSWP is now active, together with the selected compatible database. Also, the previous Active OSWP
is still available, but NotActive. In case the activation was done on standby NT, the standby NT from before the
activation will be the active NT after the activation.

Commit an OSWP
To commit an OSWP, the system requires two OSWPs. The state of the first
Enabled/Active/UnCommitted and the state of the second OSWP is Enabled/NotActive/Committed.

OSWP

is

The manager requests that the system commit the active OSWP. The system removes all the persistent stored files
and databases that do not belong to the Enabled/Active OSWP. The state of the OSWP to be committed is
Enabled/Active/Committing during the complete commit operation.
Finally, after a successful commit process, the system has only one OSWP. The state of this OSWP is
Enabled/Active/Committed. Only files related to this OSWP are stored persistently in the system.

Command Description
This command allows the operator to configure various OSWP attributes and parameters.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> configure software-mngt oswp (index) [ primary-file-server-id <SwMngt::serverId> ] [ second-file-server-id
<SwMngt::serverId> ] [ download-set <SwMngt::downloadSet> ] [ autofetch <SwMngt::autoFetch> ] [ no activate
| activate <SwMngt::OswpAutoAct> ]

Command Parameters
Table 17.2-1 "Software Management Overall Software Package Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(index)

Format:

index to the swm oswp table

474

Released

3HH-04416-EBAA-TCZZA

01

17 Software Management Configuration Commands

Resource Identifier

Type

Description

- id of one of the two oswps


- range: [1...2]

Table 17.2-2 "Software Management Overall Software Package Configuration Command"


Command Parameters
Parameter

Type

Description

primary-file-server-id

Parameter type: <SwMngt::serverId>


Format:
- IPv4-address
Parameter type: <SwMngt::serverId>
Format:
- IPv4-address
Parameter type: <SwMngt::downloadSet>
Format:
( min-set
| actual-set
| complete-set )
Possible values:
- min-set : minimum set of files needed to activate
- actual-set : files applicable for the board types
- complete-set : all the files
Parameter type: <SwMngt::autoFetch>
Format:
disabled
Possible values:
- disabled : disable autofetch feature
Parameter type: <SwMngt::OswpAutoAct>
Format:
( manually
| after-download )
Possible values:
- manually : manually activate the OSWP
- after-download : enable the automatic activation of OSWP
after downloading

optional parameter
tftp/sftp server address for overall
descriptor file
optional parameter
2nd tftp/sftp server address for
overall descriptor file
obsolete parameter that will be
ignored
set of files needed before
triggering activation

second-file-server-id
download-set

autofetch

[no] activate

3HH-04416-EBAA-TCZZA 01

obsolete parameter that will be


ignored
disable autofetch feature
optional parameter with default
value: "manually"
determines when to active an
OSWP

Released

475

17 Software Management Configuration Commands

17.3 Database Automatic Activation Configure


Command
Command Description
This command configure database automatic activation and automatic backup states and attributes.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> configure software-mngt database [ no activate | activate <SwMngt::DbAutoAct> ] [ no backup | backup
<SwMngt::DbAutoBackup> ] [ no auto-backup-intvl | auto-backup-intvl <SwMngt::DbAutoBackIntvl> ]

Command Parameters
Table 17.3-2 "Database Automatic Activation Configure Command" Command Parameters
Parameter

Type

[no] activate

Parameter type: <SwMngt::DbAutoAct>


optional parameter with default
Format:
value: "manually"
( after-download
determines when to active
| manually )
database
Possible values:
- after-download : enable the automatic activation of
database after downloading
- manually : manually activate the OSWP
Parameter type: <SwMngt::DbAutoBackup>
optional parameter with default
Format:
value: "manually"
( manually
backup destination of database
| activate : <Ip::V4Address> : <SwMngt::dbpath> )
Possible values:
- manually : manually backup of the database
- activate : automatic backup of the database
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::dbpath>
- path for the db (example: /path_to_db)
- range: [a-zA-Z0-9-_./]
- length: x<=255
Parameter type: <SwMngt::DbAutoBackIntvl>
optional parameter with default
Format:
value: 24
- the interval period for automatic backup
the interval period for automatic

[no] backup

[no] auto-backup-intvl

476

Released

Description

3HH-04416-EBAA-TCZZA

01

17 Software Management Configuration Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

- unit: hours
- range: [1...168]

backup

Released

477

18- Ethernet Configuration Commands

18.1 Ethernet Configuration Command Tree


18.2 Ethernet IP Configuration Command
18.3 SHub Ethernet MAC Filter Configuration Command
18.4 SHub Ethernet MAC Filter Port List Configuration
Command
18.5 SHub Ethernet MAC Filter Configuration Command
18.6 SHub Ethernet Rate Configuration Command

478

Released

18-479
18-480
18-481
18-483
18-485
18-487

3HH-04416-EBAA-TCZZA

01

18 Ethernet Configuration Commands

18.1 Ethernet Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Ethernet Configuration Commands".

Command Tree
----configure
----transport
----X ip
- default-ttl
----shub
----X [no] mac-filter
- (index-num)
- [no] protocol-type
- filter
- vlan-id
- [no] action-drop
----X [no] in-port
- (port)
----[no] mac-infilter
- (index-num)
- port
- [no] protocol-type
- filter
- vlan-id
- [no] action-drop
----rate-limit
- (ctrl-index)
- [no] lookup-enabled
- [no] bcast-pkt-enabled
- [no] mcast-pkt-enabled
- max-nbr-pkts

3HH-04416-EBAA-TCZZA 01

Released

479

18 Ethernet Configuration Commands

18.2 Ethernet IP Configuration Command


Command Description
Obsolete command, replaced by configure system management default-ttl.
This command allows the operator to configure the Ethernet IP.The parameters are configured to forwarding or
not forwarding of the datagrams, along with whether the TTL value has been provided by the transport layer.
The default value inserted into the Time-To-Live field of the IP header of datagrams originated at this entity,
whenever a TTL value is not supplied by the transport layer protocol. The indication of whether this entity is acting
as an IP router in respect to the forwarding of datagrams received by, but not addressed to, this entity. IP routers
forward datagrams, IP hosts do not.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure transport ip [ default-ttl <Ip::TTL> ]
Obsolete command, replaced by configure system management default-ttl.

Command Parameters
Table 18.2-2 "Ethernet IP Configuration Command" Command Parameters
Parameter

Type

Description

default-ttl

Parameter type: <Ip::TTL>


Format:
- time-to-live value of IP-header
- range: [1...255]

optional parameter
default value for time-to-live
field of IP header

480

Released

3HH-04416-EBAA-TCZZA

01

18 Ethernet Configuration Commands

18.3 SHub Ethernet MAC Filter Configuration


Command
Command Description
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.
By using this command traffic from an LT can be filtered but not from an individual DSL port.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub ( no mac-filter (index-num) ) | ( mac-filter (index-num) [ no protocol-type |
protocol-type <Sys::ProtocolType> ] filter <Sys::MacFilter> [ vlan-id <Sys::FilterVlanId> ] [ [ no ] action-drop ] )
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.

Command Parameters
Table 18.3-1 "SHub Ethernet MAC Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]

L2 Filter rule number

Table 18.3-2 "SHub Ethernet MAC Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] protocol-type

Parameter type: <Sys::ProtocolType>


Format:
- message protocol type
- range: [0,1536...65535]
Parameter type: <Sys::MacFilter>
Format:
( any - any
| any - <Sys::MacAddr>
| <Sys::MacAddr> - any
| <Sys::MacAddr> - <Sys::MacAddr> )
Possible values:
- any : all source MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Possible values:

optional parameter with default


value: 0
specifies the non IP protocol type
to be filtered
mandatory parameter
specifies to MAC addresses to be
matched with the packet

filter

3HH-04416-EBAA-TCZZA 01

Released

481

18 Ethernet Configuration Commands

Parameter

Type

vlan-id

- any : all destination MAC address


Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Parameter type: <Sys::FilterVlanId>
Format:
- vlan id
- range: [0...4094]
Parameter type: boolean

[no] action-drop

482

Released

Description

optional parameter
Vlan Id to be filtered
optional parameter
the packet will be discarded

3HH-04416-EBAA-TCZZA

01

18 Ethernet Configuration Commands

18.4 SHub Ethernet MAC Filter Port List


Configuration Command
Command Description
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.
This command allows the operator to limit the filter to only the traffic coming from one specific port.
This command allows traffic from an LT to be filtered, but not from an individual DSL port.
By using this command, traffic from an LT can be filtered but not from an individual DSL port.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub mac-filter (index-num) ( no in-port (port) ) | ( in-port (port) )
Obsolete command, replaced by configure transport shub mac-infilter (index-num) port.

Command Parameters
Table 18.4-1 "SHub Ethernet MAC Filter Port List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex> )
Possible values:
- lt : line board
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

L2 Filter rule number

(port)

3HH-04416-EBAA-TCZZA 01

the port number

Released

483

18 Ethernet Configuration Commands

Resource Identifier

Type

Description

Field type <Shub::SlotId>


- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

484

Released

3HH-04416-EBAA-TCZZA

01

18 Ethernet Configuration Commands

18.5 SHub Ethernet MAC Filter Configuration


Command
Command Description
By using this command traffic from an LT can be filtered but not from an individual DSL port.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub ( no mac-infilter (index-num) port <Shub::InDataPort> ) | ( mac-infilter (index-num)
port <Shub::InDataPort> [ no protocol-type | protocol-type <Sys::ProtocolType> ] filter <Sys::MacFilter> [ vlan-id
<Sys::FilterVlanId> ] [ [ no ] action-drop ] )

Command Parameters
Table 18.5-1 "SHub Ethernet MAC Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Parameter type: <Shub::InDataPort>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| all
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : line board
- network : network port
- all : apply to all ports
- nt : active nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub

L2 Filter rule number

port

3HH-04416-EBAA-TCZZA 01

the port number

Released

485

18 Ethernet Configuration Commands

Resource Identifier

Type

Description

Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number

Table 18.5-2 "SHub Ethernet MAC Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] protocol-type

Parameter type: <Sys::ProtocolType>


Format:
- message protocol type
- range: [0,1536...65535]
Parameter type: <Sys::MacFilter>
Format:
( any - any
| any - <Sys::MacAddr>
| <Sys::MacAddr> - any
| <Sys::MacAddr> - <Sys::MacAddr> )
Possible values:
- any : all source MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Possible values:
- any : all destination MAC address
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Parameter type: <Sys::FilterVlanId>
Format:
- vlan id
- range: [0...4094]
Parameter type: boolean

optional parameter with default


value: 0
specifies the non IP protocol type
to be filtered
mandatory parameter
specifies to MAC addresses to be
matched with the packet

filter

vlan-id

[no] action-drop

486

Released

optional parameter
Vlan Id to be filtered
optional parameter
the packet will be discarded

3HH-04416-EBAA-TCZZA

01

18 Ethernet Configuration Commands

18.6 SHub Ethernet Rate Configuration Command


Command Description
This command allows the operator to configure the rate limit.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub rate-limit (ctrl-index) [ [ no ] lookup-enabled ] [ [ no ] bcast-pkt-enabled ] [ [ no ]
mcast-pkt-enabled ] [ max-nbr-pkts <Sys::RateCtrlLimit> ]

Command Parameters
Table 18.6-1 "SHub Ethernet Rate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ctrl-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

control index of the rate

Table 18.6-2 "SHub Ethernet Rate Configuration Command" Command Parameters


Parameter

Type

Description

[no] lookup-enabled

Parameter type: boolean

[no] bcast-pkt-enabled

Parameter type: boolean

[no] mcast-pkt-enabled

Parameter type: boolean

max-nbr-pkts

Parameter type: <Sys::RateCtrlLimit>


Format:
- max nbr of packets transmitted on this interface
- range: [0...33554431]

optional parameter
enable this status
optional parameter
enable this status
optional parameter
enable this status
optional parameter
maximum number of DLF,MC
and BC packets on an
interface.DLF,MC and BC packet

3HH-04416-EBAA-TCZZA 01

Released

487

18 Ethernet Configuration Commands

Parameter

Type

Description
types can be individually
configured to be part of this rate
limit or not.

488

Released

3HH-04416-EBAA-TCZZA

01

19- QoS Configuration Commands

19.1 QoS Configuration Command Tree


19.2 QoS Configuration Command
19.3 QoS 802.1P Class-to-Queue Mapping Configuration
Command
19.4 QoS Dsl Control Pkt Policer Configuration Command
19.5 QoS Nni Control Pkt Policer Configuration Command
19.6 QoS DSCP-to-Dot1P Alignment for L3 Forwarded
Traffic Configuration Command
19.7 QoS Queue Profile Configuration Command
19.8 QoS Scheduler Node Profile Configuration Command
19.9 QoS CAC Profile Configuration Command
19.10 QoS Single Dot1P Marker Configuration Command
19.11 QoS Single DSCP Marker Configuration Command
19.12 QoS DSCP Contract Table Marker Configuration
Command
19.13 QoS DSCP Contract Table Code-point Configuration
Command For DSCP-contract
19.14 QoS Dot1P and DSCP Contract Table Marker
Configuration Command
19.15 DSCP Contract Table Codepoint Configuration
Command For D1p-dscp-contract
19.16 QoS Dot1P and Single DSCP Marker Configuration
Command
19.17 QoS Dot1P Alignment Marker Configuration
Command
19.18 QoS Dot1P Remark Table Marker Configuration
Command
19.19 QoS Dot1P Remark Table Dot1p-value Configuration
Command For Dot1P-Remark
19.20 QoS Policer Profile Configuration Command
19.21 QoS L2 Filter Profile Configuration Command
19.22 QoS L3 Filter Profile Configuration Command
19.23 QoS Policy Action Profile Configuration Command
19.24 QoS Policy Profile Configuration Command
19.25 QoS Session Profile Configuration Command
19.26 QoS Session Upstream Policy List Configuration
Command
19.27 QoS Session Downstream Policy List Configuration
Command
19.28 QoS Shaper Profile Configuration Command
19.29 QoS Bandwidth Profile Configuration Command
19.30 QoS IngressQoS Profile Configuration Command
19.31 QoS Rate Limit Profile Configuration Command
19.32 QoS DSCP to Pbit Mapping Profile Configuration
Command
19.33 QoS DSCP to Pbit Mapping Profile Configuration
Command
19.34 QoS Board-Level Queue and Performance
Configuration Command
19.35 QoS Queue Threshold Crossing Alarm Configuration

3HH-04416-EBAA-TCZZA 01

19-491
19-497
19-499
19-501
19-503
19-504
19-505
19-508
19-510
19-512
19-513
19-514
19-515
19-516
19-517
19-518
19-519
19-521
19-522
19-523
19-526
19-528
19-531
19-533
19-535
19-538
19-539
19-540
19-542
19-544
19-547
19-550
19-551
19-552
19-554

Released

489

Command
19.36 QoS DSL Link Configuration Command
19.37 QoS LIM Queue Configuration Command
19.38 QoS ShdSL Link Configuration Command
19.39 QoS LIM Queue (SHDSL) Configuration Command
19.40 QoS Interface Configuration Command
19.41 QoS Interface Queue Configuration Command
19.42 QoS Interface Upstream Queue Configuration
Command
19.43 QoS Interface Remote Downstream Queue
Configuration Command
19.44 SHub QoS Traffic Class Configuration Command
19.45 SHub QoS Queue Configuration Command
19.46 SHub QoS DSCP2P Map Configuration Command
19.47 SHub QoS Flow Configuration Command
19.48 SHub QoS Policer Configuration Command
19.49 SHub QoS Ingress Policing on Port Configuration
Command
19.50 QoS Line Control Packets Rate Limit Configuration
Command
19.51 P-bit Based Scheduling For SC Forwarder Cross
Connect/Residential Bridge Configuration Command

490

Released

19-557
19-559
19-561
19-563
19-565
19-570
19-573
19-577
19-580
19-581
19-583
19-584
19-586
19-588
19-589
19-591

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.1 QoS Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "QoS Configuration Commands".

Command Tree
----configure
----qos
- [no] atm-overhead-fact
- [no] eth-efm-fact
- [no] enable-alignment
- [no] cac-mode
----tc-map-dot1p
- (index)
X queue
- tc
- dpcolor
- policer-color
----dsl-ctrl-pkt-policer
- [no] sustained-rate
- [no] burst-size
- [no] protocol-ctrl
----nni-ctrl-pkt-policer
- [no] sustained-rate
- [no] burst-size
----dscp-map-dot1p
- (index)
- dot1p-value
----profiles
----[no] queue
- (name)
- (bac-complex-type)
- [no] unit
----[no] scheduler-node
- (name)
- priority
- weight
- shaper-profile
- [no] ext-shaper
- [no] mcast-inc-shape
----[no] cac
- (name)
- res-voice-bandwidth
- max-mcast-bandwidth
- res-data-bandwidth
- [no] cac-type
----marker
----[no] d1p
- (name)
- default-dot1p
----[no] dscp

3HH-04416-EBAA-TCZZA 01

Released

491

19 QoS Configuration Commands

- (name)
- default-dscp
- [no] alignment
----[no] dscp-contract
- (name)
- [no] alignment
----codepoint
- (codepoint)
- [no] dscp-value
----[no] d1p-dscp-contract
- (name)
- dot1p-value
X [no] alignment
----codepoint
- (codepoint)
- [no] dscp-value
----[no] d1p-dscp
- (name)
- default-dscp
- default-dot1p
----[no] d1p-alignment
- (name)
- (alignment)
- [no] dscp-pbit-prof
----[no] dot1p-remark
- (name)
----dot1p-value
- (dot1p-value)
- [no] remark-value
----[no] policer
- (name)
- committed-info-rate
- committed-burst-size
- [no] policer-type
- [no] excess-info-rate
- [no] excess-burst-size
- [no] coupling-flag
- [no] color-mode
- [no] green-action
- [no] yellow-action
- [no] red-action
- [no] policed-size-ctrl
----[no] l2-filter
- (name)
- [no] dst-mac-addr
- [no] src-mac-addr
- [no] ethertype
- [no] dot1p-priority
- [no] canonical-format
- [no] vlan-id
----[no] l3-filter
- (name)
- [no] filter-type
- [no] dst-ip-addr
- [no] src-ip-addr
- [no] dst-ipv6-addr
- [no] src-ipv6-addr
- [no] min-dst-port
- [no] max-dst-port

492

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

- [no] min-src-port
- [no] max-src-port
- [no] dscp-value
- [no] protocol
----[no] policy-action
- (name)
- [no] dscp-value
- [no] dot1p-value
- [no] discard-packet
- [no] shared-policer
- [no] policer-profile
----[no] policy
- (name)
- filter
- [no] precedence
- [no] policy-action
----[no] session
- (name)
- logical-flow-type
- [no] up-policer
- [no] down-policer
- [no] up-marker
----[no] up-policy
- (name)
----[no] down-policy
- (name)
----[no] shaper
- (name)
- committed-info-rate
- committed-burst-size
- [no] excess-info-rate
- [no] type
- [no] autoshape
----[no] bandwidth
- (name)
- committed-info-rate
- assured-info-rate
- excessive-info-rate
- [no] delay-tolerance
- [no] assu-burst-size
- [no] exce-burst-size
----[no] ingress-qos
- (name)
- [no] dot1-p0-tc
- [no] dot1-p1-tc
- [no] dot1-p2-tc
- [no] dot1-p3-tc
- [no] dot1-p4-tc
- [no] dot1-p5-tc
- [no] dot1-p6-tc
- [no] dot1-p7-tc
- [no] usedei
- [no] dot1-p0-color
- [no] dot1-p1-color
- [no] dot1-p2-color
- [no] dot1-p3-color
- [no] dot1-p4-color
- [no] dot1-p5-color
- [no] dot1-p6-color

3HH-04416-EBAA-TCZZA 01

Released

493

19 QoS Configuration Commands

- [no] dot1-p7-color
----[no] rate-limit
- (name)
- [no] total-rate
- [no] total-burst
- [no] arp-rate
- [no] arp-burst
- [no] dhcp-rate
- [no] dhcp-burst
- [no] igmp-rate
- [no] igmp-burst
- [no] pppoe-rate
- [no] pppoe-burst
- [no] nd-rate
- [no] nd-burst
- [no] icmpv6-rate
- [no] icmpv6-burst
- [no] mld-rate
- [no] mld-burst
- [no] dhcpv6-rate
- [no] dhcpv6-burst
- [no] cfm-rate
- [no] cfm-burst
----[no] dscp-pbit
- (name)
----codepoint
- (codepoint)
- dot1p-value
----global
- (index)
- [no] buffer-occ-thresh
- [no] queue-stats
- [no] dsload-tca
- [no] dsload-thresh
- [no] buffer-tca
- [no] up-buf-thresh
- [no] up-obc-thresh
- [no] dn-obc-thresh
- [no] dn-buf-thresh
- [no] part-buf-thresh
----tca
- (index)
- queue
- [no] tca-enable
- [no] load-thresh
- [no] dis-frame-th
----X dsl-port
- (index)
- [no] scheduler-profile
- cac-profile
----X queue
- (queue)
- queue-profile
----X shdsl-port
- (index)
- scheduler-profile
- cac-profile
----X queue
- (queue)

494

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

- queue-profile
----interface
- (index)
- [no] scheduler-node
- [no] ingress-profile
- [no] cac-profile
- [no] ext-cac
- [no] ds-queue-sharing
- [no] us-queue-sharing
- [no] ds-num-queue
- [no] ds-num-rem-queue
- [no] us-num-queue
- [no] queue-stats-on
- [no] autoschedule
- oper-weight
- oper-rate
- [no] us-vlanport-queue
- [no] dsfld-shaper-prof
- [no] gem-sharing
----queue
- (queue)
- priority
- weight
- oper-weight
- queue-profile
- shaper-profile
----upstream-queue
- (queue)
- [no] priority
- [no] weight
- [no] bandwidth-profile
- [no] ext-bw
- [no] bandwidth-sharing
- [no] queue-profile
- [no] shaper-profile
----ds-rem-queue
- (queue)
- [no] priority
- [no] weight
----shub
----tc-map-dot1p
- (tc-priority)
- traffic-class
----queue-config
- (port)
- [no] queue0-weight
- [no] queue1-weight
- [no] rx-pause
- [no] egress-rate
- [no] dscp2p-enable
----dscp-map-dot1p
- (dscp-index)
- dot1p-value
----[no] flow
- (index)
- [no] name
X (old-type)
- [no] type
----[no] policer

3HH-04416-EBAA-TCZZA 01

Released

495

19 QoS Configuration Commands

- (port-id)
- flow
- meter
----[no] meter
- (index)
- [no] name
- max-ingress-rate
- burst-size
----[no] ctrl-pkt-policer
- (protocol-id)
- [no] sustained-rate
- [no] burst-size
----pbit-scheduling
- [no] sc-xcon-us
- [no] sc-xcon-dn
- [no] sc-rb-us
- [no] sc-rb-dn

496

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.2 QoS Configuration Command


Command Description
This command allows the operator to specify global QoS parameters.
The ATM overhead factor is used to calculate ATM bandwidth required by streams for which bandwidth
parameters are specified as Ethernet bandwidth. The ATM overhead factor specifies in terms of percentage what
part of a given raw ATM bit rate will be available for Ethernet frames. The default value is 85%, which means a
typical overhead of 15% for ATM/AAL5. QoS management will use this value to deduct the available Ethernet rate
on ATM-based DSL interfaces.
The Eth EFM overhead factor is used to calculate EFM bandwidth required by streams for which bandwidth
parameters are specified as Ethernet bandwidth. The Eth EFM overhead factor specifies in terms of percentage
what part of a given raw EFM bit rate will be available for Ethernet frames. The default value is 97%, which
means a typical overhead of 3% for EFM Encapsulation.
The enable alignment is used to enable or disable the DSCP to P-bits alignment for all the L3 forwarded traffic.
The Global CAC-mode selection switch determines whether Connection Admission Control relies on the
guaranteed sync rate or the actual line rate of the physical interface.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos [ no atm-overhead-fact | atm-overhead-fact <Qos::AtmFactor> ] [ no eth-efm-fact | eth-efm-fact
<Qos::EthEfmFactor> ] [ [ no ] enable-alignment ] [ no cac-mode | cac-mode <Qos::CacMode> ]

Command Parameters
Table 19.2-2 "QoS Configuration Command" Command Parameters
Parameter

Type

[no] atm-overhead-fact

Parameter type: <Qos::AtmFactor>


optional parameter with default
Format:
value: 85
- over head factor introduced by atm layer
over head factor introduced by
- unit: %
atm layer
- range: [1...100]
Parameter type: <Qos::EthEfmFactor>
optional parameter with default
Format:
value: 97
- value to estimate bandwidth overhead inserted by efm value to estimate bandwidth
layer
overhead inserted by efm layer
- unit: %
- range: [1...100]
Parameter type: boolean
optional parameter
DSCP to P-bit alignment for all
forwarded L3 traffic

[no] eth-efm-fact

[no] enable-alignment

3HH-04416-EBAA-TCZZA 01

Description

Released

497

19 QoS Configuration Commands

Parameter

Type

Description

[no] cac-mode

Parameter type: <Qos::CacMode>


Format:
( nocac
| msr
| alr )
Possible values:
- nocac : no cac in system
- msr : base on minimum synchronized rate
- alr : base on actual line rate

optional parameter with default


value: "msr"
This object stores an global CAC
mode selection switch

498

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.3 QoS 802.1P Class-to-Queue Mapping


Configuration Command
Command Description
This command allows the operator to configure the downstream traffic class mapping table. This table defines
which 802.1P codepoint is cast to which egress buffer on the L3 units.
There is a second class to the queue mapping table on the SHub/IHub, but this class is independent from the
configuration perspective of this table. (See the traffic class configuration section for more information.) The
second class is used mainly for upstream traffic segregation into egress buffers on the SHub/IHub.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos tc-map-dot1p (index) [ queue <Qos::Queues> ] [ tc <Qos::QosTrafficClass> ] [ dpcolor
<Qos::Color> ] [ policer-color <Qos::PolicerColor> ]

Command Parameters
Table 19.3-1 "QoS 802.1P Class-to-Queue Mapping Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- value of 802.1p field
- range: [0...7]

value of 802.1p field

Table 19.3-2 "QoS 802.1P Class-to-Queue Mapping Configuration Command" Command


Parameters
Parameter

Type

Description

queue

Parameter type: <Qos::Queues>


Format:
- output dsl/gpon/epon port queue number
- range: [0...7,255]
Parameter type: <Qos::QosTrafficClass>
Format:
- the traffic class number
- range: [0...7]
Parameter type: <Qos::Color>
Format:
( green
| yellow )

obsolete parameter replaced by


parameter "tc"
output dsl port queue number

tc

dpcolor

3HH-04416-EBAA-TCZZA 01

optional parameter
the traffic class number
optional parameter
output discard precedence on
queue

Released

499

19 QoS Configuration Commands

Parameter

Type
Possible values:
- green : discard priority green in queue
- yellow : discard priority yellow in queue
Parameter type: <Qos::PolicerColor>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color

policer-color

500

Released

Description

optional parameter
the frame colour for trtcm

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.4 QoS Dsl Control Pkt Policer Configuration


Command
Command Description
This command allows the operator to configure a upstream QoS Dsl Control Packet Policer.This control packet
policer serves to prevent DoS attacks from subscriber premises against the control plane of the ISAM. The policing
parameters that can be configured are the sustainable rate in packets/sec and the maximum burst size in packets.
Control packets arriving at a higher rate then the sustainable rate are dropped by the policer.
Control packets arriving in a longer burst then the maximum burst size are dropped by the policer.
Control packets are packets directed to the LSM itself or inserted by the LSM. The control packet protocol type
depends on the applied forwarding model, and can be 802.1x, ARP, RIP, DHCP, IGMP, PPPoEDiscovery , PPP
LCP, PPP control, PPP LCP termination acknowledgement. Policing is not applied on control packets inserted by
the LSM.
This command allows the operator to control the DSL line level control packet policer (enable or disable) for
control protocol packets that remains in the data plane. And this feature is supported only for ARP and RIP
protocol.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dsl-ctrl-pkt-policer [ no sustained-rate | sustained-rate <Qos::SustainedRate> ] [ no burst-size |
burst-size <Qos::DslCtrlBurstSize> ] [ no protocol-ctrl | protocol-ctrl <Qos::ControlProtocolPolicerCtrl> ]

Command Parameters
Table 19.4-2 "QoS Dsl Control Pkt Policer Configuration Command" Command Parameters
Parameter

Type

Description

[no] sustained-rate

Parameter type: <Qos::SustainedRate>


Format:
- the police rate of inc user pkts in pps
- range: [1...64]
Parameter type: <Qos::DslCtrlBurstSize>
Format:
- the burst size
- range: [1...128]
Parameter type: <Qos::ControlProtocolPolicerCtrl>
Format:
( police-arprip
| nopolice-arprip )

optional parameter with default


value: 15
max
sustainable
rate
in
packets/sec
optional parameter with default
value: 10
max burst size, in packets

[no] burst-size

[no] protocol-ctrl

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "police-arprip"
DSL control packet policer
applicability for control protocol

Released

501

19 QoS Configuration Commands

Parameter

502

Released

Type

Description

Possible values:
- police-arprip : police arp rip packets by the dsl-ctrl-policer
if handled as data packet
- nopolice-arprip : no police arp rip packets by the
dsl-ctrl-policer if handled as data packet

packets that remain in data plane.


Currently under this only ARP
and RIP control packets are
controlled.

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.5 QoS Nni Control Pkt Policer Configuration


Command
Command Description
This command allows the operator to configure a upstream QoS Nni Control Packet Policer.This control packet
policer serves to prevent DoS attacks from subscriber premises against the control plane of the ISAM. The policing
parameters that can be configured are the sustainable rate in packets/sec and the maximum burst size in packets.
Control packets arriving at a higher rate then the sustainable rate are dropped by the policer.
Control packets arriving in a longer burst then the maximum burst size are dropped by the policer.
Control packets are packets directed to the LSM itself or inserted by the LSM. The control packet protocol type
depends on the applied forwarding model, and can be 802.1x, ARP, RIP, DHCP, IGMP, PPPoEDiscovery , PPP
LCP, PPP control, PPP LCP termination acknowledgement. Policing is not applied on control packets inserted by
the LSM.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos nni-ctrl-pkt-policer [ no sustained-rate | sustained-rate <Qos::NniSustainedRate> ] [ no burst-size |
burst-size <Qos::NniCtrlBurstSize> ]

Command Parameters
Table 19.5-2 "QoS Nni Control Pkt Policer Configuration Command" Command Parameters
Parameter

Type

Description

[no] sustained-rate

Parameter type: <Qos::NniSustainedRate>


Format:
- the police rate of inc user pkts in pps
- range: [1...256]
Parameter type: <Qos::NniCtrlBurstSize>
Format:
- the burst size
- range: [1...256]

optional parameter with default


value: 64
max
sustainable
rate
in
packets/sec
optional parameter with default
value: 128
max burst size, in packets

[no] burst-size

3HH-04416-EBAA-TCZZA 01

Released

503

19 QoS Configuration Commands

19.6 QoS DSCP-to-Dot1P Alignment for L3


Forwarded Traffic Configuration Command
Command Description
This command allows the operator to configure a DSCP-to-Dot1P Alignment Table for L3 forwarded traffic.This
facility allows DSCP to P-bits alignment without the use of QoS session profiles via configuring a mapping table
with global scope. It is only applied to traffic in interfaces with L3 forwarding.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dscp-map-dot1p (index) [ dot1p-value <Qos::DscpToDot1PAlign> ]

Command Parameters
Table 19.6-1 "QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command"
Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the DSCP value
- range: [0...63]

the DSCP value

Table 19.6-2 "QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command"
Command Parameters
Parameter

Type

Description

dot1p-value

Parameter type: <Qos::DscpToDot1PAlign>


Format:
- the DOT1P value
- range: [0...7]

optional parameter
the DOT1P value

504

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.7 QoS Queue Profile Configuration Command


Command Description
This command allows the operator to configure a QoS queue profile. A queue profile or buffer acceptance control
(BAC) profile contains configuration information on data plane queues. BAC profiles can be used on the L3 line
cards.
Minimum and Maximum Threshold value for queues are given in packets.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no queue (name) ) | ( queue (name) (bac-complex-type) [ no unit | unit <Qos::Units> ] )

Command Parameters
Table 19.7-1 "QoS Queue Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.7-2 "QoS Queue Profile Configuration Command" Command Parameters


Parameter

Type

(bac-complex-type)

Format:
mandatory parameter
( tail-drop : <Qos::MaxThreshold>
buffer
acceptance
| red : <Qos::MinThreshold> : <Qos::MaxThreshold> : algorithm
<Qos::DiscardProbability>
|
twocolour-taildrop
:
<Qos::MaxThreshold>
:
<Qos::MaxThresholdYellow>
|
twocolourred
:
<Qos::MinThreshold>
:
<Qos::MaxThreshold> : <Qos::DiscardProbability> :
<Qos::MinThresholdYellow>
:
<Qos::MaxThresholdYellow> : <Qos::DiscardProbYellow>
|
gpon-tail-drop
:
<Qos::MinThreshold>
:
<Qos::MaxThreshold>
|
threecolour-taildrop
:
<Qos::MaxThreshold>
:
<Qos::MaxThresholdYellow> : <Qos::MaxThresholdRed>
|
threecolour-red
:
<Qos::MinThreshold>
:
<Qos::MaxThreshold> : <Qos::DiscardProbability> :
<Qos::MinThresholdYellow>
:
<Qos::MaxThresholdYellow> : <Qos::DiscardProbYellow>

3HH-04416-EBAA-TCZZA 01

Description

Released

505

control

19 QoS Configuration Commands

Parameter

Type

Description

: <Qos::MinThresholdRed> : <Qos::MaxThresholdRed> :
<Qos::DiscardProbRed>
|
gpon-threecolour-red
:
<Qos::MinThreshold>
:
<Qos::MaxThreshold> : <Qos::DiscardProbability> :
<Qos::MinThresholdYellow>
:
<Qos::MaxThresholdYellow> : <Qos::DiscardProbYellow>
: <Qos::MinThresholdRed> : <Qos::MaxThresholdRed> :
<Qos::DiscardProbRed>
:
<Qos::MinQueueSize>
:
<Qos::MaxQueueSize> )
Possible values:
- tail-drop : tail drop algorithm
- red : random early detection algorithm
- twocolour-taildrop : colour-aware tail drop algorithm
- twocolourred : colour-aware random early detection
algorithm
- gpon-tail-drop : gpon tail drop algorithm
- threecolour-taildrop : three colour aware tail drop
algorithm
- threecolour-red : three colour aware random early
detection algorithm
- gpon-threecolour-red : three colour aware random early
detection algorithm with min and max queue sizes
Field type <Qos::MinThreshold>
- min threshold for green frames: if unit is
packet,range:[1..511]; if unit is byte,range is [1..786432] for
non gpon bactypes, for gpon bactypes,
- range: [1...1048576]
Field type <Qos::MaxThreshold>
- max threshold for green frames: if unit is
packet,range:[2..512]; if unit is byte,range is [2..786432] for
non gpon bactypes, for gpon bactypes,
- range: [2...1048576]
Field type <Qos::DiscardProbability>
- maximum discard probability of green frames
- unit: %
- range: [0...100]
Field type <Qos::MinThresholdYellow>
- min threshold for yellow frames: if unit is
packet,range:[1..511]; if unit is byte,range is [1..786432] for
non gpon bactypes, for gpon bactypes,
- range: [1...1048576]
Field type <Qos::MaxThresholdYellow>
- max threshold for yellow frames: if unit is
packet,range:[2..512]; if unit is byte,range is [2..786432] for
non gpon bactypes, for gpon bactypes,
- range: [2...1048576]
Field type <Qos::DiscardProbYellow>
- maximum discard probability of yellow frames
- unit: %
- range: [0...100]
Field type <Qos::MinThresholdRed>
- min threshold for red frames: if unit is
packet,range:[1..511]; if unit is byte,range is [1..786432] for
non gpon bactypes, for gpon bactypes,
- range: [1...1048576]
Field type <Qos::MaxThresholdRed>
- max threshold for red frames: if unit is

506

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] unit

3HH-04416-EBAA-TCZZA 01

Type

Description

packet,range:[2..512]; if unit is byte,range is [2..786432] for


non gpon bactypes, for gpon bactypes,
- range: [2...1048576]
Field type <Qos::DiscardProbRed>
- maximum discard probability of red frames
- unit: %
- range: [0...100]
Field type <Qos::MinQueueSize>
- minimum gauranteed queue size : if unit is
packet,range:[1..511]; if unit is byte,range is [1..786432] for
non gpon bactypes, for gpon bactypes,
- range: [1...1048576]
Field type <Qos::MaxQueueSize>
- maximum queue size: if unit is packet,range:[2..512]; if
unit is byte,range is [2..786432] for non gpon bactypes, for
gpon bactypes,
- range: [2...1048576]
Parameter type: <Qos::Units>
optional parameter with default
Format:
value: "packet"
( packet
identify the threshold unit type
| byte )
Possible values:
- packet : the unit of discard threshold is packet
- byte : the unit of discard threshold is byte

Released

507

19 QoS Configuration Commands

19.8 QoS Scheduler Node Profile Configuration


Command
Command Description
This command allows the operator to configure a QoS scheduler node profile. The scheduler node profiles contain
configuration settings for the data plane schedulers. These scheduler node profiles are applicable to downstream
schedulers on the L3 line cards. The scheduler node settings on the service hub can be modified separately.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no scheduler-node (name) ) | ( scheduler-node (name) priority <Qos::QosPriority> weight
<Qos::QosWeight> shaper-profile <Qos::QosShaperProfileName> [ no ext-shaper | ext-shaper
<Qos::QosShaperProfileName> ] [ no mcast-inc-shape | mcast-inc-shape <Qos::QosMulticastInclShaping> ] )

Command Parameters
Table 19.8-1 "QoS Scheduler Node Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.8-2 "QoS Scheduler Node Profile Configuration Command" Command Parameters
Parameter

Type

Description

priority

Parameter type: <Qos::QosPriority>


Format:
- relative priority
- range: [1...8]
Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]
Parameter type: <Qos::QosShaperProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated

mandatory parameter
relative
priority
of
scheduler-node

the

mandatory parameter
relative
weight
of
scheduler-node

the

weight

shaper-profile

508

Released

mandatory parameter
the associated shaper profile. For
EPON OLT in downstream, this
profile used for LLID shaper on
1G PON bandwidth.

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] ext-shaper

[no] mcast-inc-shape

3HH-04416-EBAA-TCZZA 01

Type

Description

Data driven field type


Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosShaperProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosMulticastInclShaping>
Format:
( mcast-shap-on
| no-mcast-shap )
Possible values:
- mcast-shap-on : Downstream shaping includes Mcast
- no-mcast-shap : Downstream shaping doesnot include
Mcast

optional parameter with default


value: "none"
the associated shaper profile. For
EPON OLT in downstream, this
profile used for LLID shaper on
10G PON bandwidth.

optional parameter with default


value: "false"
indicates whether downstream
shaping includes Mcast

Released

509

19 QoS Configuration Commands

19.9 QoS CAC Profile Configuration Command


Command Description
This command allows the operator to configure a connection admission control (CAC) profile. CAC profiles are
used primarily for multicast video admission control. CAC profiles can be attached to subscriber interfaces. The
scope of a CAC profile is a DSL link (and not a PVC), regardless of the number of PVCs on a DSL link.
The system derives the line rate from the physical interfaces and calculates an estimate of the available Ethernet
bandwidth using configurable overhead factors. The line rate taken into account may be the guaranteed sync rate
or the actual line rate in case of DSL, based on a global configuration setting.
From this bandwidth, a part can be reserved for voice and data applications and the remaining part will be kept by
the system as the available bandwidth for multicast video. Only preconfigured multicast streams are considered for
CAC. Note that unicast video (regardless of whether it is premium content or generic Internet streaming video) is
ignored by the CAC function.
The maximum bandwidth that video will occupy can be further confined using the maximum multicast bandwidth
'max-mcast-bandwidth' parameter.
CAC profiles are applicable to line cards, but not to SHub/IHub interfaces.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no cac (name) ) | ( cac (name) res-voice-bandwidth <Qos::BandWidthKBPS>
max-mcast-bandwidth <Qos::BandWidthKBPS> res-data-bandwidth <Qos::BandWidthKBPS> [ no cac-type |
cac-type <Qos::QosCacType> ] )

Command Parameters
Table 19.9-1 "QoS CAC Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.9-2 "QoS CAC Profile Configuration Command" Command Parameters


Parameter

Type

Description

res-voice-bandwidth

Parameter type: <Qos::BandWidthKBPS>


Format:
- interface bandwidth
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::BandWidthKBPS>

mandatory parameter
reserved bandwidth for the voice
services

max-mcast-bandwidth

510

Released

mandatory parameter

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

res-data-bandwidth

[no] cac-type

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
- interface bandwidth
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::BandWidthKBPS>
Format:
- interface bandwidth
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::QosCacType>
Format:
( dsl-cac
| pon-cac )
Possible values:
- dsl-cac : cac profile for dsl links
- pon-cac : cac profile for pon interfaces

maximum allowed bandwidth for


multicast and unicast video
service
mandatory parameter
reserved bandwidth for all data
services
optional parameter with default
value: "dsl-cac"
cac-profile type

Released

511

19 QoS Configuration Commands

19.10 QoS Single Dot1P Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for singleDot1P.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p (name) ) | ( d1p (name) default-dot1p <Qos::ExtVlanSysPrio> )

Command Parameters
Table 19.10-1 "QoS Single Dot1P Marker Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.10-2 "QoS Single Dot1P Marker Configuration Command" Command Parameters
Parameter

Type

Description

default-dot1p

Parameter type: <Qos::ExtVlanSysPrio>


Format:
- the dot-1p bit value
- range: [0...7]

mandatory parameter
the default dot-1p bit value to be
applied on all frames

512

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.11 QoS Single DSCP Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for a single DSCP.
All IP packets will be marked with the specified DSCP value. This marker type is incompatible with DSCP to P-bits
alignment.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no dscp (name)
<Qos::DscpToDot1PAlignmentDscpIndex> [ [ no ] alignment ] )

dscp

(name)

default-dscp

Command Parameters
Table 19.11-1 "QoS Single DSCP Marker Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.11-2 "QoS Single DSCP Marker Configuration Command" Command Parameters
Parameter

Type

Description

default-dscp

Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex>


Format:
- the DSCP value
- range: [0...63]
Parameter type: boolean

mandatory parameter
the default DSCP value to be
applied on all frames

[no] alignment

3HH-04416-EBAA-TCZZA 01

optional parameter
enable DSCP to P-bits alignment

Released

513

19 QoS Configuration Commands

19.12 QoS DSCP Contract Table Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for a DSCP contract table. To configure the DSCP
codepoints in the contract table, the command "configure qos profiles marker dscp-contract (name) codepoint
(codepoint)" is to be used.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no dscp-contract (name) ) | ( dscp-contract (name) [ [ no ] alignment ] )

Command Parameters
Table 19.12-1 "QoS DSCP Contract Table Marker Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.12-2 "QoS DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter

Type

Description

[no] alignment

Parameter type: boolean

optional parameter
enable DSCP to P-bits alignment

514

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.13 QoS DSCP Contract Table Code-point


Configuration Command For DSCP-contract
Command Description
This command allows the operator to configure codepoints in the DSCP contract table. To configure a marker, use
the command "configure qos profiles marker dscp-contract (name)".

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker dscp-contract (name) codepoint (codepoint) [ no dscp-value | dscp-value
<Qos::DscpToDot1PAlignmentDscpIndex> ]

Command Parameters
Table 19.13-1 "QoS DSCP Contract Table Code-point Configuration Command For
DSCP-contract" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- the number of the DSCP codepoint
- range: [0...63]

A unique profile name

(codepoint)

the value of the codepoint

Table 19.13-2 "QoS DSCP Contract Table Code-point Configuration Command For
DSCP-contract" Command Parameters
Parameter

Type

Description

[no] dscp-value

Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex>


Format:
- the DSCP value
- range: [0...63]

optional parameter with default


value: 0L
the dscp value to be assigned to
the codepoint

3HH-04416-EBAA-TCZZA 01

Released

515

19 QoS Configuration Commands

19.14 QoS Dot1P and DSCP Contract Table Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for Dot1P and a DSCP contract table. To configure the
DSCP codepoints in the contract table, the command "configure qos profiles marker d1p-dscp-contract (name)
codepoint (codepoint)" is to be used.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-dscp-contract (name) ) | ( d1p-dscp-contract (name) dot1p-value
<Qos::ExtVlanSysPrio> [ [ no ] alignment ] )

Command Parameters
Table 19.14-1 "QoS Dot1P and DSCP Contract Table Marker Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.14-2 "QoS Dot1P and DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter

Type

Description

dot1p-value

Parameter type: <Qos::ExtVlanSysPrio>


Format:
- the dot-1p bit value
- range: [0...7]
Parameter type: boolean

mandatory parameter
the default dot-1p bit value to be
applied on all frames

[no] alignment

516

Released

obsolete parameter that will be


ignored
enable DSCP to P-bits alignment

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.15 DSCP Contract Table Codepoint


Configuration Command For D1p-dscp-contract
Command Description
This command allows the operator to configure codepoints for a DSCP contract table. To configure a Dot1P and
DSCP contract table , use the command "configure qos profiles marker d1p-dscp-contract (name)".

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker d1p-dscp-contract (name) codepoint (codepoint) [ no dscp-value | dscp-value
<Qos::DscpToDot1PAlignmentDscpIndex> ]

Command Parameters
Table 19.15-1 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- the number of the DSCP codepoint
- range: [0...63]

A unique profile name

(codepoint)

the number of the codepoint

Table 19.15-2 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Command Parameters
Parameter

Type

Description

[no] dscp-value

Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex>


Format:
- the DSCP value
- range: [0...63]

optional parameter with default


value: 0L
the dscp value to be assigned to
the codepoint

3HH-04416-EBAA-TCZZA 01

Released

517

19 QoS Configuration Commands

19.16 QoS Dot1P and Single DSCP Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for Dot1P and single DSCP.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-dscp (name) ) | ( d1p-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> default-dot1p <Qos::ExtVlanSysPrio> )

(name)

default-dscp

Command Parameters
Table 19.16-1 "QoS Dot1P and Single DSCP Marker Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.16-2 "QoS Dot1P and Single DSCP Marker Configuration Command" Command
Parameters
Parameter

Type

Description

default-dscp

Parameter type: <Qos::DscpToDot1PAlignmentDscpIndex>


Format:
- the DSCP value
- range: [0...63]
Parameter type: <Qos::ExtVlanSysPrio>
Format:
- the dot-1p bit value
- range: [0...7]

mandatory parameter
the default DSCP value to be
applied on all frames

default-dot1p

518

Released

mandatory parameter
the default dot-1p bit value to be
applied on all frames

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.17 QoS Dot1P Alignment Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for Dot1P alignment.
Default value for the global DSCP To Dot1P Alignment Table
DSCP Value

P-bit Value

0-7

8-15

16-23

24-31

32-39

40-47

48-55

56-63

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no d1p-alignment (name) ) | ( d1p-alignment (name) (alignment) [ no
dscp-pbit-prof | dscp-pbit-prof <Qos::QosDscpToPbitProfileName> ] )

Command Parameters
Table 19.17-1 "QoS Dot1P Alignment Marker Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.17-2 "QoS Dot1P Alignment Marker Configuration Command" Command Parameters
Parameter

Type

Description

(alignment)

Format:

mandatory parameter

3HH-04416-EBAA-TCZZA 01

Released

519

19 QoS Configuration Commands

Parameter

[no] dscp-pbit-prof

520

Released

Type

Description

enable
Possible values:
- enable : enable dot1p alignment
Parameter type: <Qos::QosDscpToPbitProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

enable dot1p alignment


optional parameter with default
value: "none"
Dscp to Pbit mapping profile
name applicable on this marker

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.18 QoS Dot1P Remark Table Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for a Dot1P Remark table. To configure the Dot1P
Remark value in remark table, the command "configure qos profiles marker dot1p-remark (name) dot1p-value
(val) remark-value (val)" is to be used.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker ( no dot1p-remark (name) ) | ( dot1p-remark (name) )

Command Parameters
Table 19.18-1 "QoS Dot1P Remark Table Marker Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

3HH-04416-EBAA-TCZZA 01

Released

521

19 QoS Configuration Commands

19.19 QoS Dot1P Remark Table Dot1p-value


Configuration Command For Dot1P-Remark
Command Description
This command allows the operator to configure remark dot1p value in the Dot1P Remark table. To configure the
remark value in the Dot1P Remark table, use the command "configure qos profiles marker dot1p-remark (name)
dot1p-value (val) remark-value (val)".

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker dot1p-remark (name) dot1p-value (dot1p-value) [ no remark-value | remark-value
<Qos::ExtVlanSysPrioNc> ]

Command Parameters
Table 19.19-1 "QoS Dot1P Remark Table Dot1p-value Configuration Command For
Dot1P-Remark" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- the dot-1p bit value
- range: [0...7]

A unique profile name

(dot1p-value)

the dot1p value

Table 19.19-2 "QoS Dot1P Remark Table Dot1p-value Configuration Command For
Dot1P-Remark" Command Parameters
Parameter

Type

Description

[no] remark-value

Parameter type: <Qos::ExtVlanSysPrioNc>


Format:
- the remarked dot-1p bit value (8 means no change)
- range: [0...8]

optional parameter with default


value: 8L
the remarked dot1p value

522

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.20 QoS Policer Profile Configuration Command


Command Description
This command allows the operator to configure a QoS policer profile. A QoS policer profile contains all settings
related to a policer. The ISAM supports single token bucket policers, where the action upon conformance is either
pass or discard.
The L3 line cards units support both upstream and downstream policing. A policer profile can be used within a
QoS session profile for upstream and downstream policing.
The L2 line cards units do not support policing.
The SHub/IHub supports ingress policing, but it does not use policer profiles. See the section about the QoS
Ingress Policing Configuration Command to set up ingress policing on the SHub/IHub.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no policer (name) ) | ( policer (name) committed-info-rate <Qos::CommittedInfoRate>
committed-burst-size <Qos::CommittedBurstSize> [ no policer-type | policer-type <Qos::PolicerType> ] [ no
excess-info-rate | excess-info-rate <Qos::ExcessInfoRate > ] [ no excess-burst-size | excess-burst-size
<Qos::ExcessBurstSize> ] [ no coupling-flag | coupling-flag <Qos::CouplingFlag> ] [ no color-mode | color-mode
<Qos::ColorMode> ] [ no green-action | green-action <Qos::GreenAction> ] [ no yellow-action | yellow-action
<Qos::YellowAction> ] [ no red-action | red-action <Qos::RedAction> ] [ no policed-size-ctrl | policed-size-ctrl
<Qos::PoliceFrameCtrl> ] )

Command Parameters
Table 19.20-1 "QoS Policer Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.20-2 "QoS Policer Profile Configuration Command" Command Parameters


Parameter

Type

Description

committed-info-rate

Parameter type: <Qos::CommittedInfoRate>


Format:
- information rate
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::CommittedBurstSize>
Format:

mandatory parameter
committed information rate of a
policer

committed-burst-size

3HH-04416-EBAA-TCZZA 01

mandatory parameter
committed burst size of a policer

Released

523

19 QoS Configuration Commands

Parameter

Type

[no] policer-type

[no] excess-info-rate

[no] excess-burst-size

[no] coupling-flag

[no] color-mode

[no] green-action

[no] yellow-action

524

Released

Description

- committed burst size of a policer


- unit: bytes
- range: [0...134217728]
Parameter type: <Qos::PolicerType>
Format:
( single-token-bucket
| trtcm )
Possible values:
- single-token-bucket : single token bucket
- trtcm : trtcm Policer
Parameter type: <Qos::ExcessInfoRate >
Format:
- information rate
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::ExcessBurstSize>
Format:
- excess burst size of a policer
- unit: bytes
- range: [0...134217728]
Parameter type: <Qos::CouplingFlag>
Format:
( enable
| disable )
Possible values:
- enable : enable
- disable : disable
Parameter type: <Qos::ColorMode>
Format:
( color-blind
| color-aware )
Possible values:
- color-blind : color blind mode
- color-aware : color aware mode
Parameter type: <Qos::GreenAction>
Format:
( pass
| remark : <Aaa::IgnoredQosProfileName> )
Possible values:
- pass : pass
- remark : remark
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::YellowAction>
Format:
( pass
| discard
| remark : <Aaa::IgnoredQosProfileName> )
Possible values:
- pass : pass
- discard : discard
- remark : remark
Data driven field type
Possible values are depending on the actual configuration
and software.

optional parameter with default


value: "single-token-bucket"
The parameter is not visible
during modification.
the policer type
optional parameter with default
value: 0
excess information rate of a
policer for trtcm
optional parameter with default
value: 64
excess burst size of a policer for
trtcm
optional parameter with default
value: "disable"
the coupling flag of a policer for
trtcm

optional parameter with default


value: "color-blind"
the color mode of a policer for
trtcm

optional parameter with default


value: "pass"
action for green packet of a
policer for trtcm

optional parameter with default


value: "pass"
action for yellow packet of a
policer for trtcm

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter
[no] red-action

[no] policed-size-ctrl

3HH-04416-EBAA-TCZZA 01

Type

Description

The currently allowed values can be shown with online-help.


Parameter type: <Qos::RedAction>
Format:
( pass
| discard
| remark : <Aaa::IgnoredQosProfileName> )
Possible values:
- pass : pass
- discard : discard
- remark : remark
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::PoliceFrameCtrl>
Format:
( auto-controlled
| ingress-mode
| egress-mode
| rmv4b-ingress )
Possible values:
- auto-controlled : backward compatibility for all LTs
- ingress-mode : policer working with ingress packet size
- egress-mode : policer working with egress packet size
- rmv4b-ingress : policer working on packet size with 4
bytes removed from ingress

optional parameter with default


value: "discard"
action for red packet of a policer
for trtcm

optional parameter with default


value: "auto-controlled"
control for policed frame size

Released

525

19 QoS Configuration Commands

19.21 QoS L2 Filter Profile Configuration Command


Command Description
This command allows the operator to configure an L2 filter. The created L2 filter can be reused to build policy
actions based on L2 filtering criteria, inside QoS session profiles.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no l2-filter (name) ) | ( l2-filter (name) [ no dst-mac-addr | dst-mac-addr
<Qos::MacAddrAndMask> ] [ no src-mac-addr | src-mac-addr <Qos::MacAddrAndMask> ] [ no ethertype |
ethertype <Qos::FilterEthernetType> ] [ no dot1p-priority | dot1p-priority <Qos::MatchDot1pValue> ] [ no
canonical-format | canonical-format <Qos::FilterCfi> ] [ no vlan-id | vlan-id <Qos::FilterVlanId> ] )

Command Parameters
Table 19.21-1 "QoS L2 Filter Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.21-2 "QoS L2 Filter Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] dst-mac-addr

Parameter type: <Qos::MacAddrAndMask>


Format:
<Qos::MacAddress> / <Qos::MacPrefixLength>
Field type <Qos::MacAddress>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Qos::MacPrefixLength>
- the mac address prefix length
- range: [0...48]
Parameter type: <Qos::MacAddrAndMask>
Format:
<Qos::MacAddress> / <Qos::MacPrefixLength>
Field type <Qos::MacAddress>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Qos::MacPrefixLength>
- the mac address prefix length
- range: [0...48]

optional parameter with default


value: "00 : 00 : 00 : 00 : 00 :
00/0"
destination mac address to be
matched with the packet

[no] src-mac-addr

526

Released

optional parameter with default


value: "00 : 00 : 00 : 00 : 00 :
00/0"
source mac address to be
matched with the packet

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

Type

Description

[no] ethertype

Parameter type: <Qos::FilterEthernetType>


Format:
( ip
| x75
| nbs
| ecma
| chaos
| x25
| arp
| rarp
| appletalk
| snmp
| loopback
| pppoe-discovery
| pppoe
| ipv6
| all
| <Qos::EtherType> )
Possible values:
- ip : ip
- x75 : x75
- nbs : nbs
- ecma : ecma
- chaos : chaos
- x25 : x25
- arp : arp
- rarp : rarp
- appletalk : appletalk
- snmp : snmp
- loopback : loopback
- pppoe-discovery : pppoe-discovery
- pppoe : pppoe
- ipv6 : ipv6
- all : all ethtype values are considered a match
Field type <Qos::EtherType>
- ethertype value
- range: [-1...65535]
Parameter type: <Qos::MatchDot1pValue>
Format:
- dot1p value to be matched, -1 means match all
- range: [-1...7]
Parameter type: <Qos::FilterCfi>
Format:
- canonical format indicator, -1 means match all
- range: [-1...1]
Parameter type: <Qos::FilterVlanId>
Format:
- vlan id to be matched, -1 means match all
- range: [-1...4095]

optional parameter with default


value: "all"
ethernet type to be matched with
the packet

[no] dot1p-priority

[no] canonical-format

[no] vlan-id

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: -1L
dot1p value to be matched, -1
means match all
optional parameter with default
value: -1L
canonical format indicator, -1
means match all
optional parameter with default
value: -1L
vlan id to be matched, -1 means
match all

Released

527

19 QoS Configuration Commands

19.22 QoS L3 Filter Profile Configuration Command


Command Description
This command allows the operator to configure an L3 filter. The created L3 filter can be reused to build policy
actions based on L3 filtering criteria, inside QoS session profiles.
DSCP mask is supported with defined L3-filter name with a prefix "DSCPMASKx_", 'x' must be 1~6, which means
treat dscp-value as a last 'x' bits masking -The first 8 characters are UPPER CASE ALPHABETIC = DSCPMASK;
and -The 9 character is NUMERICAL = {1, 2, 3, 4, 5, 6}; and -The 10 character is UNDERSCORE; -the remaining
is configurable.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no l3-filter (name) ) | ( l3-filter (name) [ no filter-type | filter-type <Qos::L3FilterType> ]
[ no dst-ip-addr | dst-ip-addr <Ip::AddressAndMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::AddressAndMaskFull> ] [ no dst-ipv6-addr | dst-ipv6-addr <ipv6::PrefixAndLength> ] [ no src-ipv6-addr |
src-ipv6-addr <ipv6::PrefixAndLength> ] [ no min-dst-port | min-dst-port <Qos::L4PortNumber> ] [ no
max-dst-port | max-dst-port <Qos::L4PortNumber> ] [ no min-src-port | min-src-port <Qos::L4PortNumber> ] [ no
max-src-port | max-src-port <Qos::L4PortNumber> ] [ no dscp-value | dscp-value <Qos::MatchDscpValue> ] [ no
protocol | protocol <Qos::Protocol> ] )

Command Parameters
Table 19.22-1 "QoS L3 Filter Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.22-2 "QoS L3 Filter Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] filter-type

Parameter type: <Qos::L3FilterType>


Format:
( ipv4
| ipv6 )
Possible values:
- ipv4 : ipv4
- ipv6 : ipv6
Parameter type: <Ip::AddressAndMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>

optional parameter with default


value: "ipv4"
The parameter is not visible
during modification.
L3 Filter type. Indicates to what
kind of ip frames (ipv4 or ipv6)
the L3 filter is applicable.
optional parameter with default
value: "0.0.0.0/0"
destination ipv4 address to be

[no] dst-ip-addr

528

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] src-ip-addr

[no] dst-ipv6-addr

[no] src-ipv6-addr

[no] min-dst-port

[no] max-dst-port

[no] min-src-port

[no] max-src-port

[no] dscp-value

[no] protocol

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Ip::V4Address>


- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::AddressAndMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <ipv6::PrefixAndLength>
Format:
<ipv6::Prefix> / <ipv6::PrefixLength>
Field type <ipv6::Prefix>
- IPv6-address
Field type <ipv6::PrefixLength>
- length of IPv6 address or prefix
- range: [0...128]
Parameter type: <ipv6::PrefixAndLength>
Format:
<ipv6::Prefix> / <ipv6::PrefixLength>
Field type <ipv6::Prefix>
- IPv6-address
Field type <ipv6::PrefixLength>
- length of IPv6 address or prefix
- range: [0...128]
Parameter type: <Qos::L4PortNumber>
Format:
- the layer-4 port number
- range: [0...65535]
Parameter type: <Qos::L4PortNumber>
Format:
- the layer-4 port number
- range: [0...65535]
Parameter type: <Qos::L4PortNumber>
Format:
- the layer-4 port number
- range: [0...65535]
Parameter type: <Qos::L4PortNumber>
Format:
- the layer-4 port number
- range: [0...65535]
Parameter type: <Qos::MatchDscpValue>
Format:
- dscp value to be matched, -1 means match all
- range: [-1...63]
Parameter type: <Qos::Protocol>
Format:
( egp
| eigrp
| gre
| icmp
| icmpv6
| igmp

matched with the packet. Only


applicable in case filterType is
equal to ipv4.
optional parameter with default
value: "0.0.0.0/0"
source ipv4 address to be
matched with the packet. Only
applicable in case filterType is
equal to ipv4.
optional parameter with default
value: " : : /0"
destination ipv6 address to be
matched with the packet. Only
applicable in case filterType is
equal to ipv6.
optional parameter with default
value: " : : /0"
source ipv6 address to be
matched with the packet. Only
applicable in case filterType is
equal to ipv6.
optional parameter with default
value: 0L
minimum value of the layer-4
destination port number
optional parameter with default
value: 65535L
maximum value of the layer-4
destination port number
optional parameter with default
value: 0L
minimum value of the layer-4
source port number
optional parameter with default
value: 65535L
maximum value of the layer-4
source port number
optional parameter with default
value: -1L
dscp value to be matched, -1
means match all
optional parameter with default
value: "all"
protocol to be matched with the
packet

Released

529

19 QoS Configuration Commands

Parameter

Type

Description

| igrp
| ip
| ipinip
| ipv6
| ipv6-frag
| ipv6-hopopt
| ipv6-nonxt
| ipv6-opts
| ipv6-route
| ospf-igp
| tcp
| udp
| rsvp
| all
| <Qos::ProtocolType> )
Possible values:
- egp : egp (IANA protocol number 8)
- eigrp : eigrp (IANA protocol number 88)
- gre : gre (IANA protocol number 47)
- icmp : icmp (IANA protocol number 1)
- icmpv6 : icmpv6 (IANA protocol number 58)
- igmp : igmp (IANA protocol number 2)
- igrp : igrp (IANA protocol number 9)
- ip : ip (IANA protocol number 4)
- ipinip : ipinip(protocol id should be 94)
- ipv6 : ipv6 (IANA protocol number 41)
- ipv6-frag : ipv6-frag (IANA protocol number 44)
- ipv6-hopopt : ipv6-HOPOPT (IANA protocol number 0)
- ipv6-nonxt : ipv6-NoNxt (IANA protocol number 59)
- ipv6-opts : ipv6-opts (IANA protocol number 60)
- ipv6-route : ipv6-route (IANA protocol number 43)
- ospf-igp : ospf-igp (IANA protocol number 89)
- tcp : tcp (IANA protocol number 6)
- udp : udp (IANA protocol number 17)
- rsvp : rsvp (IANA protocol number 46)
- all : all are considered as match
Field type <Qos::ProtocolType>
- ip protocol value
- range: [0...255]

530

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.23 QoS Policy Action Profile Configuration


Command
Command Description
This command allows the operator to configure a QoS policy action profile. A QoS policy action contains: discard
packet, set a DSCP value, set a Dot1P value, policing with a policer, policer sharing attribute.
Dot1P and DSCP values are set to frames matched by the filter associated with this policy action.
The forwarding action for the frames matched by the filter can be discard or pass. The default forwarding action is
pass. When the forwarding action is discard, the other policy actions in this entry will not be checked; the frame
will be discarded immediately.
Policy sharing causes multiple QoS subflow with the same policy action profile to share their policer instance, in
case they are set up within the same session profile in the same direction.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no policy-action (name) ) | ( policy-action (name) [ no dscp-value | dscp-value
<Qos::SetDscpValue> ] [ no dot1p-value | dot1p-value <Qos::SetDot1pValue> ] [ [ no ] discard-packet ] [ [ no ]
shared-policer ] [ no policer-profile | policer-profile <Qos::QosPolicerProfileName> ] )

Command Parameters
Table 19.23-1 "QoS Policy Action Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.23-2 "QoS Policy Action Profile Configuration Command" Command Parameters
Parameter

Type

Description

[no] dscp-value

Parameter type: <Qos::SetDscpValue>


Format:
- dscp value set in a matched packet, -1 means no change
- range: [-1...63]
Parameter type: <Qos::SetDot1pValue>
Format:
- dot1p value set in a matched packet, -1 means no change
- range: [-1...7]

optional parameter with default


value: -1L
dscp value set in a matched
packet, -1 means no change
optional parameter with default
value: -1L
dot1p value set in a matched
packet, -1 means no change

[no] dot1p-value

3HH-04416-EBAA-TCZZA 01

Released

531

19 QoS Configuration Commands

Parameter

Type

Description

[no] discard-packet

Parameter type: boolean

[no] shared-policer

Parameter type: boolean

[no] policer-profile

Parameter type: <Qos::QosPolicerProfileName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

optional parameter
discard the packet matching the
policy
optional parameter
enable the sharing policer
instances among subflows
optional parameter with default
value: "none"
policer used to the packet
matching the policy

532

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.24 QoS Policy Profile Configuration Command


Command Description
This command allows the operator to configure a QoS policy profile. A policy rule groups together a policy
condition (filter) with a set of associated actions. A policy rule contains:
Filter type (L2 filter or L3 filter)
L2 or L3 filter
Precedence of this policy rule
Policy action

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no policy (name) ) | ( policy (name) filter <Qos::PolicyFilter> [ no precedence |
precedence <Qos::PolicyPrecedence> ] [ no policy-action | policy-action <Qos::QosPolicyActionProfileName> ] )

Command Parameters
Table 19.24-1 "QoS Policy Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.24-2 "QoS Policy Profile Configuration Command" Command Parameters


Parameter

Type

filter

Parameter type: <Qos::PolicyFilter>


mandatory parameter
Format:
the filter for the policy rule
( l2-name : <Qos::IgnoredQosProfileName>
| l3-name : <Qos::IgnoredQosProfileName> )
Possible values:
- l2-name : refer to a l2 filter
- l3-name : refer to a l3 filter
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

3HH-04416-EBAA-TCZZA 01

Description

Released

533

19 QoS Configuration Commands

Parameter

Type

Description

[no] precedence

Parameter type: <Qos::PolicyPrecedence>


Format:
- the precedence value of the policy rule
- range: [0...255]
Parameter type: <Qos::QosPolicyActionProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

optional parameter with default


value: 10L
precedence value of the policy
rule
optional parameter with default
value: "none"
policy action profile applicable
for the policy

[no] policy-action

534

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.25 QoS Session Profile Configuration Command


Command Description
This commmand allows the operator to configure the QoS session profile. The QoS session profile is the main
building block for conveying user traffic contractual rights and treatment. The QoS session profile is a
"macro"-profile, which consists of individual settings as well as references to smaller profiles.
A QoS session profile is composed of
a logical flow type,
a marker profile,
two policer profiles for up and downstream policing,
two lists for upstream and downstream policy conditions and actions.
The logical flow type is a legacy parameter which is ignored. Any value is interpreted as "Generic", that is, the
QoS session profile can be attached to any interface. If the QoS session profile contains settings that are not
supported on the interface, then these are silently ignored by the system.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no session (name) ) | ( session (name) logical-flow-type <Qos::LogicalFlowType> [ no
up-policer | up-policer <Qos::QosPolicerProfileName> ] [ no down-policer | down-policer
<Qos::QosPolicerProfileName> ] [ no up-marker | up-marker <Qos::QosMarkerProfileName> ] )

Command Parameters
Table 19.25-1 "QoS Session Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.25-2 "QoS Session Profile Configuration Command" Command Parameters


Parameter

Type

Description

logical-flow-type

Parameter type: <Qos::LogicalFlowType>


Format:
( generic
| pvc
| dot-1x-session
| pvc-vlan-combination
| ppp-session
| ip-session

mandatory parameter
a traffic stream up on which
policy to be made. Important
note: this mandatory parameter is
depreciated. No distinction is
made any more between the
different flow types : independent
on what is configured, generic is

3HH-04416-EBAA-TCZZA 01

Released

535

19 QoS Configuration Commands

Parameter

[no] up-policer

[no] down-policer

[no] up-marker

536

Released

Type

Description

| ipoe-vlan-cc
| pppoe-vlan-cc
| ipoa-cc
| pppoa-cc
| ipoe-ibridge
| pppoe-ibridge
| pppoa-relay
| pppoe-relay
| ipoe-ip-aware-bridge
| ipoa-ip-aware-bridge
| ipoa )
Possible values:
- generic : any defined logical flow
- pvc : all frames on a pvc
- dot-1x-session : frames on a pvc except ppp frames
- pvc-vlan-combination : frames on dot-1D port with the
same vlan-id
- ppp-session : all frames on a ppp session
- ip-session : all frames in an IP session or interface
- ipoe-vlan-cc : all ipoe frames in a vlan cc interface
- pppoe-vlan-cc : all pppoe frames in a vlan cc interface
- ipoa-cc : all ipoa frames in a ipoa cc interface(replaced by
ipoa)
- pppoa-cc : all pppoa frames in a pppoa cc interface
- ipoe-ibridge : all ipoe frames in i-bridge interface
- pppoe-ibridge : all pppoe frames in i-bridge interface
- pppoa-relay : pppoa frames in pppoa relay interface
- pppoe-relay : all pppoe frames in pppoe relay
- ipoe-ip-aware-bridge : ipoe frames in ip aware bridge
interface
- ipoa-ip-aware-bridge : all ipoa frames in ip aware bridge
interface(replaced by ipoa)
- ipoa : all ipoa frames in a ipoa interface
Parameter type: <Qos::QosPolicerProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosPolicerProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosMarkerProfileName>
Format:

used.

optional parameter with default


value: "none"
policer profile name applicable
on this session upstream

optional parameter with default


value: "none"
policer profile applicable on this
session downstream

optional parameter with default


value: "none"

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

Type

Description

( none
marker profile name applicable
| name : <Qos::IgnoredQosProfileName> )
on this session upstream
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

3HH-04416-EBAA-TCZZA 01

Released

537

19 QoS Configuration Commands

19.26 QoS Session Upstream Policy List


Configuration Command
Command Description
This command allows the operator to configure a list of upstream policies in a QoS session profile. However the
number of these policy rules are hardware dependent.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles session (name) ( no up-policy (name) ) | ( up-policy (name) )

Command Parameters
Table 19.26-1 "QoS Session Upstream Policy List Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

(name)

538

Released

policy profile name applicable

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.27 QoS Session Downstream Policy List


Configuration Command
Command Description
This command allows the operator to configure a list of downstream policies in a QoS session profile.However the
number of these policy rules are hardware dependent.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles session (name) ( no down-policy (name) ) | ( down-policy (name) )

Command Parameters
Table 19.27-1 "QoS Session Downstream Policy List Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

(name)

3HH-04416-EBAA-TCZZA 01

policy profile name applicable

Released

539

19 QoS Configuration Commands

19.28 QoS Shaper Profile Configuration Command


Command Description
This command allows the operator to configure a QoS shaper profile. A QoS shaper profile contains all settings
related to a shaper. The ISAM supports single token bucket shapers. EIR is only applicable if shaper type is
singleTokenBucketGpon. CBS is applicable only if the shaper type is singleTokenBucket.
The L2+ line cards support shaping on queue.
1. GPON supports EIR and CIR. If CBS is non-zero for GPON; CLI will return an error.
2. DSL doesn't support EIR. So if user enters non-zero for EIR for DSL; CLI will return an error.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no shaper (name) ) | ( shaper (name) committed-info-rate
<Qos::ShaperCommittedInfoRate>
committed-burst-size
<Qos::ShaperCommittedBurstSizeNew>
[
no
excess-info-rate | excess-info-rate <Qos::ShaperExcessiveInfoRate> ] [ no type | type <Qos::ShaperType> ] [ no
autoshape | autoshape <Qos::AutoShape> ] )

Command Parameters
Table 19.28-1 "QoS Shaper Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.28-2 "QoS Shaper Profile Configuration Command" Command Parameters


Parameter

Type

Description

committed-info-rate

Parameter type: <Qos::ShaperCommittedInfoRate>


Format:
- committed information rate of a shaper
- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::ShaperCommittedBurstSizeNew>
Format:
- committed burst size of shaper
- unit: byte
- range: [0,64...2147483647]
Parameter type: <Qos::ShaperExcessiveInfoRate>
Format:

mandatory parameter
committed information rate of a
shaper

committed-burst-size

[no] excess-info-rate

540

Released

mandatory parameter
committed burst size of shaper

optional parameter with default


value: 0

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] type

[no] autoshape

3HH-04416-EBAA-TCZZA 01

Type

Description

- excessive information rate of a shaper


- unit: kbps
- range: [0...2147483647]
Parameter type: <Qos::ShaperType>
Format:
( singletokenbucket
| singletokenbucketgpon
| onetokentworate )
Possible values:
- singletokenbucket : single Token Bucket
- singletokenbucketgpon : single Token Bucket for GPON
- onetokentworate : single Token Two Rate Bucket
Parameter type: <Qos::AutoShape>
Format:
( autoshape-on
| no-autoshape-on )
Possible values:
- autoshape-on : enable shaping based on queue parameters
- no-autoshape-on : disable shaping based on queue
parameters

excessive information rate of


shaper
optional parameter with default
value: "singletokenbucket"
the shaper profile type

optional parameter with default


value: "no-autoshape-on"
enable or disable automatic
shaping

Released

541

19 QoS Configuration Commands

19.29 QoS Bandwidth Profile Configuration


Command
Command Description
This command allows the operator to configure a QoS Bandwidth profile. A QoS Bandwidth profile contains
upstream rate enforcement information for frames to which this profile is applied.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no bandwidth (name) ) | ( bandwidth (name) committed-info-rate
<Qos::BwCommittedInfoRate>
assured-info-rate
<Qos::BwAssuredInfoRate>
excessive-info-rate
<Qos::BwExcessiveInfoRate> [ no delay-tolerance | delay-tolerance <Qos::DelayTolerance> ] [ no assu-burst-size |
assu-burst-size <Qos::BwAssuredBurstSize> ] [ no exce-burst-size | exce-burst-size <Qos::BwExcessiveBurstSize>
])

Command Parameters
Table 19.29-1 "QoS Bandwidth Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.29-2 "QoS Bandwidth Profile Configuration Command" Command Parameters


Parameter

Type

Description

committed-info-rate

Parameter type: <Qos::BwCommittedInfoRate>


Format:
- committed information rate
- unit: kbps
- range: [0...10000000]
Parameter type: <Qos::BwAssuredInfoRate>
Format:
- assured information rate
- unit: kbps
- range: [0...10000000]
Parameter type: <Qos::BwExcessiveInfoRate>
Format:
- excessive information rate
- unit: kbps

mandatory parameter
committed information rate

assured-info-rate

excessive-info-rate

542

Released

mandatory parameter
assured information rate

mandatory parameter
excessive information rate

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter
[no] delay-tolerance

[no] assu-burst-size

[no] exce-burst-size

3HH-04416-EBAA-TCZZA 01

Type
- range: [0...10000000]
Parameter type: <Qos::DelayTolerance>
Format:
- delay tolerance
- range: [1...240]
Parameter type: <Qos::BwAssuredBurstSize>
Format:
- assured burst size
- unit: kB
- range: [1...256]
Parameter type: <Qos::BwExcessiveBurstSize>
Format:
- excessive burst size
- unit: kB
- range: [1...256]

Description
optional parameter with default
value: "1"
delay tolerance
optional parameter with default
value: 256L
assured burst size
optional parameter with default
value: 256L
excessive burst size

Released

543

19 QoS Configuration Commands

19.30 QoS IngressQoS Profile Configuration


Command
Command Description
This command allows the operator to configure a QoS Ingress profile.The IngressQoS Profile table stores the pbit
to TC mappings that can be used by a L2 Forwarder in the upstream and dowstream directions.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no ingress-qos (name) ) | ( ingress-qos (name) [ no dot1-p0-tc | dot1-p0-tc
<Qos::TCMask_0> ] [ no dot1-p1-tc | dot1-p1-tc <Qos::TCMask_1> ] [ no dot1-p2-tc | dot1-p2-tc
<Qos::TCMask_2> ] [ no dot1-p3-tc | dot1-p3-tc <Qos::TCMask_3> ] [ no dot1-p4-tc | dot1-p4-tc
<Qos::TCMask_4> ] [ no dot1-p5-tc | dot1-p5-tc <Qos::TCMask_5> ] [ no dot1-p6-tc | dot1-p6-tc
<Qos::TCMask_6> ] [ no dot1-p7-tc | dot1-p7-tc <Qos::TCMask_7> ] [ [ no ] usedei ] [ no dot1-p0-color |
dot1-p0-color <Qos::NibbleMask_0> ] [ no dot1-p1-color | dot1-p1-color <Qos::NibbleMask_1> ] [ no
dot1-p2-color | dot1-p2-color <Qos::NibbleMask_2> ] [ no dot1-p3-color | dot1-p3-color <Qos::NibbleMask_3> ] [
no dot1-p4-color | dot1-p4-color <Qos::NibbleMask_4> ] [ no dot1-p5-color | dot1-p5-color <Qos::NibbleMask_5>
] [ no dot1-p6-color | dot1-p6-color <Qos::NibbleMask_6> ] [ no dot1-p7-color | dot1-p7-color
<Qos::NibbleMask_7> ] )

Command Parameters
Table 19.30-1 "QoS IngressQoS Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.30-2 "QoS IngressQoS Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] dot1-p0-tc

Parameter type: <Qos::TCMask_0>


Format:
- traffic class corresponding to pbit0
- range: [0...7,15]
Parameter type: <Qos::TCMask_1>
Format:
- traffic class corresponding to pbit1
- range: [0...7,15]
Parameter type: <Qos::TCMask_2>

optional parameter with default


value: 15
traffic class corresponding to
pbit0
optional parameter with default
value: 15
traffic class corresponding to
pbit1
optional parameter with default

[no] dot1-p1-tc

[no] dot1-p2-tc

544

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] dot1-p3-tc

[no] dot1-p4-tc

[no] dot1-p5-tc

[no] dot1-p6-tc

[no] dot1-p7-tc

[no] usedei
[no] dot1-p0-color

[no] dot1-p1-color

[no] dot1-p2-color

[no] dot1-p3-color

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
- traffic class corresponding to pbit2
- range: [0...7,15]
Parameter type: <Qos::TCMask_3>
Format:
- traffic class corresponding to pbit3
- range: [0...7,15]
Parameter type: <Qos::TCMask_4>
Format:
- traffic class corresponding to pbit4
- range: [0...7,15]
Parameter type: <Qos::TCMask_5>
Format:
- traffic class corresponding to pbit5
- range: [0...7,15]
Parameter type: <Qos::TCMask_6>
Format:
- traffic class corresponding to pbit6
- range: [0...7,15]
Parameter type: <Qos::TCMask_7>
Format:
- traffic class corresponding to pbit7
- range: [0...7,15]
Parameter type: boolean
Parameter type: <Qos::NibbleMask_0>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_1>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_2>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_3>
Format:
( green
| yellow
| red )
Possible values:

value: 15
traffic class corresponding to
pbit2
optional parameter with default
value: 15
traffic class corresponding to
pbit3
optional parameter with default
value: 15
traffic class corresponding to
pbit4
optional parameter with default
value: 15
traffic class corresponding to
pbit5
optional parameter with default
value: 15
traffic class corresponding to
pbit6
optional parameter with default
value: 15
traffic class corresponding to
pbit7
optional parameter
optional parameter with default
value: "green"
ingress color corresponding to
pbit0

optional parameter with default


value: "green"
ingress color corresponding to
pbit1

optional parameter with default


value: "green"
ingress color corresponding to
pbit2

optional parameter with default


value: "green"
ingress color corresponding to
pbit3

Released

545

19 QoS Configuration Commands

Parameter

Type
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_4>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_5>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_6>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color
Parameter type: <Qos::NibbleMask_7>
Format:
( green
| yellow
| red )
Possible values:
- green : green color
- yellow : yellow color
- red : red color

[no] dot1-p4-color

[no] dot1-p5-color

[no] dot1-p6-color

[no] dot1-p7-color

546

Released

Description

optional parameter with default


value: "green"
ingress color corresponding to
pbit4

optional parameter with default


value: "green"
ingress color corresponding to
pbit5

optional parameter with default


value: "green"
ingress color corresponding to
pbit6

optional parameter with default


value: "green"
ingress color corresponding to
pbit7

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.31 QoS Rate Limit Profile Configuration


Command
Command Description
This command allows the operator to configure a QoS rate limit profile. A QoS rate limit profile contains all rate
limit values related to different protocols, or total protocol values
Total protocol ratelimit value and supported protocol ratelimit value

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no rate-limit (name) ) | ( rate-limit (name) [ no total-rate | total-rate
<Qos::RateLimitTotalRate> ] [ no total-burst | total-burst <Qos::RateLimitTotalBurst> ] [ no arp-rate | arp-rate
<Qos::RateLimitProtocolRate> ] [ no arp-burst | arp-burst <Qos::RateLimitProtocolBurst> ] [ no dhcp-rate |
dhcp-rate <Qos::RateLimitProtocolRate> ] [ no dhcp-burst | dhcp-burst <Qos::RateLimitProtocolBurst> ] [ no
igmp-rate
|
igmp-rate
<Qos::RateLimitProtocolRate>
]
[
no
igmp-burst
|
igmp-burst
<Qos::RateLimitProtocolBurst> ] [ no pppoe-rate | pppoe-rate <Qos::RateLimitProtocolRate> ] [ no pppoe-burst |
pppoe-burst <Qos::RateLimitProtocolBurst> ] [ no nd-rate | nd-rate <Qos::RateLimitProtocolRate> ] [ no nd-burst |
nd-burst <Qos::RateLimitProtocolBurst> ] [ no icmpv6-rate | icmpv6-rate <Qos::RateLimitProtocolRate> ] [ no
icmpv6-burst
|
icmpv6-burst
<Qos::RateLimitProtocolBurst>
]
[
no
mld-rate
|
mld-rate
<Qos::RateLimitProtocolRate> ] [ no mld-burst | mld-burst <Qos::RateLimitProtocolBurst> ] [ no dhcpv6-rate |
dhcpv6-rate <Qos::RateLimitProtocolRate> ] [ no dhcpv6-burst | dhcpv6-burst <Qos::RateLimitProtocolBurst> ] [
no cfm-rate | cfm-rate <Qos::RateLimitProtocolRate> ] [ no cfm-burst | cfm-burst <Qos::RateLimitProtocolBurst> ]
)

Command Parameters
Table 19.31-1 "QoS Rate Limit Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

Table 19.31-2 "QoS Rate Limit Profile Configuration Command" Command Parameters
Parameter

Type

Description

[no] total-rate

Parameter type: <Qos::RateLimitTotalRate>


Format:
- protocol rate limit total rate
- unit: pps

optional parameter with default


value: 0
committed total rate limit value

3HH-04416-EBAA-TCZZA 01

Released

547

19 QoS Configuration Commands

Parameter

Type

[no] total-burst

[no] arp-rate

[no] arp-burst

[no] dhcp-rate

[no] dhcp-burst

[no] igmp-rate

[no] igmp-burst

[no] pppoe-rate

[no] pppoe-burst

[no] nd-rate

[no] nd-burst

[no] icmpv6-rate

548

Description

- range: [0...254]
Parameter type: <Qos::RateLimitTotalBurst>
Format:
- protocol rate limit total burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>

Released

optional parameter with default


value: 0
committed total rate limit burst
value
optional parameter with default
value: 0
ARP rate limit value
optional parameter with default
value: 0
ARP burst value
optional parameter with default
value: 0
DHCP rate limit value
optional parameter with default
value: 0
DHCP burst value
optional parameter with default
value: 0
IGMP rate limit value
optional parameter with default
value: 0
IGMP burst value
optional parameter with default
value: 0
PPPoE rate limit value
optional parameter with default
value: 0
PPPoE burst value
optional parameter with default
value: 0
Nd rate limit value
optional parameter with default
value: 0
Nd burst value
optional parameter with default

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] icmpv6-burst

[no] mld-rate

[no] mld-burst

[no] dhcpv6-rate

[no] dhcpv6-burst

[no] cfm-rate

[no] cfm-burst

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolRate>
Format:
- protocol rate limit value
- unit: pps
- range: [0...254]
Parameter type: <Qos::RateLimitProtocolBurst>
Format:
- protocol rate limit burst
- unit: pps
- range: [0...254]

value: 0
ICMP V6 rate limit value
optional parameter with default
value: 0
ICMP V6 burst value
optional parameter with default
value: 0
MLD rate limit value
optional parameter with default
value: 0
MLD burst value
optional parameter with default
value: 0
DHCP V6 rate limit value
optional parameter with default
value: 0
DHCP v6 burst value
optional parameter with default
value: 0
CFM rate limit value
optional parameter with default
value: 0
CFM burst value

Released

549

19 QoS Configuration Commands

19.32 QoS DSCP to Pbit Mapping Profile


Configuration Command
Command Description
This command allows the operator to configure a QoS DSCP to Pbit mapping profile. To configure the DSCP
codepoints in the DSCP to dot1p mapping, the command "configure qos profiles dscp-pbit (name) codepoint
(codepoint) (value)" is to be used.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles ( no dscp-pbit (name) ) | ( dscp-pbit (name) )

Command Parameters
Table 19.32-1 "QoS DSCP to Pbit Mapping Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name

550

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.33 QoS DSCP to Pbit Mapping Profile


Configuration Command
Command Description
This command allows the operator to configure a QoS DSCP to Pbit mapping profile. To configure the DSCP
codepoints in the DSCP to dot1p mapping, the command "configure qos profiles dscp-pbit (name) codepoint
(codepoint) (value)" is to be used.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles dscp-pbit (name) codepoint (codepoint) [ dot1p-value <Qos::DscpToDot1PAlign> ]

Command Parameters
Table 19.33-1 "QoS DSCP to Pbit Mapping Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Format:
- the number of the DSCP codepoint
- range: [0...63]

A unique profile name

(codepoint)

the value of the codepoint

Table 19.33-2 "QoS DSCP to Pbit Mapping Profile Configuration Command" Command
Parameters
Parameter

Type

Description

dot1p-value

Parameter type: <Qos::DscpToDot1PAlign>


Format:
- the DOT1P value
- range: [0...7]

optional parameter
the dot1p value to be assigned to
the dscp codepoint

3HH-04416-EBAA-TCZZA 01

Released

551

19 QoS Configuration Commands

19.34 QoS Board-Level Queue and Performance


Configuration Command
Command Description
This command allows the operator to configure various parameters related to board-level traffic load and packet
loss.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos global (index) [ no buffer-occ-thresh | buffer-occ-thresh <Qos::PercentThresh> ] [ [ no ]
queue-stats ] [ [ no ] dsload-tca ] [ no dsload-thresh | dsload-thresh <Qos::PercentThresh> ] [ [ no ] buffer-tca ] [ no
up-buf-thresh | up-buf-thresh <Qos::UpAggrBufOvflwTcaTh> ] [ no up-obc-thresh | up-obc-thresh
<Qos::UpObcAggrBufOvflwTcaTh> ] [ no dn-obc-thresh | dn-obc-thresh <Qos::DnObcAggrBufOvflwTcaTh> ] [
no dn-buf-thresh | dn-buf-thresh <Qos::DnUcAggrBufOvflwTcaTh> ] [ no part-buf-thresh | part-buf-thresh
<Qos::PartBufThresh> ]

Command Parameters
Table 19.34-1 "QoS Board-Level Queue and Performance Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

the physical number of the slot

Table 19.34-2 "QoS Board-Level Queue and Performance Configuration Command" Command
Parameters
Parameter

Type

Description

[no] buffer-occ-thresh

Parameter type: <Qos::PercentThresh>


Format:

optional parameter with default


value: 0

552

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

Type

Description

- Percentage of the QoS Thresh


- range: [0...100]

[no] queue-stats
[no] dsload-tca

[no] dsload-thresh

[no] buffer-tca

[no] up-buf-thresh

[no] up-obc-thresh

[no] dn-obc-thresh

[no] dn-buf-thresh

[no] part-buf-thresh

3HH-04416-EBAA-TCZZA 01

the ratio of occupied data buffer


entries to the LT global data
buffer size, above which the
partial buffer threshold alarm will
be triggered.(only applicable to
low priority traffic i.e. BE and
CL)
Parameter type: boolean
optional parameter
enable or disable generation of
queue statistics
Parameter type: boolean
optional parameter
enable or disable the threshold
crossing alarm associated to
card-level load of downstream
traffic
Parameter type: <Qos::PercentThresh>
optional parameter with default
Format:
value: 0
- Percentage of the QoS Thresh
Percentage of LT fan-out load
- range: [0...100]
above which the alarm will be
triggered.
Parameter type: boolean
optional parameter
enable the threshold crossover
alarm of aggregation buffer
overflow
Parameter type: <Qos::UpAggrBufOvflwTcaTh>
optional parameter with default
Format:
value: 0
- Qos thresh
the threshold of upstream
- range: [0...2147483647]
aggregation buffer overflow
TCA.
Parameter type: <Qos::UpObcAggrBufOvflwTcaTh>
optional parameter with default
Format:
value: 0
- Qos thresh
The threshold of OBC-directed
- range: [0...2147483647]
upstream aggregation buffer
overflow TCA.
Parameter type: <Qos::DnObcAggrBufOvflwTcaTh>
optional parameter with default
Format:
value: 0
- Qos thresh
The threshold of downstream
- range: [0...2147483647]
OBC-directed aggregation buffer
overflow TCA.
Parameter type: <Qos::DnUcAggrBufOvflwTcaTh>
optional parameter with default
Format:
value: 0
- Qos thresh
The threshold of downstream
- range: [0...2147483647]
data aggregation buffer overflow
TCA.
Parameter type: <Qos::PartBufThresh>
optional parameter with default
Format:
value: "0"
- threshold of dropped lower class packets of global buffer. The threshold of dropped lower
range: [0...18446744073709551615]
class packets of global buffer
occupancy threshold overflow
TCA.

Released

553

19 QoS Configuration Commands

19.35 QoS Queue Threshold Crossing Alarm


Configuration Command
Command Description
This command allows the operator to configure various parameters related to subscriber interface and queue level
traffic load and packet loss.
Load per physical line is calculated by matching the total number of bytes transmitted versus the capacity of the
interface in the relevant measurement epoch. Load per queue is measured in terms of the contribution to the
interface level load of traffic passed in a certain queue.
Threshold crossing alarms can be specified for the load and packet loss parameters per line and per traffic class.
This feature can be useful to detect network anomalies by watching over packet discard or load level in
high-priority traffic classes.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos tca (index) queue <Qos::TcaQueues> [ [ no ] tca-enable ] [ no load-thresh | load-thresh
<Qos::PercentThresh> ] [ no dis-frame-th | dis-frame-th <Qos::QosQueueStatsDiscFramesTcaThreshold> ]

Command Parameters
Table 19.35-1 "QoS Queue Threshold Crossing Alarm Configuration Command" Resource
Parameters
Resource Identifier

Type

(index)

Format:
physical port or lag port of a dsl
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / link
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

554

Released

Description

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>


| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

3HH-04416-EBAA-TCZZA 01

Released

555

19 QoS Configuration Commands

Resource Identifier

Type

Description

Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Qos::TcaQueues>
Format:
- output dsl/gpon/epon port queue number
- range: [0...7,255]

queue

the queue with in the scope of


one dsl link of tca

Table 19.35-2 "QoS Queue Threshold Crossing Alarm Configuration Command" Command
Parameters
Parameter

Type

[no] tca-enable

Parameter type: boolean

[no] load-thresh

Parameter type: <Qos::PercentThresh>


Format:
- Percentage of the QoS Thresh
- range: [0...100]
Parameter
<Qos::QosQueueStatsDiscFramesTcaThreshold>
Format:
- Qos thresh
- range: [0...2147483647]

[no] dis-frame-th

556

Released

Description
optional parameter
each queue statistic TCA of this
queue
optional parameter with default
value: 0
The threshold of queue traffic
load.
type: optional parameter with default
value: 0
The threshold of discarded
frames of this queue.

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.36 QoS DSL Link Configuration Command


Command Description
Obsolete command, replaced by configure qos interface (index).
This command allows the operator to configure QoS settings on subscriber interfaces. For each subscriber
interface the operator can apply scheduling and CAC settings.
A scheduler profile is used to configure egress scheduler settings for egress subscriber interfaces on L3 cards. A
CAC profile is used to configure CAC settings for a subscriber interface.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) [ no scheduler-profile | scheduler-profile <Qos::SchedulerProfName> ] [
cac-profile <Qos::QosCacProfileName> ]
Obsolete command, replaced by configure qos interface (index).

Command Parameters
Table 19.36-1 "QoS DSL Link Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a subscriber
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface.
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 19.36-2 "QoS DSL Link Configuration Command" Command Parameters


Parameter

Type

Description

[no] scheduler-profile

Parameter type: <Qos::SchedulerProfName>


Format:
name : <Qos::IgnoredQosProfileName>
Possible values:
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration

optional parameter with default


value: "name : CL_66"
name of scheduler profile to be
mapped on this subscriber
interface.

3HH-04416-EBAA-TCZZA 01

Released

557

19 QoS Configuration Commands

Parameter

Type

cac-profile

558

Description

and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
optional parameter
Format:
name of cac profile to be mapped
( name : <Qos::IgnoredQosProfileName>
on this subscriber interface.
| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.37 QoS LIM Queue Configuration Command


Command Description
Obsolete command, replaced by configure qos interface (index) queue.
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each DSL interface
supports four downstream buffers, which can be configured independently using buffer acceptance control (BAC)
profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. However, this is
not recommended because this allows QoS un-aware packet discard. If the total downstream buffer pool is
over-subscribed, the system logs a warning message. Proceed with care, as this allows QoS un-aware packet
discard in extreme traffic conditions.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) queue (queue) [ queue-profile <Qos::QosQueueProfileName> ]
Obsolete command, replaced by configure qos interface (index) queue.

Command Parameters
Table 19.37-1 "QoS LIM Queue Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a subscriber
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface.
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
queue in scope of 1 dsl link on a
- output dsl/gpon/epon port queue number
line-interface-module
- range: [0...7,255]

(queue)

Description

Table 19.37-2 "QoS LIM Queue Configuration Command" Command Parameters


Parameter

Type

Description

queue-profile

Parameter type: <Qos::QosQueueProfileName>


Format:

optional parameter
name of the queue profile

3HH-04416-EBAA-TCZZA 01

Released

559

19 QoS Configuration Commands

Parameter

Type

Description

( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

560

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.38 QoS ShdSL Link Configuration Command


Command Description
Obsolete command, replaced by configure qos interface (index).
This command allows the operator to configure Shdsl links. For each Shdsl link the operator can apply scheduling
and CAC settings.
A scheduler profile is used to configure egress scheduler settings for each egress Shdsl interface. A CAC profile is
used to configure CAC settings for each Shdsl interface.
The Shdsl link table can be configured on the SMLT-H , SMLT-J and NSLT-A units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shdsl-port (index) [ scheduler-profile <Qos::QosSchedulerProfileName> ] [ cac-profile
<Qos::QosCacProfileName> ]
Obsolete command, replaced by configure qos interface (index).

Command Parameters
Table 19.38-1 "QoS ShdSL Link Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a shdsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 19.38-2 "QoS ShdSL Link Configuration Command" Command Parameters


Parameter

Type

Description

scheduler-profile

Parameter type: <Qos::QosSchedulerProfileName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate

optional parameter
name of scheduler profile to be
mapped on this dsl link

3HH-04416-EBAA-TCZZA 01

Released

561

19 QoS Configuration Commands

Parameter

Type

cac-profile

562

Description

- name : enter profile name to be associated


Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
optional parameter
Format:
name of cac profile to be mapped
( name : <Qos::IgnoredQosProfileName>
on this dsl link
| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.39 QoS LIM Queue (SHDSL) Configuration


Command
Command Description
Obsolete command, replaced by configure qos interface (index) queue.
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each SHDSL
interface supports four downstream buffers, which can be configured independently using buffer acceptance
control (BAC) profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. However, this is
not recommended because this allows QoS un-aware packet discard. If the total downstream buffer pool is
over-subscribed, the system logs a warning message. Proceed with care, as this allows QoS un-aware packet
discard in extreme traffic conditions.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shdsl-port (index) queue (queue) [ queue-profile <Qos::QosQueueProfileName> ]
Obsolete command, replaced by configure qos interface (index) queue.

Command Parameters
Table 19.39-1 "QoS LIM Queue (SHDSL) Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a shdsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
queue in scope of 1 dsl link on a
- output dsl/gpon/epon port queue number
line-interface-module
- range: [0...7,255]

(queue)

Description

Table 19.39-2 "QoS LIM Queue (SHDSL) Configuration Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

563

19 QoS Configuration Commands

Parameter

Type

queue-profile

Parameter type: <Qos::QosQueueProfileName>


optional parameter
Format:
name of the queue profile
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

564

Released

Description

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.40 QoS Interface Configuration Command


Command Description
This command allows the operator to configure QoS settings on a user-port Interface. A user-port Interface can be
a DSL-link, an Shdsl-link, an Ethernet Line, a Link Aggregation Group or a pon, ont or uni interface. For each
Interface the operator can apply scheduling and CAC and shaper settings.
A scheduler node profile is used to configure egress scheduler settings for each egress Interface. A CAC profile is
used to configure CAC settings for each Interface. A shaper profile is used to configure downstream flooding
shaper settings for each Interface.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos interface (index) [ no scheduler-node | scheduler-node <Qos::SchedulerNodeProfName> ] [ no
ingress-profile | ingress-profile <Qos::QosIngressProfileNameEOnu> ] [ no cac-profile | cac-profile
<Qos::QosCacProfileName> ] [ no ext-cac | ext-cac <Qos::QosCacProfileName> ] [ [ no ] ds-queue-sharing ] [ [ no
] us-queue-sharing ] [ no ds-num-queue | ds-num-queue <Qos::NumberofQueues> ] [ no ds-num-rem-queue |
ds-num-rem-queue <Qos::NumberofQueues> ] [ no us-num-queue | us-num-queue <Qos::NumberofQueues> ] [ [
no ] queue-stats-on ] [ [ no ] autoschedule ] [ oper-weight <Qos::QosWeight> ] [ oper-rate
<Qos::ShaperExcessiveInfoRate> ] [ [ no ] us-vlanport-queue ] [ no dsfld-shaper-prof | dsfld-shaper-prof
<Qos::QosShaperProfileName> ] [ no gem-sharing | gem-sharing <Qos::GemSharing> ]

Command Parameters
Table 19.40-1 "QoS Interface Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

565

19 QoS Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity

566

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 19.40-2 "QoS Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] scheduler-node

optional parameter with default


value: "none"
the name of the scheduler-node
profile to be mapped on this
user-port Interface

[no] ds-queue-sharing

Parameter type: <Qos::SchedulerNodeProfName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosIngressProfileNameEOnu>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>
| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>
| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: boolean

[no] us-queue-sharing

Parameter type: boolean

[no] ingress-profile

[no] cac-profile

[no] ext-cac

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "none"
the name of the ingress profile to
be mapped on this user-port
Interface. It only used for EPON
ONU interface current.

optional parameter with default


value: "none"
the name of the cac profile to be
mapped on this user-port
Interface. For EPON OLT in
downstream, this profile used for
CAC on 1G PON bandwidth.

optional parameter with default


value: "none"
the name of the cac profile to be
mapped on this user-port
Interface. For EPON OLT in
downstream, this profile used for
CAC on 10G PON bandwidth.

optional parameter
enable downstream queue sharing
optional parameter
enable upstream queue sharing

Released

567

19 QoS Configuration Commands

Parameter

Type

Description

[no] ds-num-queue

Parameter type: <Qos::NumberofQueues>


Format:
( not-applicable
| <Qos::NumberofQueues> )
Possible values:
- not-applicable : not applicable
Field type <Qos::NumberofQueues>
- number of queues per uni
- range: [4,8,1]
Parameter type: <Qos::NumberofQueues>
Format:
( not-applicable
| <Qos::NumberofQueues> )
Possible values:
- not-applicable : not applicable
Field type <Qos::NumberofQueues>
- number of queues per uni
- range: [4,8,1]
Parameter type: <Qos::NumberofQueues>
Format:
( not-applicable
| <Qos::NumberofQueues> )
Possible values:
- not-applicable : not applicable
Field type <Qos::NumberofQueues>
- number of queues per uni
- range: [4,8,1]
Parameter type: boolean

optional parameter with default


value: 4
number of downstream queues
per uni

[no] ds-num-rem-queue

[no] us-num-queue

[no] queue-stats-on
[no] autoschedule
oper-weight

oper-rate

[no] us-vlanport-queue
[no] dsfld-shaper-prof

[no] gem-sharing

568

Released

optional parameter with default


value: 0
number of remote downstream
queues per ont

optional parameter with default


value: 8
number of upstream queues per
uni

Parameter type: boolean


Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]
Parameter type: <Qos::ShaperExcessiveInfoRate>
Format:
- excessive information rate of a shaper
- unit: kbps
- range: [0...2147483647]
Parameter type: boolean

optional parameter
enable queue stats collection for
ont uni
optional parameter
optional parameter
operational weight of the ONT or
UNI scheduler
optional parameter
Operational rate limit when
autoShape enabled for ONT or
UNI
optional parameter
Enable Vlan Port Level Queue
Configuration
optional parameter with default
value: "none"
the name of the shaper profile
attached to the pon

Parameter type: <Qos::QosShaperProfileName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::GemSharing>
optional parameter with default
Format:
value: "disable"
( enable
enable or disable gem sharing

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

Type

Description

| disable
| not-applicable )
Possible values:
- enable : enable GEM sharing
- disable : disable GEM sharing
- not-applicable : not applicable

3HH-04416-EBAA-TCZZA 01

Released

569

19 QoS Configuration Commands

19.41 QoS Interface Queue Configuration


Command
Command Description
This command allows the operator to configure a QoS Line Card queue. On the L3 line cards, each user-port
(DSL-Link, Shdsl-link or Ethernet Line or LA-Group) supports four downstream buffers, which can be configured
independently using buffer acceptance control (BAC) profiles.
The operator can configure downstream buffers, such that the total buffer pool is oversubscribed. Please take note
that this allows QoS un-aware packet discard under extreme traffic conditions. When the total downstream buffer
pool is over-subscribed, the system logs a warning message.
Queue profile none only for epon,queue profile must have a name for other boards.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos interface (index) queue (queue) [ priority <Qos::QosPriority> ] [ weight <Qos::QosWeight> ] [
oper-weight <Qos::QosWeight> ] [ queue-profile <Qos::QosQueueProfName> ] [ shaper-profile
<Qos::QosShaperProfileName> ]

Command Parameters
Table 19.41-1 "QoS Interface Queue Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

570

Released

Description

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity

3HH-04416-EBAA-TCZZA 01

Released

571

19 QoS Configuration Commands

Resource Identifier

(queue)

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Format:
- output dsl/gpon/epon port queue number
- range: [0...7,255]

queue in scope of 1 user-port


Interface
on
a
line-interface-module

Table 19.41-2 "QoS Interface Queue Configuration Command" Command Parameters


Parameter

Type

Description

priority

Parameter type: <Qos::QosPriority>


Format:
- relative priority
- range: [1...8]
Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]
Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]
Parameter type: <Qos::QosQueueProfName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosShaperProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

optional parameter
relative priority of the scheduler

weight

oper-weight

queue-profile

shaper-profile

572

Released

optional parameter
relative weight of the scheduler
optional parameter
relative weight of the scheduler operational value
optional parameter
name of the queue profile

optional parameter
name of the shaper profile

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.42 QoS Interface Upstream Queue Configuration


Command
Command Description
This command allows the operator to configure the upstream queues on the LIM with queue profiles
The operator can configure the upstream queue priority and upstream queue weight along with an option to enable
or disable the bandwidth sharing.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos interface (index) upstream-queue (queue) [ no priority | priority <Qos::QosPriority> ] [ no weight |
weight <Qos::QosWeight> ] [ no bandwidth-profile | bandwidth-profile <Qos::QosBandwidthProfileName> ] [ no
ext-bw | ext-bw <Qos::QosBandwidthProfileName> ] [ no bandwidth-sharing | bandwidth-sharing
<Qos::BandwidthSharing> ] [ no queue-profile | queue-profile <Qos::QosQueueProfName> ] [ no shaper-profile |
shaper-profile <Qos::QosShaperProfileName> ]

Command Parameters
Table 19.42-1 "QoS Interface Upstream Queue Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

573

19 QoS Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id

574

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Resource Identifier

(queue)

Type

Description

Field type <Eqpt::SVlan>


- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Format:
- output dsl/gpon/epon port queue number
- range: [0...7,255]

queue in scope of 1 user-port


Interface
on
a
line-interface-module or ont uni,
value
255
indicates
the
configuration is on the interface
not on the queue

Table 19.42-2 "QoS Interface Upstream Queue Configuration Command" Command Parameters
Parameter

Type

Description

[no] priority

Parameter type: <Qos::QosPriority>


Format:
- relative priority
- range: [1...8]
Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]
Parameter type: <Qos::QosBandwidthProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>
| none )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosBandwidthProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>
| none )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::BandwidthSharing>
Format:
( no-sharing
| uni-sharing
| ont-sharing
| vlan-port-sharing )
Possible values:
- no-sharing : disable shaper sharing
- uni-sharing : enable BW or TCONT sharing on a single
UNI
- ont-sharing : enable BW or TCONT sharing on across
UNIs of an ONT
- vlan-port-sharing : enable BW or TCONT sharing on a
vlan port

optional parameter with default


value: 1
relative priority

[no] weight

[no] bandwidth-profile

[no] ext-bw

[no] bandwidth-sharing

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 1
relative weight
optional parameter with default
value: "none"
the name of the bandwidth
profile. For EPON OLT in
downstream, this profile used for
DBA on 1G PON bandwidth.

optional parameter with default


value: "none"
the name of the bandwidth
profile. For EPON OLT in
downstream, this profile used for
DBA on 10G PON bandwidth.

optional parameter with default


value: "no-sharing"
enable or disable shaper sharing

Released

575

19 QoS Configuration Commands

Parameter

Type

Description

[no] queue-profile

Parameter type: <Qos::QosQueueProfName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosShaperProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

optional parameter with default


value: "none"
name of the queue profile

[no] shaper-profile

576

Released

optional parameter with default


value: "none"
name of the shaper profile

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.43 QoS Interface Remote Downstream Queue


Configuration Command
Command Description
This command allows the operator to configure the downstream queues on the ONT.
The operator can configure the downstream queue priority and downstream queue weight at the ONT.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos interface (index) ds-rem-queue (queue) [ no priority | priority <Qos::QosPriority> ] [ no weight |
weight <Qos::QosWeight> ]

Command Parameters
Table 19.43-1 "QoS Interface Remote Downstream Queue Configuration Command" Resource
Parameters
Resource Identifier

Type

(index)

Format:
physical port or la-group of a
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-port Interface
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

577

19 QoS Configuration Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>

578

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Resource Identifier
(queue)

Type
- customer vlan id
Format:
- output dsl/gpon/epon port queue number
- range: [0...7,255]

Description
queue in scope of 1 user-port
Interface
on
a
line-interface-module or ont uni,
value
255
indicates
the
configuration is on the interface
not on the queue

Table 19.43-2 "QoS Interface Remote Downstream Queue Configuration Command" Command
Parameters
Parameter

Type

Description

[no] priority

Parameter type: <Qos::QosPriority>


Format:
- relative priority
- range: [1...8]
Parameter type: <Qos::QosWeight>
Format:
- relative weight
- range: [0...127]

optional parameter with default


value: 1
relative priority

[no] weight

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 10
relative weight

Released

579

19 QoS Configuration Commands

19.44 SHub QoS Traffic Class Configuration


Command
Command Description
This command allows the operator to configure SHub QoS traffic classes. The SHub has four defined traffic
classes. The mapping of frames with 802.1P codepoint to egress buffers determines how each traffic class is put
into egress buffers and, in a later step, how each traffic class is scheduled on the SHub egress interfaces.
This traffic class mapping table is not applicable on the units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub tc-map-dot1p (tc-priority) [ traffic-class <Qos::ShubTrafficClass> ]

Command Parameters
Table 19.44-1 "SHub QoS Traffic Class Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(tc-priority)

Format:
- priority value in the received frames
- range: [0...7]

priority value in the received


frames

Table 19.44-2 "SHub QoS Traffic Class Configuration Command" Command Parameters
Parameter

Type

Description

traffic-class

Parameter type: <Qos::ShubTrafficClass>


Format:
- value of traffic class, the received frame is mapped to
- range: [0...3]

optional parameter
value of traffic class,the received
frame is mapped to

580

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.45 SHub QoS Queue Configuration Command


Command Description
This command allows the operator to configure the SHub QoS queue. The SHub features several network interfaces
that can be used for network, subtending, or directly attached customer interfaces (known as "user" interfaces on
the SHub) in any combination.
Each network interface features a hierarchical scheduler with queues (0, 1) scheduled as weighted round robin
(WRR) and queues (2,3) scheduled as strict priority. Queue 3 is the highest priority.
The WRR weights, egress shaping rate, and ingress policing rate can be configured for each SHub interface. See
the section on the QoS Ingress Policing Configuration Command for more information.
The SHub can also send and receive pause frames, but it is configured such that it will never generate pause frames
as a result of congestion on an egress interface. However, the SHub can correctly honor backpressure from peer
nodes that cannot handle the traffic.
Note that all SHub port settings are the same within a link aggregate group.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub queue-config (port) [ no queue0-weight | queue0-weight <Qos::ShubQueueWeight1> ] [ no
queue1-weight | queue1-weight <Qos::ShubQueueWeight1> ] [ [ no ] rx-pause ] [ no egress-rate | egress-rate
<Qos::ShubPortRate> ] [ [ no ] dscp2p-enable ]

Command Parameters
Table 19.45-1 "SHub QoS Queue Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

the unique id for the port

3HH-04416-EBAA-TCZZA 01

Released

581

19 QoS Configuration Commands

Table 19.45-2 "SHub QoS Queue Configuration Command" Command Parameters


Parameter

Type

Description

[no] queue0-weight

Parameter type: <Qos::ShubQueueWeight1>


Format:
- the weight for the queue
- range: [1...15]
Parameter type: <Qos::ShubQueueWeight1>
Format:
- the weight for the queue
- range: [1...15]
Parameter type: boolean

optional parameter with default


value: 1
queue zero weight

[no] queue1-weight

[no] rx-pause
[no] egress-rate

Parameter type: <Qos::ShubPortRate>


Format:
- a flow rate value
- unit: 64kbps
- range: [1...163840]
Parameter type: boolean

[no] dscp2p-enable

582

Released

optional parameter with default


value: 2
queue one weight
optional parameter
enable qos pause for receive
optional parameter with default
value: 16384
port egress rate
optional parameter
dscp to p-bit map enable

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.46 SHub QoS DSCP2P Map Configuration


Command
Command Description
This command allows the operator to map the DSCP value to the 802.1p priority.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub dscp-map-dot1p (dscp-index) [ dot1p-value <Qos::ShubDSCPPriority> ]

Command Parameters
Table 19.46-1 "SHub QoS DSCP2P Map Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(dscp-index)

Format:
- the dscp value in the ip frame
- range: [0...63]

the dscp value

Table 19.46-2 "SHub QoS DSCP2P Map Configuration Command" Command Parameters
Parameter

Type

Description

dot1p-value

Parameter type: <Qos::ShubDSCPPriority>


Format:
- the 802.1p priority value mapped to
- range: [0...7]

optional parameter
the 802.1p priority value mapped
to

3HH-04416-EBAA-TCZZA 01

Released

583

19 QoS Configuration Commands

19.47 SHub QoS Flow Configuration Command


Command Description
This command allows the operator to configure various flows to be policed.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub ( no flow (index) ) | ( flow (index) [ no name | name <Qos::FlowString> ] [ (old-type) ] [ no
type | type <Qos::FlowType> ] )

Command Parameters
Table 19.47-1 "SHub QoS Flow Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- unique index for the flow
- range: [1...64]

index used to identify a flow

Table 19.47-2 "SHub QoS Flow Configuration Command" Command Parameters


Parameter

Type

Description

[no] name

Parameter type: <Qos::FlowString>


Format:
- string to identify the flow
- length: 1<=x<=15
Format:
( port
| vlan : <Qos::VlanId>
| vlan-dot1p : <Qos::VlanId> : <Qos::FlowPriority>
| vlan-dscp : <Qos::VlanId> : <Qos::FlowDscp> )
Possible values:
- port : rate limit a physical port
- vlan : rate limit a VLAN on an ingress port
- vlan-dot1p : rate limit a VLAN on a 802.1p traffic class
criterion
- vlan-dscp : rate limit a vlan on a dscp traffic class criterion
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::FlowPriority>

optional parameter with default


value: """"
name of the flow

(old-type)

584

Released

obsolete parameter replaced by


parameter "type"
type of qos flow

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Parameter

[no] type

3HH-04416-EBAA-TCZZA 01

Type

Description

- flow priority for the vlan dot1p


- range: [0...8]
Field type <Qos::FlowDscp>
- dscp value to detect the flow
- range: [0...64]
Parameter type: <Qos::FlowType>
optional parameter with default
Format:
value: "port"
( port
type of qos flow
| vlan : <Qos::VlanId>
| vlan-dot1p : <Qos::VlanId> : <Qos::FlowPriority>
| vlan-dscp : <Qos::VlanId> : <Qos::FlowDscp> )
Possible values:
- port : rate limit a physical port
- vlan : rate limit a VLAN on an ingress port
- vlan-dot1p : rate limit a VLAN on a 802.1p traffic class
criterion
- vlan-dscp : rate limit a vlan on a dscp traffic class criterion
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::VlanId>
- vlan id to detect the flow
- range: [0...4092]
Field type <Qos::FlowPriority>
- flow priority for the vlan dot1p
- range: [0...8]
Field type <Qos::FlowDscp>
- dscp value to detect the flow
- range: [0...64]

Released

585

19 QoS Configuration Commands

19.48 SHub QoS Policer Configuration Command


Command Description
This command allows the operator to enact policing on a SHub interface. It uses previously created policer and
flow definition blocks.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub ( no policer (port-id) flow <Qos::PolicerFlowIndex> ) | ( policer (port-id) flow
<Qos::PolicerFlowIndex> meter <Qos::PolicerMeterIndex> )

Command Parameters
Table 19.48-1 "SHub QoS Policer Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port-id)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Parameter type: <Qos::PolicerFlowIndex>
Format:
- index for the flow
- range: [1...64]

shub qos port index

flow

index of an existing flow

Table 19.48-2 "SHub QoS Policer Configuration Command" Command Parameters


Parameter

Type

Description

meter

Parameter type: <Qos::PolicerMeterIndex>


Format:
- index for the meter
- range: [1...64]

mandatory parameter
index of an existing meter

586

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

Command Output
Table 19.48-3 "SHub QoS Policer Configuration Command" Display parameters
Specific Information
name
policer-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ip::ActivateRowStatus>


( active
| not-active )
Possible values:
- active : active route
- not-active : active route

the status of the policer which


indicates whether the policer is
active or inactive.
This element is only shown in
detail mode.

Released

587

19 QoS Configuration Commands

19.49 SHub QoS Ingress Policing on Port


Configuration Command
Command Description
This command allows the operator to configure a SHub policer. The construct can be used subsequently on many
physical interfaces in association with SHubflows.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub ( no meter (index) ) | ( meter (index) [ no name | name <Qos::DisplayString> ]
max-ingress-rate <Qos::MeterIngressRate> burst-size <Qos::MeterBurstSize> )

Command Parameters
Table 19.49-1 "SHub QoS Ingress Policing on Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- unique index for meter
- range: [1...64]

index used to identify a meter

Table 19.49-2 "SHub QoS Ingress Policing on Port Configuration Command" Command
Parameters
Parameter

Type

Description

[no] name

Parameter type: <Qos::DisplayString>


Format:
- string to identify the meter
- length: 1<=x<=15
Parameter type: <Qos::MeterIngressRate>
Format:
- ingress max policing rate,in steps of 64Kbps
- range: [1...163840]
Parameter type: <Qos::MeterBurstSize>
Format:
- ingress policer's burst tolerance
- range: [0...7]

optional parameter with default


value: """"
name of the meter

max-ingress-rate

burst-size

588

Released

mandatory parameter
the max ingress rate applied on a
port
mandatory parameter
max ingress burst size allowed

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.50 QoS Line Control Packets Rate Limit


Configuration Command
Command Description
This command allows the operator to configure police rate and burst per protocl.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos ( no ctrl-pkt-policer (protocol-id) ) | ( ctrl-pkt-policer (protocol-id) [ no sustained-rate |
sustained-rate <Qos::SustainedRate> ] [ no burst-size | burst-size <Qos::DslCtrlBurstSize> ] )

Command Parameters
Table 19.50-1 "QoS Line Control Packets Rate Limit Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(protocol-id)

Format:
( arp
| igmp
| dhcpv4
| dhcpv6
| icmpv6
| cfm
| pppox )
Possible values:
- arp : arp
- igmp : igmp
- dhcpv4 : dhcpv4
- dhcpv6 : dhcpv6
- icmpv6 : icmpv6
- cfm : cfm
- pppox : pppox

protocol
id
for
arp,igmp,dhcpv4,dhcpv6,icmpv6,cfm,pp

Table 19.50-2 "QoS Line Control Packets Rate Limit Configuration Command" Command
Parameters
Parameter

Type

Description

[no] sustained-rate

Parameter type: <Qos::SustainedRate>


Format:
- the police rate of inc user pkts in pps
- range: [1...64]

optional parameter with default


value: 15
police the user incoming packets
on all pvc's for the protocol of a

3HH-04416-EBAA-TCZZA 01

Released

589

19 QoS Configuration Commands

Parameter

Type

Description

[no] burst-size

Parameter type: <Qos::DslCtrlBurstSize>


Format:
- the burst size
- range: [1...128]

dsl line.
optional parameter with default
value: 10
police the user incoming packets
on all pvc's for the protocol of a
dsl line.

590

Released

3HH-04416-EBAA-TCZZA

01

19 QoS Configuration Commands

19.51 P-bit Based Scheduling For SC Forwarder


Cross Connect/Residential Bridge Configuration
Command
Command Description
This command allows the operator to configure the P-bit based scheduling for the S+C VLAN forwarder model for
Cross Connect / Residential Bridge.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos pbit-scheduling [ no sc-xcon-us | sc-xcon-us <Qos::PbitSched> ] [ no sc-xcon-dn | sc-xcon-dn
<Qos::PbitSched> ] [ no sc-rb-us | sc-rb-us <Qos::PbitSched> ] [ no sc-rb-dn | sc-rb-dn <Qos::PbitSched> ]

Command Parameters
Table 19.51-2 "P-bit Based Scheduling For SC Forwarder Cross Connect/Residential Bridge
Configuration Command" Command Parameters
Parameter

Type

Description

[no] sc-xcon-us

Parameter type: <Qos::PbitSched>


Format:
( svlanpbitbased
| cvlanpbitbased )
Possible values:
- svlanpbitbased : S-VLAN p-bit based
- cvlanpbitbased : C-VLAN p-bit based
Parameter type: <Qos::PbitSched>
Format:
( svlanpbitbased
| cvlanpbitbased )
Possible values:
- svlanpbitbased : S-VLAN p-bit based
- cvlanpbitbased : C-VLAN p-bit based
Parameter type: <Qos::PbitSched>
Format:
( svlanpbitbased
| cvlanpbitbased )
Possible values:
- svlanpbitbased : S-VLAN p-bit based

optional parameter with default


value: "svlanpbitbased"
This objects configure the
behavior of pbit scheduling in
S+C Vlan Cross Connect in
upstream direction

[no] sc-xcon-dn

[no] sc-rb-us

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "svlanpbitbased"
This objects configure the
behavior of pbit scheduling in
S+C Vlan Cross Connect in
downstream direction
optional parameter with default
value: "svlanpbitbased"
This objects configure the
behavior of pbit scheduling in
S+C Vlan iBridge in upstream
direction

Released

591

19 QoS Configuration Commands

Parameter
[no] sc-rb-dn

592

Released

Type

Description

- cvlanpbitbased : C-VLAN p-bit based


Parameter type: <Qos::PbitSched>
Format:
( svlanpbitbased
| cvlanpbitbased )
Possible values:
- svlanpbitbased : S-VLAN p-bit based
- cvlanpbitbased : C-VLAN p-bit based

optional parameter with default


value: "cvlanpbitbased"
This objects configure the
behavior of pbit scheduling in
S+C Vlan iBridge in downstream
direction

3HH-04416-EBAA-TCZZA

01

20- VLAN Configuration Commands

20.1 VLAN Configuration Command Tree


20.2 VLAN General Configuration Command
20.3 Virtual MAC Configuration Command
20.4 VLAN Configuration Command
20.5 VLAN Filtering Database Configuration Command
20.6 VLAN Port Filtering Database Configuration
Command
20.7 VLAN Protocol-based Configuration Command
20.8 SHub General VLAN Configuration Command
20.9 SHub VLAN Configuration Command
20.10 SHub Static Egress Port for VLAN Configuration
Command
20.11 SHub Static Untagged Egress Port for VLAN
Configuration Command
20.12 SHub Unicast MAC Filtering Database Configuration
Command
20.13 Vlan Pbit Traffic Counter Configuration Command
20.14 Vlan Priority Regeneration Profile Configuration
Command

3HH-04416-EBAA-TCZZA 01

20-594
20-596
20-597
20-598
20-605
20-607
20-610
20-613
20-614
20-616
20-618
20-619
20-621
20-624

Released

593

20 VLAN Configuration Commands

20.1 VLAN Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "VLAN Configuration Commands".

Command Tree
----configure
----vlan
- [no] broadcast-frames
- priority-policy
----vmac-address-format
- host-id
----[no] id
- (vlanid)
- [no] name
- mode
- [no] sntp-proxy
- [no] priority
- [no] vmac-translation
- [no] vmac-dnstr-filter
- [no] vmac-not-in-opt61
- [no] new-broadcast
- [no] protocol-filter
- [no] pppoe-relay-tag
- [no] dhcp-opt-82
- [no] circuit-id-dhcp
- [no] remote-id-dhcp
- [no] dhcp-linerate
- [no] pppoe-linerate
- [no] dhcpv6-linerate
- [no] circuit-id-pppoe
- [no] remote-id-pppoe
- [no] new-secure-fwd
- [no] aging-time
- [no] l2cp-transparent
- [no] dhcpv6-itf-id
- [no] dhcpv6-remote-id
- [no] dhcpv6-trst-port
- [no] enterprise-number
- [no] icmpv6-sec-fltr
- [no] in-qos-prof-name
- [no] ipv4-mcast-ctrl
- [no] ipv6-mcast-ctrl
- [no] mac-mcast-ctrl
- [no] dis-proto-rip
- [no] proto-ntp
- [no] dis-ip-antispoof
- [no] unknown-unicast
- [no] pt2ptgem-flooding
- [no] mac-movement-ctrl
- [no] cvlan4095passthru

594

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
----[no] vlan-port
- (port)
- unicast-mac
----[no] port-protocol
- (port)
- protocol-group
- vlan-id
- priority
----shub
- [no] dual-tag-mode
----[no] id
- (vlanid)
- [no] name
- mode
- [no] mac-move-allow
- [no] mac-learning-off
- user2-comm
----[no] egress-port
- (port)
----[no] untag-port
- (port)
----[no] unicast-mac
- (unicast-mac)
- vlan-id
- forward-port
----pbit-statistics
----[no] port
- (vlan-port)
- min-dot1p
- max-dot1p
----[no] priority-regen
- (profile-idx)
- profile-name
- [no] pbit0
- [no] pbit1
- [no] pbit2
- [no] pbit3
- [no] pbit4
- [no] pbit5
- [no] pbit6
- [no] pbit7

3HH-04416-EBAA-TCZZA 01

Released

595

20 VLAN Configuration Commands

20.2 VLAN General Configuration Command


Command Description
This command allows the operator to specify VLAN parameters that are globally applicable to VLANs:
- broadcast-frames : applies to VLANs of type residential bridge.when configured,broadcasting of frames is
configurable on a per vlan basis, when the parameter is configured as "no broadcast-frames", downstream
broadcast is disabled globally for all vlans.
- priority-policy : applies to VLANs of type residential bridge, cross-connect and QoS-aware.Indicates if the
priority of upstream frames is selected from the vlan (pvid) or port-default.This configuration is only applicable for
untagged user traffic.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan [ [ no ] broadcast-frames ] priority-policy <Vlan::PriorityMap>

Command Parameters
Table 20.2-2 "VLAN General Configuration Command" Command Parameters
Parameter

Type

Description

[no] broadcast-frames

Parameter type: boolean

priority-policy

Parameter type: <Vlan::PriorityMap>


Format:
( vlan-specific
| port-default )
Possible values:
- vlan-specific : the priority of the vlan
- port-default : the default priority of the port

optional parameter
broadcasting of frames is
configurable per vlan
optional parameter
specifies how to deal with
ethernet priority of the upstream
frames

596

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.3 Virtual MAC Configuration Command


Command Description
This command allows the user to configure the format in which a virtual MAC address is defined.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan vmac-address-format [ host-id <Vlan::vmacUniqueHostID> ]

Command Parameters
Table 20.3-2 "Virtual MAC Configuration Command" Command Parameters
Parameter

Type

host-id

Parameter type: <Vlan::vmacUniqueHostID>


optional parameter
Format:
Value of vMac unique host
- A unique host Id within an EMAN connected to the same ID.Range
1...524287
for
IP edges
DSL/ETH vMAC range 1...65535
- range: [1...524287]
for GPON vMAC

3HH-04416-EBAA-TCZZA 01

Description

Released

597

20 VLAN Configuration Commands

20.4 VLAN Configuration Command


Command Description
This command allows the operator to specify a VLAN and its attributes. The following combination is not
allowed:pppoe-relay-tag=configurable, while circuit-id-pppoe and remote-id-pppoe are both disable or
customer-id or physical-id.
The circuit-id-pppoe and remote-id-pppoe take effect when the pppoe-relay-tag is configurable.
The circuit-id-dhcp and remote-id-dhcp take effect when the dhcp-opt-82 is true.
- broadcast-frames: applies to VLANs of type residential bridge.The configured value of this parameter has no
meaning when broadcast-frames is not enabled at node level, meaning globally for all VLANs
- priority: The selection of the vlan based priority can apply provided the prioritypolicy at node level is
vlan-specific.
- vmac-translation: this configuration value has no effect in case mac learning is disabled (mac-learn-off).
- Note that vmac-translation, vmac-dnstr-filter and vmac-not-in-opt61 parameters can be enabled only at SVLAN
level in case of SC-VLAN CC mode.
- RIP will be enabled automatically by default during the creation of VLAN.
The vlan numbering space is the concatenation of an Service Provider VLAN, say S-VLAN-ID, and a Customer
VLAN, say C-VLAN-ID. Remark that the S-VLAN-ID is assumed to be unique.
The VLAN-ID value "0" - which is not a valid VLAN-tag value- is used to indicate "not applicable". The value 4097
should not be used as a valid forwarding vlan.
Following convention applies:
- S-VLAN is identified as (S-VLAN-ID, C-VLAN-ID=0)
- unstacked C-VLAN:
- the S-VLAN is absent or not applicable
- C-VLAN-ID > 0. A constraint exists for VLAN 1: it is reserved as the VLAN-unaware bridge. This VLAN is
managed as any other VLAN (i.e. it can be created, modified, removed) but it must be a residential bridged VLAN.
- stacked C-VLAN is identified as (S-VLAN-ID>1, C-VLAN-ID>1)
- ipv6-mcast-ctrl: This parameter is used in the following cases: - on the NGLT-A GPON linecard, ipv6-mcast-ctrl
parameter is used to allow or disallow upstream and downstream IPv6 multicast traffic - for all other linecards, in
case no DHCPv6 protocol processing is performed on the linecard (i.e. secure-forwarding,dhcpv6-itf-id and
dhcpv6-remote-id are all disabled), the ipv6-mcast-ctrl parameter is used to control upstream and downstream
DHCPv6 multicast traffic

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan ( no id (vlanid) ) | ( id (vlanid) [ no name | name <Vlan::AdminString> ] mode

598

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

<Vlan::SystemMode> [ [ no ] sntp-proxy ] [ no priority | priority <Vlan::Priority> ] [ [ no ] vmac-translation ] [ [ no


] vmac-dnstr-filter ] [ [ no ] vmac-not-in-opt61 ] [ no new-broadcast | new-broadcast
<Vlan::NewStaticBrdcastControl> ] [ no protocol-filter | protocol-filter <Vlan::ProtGroup> ] [ no pppoe-relay-tag |
pppoe-relay-tag <Vlan::PppoeRelayEnableR3.1> ] [ [ no ] dhcp-opt-82 ] [ no circuit-id-dhcp | circuit-id-dhcp
<Vlan::CircuitIdDhcp> ] [ no remote-id-dhcp | remote-id-dhcp <Vlan::RemoteIdDhcp> ] [ no dhcp-linerate |
dhcp-linerate <Vlan::Dhcp-linerate> ] [ no pppoe-linerate | pppoe-linerate <Vlan::Pppoe-linerate> ] [ no
dhcpv6-linerate | dhcpv6-linerate <Vlan::Dhcpv6-linerate> ] [ no circuit-id-pppoe | circuit-id-pppoe
<Vlan::CircuitIdPppoe> ] [ no remote-id-pppoe | remote-id-pppoe <Vlan::RemoteIdPppoe> ] [ no new-secure-fwd |
new-secure-fwd <Vlan::NewSecureForward> ] [ no aging-time | aging-time <Vlan::MacAgingTime> ] [ [ no ]
l2cp-transparent ] [ no dhcpv6-itf-id | dhcpv6-itf-id <Vlan::Dhcpv6InterfaceId> ] [ no dhcpv6-remote-id |
dhcpv6-remote-id <Vlan::Dhcpv6RemoteId> ] [ no dhcpv6-trst-port | dhcpv6-trst-port <Vlan::Dhcpv6TrstPort> ] [
no enterprise-number | enterprise-number <Vlan::Enterprisenumber> ] [ [ no ] icmpv6-sec-fltr ] [ no
in-qos-prof-name | in-qos-prof-name <Qos::QosIngressProfileName> ] [ [ no ] ipv4-mcast-ctrl ] [ [ no ]
ipv6-mcast-ctrl ] [ [ no ] mac-mcast-ctrl ] [ [ no ] dis-proto-rip ] [ [ no ] proto-ntp ] [ [ no ] dis-ip-antispoof ] [ [ no ]
unknown-unicast ] [ [ no ] pt2ptgem-flooding ] [ [ no ] mac-movement-ctrl ] [ no cvlan4095passthru |
cvlan4095passthru <Vlan::cvlan4095Passthru> ] )

Command Parameters
Table 20.4-1 "VLAN Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

Table 20.4-2 "VLAN Configuration Command" Command Parameters


Parameter

Type

Description

[no] name

Parameter type: <Vlan::AdminString>


Format:
- char string
- length: x<=80
Parameter type: <Vlan::SystemMode>
Format:
( cross-connect
| residential-bridge
| qos-aware
| layer2-terminated
| mirror )
Possible values:
- cross-connect : crossconnect vlan
- residential-bridge : residential bridge vlan
- qos-aware : qos aware vlan
- layer2-terminated : layer2 terminated vlan
- mirror : mirror vlan
Parameter type: boolean

optional parameter with default


value: ""
name

mode

[no] sntp-proxy

3HH-04416-EBAA-TCZZA 01

mandatory parameter
mode

optional parameter

Released

599

20 VLAN Configuration Commands

Parameter

Type

[no] priority

[no] vmac-translation

Parameter type: <Vlan::Priority>


Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: boolean

[no] vmac-dnstr-filter

Parameter type: boolean

[no] vmac-not-in-opt61

Parameter type: boolean

[no] new-broadcast

Parameter type: <Vlan::NewStaticBrdcastControl>


Format:
( inherit
| enable
| disable )
Possible values:
- inherit : for S+C VLAN: inherit from S VLAN level if
existing; for S or C VLAN: inherit from default fixed system
value (which is disable)
- enable : new switch broadcast frames
- disable : new disable broadcast frames
Parameter type: <Vlan::ProtGroup>
Format:
( pass-all
| pass-pppoe
| pass-ipoe
| pass-pppoe-ipoe
| pass-ipv6oe
| pass-pppoe-ipv6oe
| pass-ipoe-ipv6oe
| pass-pppoe-ipoe-ipv6oe )
Possible values:
- pass-all : pass all traffic
- pass-pppoe : pass traffic of PPPoE protocol group
- pass-ipoe : pass traffic of IPv4oE protocol group
- pass-pppoe-ipoe : pass PPPoE and IPv4oE protocol groups
- pass-ipv6oe : pass traffic of IPv6oE protocol group
- pass-pppoe-ipv6oe : pass PPPoE and IPv6oE protocol
groups
- pass-ipoe-ipv6oe : pass IPv4oE and IPv6oE protocol
groups
- pass-pppoe-ipoe-ipv6oe: pass PPPoE, IPv4oE and IPv6oE
protocol groups
Parameter type: <Vlan::PppoeRelayEnableR3.1>
Format:
( true
| false
| configurable )

[no] protocol-filter

[no] pppoe-relay-tag

600

Released

Description
enable SNTP proxy
optional parameter with default
value: 0
default frame priority
optional parameter
The parameter is not visible
during creation.
enable virtual Mac address
translation
optional parameter
The parameter is not visible
during creation.
enable virtual Mac source address
downstream blocking
optional parameter
skip vmac translation in dhcp
option 61 even when vmac is
enabled
optional parameter with default
value: "inherit"
switch
downstream
new
broadcast frames

optional parameter with default


value: "pass-all"
filter protocol groups

optional parameter with default


value: "false"
the format of the pppoe relay tag

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Parameter

[no] dhcp-opt-82

[no] circuit-id-dhcp

[no] remote-id-dhcp

[no] dhcp-linerate

[no] pppoe-linerate

[no] dhcpv6-linerate

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- true : pppoe tag with the current fixed format
- false : no pppoe tag
- configurable : circuit-id-pppoe and remote-id-pppoe
controlling format
Parameter type: boolean
optional parameter
The parameter is not visible
during creation.
enable dhcp option 82 (relay)
Parameter type: <Vlan::CircuitIdDhcp>
optional parameter with default
Format:
value: "disable"
( customer-id
The parameter is not visible
| physical-id
during creation.
| ccsa-format
circuit id
| disable )
Possible values:
- customer-id : customer identity as circuit id
- physical-id : physical line identity as circuit id
- ccsa-format : circuit id in ccsa format
- disable : no circuit id
Parameter type: <Vlan::RemoteIdDhcp>
optional parameter with default
Format:
value: "disable"
( customer-id
The parameter is not visible
| disable
during creation.
| physical-id )
remote id
Possible values:
- customer-id : customer identity as remote id
- disable : no remote id
- physical-id : physical line identity as remote id
Parameter type: <Vlan::Dhcp-linerate>
optional parameter with default
Format:
value: "notadd"
( addactuallinerate
The parameter is not visible
| notadd
during creation.
| addalllineparameters )
enable insertion of the linerate for
Possible values:
dhcp protocol
- addactuallinerate : add DSL actual line up and down rate
for DHCP
- notadd : not add DSLlinerate for DHCP
- addalllineparameters : add all DSL line parameters for
DHCP
Parameter type: <Vlan::Pppoe-linerate>
optional parameter with default
Format:
value: "notadd"
( addactuallinerate
The parameter is not visible
| notadd
during creation.
| addalllineparameters )
enable insertion of the linerate for
Possible values:
pppoe protocol (Only applicable
- addactuallinerate : add DSL actual line up and down rate on DSL LT boards, not on GPON
for PPPoE
LT boards. In case both GPON
- notadd : not add DSLlinerate for PPPoE
ports and DSL ports are
- addalllineparameters : add all DSL line parameters for configured in one VLAN, the
PPPoE
pppoe-linerate parameter will
only be applied on DSL LT
boards.)
Parameter type: <Vlan::Dhcpv6-linerate>
optional parameter with default
Format:
value: "notadd"
( notadd
The parameter is not visible
| addalllineparameters )
during creation.

Released

601

20 VLAN Configuration Commands

Parameter

Type

[no] circuit-id-pppoe

[no] remote-id-pppoe

[no] new-secure-fwd

[no] aging-time

[no] l2cp-transparent
[no] dhcpv6-itf-id

[no] dhcpv6-remote-id

602

Released

Description

Possible values:
enable insertion of the linerate for
- notadd : not add DSLlinerate for DHCPv6
dhcpv6 protocol
- addalllineparameters : add all DSL line parameters for
DHCPv6
Parameter type: <Vlan::CircuitIdPppoe>
optional parameter with default
Format:
value: "disable"
( disable
The parameter is not visible
| customer-id
during creation.
| physical-id
the circuitid sub option for pppoe
| ccsa-format )
relay
Possible values:
- disable : no circuit id
- customer-id : customer identity as circuit id
- physical-id : physical line identity as circuit id
- ccsa-format : circuit id in ccsa format
Parameter type: <Vlan::RemoteIdPppoe>
optional parameter with default
Format:
value: "disable"
( disable
The parameter is not visible
| customer-id
during creation.
| physical-id )
the remoteid sub option for pppoe
Possible values:
relay
- disable : no remote id
- customer-id : customer identity as remote id
- physical-id : physical line identity as remote id
Parameter type: <Vlan::NewSecureForward>
optional parameter with default
Format:
value: "inherit"
( inherit
enable new-secure-forwarding for
| disable
the vlan
| enable )
Possible values:
- inherit : inherit new-secure-forwarding
- disable : disable new-secure-forwarding
- enable : enable new-secure-forwarding
Parameter type: <Vlan::MacAgingTime>
optional parameter with default
Format:
value: -1
- mac aging time in seconds
Mac aging time in seconds; i.c.o
- unit: sec
default,the system level value is
- range: [-1,10...1000000]
applicable.
Parameter type: boolean
optional parameter
enable l2cp-transparent
Parameter type: <Vlan::Dhcpv6InterfaceId>
optional parameter with default
Format:
value: "disable"
( disable
The parameter is not visible
| customer-id
during creation.
| physical-id
dhcpv6-itf-id
| ccsa-format )
Possible values:
- disable : no interface id
- customer-id : customer identity as interface id
- physical-id : physical line identity as interface id
- ccsa-format : interface id in ccsa format
Parameter type: <Vlan::Dhcpv6RemoteId>
optional parameter with default
Format:
value: "disable"
( disable
The parameter is not visible
| customer-id
during creation.
| physical-id )
dhcpv6-remote-id
Possible values:

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Parameter

[no] dhcpv6-trst-port

[no] enterprise-number

Type
- disable : no interface id
- customer-id : customer identity as interface id
- physical-id : physical line identity as interface id
Parameter type: <Vlan::Dhcpv6TrstPort>
Format:
( trusted
| untrusted )
Possible values:
- trusted : trusted port
- untrusted : untrusted port
Parameter type: <Vlan::Enterprisenumber>
Format:
- enterprise number
- range: [1...4294967295]

Description

optional parameter with default


value: "untrusted"
The parameter is not visible
during creation.
dhcpv6-trst-port
optional parameter with default
value: "3561"
The parameter is not visible
during creation.
enterprise number
optional parameter
The parameter is not visible
during creation.
enable icmpv6 secure filter
optional parameter with default
value: "default"
qos ingress profile name

[no] icmpv6-sec-fltr

Parameter type: boolean

[no] in-qos-prof-name

Parameter type: <Qos::QosIngressProfileName>


Format:
( default
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- default : default profile name
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: boolean
optional parameter
enable ipv4 multicast control:
forward ipv4 multicast frames in
this vlan
Parameter type: boolean
optional parameter
enable ipv6 multicast control:
forward ipv6 multicast frames in
this vlan
Parameter type: boolean
optional parameter
enable mac multicast control:
forward mac multicast frames in
this vlan
Parameter type: boolean
optional parameter
disable RIP-IPv4 protocol
Parameter type: boolean
optional parameter
enable ntp protocol
Parameter type: boolean
optional parameter
disable IP anti-spoofing
Parameter type: boolean
optional parameter
enable unknown unicast flooding
Parameter type: boolean
optional parameter
enable flooding on unicast GEM
port
Parameter type: boolean
optional parameter
enable mac movement in this
vlan
Parameter type: <Vlan::cvlan4095Passthru>
optional parameter with default

[no] ipv4-mcast-ctrl

[no] ipv6-mcast-ctrl

[no] mac-mcast-ctrl

[no] dis-proto-rip
[no] proto-ntp
[no] dis-ip-antispoof
[no] unknown-unicast
[no] pt2ptgem-flooding
[no] mac-movement-ctrl
[no] cvlan4095passthru

3HH-04416-EBAA-TCZZA 01

Released

603

20 VLAN Configuration Commands

Parameter

604

Released

Type

Description

Format:
( passthru
| not-applicable )
Possible values:
- passthru : Allow passthru of cvlan 4095 - applicable only
for SVLANCC
- not-applicable : Legacy behavior

value: "not-applicable"
CVLAN
4095
tunneling
behavior. Only applicable for
SVLANCC forwarder

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.5 VLAN Filtering Database Configuration


Command
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN and
unicast MAC address.
This information is used by the bridge in determining how to propagate a received frame.
Use of this command is disencouraged because it will be obsoleted and replaced in the future by the VLAN Port
Filtering Database Configuration command.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan ( no unicast-mac (unicast-mac) vlan-id <Vlan::StackedVlan> ) | ( unicast-mac (unicast-mac)
vlan-id <Vlan::StackedVlan> forward-port <Itf::AtmInterfaceVpiVci> )

Command Parameters
Table 20.5-1 "VLAN Filtering Database Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(unicast-mac)

Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

unicast mac address

vlan-id

network vlan id

Table 20.5-2 "VLAN Filtering Database Configuration Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

605

20 VLAN Configuration Commands

Parameter

Type

forward-port

Parameter type: <Itf::AtmInterfaceVpiVci>


mandatory parameter
Format:
forward bridge port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

606

Released

Description

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.6 VLAN Port Filtering Database Configuration


Command
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN Port and
unicast MAC address.
This information is used by the bridge in determining how to propagate a received frame.
This command will in time obsolete and replace the VLAN Filtering Database Configuration command. Already
now, it must be used in case multiple vlan ports are configured on the same bridge port and attached to the same
I-Bridge.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan ( no vlan-port (port) unicast-mac <Vlan::MacAddr> ) | ( vlan-port (port) unicast-mac
<Vlan::MacAddr> )

Command Parameters
Table 20.6-1 "VLAN Port Filtering Database Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>

3HH-04416-EBAA-TCZZA 01

Description
vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:

Released

607

20 VLAN Configuration Commands

Resource Identifier

Description

<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::MacAddr>
unicast mac address
Format:

unicast-mac

608

Type

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Resource Identifier

Type

Description

- mac address (aa:bb:cc:a1:02:03)


- length: 6

3HH-04416-EBAA-TCZZA 01

Released

609

20 VLAN Configuration Commands

20.7 VLAN Protocol-based Configuration


Command
Command Description
For protocol-based VLANs, this command allows the operator to specify how incoming traffic on a port is
allocated to a particular VLAN and priority.
For Ethernet frames, the mapping to either the PPPoE or IPoE protocol is:
protocol value 0x8863: PPPoE
protocol value 0x8864: PPPoE
protocol value 0x0800: IPoE
protocol value 0x0806: IPoE
protocol value 0x8035: IPoE
For RFC_1042 frames the mapping to either PPPoE or IPoE protocol is:
protocol value 0x8863: PPPoE
protocol value 0x8864: PPPoE
protocol value 0x0800: IPoE
protocol value 0x0806: IPoE
protocol value 0x8035: IPoE
priority: The selection of the priority for upstream frames, in case of a protocol based vlan, is not dependent on the
configuration of the priority-policy configured at node level.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan ( no port-protocol (port) protocol-group <Vlan::GroupId> ) | ( port-protocol (port) protocol-group
<Vlan::GroupId> vlan-id <Vlan::StackedVlan> priority <Vlan::Priority> )

Command Parameters
Table 20.7-1 "VLAN Protocol-based Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>

610

Released

Description
identity of a port(e.g. atm PVC,
/ EFM port,...)
/
/
/

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Resource Identifier

protocol-group

Type

Description

<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::GroupId>
protocol group
Format:
( pppoe
| ipoe
| ipv6oe )
Possible values:
- pppoe : PPPoE
- ipoe : IPv4oE
- ipv6oe : IPv6oE

Table 20.7-2 "VLAN Protocol-based Configuration Command" Command Parameters


Parameter

Type

Description

vlan-id

Parameter type: <Vlan::StackedVlan>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]

mandatory parameter
protocol group vlan id

3HH-04416-EBAA-TCZZA 01

Released

611

20 VLAN Configuration Commands

Parameter

Type

priority

Field type <Vlan::CVlanIndex>


- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]

612

Released

Description

mandatory parameter
priority of protocol based vlan

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.8 SHub General VLAN Configuration Command


Command Description
This command allows the operator to specify the tagging mode globally applicable to SHub VLANs.
Setting means that the SHub works as a stacked-VLAN bridge in dual tagged mode.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub [ [ no ] dual-tag-mode ]

Command Parameters
Table 20.8-2 "SHub General VLAN Configuration Command" Command Parameters
Parameter

Type

Description

[no] dual-tag-mode

Parameter type: boolean

optional parameter
vlan stacking is active

3HH-04416-EBAA-TCZZA 01

Released

613

20 VLAN Configuration Commands

20.9 SHub VLAN Configuration Command


Command Description
This command allows the operator to specify a VLAN and its attributes on the SHub.
Clarification regarding 'entry-status': If a failure occurs during the configuration of VLAN, please check if the
VLAN was created and if the corresponding entry-status is valid. If not, please delete and re-create the entire
VLAN.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub ( no id (vlanid) ) | ( id (vlanid) [ no name | name <Vlan::AdminName> ] mode
<Shub::SystemMode> [ [ no ] mac-move-allow ] [ [ no ] mac-learning-off ] [ user2-comm
<Shub::UserToUserCommStatus> ] )

Command Parameters
Table 20.9-1 "SHub VLAN Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 20.9-2 "SHub VLAN Configuration Command" Command Parameters


Parameter

Type

Description

[no] name

Parameter type: <Vlan::AdminName>


Format:
- char string
- length: x<=32
Parameter type: <Shub::SystemMode>
Format:
( cross-connect
| residential-bridge
| layer2-terminated
| layer2-term-nwport
| v-vlan
| reserved
| voice-vlan )
Possible values:
- cross-connect : crossconnect vlan
- residential-bridge : residential bridge vlan
- layer2-terminated : layer2 terminated vlan

optional parameter with default


value: ""
name

mode

614

Released

mandatory parameter
The parameter is not visible
during modification.
mode

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Parameter

Type

[no] mac-move-allow
[no] mac-learning-off
user2-comm

Description

- layer2-term-nwport : layer2 terminated vlan on network


port
- v-vlan : virtual vlan
- reserved : internal and external communication via vlan
- voice-vlan : voice vlan
Parameter type: boolean
optional parameter
mac move allowed
Parameter type: boolean
optional parameter
disable mac-learning
Parameter type: <Shub::UserToUserCommStatus>
optional parameter
Format:
user-2-user communication status
( enable
| disable )
Possible values:
- enable : user-2-user communication enable
- disable : user-2-user communication disable

Command Output
Table 20.9-3 "SHub VLAN Configuration Command" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::WaitRowStatusVlan>


( valid
| corrupted
| corrupted )
Possible values:
- valid : VLAN configuration is ok
corrupted
:
VLAN
configuration
operational(not-in-service)
corrupted
:
VLAN
configuration
operational(not-ready)

the status of the VLAN instance


This element is only shown in
detail mode.

is

not

is

not

Released

615

20 VLAN Configuration Commands

20.10 SHub Static Egress Port for VLAN


Configuration Command
Command Description
This command allows the operator to specify the set of ports that are statically allocated as egress ports for the
specified VLAN.
egress-port: controller port (nt) is not supported in NANT-A and ECNT-C board.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) ( no egress-port (port) ) | ( egress-port (port) )

Command Parameters
Table 20.10-1 "SHub Static Egress Port for VLAN Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number

vlan id

(port)

616

Released

egress port

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

3HH-04416-EBAA-TCZZA 01

Released

617

20 VLAN Configuration Commands

20.11 SHub Static Untagged Egress Port for VLAN


Configuration Command
Command Description
This command allows the operator to specify the egress ports that should transmit packets for this VLAN as
untagged.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) ( no untag-port (port) ) | ( untag-port (port) )

Command Parameters
Table 20.11-1 "SHub Static Untagged Egress Port for VLAN Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]
Format:
( network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- network : network port
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

vlan id

(port)

618

Released

the untagged network port

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.12 SHub Unicast MAC Filtering Database


Configuration Command
Command Description
This command allows the operator to specify entries in the Layer 2 filtering database for a specific VLAN and
unicast MAC address. This configuration applies to the SHub.
This information is used by the bridge in determining how to propagate a received frame.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub ( no unicast-mac (unicast-mac) vlan-id <Sys::VlanId> ) | ( unicast-mac (unicast-mac) vlan-id
<Sys::VlanId> forward-port <Shub::UcastForwardPort> )

Command Parameters
Table 20.12-1 "SHub Unicast MAC Filtering Database Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(unicast-mac)

Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Sys::VlanId>
Format:
- vlan id
- range: [1...4093]

unicast mac address

vlan-id

vlan id

Table 20.12-2 "SHub Unicast MAC Filtering Database Configuration Command" Command
Parameters
Parameter

Type

Description

forward-port

Parameter type: <Shub::UcastForwardPort>


Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board

mandatory parameter
forward port

3HH-04416-EBAA-TCZZA 01

Released

619

20 VLAN Configuration Commands

Parameter

Type

Description

- network : network port


- nt : port of the nt
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number

620

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

20.13 Vlan Pbit Traffic Counter Configuration


Command
Command Description
This command allows the operator to configure the p-bit traffic counter.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan pbit-statistics ( no port (vlan-port) min-dot1p <Vlan::Dot1pMin> max-dot1p <Vlan::Dot1pMax> )
| ( port (vlan-port) min-dot1p <Vlan::Dot1pMin> max-dot1p <Vlan::Dot1pMax> )

Command Parameters
Table 20.13-1 "Vlan Pbit Traffic Counter Configuration Command" Resource Parameters
Resource Identifier

Type

(vlan-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni

3HH-04416-EBAA-TCZZA 01

Description
vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:

Released

621

20 VLAN Configuration Commands

Resource Identifier

Description

stacked : <Eqpt::SVlan> : <Eqpt::CVlan>


| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::Dot1pMin>
min p-bit value
Format:
- dot1p value range
- range: [0...7]
Parameter type: <Vlan::Dot1pMax>
max p-bit value
Format:
- dot1p value range
- range: [0...7]

min-dot1p

max-dot1p

622

Type

Released

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

3HH-04416-EBAA-TCZZA 01

Released

623

20 VLAN Configuration Commands

20.14 Vlan Priority Regeneration Profile


Configuration Command
Command Description
This command allows the operator to configure a priority regeneration profile. The priority regeneration profile
table stores the pbit to TC mappings that can be used by a L2 Forwarder in the upstream and downstream
directions. The first 10 profiles are hard-coded and may be neither edited nor deleted.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan ( no priority-regen (profile-idx) ) | ( priority-regen (profile-idx) profile-name <AsamProfileName>
[ no pbit0 | pbit0 <Vlan::NibbleMaskRestricted_0> ] [ no pbit1 | pbit1 <Vlan::NibbleMaskRestricted_1> ] [ no
pbit2 | pbit2 <Vlan::NibbleMaskRestricted_2> ] [ no pbit3 | pbit3 <Vlan::NibbleMaskRestricted_3> ] [ no pbit4 |
pbit4 <Vlan::NibbleMaskRestricted_4> ] [ no pbit5 | pbit5 <Vlan::NibbleMaskRestricted_5> ] [ no pbit6 | pbit6
<Vlan::NibbleMaskRestricted_6> ] [ no pbit7 | pbit7 <Vlan::NibbleMaskRestricted_7> ] )

Command Parameters
Table 20.14-1 "Vlan Priority Regeneration Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(profile-idx)

Format:
- a unique index value for the priority regeneration profile
- range: [11...32]

A unique profile index

Table 20.14-2 "Vlan Priority Regeneration Profile Configuration Command" Command


Parameters
Parameter

Type

Description

profile-name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Vlan::NibbleMaskRestricted_0>
Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_1>
Format:
- nibble mask
- range: [0...8]

mandatory parameter
A unique profile name

[no] pbit0

[no] pbit1

624

Released

optional parameter with default


value: 8
pbit mapping corresponding to
pbit0
optional parameter with default
value: 8
pbit mapping corresponding to
pbit1

3HH-04416-EBAA-TCZZA

01

20 VLAN Configuration Commands

Parameter

Type

Description

[no] pbit2

Parameter type: <Vlan::NibbleMaskRestricted_2>


Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_3>
Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_4>
Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_5>
Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_6>
Format:
- nibble mask
- range: [0...8]
Parameter type: <Vlan::NibbleMaskRestricted_7>
Format:
- nibble mask
- range: [0...8]

optional parameter with default


value: 8
pbit mapping corresponding to
pbit2
optional parameter with default
value: 8
pbit mapping corresponding to
pbit3
optional parameter with default
value: 8
pbit mapping corresponding to
pbit4
optional parameter with default
value: 8
pbit mapping corresponding to
pbit5
optional parameter with default
value: 8
pbit mapping corresponding to
pbit6
optional parameter with default
value: 8
pbit mapping corresponding to
pbit7

[no] pbit3

[no] pbit4

[no] pbit5

[no] pbit6

[no] pbit7

3HH-04416-EBAA-TCZZA 01

Released

625

21- Bridge Configuration Commands

21.1 Bridge Configuration Command Tree


21.2 Bridge General Configuration Command
21.3 Bridge Port Configuration Command
21.4 Bridge Port to VLAN Association Configuration
Command
21.5 L2 Static User Ip Address Configuration Command
21.6 L2 Static User Ipv6 Address Configuration Command
21.7 SHub Bridge Configuration Command
21.8 SHub Bridge Port Configuration Command
21.9 Mac learning Configuration Command

626

Released

21-627
21-629
21-630
21-636
21-642
21-644
21-646
21-647
21-649

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

21.1 Bridge Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Bridge Configuration Commands".

Command Tree
----configure
----bridge
- [no] ageing-time
----[no] port
- (port)
- [no] pvid
- [no] default-priority
- [no] mac-learn-off
- [no] max-unicast-mac
- [no] qos-profile
- [no] prio-regen-prof
- [no] prio-regen-name
- [no] max-committed-mac
- [no] mirror-mode
- [no] mirror-vlan
- [no] pvid-tagging-flag
----[no] vlan-id
- (index)
- [no] tag
- [no] network-vlan
- [no] vlan-scope
- [no] qos
- [no] qos-profile
- [no] prior-best-effort
- [no] prior-background
- [no] prior-spare
- [no] prior-exc-effort
- [no] prior-ctrl-load
- [no] prior-less-100ms
- [no] prior-less-10ms
- [no] prior-nw-ctrl
- [no] in-qos-prof-name
- [no] max-up-qos-policy
- [no] max-ip-antispoof
- [no] max-unicast-mac
- [no] max-ipv6-antispf
- [no] mac-learn-ctrl
- [no] ds-dedicated-q
----static-user
----[no] ip-address
- (ipaddr)
----[no] ipv6-address
- (prefixandlength)
----shub
- [no] ageing-time

3HH-04416-EBAA-TCZZA 01

Released

627

21 Bridge Configuration Commands

----port
- (network-port)
- [no] default-priority
- [no] pvid
- [no] accept-frame-type
X [no] enable-dual-tag
- [no] force-add-tag
- [no] enable-pbit-mode
----mac-learning
- [no] disable-nw-port

628

Released

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

21.2 Bridge General Configuration Command


Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire bridge.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge [ no ageing-time | ageing-time <Vlan::AgingTime> ]

Command Parameters
Table 21.2-2 "Bridge General Configuration Command" Command Parameters
Parameter

Type

Description

[no] ageing-time

Parameter type: <Vlan::AgingTime>


Format:
- ageing time
- unit: sec
- range: [10...1000000]

optional parameter with default


value: 300
ageing timeout for dynamic mac
entries

3HH-04416-EBAA-TCZZA 01

Released

629

21 Bridge Configuration Commands

21.3 Bridge Port Configuration Command


Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port. These
parameters determine the handling of frames on the bridge port.
Priority Regeneration Profile: these profiles are predetermined. Following profiles are available:
Profile 1: Trusted Port
Profile 2: Best Effort
Profile 3: Controlled Load, all priority 3 traffic
Profile 4: Controlled Load, all priority 4 traffic
Profile 5: Background
Profile 6: Best Effort, Controlled Load, Voice
Profile 7: Best Effort, Controlled Load, Voice according 802.1d Annex G
Profile 8: Best Effort, Voice
Profile 9: L2 VPN with 3 traffic classes
Profile 10: L2 VPN with 4 traffic classes
Details on these profiles can be obtained using a show command.
The parameter 'acceptable-frame-type' controls the format of frames received from the users. The parameter can
take either of three values,
single-tagged: This configuration allows the user to send single tagged frames. The VLAN-id of tagged frames will
be verified against the configured port-vlan associations. Untagged frames and priority tagged frames will be
discarded (in absence of configuration on how to handle untagged and priority tagged frames). Double tagged
frames will be discarded. The configuration of this value should be completed with the configuration of:
one or more port-vlan associations.
The configuration of this value should not be combined with the configuration of:
a port default vlan, or
a port-protocol default vlan for PPPoE, or
a terminated PPPoE interface, or
a port-protocol default vlan for IPoE, or
a terminated IPoE interface.
untagged: This configuration allows the user to send untagged frames and on some types of HW also priority
tagged frames. Processing untagged / priority tagged frames requires additional configuration. Such frames will be
discarded in absence of such additional configuration. The configuration of the acceptable-Frame-Type to this
value results also in the autonomous creation by the system of an 'IGMP channel' and of an '802.1x Port'
associated to this Bridge Port. These objects are created with default values such that the corresponding function is
'disabled'. The configuration this value should be completed with the creation of:
one or more port-vlan associations and
a port default vlan, and/or
a port-protocol default vlan for PPPoE, and/or
a port-protocol default vlan for IPoE,
or instead of a port-protocol default vlan for PPPoE.
a terminated PPPoE interface, or
or instead of a port-protocol default vlan for IPoE.
a terminated IPoE interface.
However, note that this value is not always strictly forced on all HW. E.g. some type of LSMs will accept and

630

Released

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

forward single tagged frames when the VLAN-id matches a configured port-vlan association. Other type of LSMs
will always discard single tagged frame.
Note that for the multivlan feature, tagged user traffic will be sent but the "acceptable frame types" must be set to
"untagged".
mixed-untagged: This value allows the user to send single tagged frames, untagged frames, and on some types of
HW also priority tagged frames. The VLAN-id of single tagged frames will be verified against the configured
port-vlan associations. Untagged / priority tagged frames will be processed according additional configuration.
Such frames will be discarded in absence of such additional configuration. The configuration of this value should
be completed with the configuration of:
one or more port-vlan associations, and
a port default vlan, and/or
a port-protocol default vlan for PPPoE, and/or
a port-protocol default vlan for IPoE.
default-priority: The selection of the port default-priority can apply provided the priority-policy at node level is
port-default.
mac-learn-off : The configuration value has no effect in case the bridge port is used for IpoA CC and EPON
boards: the system accepts all values but no mac learning will be done.
Remark: Please note that in case the RADIUS server returns a VLAN for 802.1x authenticated ports, it is
recommended to not configure a port default VLAN ID (PVID) on that user port. In any case, the VLAN ID
returned by the RADIUS server may not equal the pre- configured PVID on the user port. In addition, the returned
VLAN ID by the RADIUS server may not be configured as the PVID on the user port after successful 802.1x
authentication.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge ( no port (port) ) | ( port (port) [ no pvid | pvid <Vlan::StackedVlan> ] [ no default-priority |
default-priority <Vlan::Priority> ] [ [ no ] mac-learn-off ] [ no max-unicast-mac | max-unicast-mac
<Vlan::MaxMac> ] [ no qos-profile | qos-profile <Qos::QosSessionProfileName> ] [ no prio-regen-prof |
prio-regen-prof
<Vlan::PrioRegenProfile>
]
[
no
prio-regen-name
|
prio-regen-name
<Vlan::PrioRegenProfileName> ] [ no max-committed-mac | max-committed-mac <Vlan::ComitMaxMac> ] [ no
mirror-mode | mirror-mode <Vlan::MirrorMode> ] [ no mirror-vlan | mirror-vlan <Vlan::MirrorVlan> ] [ no
pvid-tagging-flag | pvid-tagging-flag <Vlan::PvidTaggingFlag> ] )

Command Parameters
Table 21.3-1 "Bridge Port Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>

3HH-04416-EBAA-TCZZA 01

Description
identity of a port(e.g. uplink port,
/ atm pvc, efm port, eth port, la
group ...)
/
/
/

Released

631

21 Bridge Configuration Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 21.3-2 "Bridge Port Configuration Command" Command Parameters


Parameter

Type

Description

[no] pvid

Parameter type: <Vlan::StackedVlan>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: boolean

optional parameter with default


value: "stacked : 0 : 4097"
The parameter is not visible
during creation.
default vlan id for untagged
frames

[no] default-priority

[no] mac-learn-off

632

Released

optional parameter with default


value: 0
priority to be set in upstream
frames
optional parameter
disable self learning of mac

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Parameter

Type

[no] max-unicast-mac

Parameter type: <Vlan::MaxMac>


Format:
- number of unicast mac addresses
- range: [1...8192]
Parameter type: <Qos::QosSessionProfileName>
Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::PrioRegenProfile>
Format:
( none
| trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3
| l2-vpn-4
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21
| 22
| 23
| 24
| 25
| 26
| 27
| 28
| 29
| 30
| 31
| 32 )
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic

[no] qos-profile

[no] prio-regen-prof

3HH-04416-EBAA-TCZZA 01

Description
address
optional parameter with default
value: "1"
max uncommitted unicast mac
addresses
optional parameter with default
value: "none"
qos profile name

optional parameter with default


value: "none"
priority regeneration profile

Released

633

21 Bridge Configuration Commands

Parameter

Type

[no] prio-regen-name

[no] max-committed-mac

[no] mirror-mode

optional parameter with default


value: "none"
priority regeneration profile name

optional parameter with default


value: "65535"
max committed unicast mac
addresses. 65535 means the
committed value is the same as
max-unicast-mac
optional parameter with default
value: "disable"
flow mirroring mode of the
bridge port

Parameter type: <Vlan::MirrorMode>


Format:
( disable
| overwrite-outer-vlan )
Possible values:
- disable : disable mirror vlan tag
- overwrite-outer-vlan : overwrite outer vlan tag with mirror
vlan tag
Parameter type: <Vlan::MirrorVlan>
optional parameter with default
Format:
value: 0
- mirroring vlan id
vlan-id to be inserted into

[no] mirror-vlan

634

Description

- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Parameter type: <Vlan::PrioRegenProfileName>
Format:
( none
| name : <Vlan::IgnoredVlanProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::ComitMaxMac>
Format:
- number of unicast mac addresses
- range: [0...128,65535]

Released

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Parameter

[no] pvid-tagging-flag

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [0...4093]

mirrored
packets.
This
configuration value has no effect
in case mirroring mode of the
bridgeport
is
disabled
(mirror-mode).
optional parameter with default
value: "onu"
pvid will be tagged in ONU or in
OLT.

Parameter type: <Vlan::PvidTaggingFlag>


Format:
( onu
| olt )
Possible values:
- onu : pvid is handled in ONU.
- olt : pvid is handled in OLT.

Released

635

21 Bridge Configuration Commands

21.4 Bridge Port to VLAN Association


Configuration Command
Command Description
This command allows the operator to associate a VLAN to a bridge port and to define VLAN attributes on this port.
The parameters that allow to configure the priority bits (prior-best-effort till prior-nw-ctrl) only apply in case of a
qos-aware VLAN.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge port (port) ( no vlan-id (index) ) | ( vlan-id (index) [ no tag | tag <Vlan::PortUntagStatus> ] [ no
network-vlan | network-vlan <Vlan::StackedVlan> ] [ no vlan-scope | vlan-scope <Vlan::VlanScope> ] [ no qos |
qos <Vlan::QosPolicy> ] [ no qos-profile | qos-profile <Qos::QosSessionProfileName> ] [ [ no ] prior-best-effort ] [
[ no ] prior-background ] [ [ no ] prior-spare ] [ [ no ] prior-exc-effort ] [ [ no ] prior-ctrl-load ] [ [ no ]
prior-less-100ms ] [ [ no ] prior-less-10ms ] [ [ no ] prior-nw-ctrl ] [ no in-qos-prof-name | in-qos-prof-name
<Qos::QosIngressProfileNameForVlan> ] [ no max-up-qos-policy | max-up-qos-policy <Vlan::MaxUpQoSPolicy>
] [ no max-ip-antispoof | max-ip-antispoof <Vlan::MaxIpAntispoof> ] [ no max-unicast-mac | max-unicast-mac
<Vlan::BridgeMaxMac> ] [ no max-ipv6-antispf | max-ipv6-antispf <Vlan::MaxIpAntispoof> ] [ no mac-learn-ctrl |
mac-learn-ctrl <Vlan::MacLearnCtrl> ] [ no ds-dedicated-q | ds-dedicated-q <Vlan::DsDedicatedQueue> ] )

Command Parameters
Table 21.4-1 "Bridge Port to VLAN Association Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number

636

Released

Description
identity of a port(e.g. uplink port,
/ atm pvc, efm port, eth port, la
group ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Resource Identifier

(index)

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
vlan id
( <Vlan::UVlanIndex>
|
stacked
:
<Vlan::SVlanIndexStacked>
:
<Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndexStacked>
- service vlan identity
- range: [1...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

Table 21.4-2 "Bridge Port to VLAN Association Configuration Command" Command Parameters
Parameter

Type

Description

[no] tag

Parameter type: <Vlan::PortUntagStatus>


Format:
( untagged
| single-tagged
| priority-tagged )
Possible values:
- untagged : untagged outgoing frames
- single-tagged : singletagged outgoing frames
- priority-tagged : prioritytagged outgoing frames
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity

optional parameter with default


value: "untagged"
tag control for egress port

[no] network-vlan

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "stacked : 0 : 4097"
network vlan id

Released

637

21 Bridge Configuration Commands

Parameter

Type
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::VlanScope>
Format:
( network
| local )
Possible values:
- network : network wide scope
- local : local scope
Parameter type: <Vlan::QosPolicy>
Format:
( priority : <Vlan::Priority>
| profile : none
| profile : trusted-port
| profile : best-effort
| profile : cl-all-prio-3
| profile : cl-all-prio-4
| profile : background
| profile : be-cl-voice
| profile : be-cl-1d-voice
| profile : be-voice
| profile : l2-vpn-3
| profile : l2-vpn-4
| profile : 11
| profile : 12
| profile : 13
| profile : 14
| profile : 15
| profile : 16
| profile : 17
| profile : 18
| profile : 19
| profile : 20
| profile : 21
| profile : 22
| profile : 23
| profile : 24
| profile : 25
| profile : 26
| profile : 27
| profile : 28
| profile : 29
| profile : 30
| profile : 31
| profile : 32
| prio-regen-name : none
|
prio-regen-name
:
<Vlan::IgnoredVlanProfileName> )
Possible values:
- priority : fixed priority identify

[no] vlan-scope

[no] qos

638

Released

Description

optional parameter with default


value: "network"
the vlan scope

optional parameter with default


value: "profile : none"
the qos policy

name

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Parameter

[no] qos-profile

3HH-04416-EBAA-TCZZA 01

Type

Description

- profile : regeneration profile identify


- prio-regen-name : priority regeneration profile name
Field type <Vlan::Priority>
- priority of ethernet frames
- range: [0...7]
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosSessionProfileName>
optional parameter with default
Format:
value: "none"
( none
qos profile name
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.

Released

639

21 Bridge Configuration Commands

Parameter

Type

[no] prior-best-effort
[no] prior-background
[no] prior-spare
[no] prior-exc-effort
[no] prior-ctrl-load
[no] prior-less-100ms
[no] prior-less-10ms
[no] prior-nw-ctrl
[no] in-qos-prof-name

[no] max-up-qos-policy

[no] max-ip-antispoof

[no] max-unicast-mac

[no] max-ipv6-antispf

[no] mac-learn-ctrl

640

Released

Description

The currently allowed values can be shown with online-help.


Parameter type: boolean
optional parameter
enable best effort priority (value
0)
Parameter type: boolean
optional parameter
enable background priority (value
1)
Parameter type: boolean
optional parameter
enable spare priority (value 2)
Parameter type: boolean
optional parameter
enable the excellent effort
priority (value 3)
Parameter type: boolean
optional parameter
enable the controlled load priority
(value 4)
Parameter type: boolean
optional parameter
enable video <100ms latency and
jitter priority (value 5)
Parameter type: boolean
optional parameter
enable video <10ms latency and
jitter priority (value 6)
Parameter type: boolean
optional parameter
enable the network controlled
priority (value 7)
Parameter type: <Qos::QosIngressProfileNameForVlan>
optional parameter with default
Format:
value: "name : Default_TC0"
( default
The parameter is not visible
| name : <Qos::IgnoredQosProfileName> )
during modification.
Possible values:
a pointer to the Qos Profile that
- default : default profile name
maps pbits to TCs on a VLAN
- name : enter profile name to be associated
port basis
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::MaxUpQoSPolicy>
optional parameter with default
Format:
value: "0"
- the max number of Qos Policy numbers (ACL and CCL) the max number of Qos Policy
on a VLAN port basis
numbers (ACL and CCL) on a
- range: [0...8]
VLAN port basis
Parameter type: <Vlan::MaxIpAntispoof>
optional parameter with default
Format:
value: "65535"
- the max number of IP Antispoofing on a VLAN port basis the max number of IP address
- range: [0...8,65535]
number in IP antispoofing and/or
ARP relay
Parameter type: <Vlan::BridgeMaxMac>
optional parameter with default
Format:
value: "65535"
- number of unicast mac addresses
max uncommitted unicast mac
- range: [0...65535,65535]
addresses
Parameter type: <Vlan::MaxIpAntispoof>
optional parameter with default
Format:
value: "65535"
- the max number of IP Antispoofing on a VLAN port basis the max number of IPV6 address
- range: [0...8,65535]
number in IP antispoofing and/or
ARP relay
Parameter type: <Vlan::MacLearnCtrl>
optional parameter with default
Format:
value: "3"
- MAC addresses shall be learned 1: mac-learn is enabled 2: MAC address learned control

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Parameter

[no] ds-dedicated-q

Type

Description

mac-learn is disabled 3: mac-learn is inherited from bridge up(1), down(2), inherit from
port
bridgedPort(3)
- range: [1...3]
Parameter type: <Vlan::DsDedicatedQueue>
optional parameter with default
Format:
value: "disable"
( enable
Packets
use
dedicated
| disable )
downstream PON level queue
Possible values:
- enable : enable use of downstream dedicated Q
- disable : disable use of downstream dedicated Q

Command Output
Table 21.4-3 "Bridge Port to VLAN Association Configuration Command" Display parameters
Specific Information
name
prio-regen-name

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::PrioRegenProfileName>


priority regeneration profile name
( none
This element is only shown in
| name : <Vlan::IgnoredVlanProfileName> )
detail mode.
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

641

21 Bridge Configuration Commands

21.5 L2 Static User Ip Address Configuration


Command
Command Description
This command allows the operator to configure the IP-address for a user interface(vlan-port) of a L2 forwarder.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge port (port) vlan-id (index) static-user ( no ip-address (ipaddr) ) | ( ip-address (ipaddr) )

Command Parameters
Table 21.5-1 "L2 Static User Ip Address Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

642

Released

Description
identity of a port(e.g. uplink port,
/ atm pvc, efm port, eth port, la
group ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Resource Identifier

(index)

(ipaddr)

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Eqpt::PonId>


- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
vlan id
( <Vlan::UVlanIndex>
|
stacked
:
<Vlan::SVlanIndexStacked>
:
<Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndexStacked>
- service vlan identity
- range: [1...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Format:
inetaddress
<Ip::V4Address> / <Ip::PrefixLengthArpRelay>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthArpRelay>
- IP address prefix length
- range: [8...32]

Released

643

21 Bridge Configuration Commands

21.6 L2 Static User Ipv6 Address Configuration


Command
Command Description
This command allows the operator to configure the IPv6-address for a user interface(vlan-port) of a L2 forwarder.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge port (port) vlan-id (index) static-user ( no ipv6-address (prefixandlength) ) | ( ipv6-address
(prefixandlength) )

Command Parameters
Table 21.6-1 "L2 Static User Ipv6 Address Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

644

Released

Description
identity of a port(e.g. uplink port,
/ atm pvc, efm port, eth port, la
group ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

Resource Identifier

(index)

(prefixandlength)

3HH-04416-EBAA-TCZZA 01

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
vlan id
( <Vlan::UVlanIndex>
|
stacked
:
<Vlan::SVlanIndexStacked>
:
<Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndexStacked>
- service vlan identity
- range: [1...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Format:
ipv6 address prefix
<ipv6::Prefix> / <ipv6::PrefixLengthLimited>
Field type <ipv6::Prefix>
- IPv6-address
Field type <ipv6::PrefixLengthLimited>
- length of IPv6 address or prefix
- range: [49...64,128]

Released

645

21 Bridge Configuration Commands

21.7 SHub Bridge Configuration Command


Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire SHub bridge.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge shub [ no ageing-time | ageing-time <Shub::AgingTime> ]

Command Parameters
Table 21.7-2 "SHub Bridge Configuration Command" Command Parameters
Parameter

Type

Description

[no] ageing-time

Parameter type: <Shub::AgingTime>


Format:
- ageing time
- unit: sec
- range: [10...1000000]

optional parameter with default


value: 300
program ageing timeout for
dynamic mac entries

646

Released

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

21.8 SHub Bridge Port Configuration Command


Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port on the SHub.
These parameters determine the handling of frames on the bridge port.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge shub port (network-port) [ no default-priority | default-priority <Shub::PortPriority> ] [ no pvid |
pvid <Vlan::VlanOamIndex> ] [ no accept-frame-type | accept-frame-type <Shub::VlanFrameTypes> ] [ [ no ]
enable-dual-tag ] [ [ no ] force-add-tag ] [ [ no ] enable-pbit-mode ]

Command Parameters
Table 21.8-1 "SHub Bridge Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

the network port

Table 21.8-2 "SHub Bridge Port Configuration Command" Command Parameters


Parameter

Type

Description

[no] default-priority

Parameter type: <Shub::PortPriority>


Format:
- port priority
- range: [0...7]
Parameter type: <Vlan::VlanOamIndex>
Format:
- vlan id
- range: [1...4093]

optional parameter with default


value: "0"
default ingress user priority

[no] pvid

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 1
port vlan id

Released

647

21 Bridge Configuration Commands

Parameter

Type

Description

[no] accept-frame-type

optional parameter with default


value: "all"
accept frame types

[no] enable-dual-tag

Parameter type: <Shub::VlanFrameTypes>


Format:
( all
| tagged )
Possible values:
- all : admit all frame types
- tagged : admit only vlan tagged
Parameter type: boolean

[no] force-add-tag

Parameter type: boolean

[no] enable-pbit-mode

Parameter type: boolean

648

Released

obsolete parameter replaced by


parameter "force-add-tag"
enable dual tag
optional parameter
enable force add tag
optional parameter
copy pbit mode

3HH-04416-EBAA-TCZZA

01

21 Bridge Configuration Commands

21.9 Mac learning Configuration Command


Command Description
This command allows the operator to configure the mac learning states.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge shub mac-learning [ [ no ] disable-nw-port ]

Command Parameters
Table 21.9-2 "Mac learning Configuration Command" Command Parameters
Parameter

Type

Description

[no] disable-nw-port

Parameter type: boolean

optional parameter
disable network
learning function

3HH-04416-EBAA-TCZZA 01

Released

649

port

mac

22- Link Aggregation Configuration Commands

22.1 Link Aggregation Configuration Command Tree


22.2 Link Aggregation Configuration Command
22.3 Link Aggregation Group Configuration Command

650

Released

22-651
22-652
22-653

3HH-04416-EBAA-TCZZA

01

22 Link Aggregation Configuration Commands

22.1 Link Aggregation Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Link Aggregation Configuration Commands".

Command Tree
----configure
----la
- [no] disable-lacp
----aggregator-port
- (network-port)
- name
- [no] link-up-down-trap
- [no] actor-sys-prio
- selection-policy
- actor-key
- [no] actor-port-prio
- [no] active-lacp
- [no] short-timeout
- [no] aggregatable
- lacp-mode

3HH-04416-EBAA-TCZZA 01

Released

651

22 Link Aggregation Configuration Commands

22.2 Link Aggregation Configuration Command


Command Description
This command allows the operator to configure the Link Aggregation on the SHub. It allows the operator to enable
or disable the Link Aggregation feature.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure la [ [ no ] disable-lacp ]

Command Parameters
Table 22.2-2 "Link Aggregation Configuration Command" Command Parameters
Parameter

Type

Description

[no] disable-lacp

Parameter type: boolean

optional parameter
la
module
stops
operations

652

Released

3HH-04416-EBAA-TCZZA

01

protocol

22 Link Aggregation Configuration Commands

22.3 Link Aggregation Group Configuration


Command
Command Description
This command allows the operator to specify the Link Aggregation Group parameters. The configuration should be
performed for the primary link. Link Aggregation Group is identified by means of the primary link, also referred to
as aggregator-port. The primary link for an aggregation group is the link with the lowest SHub logical port number
within the group, provided the operational state of the link is UP. (Note: Lowest SFP faceplate number in the
aggregation group is not necessarily the lowest SHub logical port number. Some lower SFP faceplate numbers are
mapped to higher SHub logical port numbers internally.)
The configuration should be performed for the primary link. The settings configured for the primary link of the
aggregation group apply to each and every link that is a member of the Link Aggregation Group.
The link that is denoted as primary link may change during the lifetime of the aggregation group. To cope with this
phenomenon, the operator is advised to repeat the configurations described in this section for each link of the
aggregation group. Care shall be taken to configure identical settings for all links within the aggregation group.
The primary link can be learned using a show command.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure la aggregator-port (network-port) [ name <Shub::AggName> ] [ [ no ] link-up-down-trap ] [ no
actor-sys-prio | actor-sys-prio <Shub::LaPortActorSysPriority> ] [ selection-policy <Shub::AggSelectPolicy> ] [
actor-key <Shub::LacpKey> ] [ no actor-port-prio | actor-port-prio <Shub::LaPortActorPortPriority> ] [ [ no ]
active-lacp ] [ [ no ] short-timeout ] [ [ no ] aggregatable ] [ lacp-mode <Shub::LacpMode> ]

Command Parameters
Table 22.3-1 "Link Aggregation Group Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port

interface index of network port

3HH-04416-EBAA-TCZZA 01

Released

653

22 Link Aggregation Configuration Commands

Resource Identifier

Type

Description

- eth : ethernet port (or lemi)


Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

Table 22.3-2 "Link Aggregation Group Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <Shub::AggName>


Format:
- char string
- length: x<=20
Parameter type: boolean

optional parameter
aggregate name

[no] link-up-down-trap
[no] actor-sys-prio

[no] active-lacp

Parameter type: <Shub::LaPortActorSysPriority>


Format:
- la aggregate actor system priority
- range: [0...65535]
Parameter type: <Shub::AggSelectPolicy>
Format:
( mac-src
| mac-dst
| mac-src-dst
| ip-src
| ip-dst
| ip-src-dst )
Possible values:
- mac-src : source mac based
- mac-dst : destination mac based
- mac-src-dst : source and destination mac based
- ip-src : source ip based
- ip-dst : destination ip based
- ip-src-dst : source and destination ip based
Parameter type: <Shub::LacpKey>
Format:
- link aggregate key
- range: [0...65535]
Parameter type: <Shub::LaPortActorPortPriority>
Format:
- la aggregate actor port priority
- range: [0...255]
Parameter type: boolean

[no] short-timeout

Parameter type: boolean

[no] aggregatable

Parameter type: boolean

lacp-mode

Parameter type: <Shub::LacpMode>


Format:
( enable-lacp
| disable-lacp
| manual )
Possible values:
- enable-lacp : enable lacp
- disable-lacp : disable lacp
- manual : manual aggregation

selection-policy

actor-key

[no] actor-port-prio

654

Released

optional parameter
enable link up down trap
optional parameter with default
value: "1"
actor system priority
optional parameter
link aggregation selection policy

optional parameter
key for the actor
optional parameter with default
value: "1"
port priority for the actor
optional parameter
set lacp active for the actor
optional parameter
short timeout for the lacp
protocol
optional parameter
port is candidate to be aggregated
optional parameter
lacp mode

3HH-04416-EBAA-TCZZA

01

22 Link Aggregation Configuration Commands

3HH-04416-EBAA-TCZZA 01

Released

655

23- Multiple Spanning Tree Configuration


Commands

23.1 Multiple Spanning Tree Configuration Command Tree


23.2 SHub MSTP general configuration Command
23.3 SHub MSTP Instance configuration Command
23.4 SHub MSTP Vlan-Instance Mapping configuration
Command
23.5 SHub MSTP Port configuration Command
23.6 SHub MSTP Port-Instance configuration Command

656

Released

23-657
23-658
23-660
23-661
23-662
23-664

3HH-04416-EBAA-TCZZA

01

23 Multiple Spanning Tree Configuration Commands

23.1 Multiple Spanning Tree Configuration


Command Tree
Description
This chapter gives an overview of nodes that are handled by "Multiple Spanning Tree Configuration Commands".

Command Tree
----configure
----mstp
----general
- [no] disable-stp
- [no] priority
- [no] max-age
- [no] hello-time
- [no] forward-delay
- [no] version
- [no] tx-hold-count
- [no] path-cost-type
- [no] max-hop-count
- region-name
- [no] region-version
- [no] config-id-sel
----[no] instance
- (instance)
- [no] priority
----[no] associate-vlan
- (vlan)
----port
- (port)
- [no] priority
- [no] disable-stp
- path-cost
- [no] edge-port
- [no] admin-p2p
- [no] hello-time
----port-instance
- (network-port)
- instance
- [no] priority
- [no] disable-stp
- path-cost

3HH-04416-EBAA-TCZZA 01

Released

657

23 Multiple Spanning Tree Configuration Commands

23.2 SHub MSTP general configuration Command


Command Description
This command allows the operator to configure the general MSTP parameters .The configuration of the parameters
apply for the whole bridge.This configuration applies to the SHub.
The port, instance and port-instance specific MSTP parameters are in subsequent chapters.
The bridge max-age value should be less than or equal to (2 * ((forward-delay/100)-1) and should be greater than
or equal to (2 * ((Port hello-time/100) + 1)).
The bridge hello-time is only applicable when the version is stp/rstp, in case of version mstp the port hello-time is
used.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mstp general [ [ no ] disable-stp ] [ no priority | priority <Shub::StpPriority> ] [ no max-age | max-age
<Shub::StpMaxAge> ] [ no hello-time | hello-time <Shub::StpHelloTime> ] [ no forward-delay | forward-delay
<Shub::StpFwDelay> ] [ no version | version <Shub::StpProtVersion> ] [ no tx-hold-count | tx-hold-count
<Shub::StpTxHoldCount> ] [ no path-cost-type | path-cost-type <Shub::StpPathCostType> ] [ no max-hop-count |
max-hop-count <Shub::StpMaxHopCount> ] [ region-name <Shub::StpRegionName> ] [ no region-version |
region-version <Shub::StpRegionVersion> ] [ no config-id-sel | config-id-sel <Shub::StpConfigIdSelector> ]

Command Parameters
Table 23.2-2 "SHub MSTP general configuration Command" Command Parameters
Parameter

Type

Description

[no] disable-stp

Parameter type: boolean

[no] priority

Parameter type: <Shub::StpPriority>


Format:
- stp bridge priority(n*4096)
- range: [0...61440]
Parameter type: <Shub::StpMaxAge>
Format:
- stp bridge priority(n*100)
- unit: 10msec
- range: [600...4000]
Parameter type: <Shub::StpHelloTime>
Format:
- stp bridge hello time(n*100)
- unit: 10msec
- range: [100...1000]

optional parameter
all stp protocol operations stop
optional parameter with default
value: 32768
stp bridge priority(n*4096)

[no] max-age

[no] hello-time

658

Released

optional parameter with default


value: 2000
stp
max-age
for
root-bridge(n*100)
optional parameter with default
value: 200
stp hello-time for bridge acting as
root(n*100)

3HH-04416-EBAA-TCZZA

01

23 Multiple Spanning Tree Configuration Commands

Parameter

Type

Description

[no] forward-delay

Parameter type: <Shub::StpFwDelay>


Format:
- stp bridge forward delay(n*100)
- unit: 10msec
- range: [400...3000]
Parameter type: <Shub::StpProtVersion>
Format:
( stp-compatible
| rstp
| mstp )
Possible values:
- stp-compatible : spanning tree protocol IEEE 802.1D
- rstp : rapid spanning tree protocol IEEE 802.1w
- mstp : multiple spanning tree protocol IEEE 802.1s
Parameter type: <Shub::StpTxHoldCount>
Format:
- maximum transmission rate limit
- range: [1...10]
Parameter type: <Shub::StpPathCostType>
Format:
( 16-bit
| 32-bit )
Possible values:
- 16-bit : stp-8021d-1998 path cost
- 32-bit : stp-8021t-2001 path cost
Parameter type: <Shub::StpMaxHopCount>
Format:
- maximum hop count value
- unit: 10msec
- range: [600...4000]
Parameter type: <Shub::StpRegionName>
Format:
- name of the regions configuration
- length: x<=32
Parameter type: <Shub::StpRegionVersion>
Format:
- version of the MSTP region
- range: [0...4000]
Parameter type: <Shub::StpConfigIdSelector>
Format:
- configuration id format selector to identify the bridge
- range: [0...255]

optional parameter with default


value: 1500
forward delay value (n*100)

[no] version

[no] tx-hold-count

[no] path-cost-type

[no] max-hop-count

region-name

[no] region-version

[no] config-id-sel

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "rstp"
spanning tree protocol version

optional parameter with default


value: 3
maximum transmission rate limit
optional parameter with default
value: "32-bit"
version of stp default path costs

optional parameter with default


value: 2000
max hop count(n*100)
optional parameter
name of regions configuration(by
default the bridgeId)
optional parameter with default
value: 0
version of the MSTP region
optional parameter with default
value: 0
configuration id selector used to
identify the bridge

Released

659

23 Multiple Spanning Tree Configuration Commands

23.3 SHub MSTP Instance configuration Command


Command Description
This command allows the operator to configure the MSTP parameters for a specific MSTP instance. This
configuration applies to the SHub.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mstp ( no instance (instance) ) | ( instance (instance) [ no priority | priority <Shub::StpPriority> ] )

Command Parameters
Table 23.3-1 "SHub MSTP Instance configuration Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...16]

MSTP instance

Table 23.3-2 "SHub MSTP Instance configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Shub::StpPriority>


Format:
- stp bridge priority(n*4096)
- range: [0...61440]

optional parameter with default


value: 32768
the Bridge Priority(n*4096)

660

Released

3HH-04416-EBAA-TCZZA

01

23 Multiple Spanning Tree Configuration Commands

23.4 SHub MSTP Vlan-Instance Mapping


configuration Command
Command Description
This command allows the operator to map/unmap VLANs to a specific MSTP instance.The VLAN can be associated
with the MSTP instance without being configured first. One or more VLANs can be associated to an instance, but
one VLAN can not be assigned to different instances.
This configuration applies to the SHub.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mstp instance (instance) ( no associate-vlan (vlan) ) | ( associate-vlan (vlan) )

Command Parameters
Table 23.4-1 "SHub MSTP Vlan-Instance Mapping configuration Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...16]
Format:
- vlan id
- range: [2...4094]

MSTP instance

(vlan)

3HH-04416-EBAA-TCZZA 01

vlan id to be associated with the


mstp instance

Released

661

23 Multiple Spanning Tree Configuration Commands

23.5 SHub MSTP Port configuration Command


Command Description
This command allows the operator to configure the port parameters for the Common Instance. This configuration
applies to the SHub.
By default mstp is enabled on the network and outband ports.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mstp port (port) [ no priority | priority <Shub::MstpPortPriority> ] [ [ no ] disable-stp ] [ path-cost
<Shub::MstpPathCost> ] [ [ no ] edge-port ] [ no admin-p2p | admin-p2p <Shub::MstpAdminP2PPort> ] [ no
hello-time | hello-time <Shub::StpHelloTime> ]

Command Parameters
Table 23.5-1 "SHub MSTP Port configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub

isam network port

Table 23.5-2 "SHub MSTP Port configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Shub::MstpPortPriority>


Format:
- mstp port priority(n*16)
- range: [0...240]
Parameter type: boolean

optional parameter with default


value: 128
mstp port priority(n*16)

[no] disable-stp

662

Released

optional parameter
current Msti port state disabled

3HH-04416-EBAA-TCZZA

01

23 Multiple Spanning Tree Configuration Commands

Parameter

Type

Description

path-cost

Parameter type: <Shub::MstpPathCost>


Format:
- port path cost
- range: [1...200000000]
Parameter type: boolean

optional parameter
port path cost

[no] edge-port
[no] admin-p2p

[no] hello-time

3HH-04416-EBAA-TCZZA 01

Parameter type: <Shub::MstpAdminP2PPort>


Format:
( force-true
| force-false
| auto )
Possible values:
- force-true : p2p link connection
- force-false : shared media connection
- auto : auto
Parameter type: <Shub::StpHelloTime>
Format:
- stp bridge hello time(n*100)
- unit: 10msec
- range: [100...1000]

optional parameter
port state enabled for the MSTP
optional parameter with default
value: "auto"
admin p2p status of the LAN
segment attached to the port

optional parameter with default


value: 200
port hello time(n*100)

Released

663

23 Multiple Spanning Tree Configuration Commands

23.6 SHub MSTP Port-Instance configuration


Command
Command Description
This command allows the operator to configure the MSTP parameters for a specific port-instance configuration. In
order to be able to configure the port-instance parameters, the port must be member of the vlan-port map.This
configuration applies to the SHub.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mstp port-instance (network-port) instance <Shub::MstpInstance> [ no priority | priority
<Shub::MstpPortPriority> ] [ [ no ] disable-stp ] [ path-cost <Shub::MstpPathCost> ]

Command Parameters
Table 23.6-1 "SHub MSTP Port-Instance configuration Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Parameter type: <Shub::MstpInstance>
Format:
- MSTP Instance
- range: [1...16]

isam network port

instance

mstp instance

Table 23.6-2 "SHub MSTP Port-Instance configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Shub::MstpPortPriority>

optional parameter with default

664

Released

3HH-04416-EBAA-TCZZA

01

23 Multiple Spanning Tree Configuration Commands

Parameter

Type

Description
value: 128
mstp port priority(n*16)

[no] disable-stp

Format:
- mstp port priority(n*16)
- range: [0...240]
Parameter type: boolean

path-cost

3HH-04416-EBAA-TCZZA 01

Parameter type: <Shub::MstpPathCost>


Format:
- port path cost
- range: [1...200000000]

optional parameter
current Msti port state disabled
optional parameter
port path cost

Released

665

24- IP Configuration Commands

24.1 IP Configuration Command Tree


24.2 VLAN Bundle Configuration Command
24.3 VRF Configuration Command
24.4 IP Interface Network Configuration Command
24.5 IP Interface Network Numbered Configuration
Command
24.6 IP Interface User Port Configuration Command
24.7 IP User Port ARP Proxy Statistics Configuration
Command
24.8 IP Interface User Bridge Port Configuration Command
24.9 IP User Gateway Interface VRF Configuration
Command
24.10 VRF Route Configuration Command
24.11 IP SHub VRF Configuration Command
24.12 IP SHub VRF Route Map Command
24.13 IP SHub VRF Route Preference Command
24.14 IP SHub VRF Route Configuration Command
24.15 IP SHub VRF ARP Configuration Command
24.16 IP SHub ARP Configuration Command
24.17 IP SHub ARP per VLAN Configuration Command
24.18 IP SHub VRF Route Preference Command

666

Released

24-667
24-669
24-670
24-672
24-673
24-674
24-676
24-678
24-680
24-681
24-683
24-685
24-687
24-688
24-690
24-691
24-692
24-693

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.1 IP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "IP Configuration Commands".

Command Tree
----configure
----ip
----[no] vlan-bind
- (vlan-id)
- layer3-itf
----[no] vrf
- (index)
- name
- [no] desc
- [no] contact
- [no] my-ipaddress
- [no] default-ttl
- [no] reassem-timeout
- [no] mode
----[no] network-itf
- (vlanid)
- [no] arp-policy
- [no] unnumbered
----[no] ip-address
- (ip-address)
----user-itf
----[no] port
- (port-interface)
- [no] qos-profile
----[no] arp-proxy-stats
----X [no] bridgeport
- (port-interface)
- [no] qos-profile
----gateway-itf
----[no] ip-address
- (ip-address)
----[no] route-dest
- (dest-ip-address)
- next-hop
----shub
----[no] vrf
- (index)
- name
- (modeandcommstatus)
- [no] forward-ttl-zero
- [no] max-routes
----[no] routing-option
----[no] route-map
- (dest-ip)
- source-proto
- (export)

3HH-04416-EBAA-TCZZA 01

Released

667

24 IP Configuration Commands

- dest-proto
----X preference
----X route-type
- (index)
- value
----[no] route-dest
- (dest)
- next-hop
- vlan-id
- [no] metric
----arp
- [no] max-arp-entries
----arp
X cache-timeout
X cache-pending
X cache-refresh
X cache-retry-time
X max-retry-itvl
X max-retries
----vlan
- (vlanid)
- [no] gratuitous-arp
----[no] routing-option
----preference
----route-type
- (index)
- value

668

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.2 VLAN Bundle Configuration Command


Command Description
This command allows the operator to create or delete a VLAN bundle.
Deleting the last VLAN deletes the VLAN bundle.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip ( no vlan-bind (vlan-id) ) | ( vlan-bind (vlan-id) layer3-itf <Itf::IpoeInterface> )

Command Parameters
Table 24.2-1 "VLAN Bundle Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

specifies the vlan ID.

Table 24.2-2 "VLAN Bundle Configuration Command" Command Parameters


Parameter

Type

Description

layer3-itf

Parameter type: <Itf::IpoeInterface>


Format:
( <Ip::Layer3ID>
| new )
Possible values:
- new : new ip interface
Field type <Ip::Layer3ID>
- the layer3 interface

mandatory parameter
The parameter is not visible
during modification.
specifies the layer3 interface.

3HH-04416-EBAA-TCZZA 01

Released

669

24 IP Configuration Commands

24.3 VRF Configuration Command


Command Description
This command allows the operator to create, delete, or modify a VRF context for the data plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.
Modification of my-ipaddress is not possible if PPPoE connections are established in the VRF.
Removal of the VRF is not possible when IP interfaces are attached or when a PPPoE connection is established in
the VRF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip ( no vrf (index) ) | ( vrf (index) name <Vrf::VrfName> [ no desc | desc <Vrf::VrfDescription> ] [ no
contact | contact <Vrf::VrfContact> ] [ no my-ipaddress | my-ipaddress <Ip::V4AddressHex> ] [ no default-ttl |
default-ttl <Vrf::DefaultTTL> ] [ no reassem-timeout | reassem-timeout <Vrf::ReAssyTimeOut> ] [ no mode |
mode <Vrf::VrfMode> ] )

Command Parameters
Table 24.3-1 "VRF Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]

the vrf index

Table 24.3-2 "VRF Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <Vrf::VrfName>


Format:
- the name which uniquely identify a VRF
- length: 1<=x<=32
Parameter type: <Vrf::VrfDescription>
Format:
- a string describing the VRF
- length: x<=32
Parameter type: <Vrf::VrfContact>
Format:
- the contact info for administration of VRF
- length: x<=32
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

mandatory parameter
the name

[no] desc

[no] contact

[no] my-ipaddress

670

Released

optional parameter with default


value: ""
the description
optional parameter with default
value: ""
contact
information
for
administration of this VRF
optional parameter with default
value: "0.0.0.0"
Ip Address of the system within

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

Parameter

Type

[no] default-ttl

Parameter type: <Vrf::DefaultTTL>


Format:
- time-to-live value of IP-header
- range: [1...255]
Parameter type: <Vrf::ReAssyTimeOut>
Format:
- reassembly timeout value
- unit: sec
- range: [0...2147483647]
Parameter type: <Vrf::VrfMode>
Format:
( forwarder
| router )
Possible values:
- forwarder : acting in forwarder mode without user to user
traffic
- router : acting in router mode

[no] reassem-timeout

[no] mode

3HH-04416-EBAA-TCZZA 01

Description
this VRF
optional parameter with default
value: 32
default value for time-to-live
optional parameter with default
value: 30
maximum seconds the fragments
to be held for reassembly
optional parameter with default
value: "forwarder"
the mode

Released

671

24 IP Configuration Commands

24.4 IP Interface Network Configuration Command


Command Description
This command allows the operator to create the IP interface on a network port.
A vrf configured in router mode can be associated with only one vlan interface. If the user tries to associate
another vlan interface with the same vrf , CLI provides an error , but deletion of the unassociated vlan is not
possible directly. Please use the admin command "admin ip no vlan-itf-delete (index) " only to remove the
unassociated vlan interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) ( no network-itf (vlanid) ) | ( network-itf (vlanid) [ no arp-policy | arp-policy
<Vrf::ArpPolicy> ] [ [ no ] unnumbered ] )

Command Parameters
Table 24.4-1 "IP Interface Network Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
- vlan id
- range: [1...4093]

the vrf index

(vlanid)

vlan id

Table 24.4-2 "IP Interface Network Configuration Command" Command Parameters


Parameter

Type

Description

[no] arp-policy

Parameter type: <Vrf::ArpPolicy>


Format:
( not-trusted
| trusted )
Possible values:
- not-trusted : not trusted ARP packets
- trusted : trusted ARP packets
Parameter type: boolean

optional parameter with default


value: "not-trusted"
system behaviour to received
ARP packets

[no] unnumbered

672

Released

optional parameter
unnumbered interface

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.5 IP Interface Network Numbered Configuration


Command
Command Description
This command allows the operator to associate the IP address with the numbered interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) network-itf (vlanid) ( no ip-address (ip-address) ) | ( ip-address (ip-address) )

Command Parameters
Table 24.5-1 "IP Interface Network Numbered Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
- vlan id
- range: [1...4093]
Format:
<Ip::V4Address> / <Ip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLength>
- IP address prefix length
- range: [0...30]

the vrf index

(vlanid)
(ip-address)

3HH-04416-EBAA-TCZZA 01

vlan id
inet-address

Released

673

24 IP Configuration Commands

24.6 IP Interface User Port Configuration Command


Command Description
This command allows the operator to configure the user port interface (rack/shelf/Lt-slot/port/vpi:vci).

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) user-itf ( no port (port-interface) ) | ( port (port-interface) [ no qos-profile | qos-profile
<Vlan::QosProfileName> ] )

Command Parameters
Table 24.6-1 "IP Interface User Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>

the vrf index

(port-interface)

674

Released

identification of the port or


/ virtual channel
:
/
/
:
/
:
/
/
:
/
:
/
/
/

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 24.6-2 "IP Interface User Port Configuration Command" Command Parameters
Parameter

Type

Description

[no] qos-profile

Parameter type: <Vlan::QosProfileName>


Format:
( none
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

optional parameter with default


value: "none"
qos profile name

3HH-04416-EBAA-TCZZA 01

Released

675

24 IP Configuration Commands

24.7 IP User Port ARP Proxy Statistics


Configuration Command
Command Description
This command allows the operator to enable the ARP proxy statistic.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) user-itf port (port-interface) ( no arp-proxy-stats ) | ( arp-proxy-stats )

Command Parameters
Table 24.7-1 "IP User Port ARP Proxy Statistics Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>

the vrf index

(port-interface)

676

Released

identification of the port or


/ virtual channel
:
/
/
:
/
:
/
/
:
/
:
/
/

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

677

24 IP Configuration Commands

24.8 IP Interface User Bridge Port Configuration


Command
Command Description
Obsolete command, replaced by configure ip vrf (index) user-itf port.
This command allows the
(rack/shelf/Lt-slot/port/vpi:vci).

operator

to

configure

the

user

bridge

port(IPoE)

interface

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) user-itf ( no bridgeport (port-interface) ) | ( bridgeport (port-interface) [ no qos-profile |
qos-profile <Qos::QosSessionProfileName> ] )
Obsolete command, replaced by configure ip vrf (index) user-itf port.

Command Parameters
Table 24.8-1 "IP Interface User Bridge Port Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port-interface)

678

Released

Description

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

Table 24.8-2 "IP Interface User Bridge Port Configuration Command" Command Parameters
Parameter

Type

[no] qos-profile

Parameter type: <Qos::QosSessionProfileName>


optional parameter with default
Format:
value: "none"
( none
qos profile name
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

3HH-04416-EBAA-TCZZA 01

Description

Released

679

24 IP Configuration Commands

24.9 IP User Gateway Interface VRF Configuration


Command
Command Description
This command allows the operator to create a user gateway interface. When a VRF is created, an autogenerated
entry is added to the VRF IP interface table. The operator can then associate multiple IP addresses with this
interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) gateway-itf ( no ip-address (ip-address) ) | ( ip-address (ip-address) )

Command Parameters
Table 24.9-1 "IP User Gateway Interface VRF Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
<Ip::V4Address> / <Ip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLength>
- IP address prefix length
- range: [0...30]

the vrf index

(ip-address)

680

Released

inet-address

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.10 VRF Route Configuration Command


Command Description
This command allows the operator to create or delete an indirect or direct route toward the network and a direct
route toward the user side. The next-hop address must match one of the network-side IP interfaces.
Only one default route can be created per VRF. Use the address 0.0.0.0 to specify a default route.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) ( no route-dest (dest-ip-address) next-hop <Ip::IfType> ) | ( route-dest (dest-ip-address)
next-hop <Ip::IfType> )

Command Parameters
Table 24.10-1 "VRF Route Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
inet-address with prefix
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::IfType>
the next hop IP-address
Format:
( direct : user-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| <Ip::V4Address> : network : vlan : <Eqpt::VlanId>
| <Ip::V4Address> : network : any
| direct : network : <Eqpt::VlanId>
| direct : user-bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId>
/ <Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| direct : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| direct : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>

(dest-ip-address)

next-hop

3HH-04416-EBAA-TCZZA 01

Description

Released

681

24 IP Configuration Commands

Resource Identifier

Type

Description

| direct : user-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PortId>
| direct : user-bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId>
/ <Eqpt::SlotId> / <Eqpt::PortId> )
Possible values:
- direct : direct ip-address
Field type <Ip::V4Address>
- IPv4-address
Possible values:
- network : a l2-vlan interface
- user-port : an atm pvc interface
- user-bridgeport : an bridge port interface
- vlan : an vlan port interface
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Possible values:
- any : any vlan
- vlan : a particular vlan
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::VlanId>
- VLAN id

682

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.11 IP SHub VRF Configuration Command


Command Description
This commands allows the operator to create, delete, or modify a VRF context for the control plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub ( no vrf (index) ) | ( vrf (index) [ name <Vrf::ShubVrfName> ] (modeandcommstatus) [ [ no ]
forward-ttl-zero ] [ no max-routes | max-routes <Vrf::MaxRoutes> ] )

Command Parameters
Table 24.11-1 "IP SHub VRF Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf id

Table 24.11-2 "IP SHub VRF Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <Vrf::ShubVrfName>


Format:
- the name which uniquely identify a vrf
- length: x<=32
Format:
( fast-path-mode : ena-user-user-com
| fast-path-mode : dis-user-user-com
| slow-path-mode )
Possible values:
- fast-path-mode : set fast-path mode
- slow-path-mode : set slow-path mode
Possible values:
- ena-user-user-com : set user to user comm via service-hub
- dis-user-user-com : unset user to user comm
Parameter type: boolean

optional parameter
the name

(modeandcommstatus)

[no] forward-ttl-zero
[no] max-routes

3HH-04416-EBAA-TCZZA 01

Parameter type: <Vrf::MaxRoutes>


Format:
( no-limit
| <Vrf::MaxRoutes> )

mandatory parameter
the mode and the communication
status for the vrf

optional parameter
enable packet forwarding when
ttl=0
optional parameter with default
value: "no-limit"
maximum number of entries in
the routing table

Released

683

24 IP Configuration Commands

Parameter

Type

Description

Possible values:
- no-limit : no-limit to number of route entries
Field type <Vrf::MaxRoutes>
- maximum number of route entries
- range: [0...12288]

684

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.12 IP SHub VRF Route Map Command


Command Description
This command allows the operator to configure the route map in the IP SHub.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option ( no route-map (dest-ip) source-proto <Ip::SourceProto> ) | (
route-map (dest-ip) source-proto <Ip::SourceProto> (export) dest-proto <Ip::DestProto> )

Command Parameters
Table 24.12-1 "IP SHub VRF Route Map Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
<Ip::V4Address> / <Ip::IpPrefixLengthInv>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::IpPrefixLengthInv>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::SourceProto>
Format:
( any
| static
| rip
| ospf )
Possible values:
- any : any routing protocol
- static : static routing
- rip : berkeley rip or rip2
- ospf : open shortest path first

the vrf id

(dest-ip)

source-proto

ip address and mask of the


destination route

source routing protocol

Table 24.12-2 "IP SHub VRF Route Map Command" Command Parameters
Parameter

Type

Description

(export)

Format:
( permit
| deny )
Possible values:

mandatory parameter
route allowed for export

3HH-04416-EBAA-TCZZA 01

Released

685

24 IP Configuration Commands

Parameter

Type
- permit : permit the route export
- deny : deny the route export
Parameter type: <Ip::DestProto>
Format:
( any
| ospf
| rip
| ospf-rip )
Possible values:
- any : any routing protocol
- ospf : ospf routing protocol
- rip : rip routing protocol
- ospf-rip : ospf and rip routing protocol

dest-proto

686

Released

Description
mandatory parameter
destination routing protocol

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.13 IP SHub VRF Route Preference Command


Command Description
Obsolete command, replaced by configure ip shub routing-option preference route-type.
This command allows the operator to specify the preference for the route learned by the dynamic routing protocols.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option preference route-type (index) [ value <Vrf::ShubProtPref> ]
Obsolete command, replaced by configure ip shub routing-option preference route-type.

Command Parameters
Table 24.13-1 "IP SHub VRF Route Preference Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
( static
| rip
| ospf )
Possible values:
- static : static route
- rip : RIPv2 protocol
- ospf : open shortest path first

the vrf id

(index)

the routing protocol id

Table 24.13-2 "IP SHub VRF Route Preference Command" Command Parameters
Parameter

Type

Description

value

Parameter type: <Vrf::ShubProtPref>


Format:
- the preference for the route
- range: [1...254]

optional parameter
the preference for the route

3HH-04416-EBAA-TCZZA 01

Released

687

24 IP Configuration Commands

24.14 IP SHub VRF Route Configuration Command


Command Description
This command allows the operator to create, delete, or modify a VRF context for the control plane. VRF index 0 is
reserved and cannot be created, deleted, or modified.
The IP address of the route destination must be of the type x.x.x.0/24.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) ( no route-dest (dest) next-hop <Ip::NextHopV4Address> ) | ( route-dest (dest)
next-hop <Ip::NextHopV4Address> vlan-id <Vlan::VlanId> [ no metric | metric <Vrf::ShubRouteMetric> ] )

Command Parameters
Table 24.14-1 "IP SHub VRF Route Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::NextHopV4Address>
Format:
( direct
| <Ip::V4Address> )
Possible values:
- direct : direct ip-address
Field type <Ip::V4Address>
- IPv4-address

the vrf id

(dest)

next-hop

the destination ip address and


mask of this route

the next hop ip address of this


route

Table 24.14-2 "IP SHub VRF Route Configuration Command" Command Parameters
Parameter

Type

Description

vlan-id

Parameter type: <Vlan::VlanId>


Format:
- vlan id
- range: [1...4093]

mandatory parameter
The parameter is not visible
during modification.
vlan id

688

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

Parameter

Type

Description

[no] metric

Parameter type: <Vrf::ShubRouteMetric>


Format:
- the value of routing metric
- range: [0...254]

optional parameter with default


value: 1
the primary routing metric for
this route

3HH-04416-EBAA-TCZZA 01

Released

689

24 IP Configuration Commands

24.15 IP SHub VRF ARP Configuration Command


Command Description
This commands allows the operator to configure the arp related parameters per VRF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) arp [ no max-arp-entries | max-arp-entries <Vrf::MaxArpEntries> ]

Command Parameters
Table 24.15-1 "IP SHub VRF ARP Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf id

Table 24.15-2 "IP SHub VRF ARP Configuration Command" Command Parameters
Parameter

Type

Description

[no] max-arp-entries

Parameter type: <Vrf::MaxArpEntries>


Format:
- maximum number of arp entries
- range: [-1...5120]

optional parameter with default


value: -1
maximum number of arp entries
learned per vrf. i.c.o -1 the
maximum value is selected

690

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.16 IP SHub ARP Configuration Command


Command Description
This command allows the operator to configure the IP SHub ARP parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub arp [ cache-timeout <Ip::ArpCacheTimeOut> ] [ cache-pending <Ip::ArpCachePendingTime> ]
[ cache-refresh <Ip::ArpCacheRefreshTime> ] [ cache-retry-time <Ip::ArpCacheRetryTime> ] [ max-retry-itvl
<Ip::ArpCacheMaxRetryTime> ] [ max-retries <Ip::ArpMaxRetries> ]

Command Parameters
Table 24.16-2 "IP SHub ARP Configuration Command" Command Parameters
Parameter

Type

Description

cache-timeout

Parameter type: <Ip::ArpCacheTimeOut>


Format:
- time after which the entry in cache is removed
- range: [30...86400]
Parameter type: <Ip::ArpCachePendingTime>
Format:
- time an unresolved entry will be held in cache
- range: [30...3000]
Parameter type: <Ip::ArpCacheRefreshTime>
Format:
- refresh interval for next hop ARP cache entries.
- range: [30...3600]
Parameter type: <Ip::ArpCacheRetryTime>
Format:
- retry time for next hop ARP cache entries
- range: [1...60]
Parameter type: <Ip::ArpCacheMaxRetryTime>
Format:
- max retry time for next hop ARP cache entries
- range: [600...18000]
Parameter type: <Ip::ArpMaxRetries>
Format:
- max number of retry attempts
- range: [2...10]

obsolete parameter that will be


ignored
time after which the entry in
cache is removed
obsolete parameter that will be
ignored
time an unresolved entry will be
held in cache
obsolete parameter that will be
ignored
refresh interval for next hop ARP
cache entries
obsolete parameter that will be
ignored
retry time for next hop ARP
cache entries
obsolete parameter that will be
ignored
max retry time for next hop ARP
cache entries
obsolete parameter that will be
ignored
maximum number of retry
attempts for ARP resolution

cache-pending

cache-refresh

cache-retry-time

max-retry-itvl

max-retries

3HH-04416-EBAA-TCZZA 01

Released

691

24 IP Configuration Commands

24.17 IP SHub ARP per VLAN Configuration


Command
Command Description
This command allows the operator to configure the IP SHub ARP parameters for each VLAN.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub arp vlan (vlanid) [ [ no ] gratuitous-arp ]

Command Parameters
Table 24.17-1 "IP SHub ARP per VLAN Configuration Command " Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]

the vlan id

Table 24.17-2 "IP SHub ARP per VLAN Configuration Command " Command Parameters
Parameter

Type

Description

[no] gratuitous-arp

Parameter type: boolean

optional parameter
process gratuitous broadcast ARP
messages

692

Released

3HH-04416-EBAA-TCZZA

01

24 IP Configuration Commands

24.18 IP SHub VRF Route Preference Command


Command Description
This command allows the operator to specify the preference for the route learned by the dynamic routing protocols.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub routing-option preference route-type (index) [ value <Vrf::ShubProtPref> ]

Command Parameters
Table 24.18-1 "IP SHub VRF Route Preference Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( static
| rip
| ospf )
Possible values:
- static : static route
- rip : RIPv2 protocol
- ospf : open shortest path first

the routing protocol id

Table 24.18-2 "IP SHub VRF Route Preference Command" Command Parameters
Parameter

Type

Description

value

Parameter type: <Vrf::ShubProtPref>


Format:
- the preference for the route
- range: [1...254]

optional parameter
the preference for the route

3HH-04416-EBAA-TCZZA 01

Released

693

25- ARP-RELAY Configuration Commands

25.1 ARP-RELAY Configuration Command Tree


25.2 Arp-Relay Statistics Configuration Command

694

Released

25-695
25-696

3HH-04416-EBAA-TCZZA

01

25 ARP-RELAY Configuration Commands

25.1 ARP-RELAY Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "ARP-RELAY Configuration Commands".

Command Tree
----configure
----arp-relay
----[no] statistics
- (vlan-port)

3HH-04416-EBAA-TCZZA 01

Released

695

25 ARP-RELAY Configuration Commands

25.2 Arp-Relay Statistics Configuration Command


Command Description
This command allows the operator to enable/disable the detailed arp-relay statistics.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure arp-relay ( no statistics (vlan-port) ) | ( statistics (vlan-port) )

Command Parameters
Table 25.2-1 "Arp-Relay Statistics Configuration Command" Resource Parameters
Resource Identifier

Type

(vlan-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>

696

Released

Description
the vlan-port
/
:
/
:
/
:
/
/
/
:
/
/
:
/
:
/
:
/
:

3HH-04416-EBAA-TCZZA

01

25 ARP-RELAY Configuration Commands

Resource Identifier

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

697

26- IGMP Configuration Commands

26.1 IGMP Configuration Command Tree


26.2 IGMP Channel Configuration Command
26.3 IGMP Channel Permission Package Members
Configuration Command
26.4 IGMP Channel Preview Package Members
Configuration Command
26.5 IGMP Package Bitmaps Configuration Command
26.6 IGMP System Configuration Command
26.7 IGMP System CDR Type Configuration Command
26.8 IGMP Vlan System Configuration Command
26.9 SHub IGMP IGS System Configuration Command
26.10 SHub IGMP Response Timer Configuration
Command
26.11 SHub IGMP Router Port Configuration Command
26.12 SHub IGMP VLAN Filter Configuration Command
26.13 Shub IGMP Vlan enhanced performance
Configuration Command
26.14 Shub IGMP CAC BUNDLE TABLE Configuration
Command
26.15 IGMP Multicast Vlan Translation Command
26.16 IGMP Multicast Pon Vlan Translation Command
26.17 Igmp Multicast Service Context Configuration
Command

698

Released

26-699
26-702
26-707
26-710
26-713
26-715
26-718
26-719
26-720
26-722
26-723
26-724
26-727
26-728
26-729
26-730
26-731

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.1 IGMP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "IGMP Configuration Commands".

Command Tree
----configure
----igmp
----[no] channel
- (port)
- [no] perm-pkg-bitmap
- [no] max-num-group
- [no] mode
X (cac-disable)
X (ip-anti-spoof-dis)
- [no] igmp-version
- [no] forking
- [no] lt-ont-signaling
- [no] mc-pbit-value
- [no] mcast-vlan-id
- [no] mc-vlan-xlate
- [no] mcast-svc-context
- [no] max-msg-rate
----[no] fullview-packages
- (package)
----[no] preview-packages
- (package)
----package
- (index)
- [no] name
- [no] template-name
- [no] template-version
----system
- [no] src-ip-address
- [no] verify-checksum
- [no] query-interval
- [no] max-rsp-time
- [no] robustness
- [no] mem-query-int
- [no] last-memb-cnt
- [no] last-max-resp-tim
- [no] host-report-intv
- [no] start
- [no] preview-valid
- [no] cdr-validation
- [no] cdr-generation
- [no] except-cdr-rate
- [no] cdr-export
- [no] cdr-file-aging
- [no] cdr-polling
- [no] user-igmp-version

3HH-04416-EBAA-TCZZA 01

Released

699

26 IGMP Configuration Commands

- [no] netw-igmp-version
- [no] v3-max-num-rec
- [no] forking
- [no] lt-ont-signaling
- [no] vlan-selection
- [no] disc-lwr-version
----cdr-type
- [no] periodic
- [no] period
- [no] attempt-max-pview
- [no] attempt-blackout
- [no] attempt-no-perm
----[no] vlan
- (vlan-id)
- netw-igmp-version
- [no] v3-max-num-rec
----shub
----igs-system
- [no] start-snooping
- [no] enable-snooping
- self-ip-addr-mode
- [no] self-ip-addr
X trace-selection
- [no] router-purge-intv
- [no] host-purge-intv
- [no] max-mcast-learn
- [no] glb-leave
- [no] reduced-resp-int
- [no] remove-root-int
- [no] full-flooding-off
----response-timer
- (vlan-id)
- [no] leave-rsp-timer
----[no] vlan-router-port
- (vlan-id)
- network-port
----vlan-filter
- (filter-id)
- [no] snoop-filter
- [no] igmp-version
- [no] operation-mode
- [no] self-ip-addr-mode
- [no] self-ip-addr
- [no] querier
- [no] query-int
- [no] v2-max-rsp-time
- [no] v3-max-rsp-time
- [no] v3-max-num-rec
- [no] drop-rpt-network
- [no] robustness
- [no] unsolicit-rpt-int
- [no] retry-count
----[no] vlan-enhance-perf
- (vlan-id)
- [no] pkt-fwd-state
----[no] bundle
- (bundle)
- [no] bandwidth
- [no] max-num-channel

700

Released

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

----[no] mc-vlan-xlate
- (nwvlan)
- ponvlan
----[no] mc-pon-vlan-xlate
- (pon)
- nwvlan
- ponvlan
----[no] mcast-svc-context
- (name)

3HH-04416-EBAA-TCZZA 01

Released

701

26 IGMP Configuration Commands

26.2 IGMP Channel Configuration Command


Command Description
This command allows the operator to create and configure the IGMP channel parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp ( no channel (port) ) | ( channel (port) [ no perm-pkg-bitmap | perm-pkg-bitmap
<Igmp::PermPkgBitMap> ] [ no max-num-group | max-num-group <Igmp::ChannelMaxNumGroup> ] [ no mode |
mode <Igmp::ChannelProtocolMode> ] [ (cac-disable) ] [ (ip-anti-spoof-dis) ] [ no igmp-version | igmp-version
<Igmp::UserItfVersion> ] [ no forking | forking <Igmp::ForkingStatus> ] [ no lt-ont-signaling | lt-ont-signaling
<Igmp::ChannelLtOntSignaling> ] [ no mc-pbit-value | mc-pbit-value <Igmp::McPbitValue> ] [ no mcast-vlan-id |
mcast-vlan-id <Igmp::ProtocolMcastVlan> ] [ no mc-vlan-xlate | mc-vlan-xlate <Igmp::mcVlanXlateAdmin> ] [ no
mcast-svc-context | mcast-svc-context <Igmp::McastSvcCtxtName> ] [ no max-msg-rate | max-msg-rate
<Igmp::ChannelMaxMsgRate> ] )

Command Parameters
Table 26.2-1 "IGMP Channel Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>

702

Released

Description

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Resource Identifier

Type

Description

| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity

3HH-04416-EBAA-TCZZA 01

Released

703

26 IGMP Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 26.2-2 "IGMP Channel Configuration Command" Command Parameters


Parameter

Type

Description

[no] perm-pkg-bitmap

Parameter type: <Igmp::PermPkgBitMap>


Format:
- a binary string
- length: 128

[no] max-num-group

Parameter type: <Igmp::ChannelMaxNumGroup>


Format:
- max group number this port can support
- range: [0...1024]
Parameter type: <Igmp::ChannelProtocolMode>
Format:
( ipoe
| pppoe )
Possible values:
- ipoe : IPoE mode
- pppoe : PPPoE
Format:
( cac-disable
| cac )
Possible values:
- cac-disable : disables bandwidth CAC for conf.
streams,default=enable
- cac : enables bandwidth CAC for conf.
streams,default=enable
Format:
( ip-anti-spoof-dis
| ip-anti-spoof )
Possible values:
ip-anti-spoof-dis
:
disables
IP@
anti-spoofing,default=enable
- ip-anti-spoof : enables IP@ anti-spoofing,default=enable

optional parameter with default


value: "01 : 00 : 00 : 00 : 00 : 00
: 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00"
packages, the user is allowed to
join
optional parameter with default
value: 0
max group number the port can
support
optional parameter with default
value: "ipoe"
protocol mode (ipoe or pppoe)

[no] mode

(cac-disable)

(ip-anti-spoof-dis)

704

Released

obsolete parameter that will be


ignored
bandwidth
CAC
for
pre-configured multicast streams

obsolete parameter that will be


ignored
enables IP@ anti-spoofing on this
user-interface

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Parameter

Type

Description

[no] igmp-version

Parameter type: <Igmp::UserItfVersion>


Format:
( system-inherited
|2
|3)
Possible values:
- system-inherited : inherits GMQs to userversion from the
System level
- 2 : IGMPV2 GMQs
- 3 : IGMPV3 GMQs
Parameter type: <Igmp::ForkingStatus>
Format:
( system-inherited
| enable
| disable )
Possible values:
- system-inherited : inherits forking status from the system
level
- enable : enable IGMP forking
- disable : disable IGMP forking
Parameter type: <Igmp::ChannelLtOntSignaling>
Format:
( enabled
| disabled
| inherited )
Possible values:
- enabled : lt to ont signaling is enabled
- disabled : lt to ont signaling is disabled
- inherited : inherits lt to ont signaling from the system level
Parameter type: <Igmp::McPbitValue>
Format:
- default P-bit value to be used by the ONT on the UNI-side
for downstream multicast traffic towards subscribers
- range: [0...8]

optional parameter with default


value: "system-inherited"
version of the IGMP protocol

[no] forking

[no] lt-ont-signaling

[no] mc-pbit-value

[no] mcast-vlan-id

[no] mc-vlan-xlate

[no] mcast-svc-context

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "system-inherited"
forking status of the IGMP
protocol

optional parameter with default


value: "inherited"
The parameter is not visible
during modification.
lt to ont signaling parameter

optional parameter with default


value: 8
default P-bit value to be used by
the ONT on the UNI-side for
downstream multicast traffic
towards subscribers
optional parameter with default
value: 0
vlan selection for multicast
channel
optional parameter with default
value: "disabled"
to enable or disable mcast vlan
translation

Parameter type: <Igmp::ProtocolMcastVlan>


Format:
- vlan selection value
- range: [0...4093]
Parameter type: <Igmp::mcVlanXlateAdmin>
Format:
( enabled
| disabled )
Possible values:
- enabled : allow mcast vlan translation
- disabled : disallow mcast vlan translation
Parameter type: <Igmp::McastSvcCtxtName>
optional parameter with default
Format:
value: "default"
( name : <Qos::IgnoredQosProfileName>
Multicast Service Context Name
| default )
Possible values:
- default : Default profile is associated
- name : Name of the multicast service context profile
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

705

26 IGMP Configuration Commands

Parameter

Type

[no] max-msg-rate

Parameter type: <Igmp::ChannelMaxMsgRate>


optional parameter with default
Format:
value: 0
- Maximum number of Upstream IGMP messages that can Default value 0 indicates that the
be received on this IGMP channel
value is inherited from what is set
- unit: messages/second
in the system wide setting using
- range: [0...256]
command - configure qos
dsl-ctrl-pkt-policer sustained-rate
[1...64] burst-size [1...128]

706

Released

Description

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.3 IGMP Channel Permission Package Members


Configuration Command
Command Description
This command allows the operator to configure the IGMP channel permission package members.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure igmp channel (port) ( no fullview-packages (package) ) | ( fullview-packages (package) )

Command Parameters
Table 26.3-1 "IGMP Channel Permission Package Members Configuration Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>

3HH-04416-EBAA-TCZZA 01

Description

Released

707

26 IGMP Configuration Commands

Resource Identifier

Type

Description

| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>

708

Released

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Resource Identifier

(package)

3HH-04416-EBAA-TCZZA 01

Type
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Format:
- the package number
- range: [1...1024]

Description

package member

Released

709

26 IGMP Configuration Commands

26.4 IGMP Channel Preview Package Members


Configuration Command
Command Description
This command allows the operator to configure the IGMP channel preview package members.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure igmp channel (port) ( no preview-packages (package) ) | ( preview-packages (package) )

Command Parameters
Table 26.4-1 "IGMP Channel Preview Package Members Configuration Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>

710

Released

Description

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Resource Identifier

Type

Description

| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>

3HH-04416-EBAA-TCZZA 01

Released

711

26 IGMP Configuration Commands

Resource Identifier

- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Format:
- the package number
- range: [1...1024]

(package)

712

Type

Released

Description

package member

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.5 IGMP Package Bitmaps Configuration


Command
Command Description
This command allows the operator to configure IGMP package bitmaps. The package is intended primarily for use
by a network/element manager, such as an AMS, to support multiple sets of packages in different regions.
A package is a group of zero or more multicast sources that share a common access permission. Grouping the
source channels into one or more packages provides flexibility for the service provider to deliver different levels of
services to the end users; for example, "Basic Package", "Middle-Tier Package", and "Premium Package".
NOTE:There is no requirement to configure the package. If the package is modified, there is no effect on the
multicast source.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp package (index) [ no name | name <Igmp::igmpPackageName> ] [ no template-name |
template-name <Igmp::igmpPackageTemplateName> ] [ no template-version | template-version
<Igmp::igmpPackageTemplateVersion> ]

Command Parameters
Table 26.5-1 "IGMP Package Bitmaps Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of the package
- range: [1...1024]

index of the package

Table 26.5-2 "IGMP Package Bitmaps Configuration Command" Command Parameters


Parameter

Type

Description

[no] name

Parameter type: <Igmp::igmpPackageName>


Format:
- a printable string
- length: x<=32
Parameter type: <Igmp::igmpPackageTemplateName>
Format:
- a printable string
- length: x<=32
Parameter type: <Igmp::igmpPackageTemplateVersion>
Format:
- version of the service template containing this package

optional parameter with default


value: ""
name of the package

[no] template-name

[no] template-version

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: ""
name of the service template
containing this pkg
optional parameter with default
value: 0
version of the service template

Released

713

26 IGMP Configuration Commands

Parameter

714

Released

Type

Description

- range: [0...65535]

containing this pkg

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.6 IGMP System Configuration Command


Command Description
This command allows the operator to configure the IGMP parameters that are globally applicable to the Node.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp system [ no src-ip-address | src-ip-address <Ip::V4Address> ] [ [ no ] verify-checksum ] [ no
query-interval | query-interval <Igmp::SystemQueryInterval> ] [ no max-rsp-time | max-rsp-time
<Igmp::SystemQueryMaxResponseTime> ] [ no robustness | robustness <Igmp::SystemRobustness> ] [ no
mem-query-int | mem-query-int <Igmp::MembQueryIntvl> ] [ no last-memb-cnt | last-memb-cnt
<Igmp::MembQueryCount> ] [ no last-max-resp-tim | last-max-resp-tim <Igmp::SystemLastMembMaxRespTime>
] [ no host-report-intv | host-report-intv <Igmp::SystemUnsolicitedReportIntvl> ] [ [ no ] start ] [ no preview-valid |
preview-valid
<Igmp::SystemPrevalidIntval>
]
[
no
cdr-validation
|
cdr-validation
<Igmp::SystemPrecdrvalidIntval> ] [ [ no ] cdr-generation ] [ no except-cdr-rate | except-cdr-rate
<Igmp::CDRGenerationForSingles> ] [ no cdr-export | cdr-export <Igmp::CDRGenerationMethod> ] [ no
cdr-file-aging | cdr-file-aging <Igmp::CDRFileAgingTime> ] [ no cdr-polling | cdr-polling
<Igmp::CDRSystemPollingCycle>
]
[
no
user-igmp-version
|
user-igmp-version
<Igmp::igmpSystemGMQToUserSideVersion>
]
[
no
netw-igmp-version
|
netw-igmp-version
<Igmp::V3ProcessingAdminStatus>
]
[
no
v3-max-num-rec
|
v3-max-num-rec
<Igmp::V3MaxNumRecordsReport> ] [ [ no ] forking ] [ [ no ] lt-ont-signaling ] [ [ no ] vlan-selection ] [ [ no ]
disc-lwr-version ]

Command Parameters
Table 26.6-2 "IGMP System Configuration Command" Command Parameters
Parameter

Type

Description

[no] src-ip-address

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

[no] verify-checksum

Parameter type: boolean

[no] query-interval

Parameter type: <Igmp::SystemQueryInterval>


Format:
- interval at which general membership queries transmitted
- unit: sec
- range: [2...3175]
Parameter type: <Igmp::SystemQueryMaxResponseTime>
Format:
- max query resp time advertised in IGMPv2 queries

optional parameter with default


value: "0.0.0.0"
source ip addr which is tx in
every mcast IP datagram
optional parameter
verification performed on Rx
IGMP frame
optional parameter with default
value: 125
interval at which general
membership queries transmitted

[no] max-rsp-time

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 100
max query response time

Released

715

26 IGMP Configuration Commands

Parameter
[no] robustness

[no] mem-query-int

[no] last-memb-cnt

[no] last-max-resp-tim

[no] host-report-intv

[no] start
[no] preview-valid

Description

- unit: 1/10 sec


- range: [1...31744]
Parameter type: <Igmp::SystemRobustness>
Format:
- tuning for the expected packet loss on a subnet
- range: [1...10]
Parameter type: <Igmp::MembQueryIntvl>
Format:
- spacing between GSQs (group-specific queries)
- unit: 1/10 sec
- range: [2...31744]
Parameter type: <Igmp::MembQueryCount>
Format:
- number of GSQs ( group-specific queries) to be sent
- range: [1...10]
Parameter type: <Igmp::SystemLastMembMaxRespTime>
Format:
- allows shorter max response time
- unit: 1/10 sec
- range: [1...31744]
Parameter type: <Igmp::SystemUnsolicitedReportIntvl>
Format:
- intrvl of repetitions of host's report of grp membership
- unit: sec
- range: [1...255]
Parameter type: boolean

advertised in queries 1/10 sec

Parameter type: <Igmp::SystemPrevalidIntval>


Format:
- time interval that confirm the preview session is valid
- unit: sec
- range: [1...120]
Parameter type: <Igmp::SystemPrecdrvalidIntval>
Format:
( none
| <Igmp::SystemPrecdrvalidIntval> )
Possible values:
- none : CDR generation valid immediately
Field type <Igmp::SystemPrecdrvalidIntval>
- minimum session time for generating a CDR
- unit: sec
- range: [0...120]
Parameter type: boolean

[no] cdr-validation

[no] cdr-generation
[no] except-cdr-rate

Parameter type: <Igmp::CDRGenerationForSingles>


Format:
- limit the generation of CDR records
- unit: min
- range: [1...30]
Parameter type: <Igmp::CDRGenerationMethod>
Format:
( local-file-storage
| remote-logging )
Possible values:
- local-file-storage : method the cdr generated and forwarded

[no] cdr-export

716

Type

Released

optional parameter with default


value: 2
expected pkt loss on subnet
optional parameter with default
value: 10
minimum
interval
between
group-specific queries
optional parameter with default
value: 2
number of GSQs ( group-specific
queries) to be sent
optional parameter with default
value: 2
allows shorter max response time
optional parameter with default
value: 10
intrvl of repetitions of host's
report of grp membership
optional parameter
start IGMP and mcast app
module
optional parameter with default
value: 8
time interval that confirm the
preview session is valid
optional parameter with default
value: 2
minimum session time for
generating a CDR

optional parameter
start CDR generation in the
system
optional parameter with default
value: 3
limit the generation of the CDR
records
optional parameter with default
value: "local-file-storage"
the method the cdr is to be
generated and forwarded

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Parameter

Type

Description

[no] forking

- remote-logging : remote logging method


Parameter type: <Igmp::CDRFileAgingTime>
Format:
- configure the CDR file aging time
- unit: hour
- range: [4...24]
Parameter type: <Igmp::CDRSystemPollingCycle>
Format:
- configure the polling period for the CDR records, in
multiples of 60
- unit: sec
- range: [60...900]
Parameter
type:
<Igmp::igmpSystemGMQToUserSideVersion>
Format:
(2
|3)
Possible values:
- 2 : IGMPv2 GMQs
- 3 : IGMPv3 GMQs
Parameter type: <Igmp::V3ProcessingAdminStatus>
Format:
(2
|3)
Possible values:
- 2 : IGMP version2
- 3 : IGMP version3
Parameter type: <Igmp::V3MaxNumRecordsReport>
Format:
- max number of records in an IGMPv3 membership report
- range: [0...10]
Parameter type: boolean

[no] lt-ont-signaling

Parameter type: boolean

[no] vlan-selection

Parameter type: boolean

[no] disc-lwr-version

Parameter type: boolean

[no] cdr-file-aging

[no] cdr-polling

[no] user-igmp-version

[no] netw-igmp-version

[no] v3-max-num-rec

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 8
configure the CDR file aging
time
optional parameter with default
value: 180
configure the polling period for
the CDR records
optional parameter with default
value: "3"
version of the IGMP protocol

optional parameter with default


value: "3"
version for IGMP packet to
receive/forward to n/w side

optional parameter with default


value: 3
max num of group records in one
IGMPv3 report (2 exp N)
optional parameter
enable IGMP forking in the
system level
optional parameter
enables lt to ont signaling at
system level
optional parameter
enable vlan selection
optional parameter
discard lower version packets

Released

717

26 IGMP Configuration Commands

26.7 IGMP System CDR Type Configuration


Command
Command Description
This command allows the operator to configure the IGMP system Call Detail Record

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp system cdr-type [ [ no ] periodic ] [ no period | period <Igmp::IntermGenCDRPeriod> ] [ [ no ]
attempt-max-pview ] [ [ no ] attempt-blackout ] [ [ no ] attempt-no-perm ]

Command Parameters
Table 26.7-2 "IGMP System CDR Type Configuration Command" Command Parameters
Parameter

Type

Description

[no] periodic

Parameter type: boolean

[no] period

[no] attempt-max-pview

Parameter type: <Igmp::IntermGenCDRPeriod>


Format:
- intermediate CDR generation period, in multiples of 5
- unit: min
- range: [15...60]
Parameter type: boolean

optional parameter
interim CDR records generated
for fullview/preview
optional parameter with default
value: 15
intermediate CDR generation
period

[no] attempt-blackout

Parameter type: boolean

[no] attempt-no-perm

Parameter type: boolean

718

Released

optional parameter
CDR generated when max nbr
preview exceeded is true
optional parameter
CDR generated allowed when
blackout period is active
optional parameter
CDR generated to join a mcast
with no access rights

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.8 IGMP Vlan System Configuration Command


Command Description
This command allows the operator to configure the IGMP parameters on a per Vlan basis.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp ( no vlan (vlan-id) ) | ( vlan (vlan-id) netw-igmp-version <Igmp::VlanV3ProcessStatus> [ no
v3-max-num-rec | v3-max-num-rec <Igmp::V3MaxNumRecordReport> ] )

Command Parameters
Table 26.8-1 "IGMP Vlan System Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan index
- range: [1...4093]

index of the system vlan

Table 26.8-2 "IGMP Vlan System Configuration Command" Command Parameters


Parameter

Type

Description

netw-igmp-version

Parameter type: <Igmp::VlanV3ProcessStatus>


Format:
(2
|3)
Possible values:
- 2 : IGMP version2
- 3 : IGMP version3
Parameter type: <Igmp::V3MaxNumRecordReport>
Format:
- max num of group records in one IGMPv3 report (2 exp N)
- range: [0...10]

mandatory parameter
IGMP version of the protocol

[no] v3-max-num-rec

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 3
max num of group records in one
IGMPv3 report (2 exp N)

Released

719

26 IGMP Configuration Commands

26.9 SHub IGMP IGS System Configuration


Command
Command Description
This command allows the operator to configure the IGS system-related parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub igs-system [ [ no ] start-snooping ] [ [ no ] enable-snooping ] [ self-ip-addr-mode
<Igmp::SelfIpAddressMode> ] [ no self-ip-addr | self-ip-addr <Ip::V4Address> ] [ trace-selection <SignedInteger>
] [ no router-purge-intv | router-purge-intv <Igmp::RouterInterval> ] [ no host-purge-intv | host-purge-intv
<Igmp::HostInterval> ] [ no max-mcast-learn | max-mcast-learn <Igmp::MaxMulticastLearn> ] [ no glb-leave |
glb-leave
<Igmp::GlobalLeaveMessageStatus>
]
[
no
reduced-resp-int
|
reduced-resp-int
<Igmp::ReducedResponseInterval> ] [ no remove-root-int | remove-root-int <Igmp::RemoveRootTimer> ] [ [ no ]
full-flooding-off ]

Command Parameters
Table 26.9-2 "SHub IGMP IGS System Configuration Command" Command Parameters
Parameter

Type

Description

[no] start-snooping

Parameter type: boolean

[no] enable-snooping

Parameter type: boolean

self-ip-addr-mode

Parameter type: <Igmp::SelfIpAddressMode>


Format:
( configure
| from-ip )
Possible values:
- configure : query by configure
- from-ip : query by ip
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

optional parameter
start the snooping module
optional parameter
enable snooping in the system
optional parameter
sets the mode through which IP
address can be got

[no] self-ip-addr

trace-selection

720

Parameter type: <SignedInteger>


Format:
- a signed integer

Released

optional parameter with default


value: "0.0.0.0"
The parameter is not visible
during creation.
source address while sending
IGMP query
obsolete parameter that will be
ignored
specifies what will be traced

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Parameter

Type

Description

[no] router-purge-intv

Parameter type: <Igmp::RouterInterval>


Format:
- interval after which port entry be purged
- unit: sec
- range: [1...900]
Parameter type: <Igmp::HostInterval>
Format:
- interval after which port entry be purged
- unit: sec
- range: [12...1825]
Parameter type: <Igmp::MaxMulticastLearn>
Format:
- max number of mcast entry shub can learn for channel
CAC
- range: [0...1024]
Parameter type: <Igmp::GlobalLeaveMessageStatus>
Format:
( enabled
| disabled )
Possible values:
- enabled : enable the IGMP global leave messages
- disabled : disable the IGMP global leave messages
Parameter type: <Igmp::ReducedResponseInterval>
Format:
- timer to respond a report with in the interval
- unit: sec
- range: [1...255]
Parameter type: <Igmp::RemoveRootTimer>
Format:
- remove multicast root in h/w after sending leave message
- unit: sec
- range: [0...128]
Parameter type: boolean

optional parameter with default


value: 125
interval after which router port
entry be purged

[no] host-purge-intv

[no] max-mcast-learn

[no] glb-leave

[no] reduced-resp-int

[no] remove-root-int

[no] full-flooding-off

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 260
interval after which host port
entry be purged
optional parameter with default
value: 0
max num of mcast entry shub can
learn for channel CAC
optional parameter with default
value: "enabled"
enables or disables sending
IGMP global leave messages

optional parameter with default


value: 125
timer to respond a report with in
the interval
optional parameter with default
value: 2
remove mcast root in h/w after
sending leave message
optional parameter
disables full-flooding for mcast
streams

Released

721

26 IGMP Configuration Commands

26.10 SHub IGMP Response Timer Configuration


Command
Command Description
This command allows the operator to configure the SHub response timer for each VLAN.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub response-timer (vlan-id) [ no leave-rsp-timer | leave-rsp-timer <Igmp::LeaveResponse> ]

Command Parameters
Table 26.10-1 "SHub IGMP Response Timer Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

VlanId for the leave response


timer

Table 26.10-2 "SHub IGMP Response Timer Configuration Command" Command Parameters
Parameter

Type

Description

[no] leave-rsp-timer

Parameter type: <Igmp::LeaveResponse>


Format:
- time intvl(secs) before sending leave message to router
- range: [0...10]

optional parameter with default


value: 1
interval to wait for query
response from host

722

Released

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.11 SHub IGMP Router Port Configuration


Command
Command Description
This command allows the operator to configure the reachable router port.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub ( no vlan-router-port (vlan-id) network-port <Shub::NetworkPort> ) | ( vlan-router-port
(vlan-id) network-port <Shub::NetworkPort> )

Command Parameters
Table 26.11-1 "SHub IGMP Router Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Shub::NetworkPort>
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

the id of a vlan for which a


network port is reachable

network-port

3HH-04416-EBAA-TCZZA 01

the network port that is reachable

Released

723

26 IGMP Configuration Commands

26.12 SHub IGMP VLAN Filter Configuration


Command
Command Description
This command allows the operator to configure the VLAN filter status to enable or disable IGMP snooping on that
specific VLAN.
Guidelines to configure "self-ip-addr" and "self-ip-addr-mode" (optional parameters in this command) :
configure self-ip-addr : The configuration of "self-ip-addr" is dependent on the value of the
"self-ip-addr-mode". When the self-ip-addr-mode has been set to "conf-ip-addr", it is allowed to configure the
"self-ip-addr". In all other cases, the configuration of the "self-ip-addr" will be rejected.
configure self-ip-addr-mode as "inherit-ip-intf" or "inherit-system" : The configuration of the ip-address at
interface shub ip level or system level is a precondition when setting the options "inherit-ip-intf" or
"inherit-system". The configuration of an inherit option will be rejected if the related precondition is not
fullfilled.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub vlan-filter (filter-id) [ [ no ] snoop-filter ] [ no igmp-version | igmp-version
<Igmp::VlanVersion> ] [ no operation-mode | operation-mode <Igmp::VlanMode> ] [ no self-ip-addr-mode |
self-ip-addr-mode <Igmp::VlanSelfIpAddressMode> ] [ no self-ip-addr | self-ip-addr <Ip::V4Address> ] [ no
querier | querier <Igmp::VlanQuerier> ] [ no query-int | query-int <Igmp::VlanQueryInterval> ] [ no
v2-max-rsp-time | v2-max-rsp-time <Igmp::V2VlanMaxResponseTime> ] [ no v3-max-rsp-time | v3-max-rsp-time
<Igmp::V3VlanMaxResponseTime> ] [ no v3-max-num-rec | v3-max-num-rec <Igmp::VlanMaxV3AllowedGrps>
] [ no drop-rpt-network | drop-rpt-network <Igmp::ReportAcptOnAllPorts> ] [ no robustness | robustness
<Igmp::VlanRobustnessVar> ] [ no unsolicit-rpt-int | unsolicit-rpt-int <Igmp::VlanUnsolicitedReportInterval> ] [
no retry-count | retry-count <Igmp::VlanRetryCount> ]

Command Parameters
Table 26.12-1 "SHub IGMP VLAN Filter Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(filter-id)

Format:
- vlan id for igmp filter
- range: [1...4093]

Vlan Id for which IGMP features


is to be disabled

Table 26.12-2 "SHub IGMP VLAN Filter Configuration Command" Command Parameters
Parameter

Type

Description

[no] snoop-filter

Parameter type: boolean

optional parameter
enable the snoop filter

724

Released

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

Parameter

Type

Description

[no] igmp-version

Parameter type: <Igmp::VlanVersion>


Format:
(2
|3)
Possible values:
- 2 : IGMPv2 of the vlan
- 3 : IGMPv3 of the vlan
Parameter type: <Igmp::VlanMode>
Format:
( enhance-perf <SignedInteger>
| proxy-reporting <SignedInteger> )
Possible values:
- enhance-perf : mode of the Vlan
- proxy-reporting : mode of the Vlan
Field type <SignedInteger>
- a signed integer
Parameter type: <Igmp::VlanSelfIpAddressMode>
Format:
( conf-ip-addr
| inherit-ip-intf
| inherit-system )
Possible values:
- conf-ip-addr : source IP @ inherited from the self-ip-addr
object
- inherit-ip-intf : source IP@ inherited from the configured
IP interface
- inherit-system : inherit value from system object
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

optional parameter with default


value: "3"
version of IGMP protocol for
Vlan

[no] operation-mode

[no] self-ip-addr-mode

[no] self-ip-addr

[no] querier

[no] query-int

[no] v2-max-rsp-time

[no] v3-max-rsp-time

[no] v3-max-num-rec

3HH-04416-EBAA-TCZZA 01

Parameter type: <Igmp::VlanQuerier>


Format:
( enabled
| disabled )
Possible values:
- enabled : enable the snooping switch to generate general
query messages
- disabled : disable the generation of general query messages
Parameter type: <Igmp::VlanQueryInterval>
Format:
- interval in which LANX will wait to send query messsage
- range: [60...600]
Parameter type: <Igmp::V2VlanMaxResponseTime>
Format:
- time to insert in the GMQ messages for IGMPv2
- unit: sec
- range: [1...25]
Parameter type: <Igmp::V3VlanMaxResponseTime>
Format:
- time to insert in the GMQ messages for IGMPV3
- unit: sec
- range: [1...600]
Parameter type: <Igmp::VlanMaxV3AllowedGrps>
Format:

optional parameter with default


value: "proxyreorting"
Vlan Mode for IGMP

optional parameter with default


value: "inherit-system"
mode to replace Source IP
address for IGMP packet

optional parameter with default


value: "0.0.0.0"
The parameter is not visible
during creation.
source address on IGMPreptmsgs
and IGMPgenmsgs
optional parameter with default
value: "disabled"
enables or disables query
message generation

optional parameter with default


value: 125
interval,LANX will wait to send
the query messsage
optional parameter with default
value: 25
time to insert in the GMQ
messages for IGMPv2
optional parameter with default
value: 125
time to insert in the GMQ
messages for IGMPV3
optional parameter with default
value: 3

Released

725

26 IGMP Configuration Commands

Parameter
[no] drop-rpt-network

[no] robustness

[no] unsolicit-rpt-int

[no] retry-count

726

Released

Type

Description

- max number of groups per generated igmpv3 report


- range: [0...10]
Parameter type: <Igmp::ReportAcptOnAllPorts>
Format:
( enabled
| disabled )
Possible values:
- enabled : enable IGMP to accept reports/leaves messages
- disabled : disable IGMP to accept reports/leaves messages
Parameter type: <Igmp::VlanRobustnessVar>
Format:
- number of unsolicited report should sent on the network
- range: [1...10]
Parameter type: <Igmp::VlanUnsolicitedReportInterval>
Format:
- interval to send unsolicited membership report
- range: [1...255]
Parameter type: <Igmp::VlanRetryCount>
Format:
- max nunber of queries sent before deleting the port
- range: [0...10]

max number of records per


generated igmpv3 report
optional parameter with default
value: "enabled"
IGMP snooping module accepts
reports/leave messages

optional parameter with default


value: 1
number of unsolicited report
should sent on the network
optional parameter with default
value: 10
interval to send unsolicited
membership report
optional parameter with default
value: 0
max number of queries sent
before deleting the port

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.13 Shub IGMP Vlan enhanced performance


Configuration Command
Command Description
This command allows the operator to configure a specific to the Enhanced Performance IGMP snooping

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub ( no vlan-enhance-perf (vlan-id) ) | ( vlan-enhance-perf (vlan-id) [ no pkt-fwd-state |
pkt-fwd-state <Igmp::PktFwdState> ] )

Command Parameters
Table 26.13-1 "Shub IGMP Vlan enhanced performance Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Table 26.13-2 "Shub IGMP Vlan enhanced performance Configuration Command" Command
Parameters
Parameter

Type

Description

[no] pkt-fwd-state

Parameter type: <Igmp::PktFwdState>


Format:
( enabled
| disabled )
Possible values:
- enabled : colored the report messages will be forward in
the upstream
- disabled : colored the report messages will not be
forwarded in the upstream

optional parameter with default


value: "disabled"
enable/disable,colord report msg
to be forwded in upstrm

3HH-04416-EBAA-TCZZA 01

Released

727

26 IGMP Configuration Commands

26.14 Shub IGMP CAC BUNDLE TABLE


Configuration Command
Command Description
This command allows the operator to configure igmp CAC BUNDLE.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub ( no bundle (bundle) ) | ( bundle (bundle) [ no bandwidth | bandwidth
<Igmp::BundleBandWidth> ] [ no max-num-channel | max-num-channel <Igmp::BundleMaxChannel> ] )

Command Parameters
Table 26.14-1 "Shub IGMP CAC BUNDLE TABLE Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(bundle)

Format:
- the name of the bundle
- length: x<=32

name of this bundle

Table 26.14-2 "Shub IGMP CAC BUNDLE TABLE Configuration Command" Command
Parameters
Parameter

Type

Description

[no] bandwidth

Parameter type: <Igmp::BundleBandWidth>


Format:
- max bandwidth for this bundle
- unit: kbps
- range: [0...2147483647]
Parameter type: <Igmp::BundleMaxChannel>
Format:
- max allowed channels for this bundle
- range: [0...1024]

optional parameter with default


value: 0
max bandwidth for this bundle

[no] max-num-channel

728

Released

optional parameter with default


value: 0
max allowed channels for this
bundle

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.15 IGMP Multicast Vlan Translation Command


Command Description
This command allows the operator configure source-pon vlan translation.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp ( no mc-vlan-xlate (nwvlan) ) | ( mc-vlan-xlate (nwvlan) ponvlan <Igmp::mcPonVlanId> )

Command Parameters
Table 26.15-1 "IGMP Multicast Vlan Translation Command" Resource Parameters
Resource Identifier

Type

Description

(nwvlan)

Format:
- the multicast vlan id
- range: [2...4093]

identification of the network-side


virtual lan

Table 26.15-2 "IGMP Multicast Vlan Translation Command" Command Parameters


Parameter

Type

Description

ponvlan

Parameter type: <Igmp::mcPonVlanId>


Format:
- vlan index
- range: [1...4093]

mandatory parameter
identification of the pon-side
virtual lan

3HH-04416-EBAA-TCZZA 01

Released

729

26 IGMP Configuration Commands

26.16 IGMP Multicast Pon Vlan Translation


Command
Command Description
This command allows the operator configure source-pon vlan translation on pon port.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp ( no mc-pon-vlan-xlate (pon) nwvlan <Igmp::mcSrcVlanId> ) | ( mc-pon-vlan-xlate (pon) nwvlan
<Igmp::mcSrcVlanId> ponvlan <Igmp::mcPonVlanId> )

Command Parameters
Table 26.16-1 "IGMP Multicast Pon Vlan Translation Command" Resource Parameters
Resource Identifier

Type

(pon)

Format:
identification of the pon interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Parameter type: <Igmp::mcSrcVlanId>
identification of the network-side
Format:
virtual lan
- the multicast vlan id
- range: [2...4093]

nwvlan

Description

Table 26.16-2 "IGMP Multicast Pon Vlan Translation Command" Command Parameters
Parameter

Type

Description

ponvlan

Parameter type: <Igmp::mcPonVlanId>


Format:
- vlan index
- range: [1...4093]

mandatory parameter
identification of the pon-side
virtual lan

730

Released

3HH-04416-EBAA-TCZZA

01

26 IGMP Configuration Commands

26.17 Igmp Multicast Service Context Configuration


Command
Command Description
This command allows the operator to configure multicast service context

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp ( no mcast-svc-context (name) ) | ( mcast-svc-context (name) )

Command Parameters
Table 26.17-1 "Igmp Multicast Service Context Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

A unique profile name for the


service context

3HH-04416-EBAA-TCZZA 01

Released

731

27- Multicast Configuration Commands

27.1 Multicast Configuration Command Tree


27.2 Multicast General Group Configuration Command
27.3 General Multicast Package Members Configuration
Command
27.4 Multicast Capacity Configuration Command
27.5 Multicast Channel Configuration Command
27.6 Multicast Channel Package Members Configuration
Command
27.7 Multicast Channel Configuration Command
27.8 Multicast Channel Package Members Configuration
Command
27.9 Multicast Monitoring Source Configuration Command
27.10 Multicast Monitoring Channel Configuration
Command
27.11 Multicast Static Branch Configuration Command
27.12 SHub IGMP CAC Multicast System Configuration
Command
27.13 SHub Static Multicast Streams Configuration
Command
27.14 SHub Static Multicast Egress Port Configuration
Command
27.15 SHub IGMP CAC Multicast Sources Configuration
Command

732

Released

27-733
27-735
27-737
27-738
27-739
27-741
27-742
27-744
27-745
27-746
27-747
27-749
27-750
27-751
27-753

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.1 Multicast Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Multicast Configuration Commands".

Command Tree
----configure
----mcast
----general
- [no] fast-change
- [no] pkg-memb-bitmap
- [no] max-bitrate
- [no] mean-bit-rate
----[no] package-member
- (package)
----capacity
- [no] max-num-group
- [no] max-num-uncfg
- [no] cfg-res-time
- [no] uncfg-res-time
----X [no] channel
- (grp-ip-addr)
- src-ip-addr
- [no] dis-fast-change
- [no] pkg-mem-bitmap
- [no] name
- [no] guaranteed-serv
- [no] peak-bit-rate
- vlan-id
- [no] service-name
- [no] preview-duration
- [no] preview-number
- [no] preview-blackout
----[no] packagemember
- (package)
----[no] chn
- (grp-ip-addr)
- src-ip-addr
- vlan-id
- [no] end-ip-addr
- [no] mcast-svc-context
- [no] dis-fast-change
- [no] name
- [no] guaranteed-serv
- [no] peak-bit-rate
- [no] service-name
- [no] preview-duration
- [no] preview-number
- [no] preview-blackout
----[no] packagemember
- (package)

3HH-04416-EBAA-TCZZA 01

Released

733

27 Multicast Configuration Commands

----monitor
----[no] src
- (grp-ip-addr)
- src-ip-addr
- [no] loss-duration
- [no] loss-thresh-alert
----[no] chn
- (grp-ip-addr)
- src-ip-addr
- vlan-id
- [no] loss-duration
- [no] loss-thresh-alert
----static
----[no] branch
- (grp-ip-addr)
- src-ip-addr
- port
----shub
X active-streams
- [no] max-bw
- [no] max-no-rate-based
----[no] mcast-addr
- (mcast-addr)
- vlan-id
----[no] egress-port
- (port)
----[no] src
- (src)
- vlan-id
- ip-addr
- [no] eth-sus-bit-rate
- [no] guaranteed-serv
- [no] bundle

734

Released

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.2 Multicast General Group Configuration


Command
Command Description
This command allows the operator to configure general multicast parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast general [ [ no ] fast-change ] [ no pkg-memb-bitmap | pkg-memb-bitmap
<Igmp::PkgMemBitMap> ] [ no max-bitrate | max-bitrate <Igmp::GeneralMcastMaxBitRate> ] [ no mean-bit-rate |
mean-bit-rate <Igmp::GeneralMcastMeanBitRate> ]

Command Parameters
Table 27.2-2 "Multicast General Group Configuration Command" Command Parameters
Parameter

Type

Description

[no] fast-change

Parameter type: boolean

[no] pkg-memb-bitmap

Parameter type: <Igmp::PkgMemBitMap>


Format:
- a binary string
- length: 128

[no] max-bitrate

Parameter type: <Igmp::GeneralMcastMaxBitRate>


Format:
- reasonable max bitrate in ATM level for upstream
- unit: kbps
- range: [0...100000]

optional parameter
enable fast channel change
optional parameter with default
value: "ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff : ff : ff : ff :
ff : ff : ff : ff : ff : ff : ff : ff : ff : ff
: ff : ff : ff : ff : ff : ff"
package(s) a class D address
belongs
optional parameter with default
value: 2500
reasonable downstream max
bitrate in ATM level

3HH-04416-EBAA-TCZZA 01

Released

735

27 Multicast Configuration Commands

Parameter

Type

Description

[no] mean-bit-rate

Parameter type: <Igmp::GeneralMcastMeanBitRate>


Format:
- reasonable mean bitrate in ATM level for upstream
- unit: kbps
- range: [0...100000]

optional parameter with default


value: 2500
reasonable downstream mean
bitrate in ATM level

736

Released

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.3 General Multicast Package Members


Configuration Command
Command Description
This command allows the operator to configure the IGMP general multicast package members.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure mcast general ( no package-member (package) ) | ( package-member (package) )

Command Parameters
Table 27.3-1 "General Multicast Package Members Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(package)

Format:
- the package number
- range: [1...1024]

package member

3HH-04416-EBAA-TCZZA 01

Released

737

27 Multicast Configuration Commands

27.4 Multicast Capacity Configuration Command


Command Description
This command allows the operator to configure the multicast capacity parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast capacity [ no max-num-group | max-num-group <Igmp::McastCapacityMaxNumGroup> ] [ no
max-num-uncfg | max-num-uncfg <Igmp::McastCapacityMaxNumUnCfg> ] [ no cfg-res-time | cfg-res-time
<Igmp::multicastCapacityCfgSourceReserveTime>
]
[
no
uncfg-res-time
|
uncfg-res-time
<Igmp::multicastCapacityUnCfgSourceReserveTime> ]

Command Parameters
Table 27.4-2 "Multicast Capacity Configuration Command" Command Parameters
Parameter

Type

[no] max-num-group

Parameter type: <Igmp::McastCapacityMaxNumGroup>


Format:
- no of groups the system can support in enough bandwidth
- range: [0...2048]

[no] max-num-uncfg

[no] cfg-res-time

[no] uncfg-res-time

738

Released

Description

optional parameter with default


value: 1024
max number of groups the system
(per LT) supports in enough
bandwidth
Parameter type: <Igmp::McastCapacityMaxNumUnCfg>
optional parameter with default
Format:
value: 64
- no of uncfg grps,system can support in enough bandwidth max number of uncfg groups the
- range: [0...1024]
system (per LT) supports in
enough bandwidth
Parameter
type: optional parameter with default
<Igmp::multicastCapacityCfgSourceReserveTime>
value: 125
Format:
time to reserve the unused
- time to reserve
guaranteed configured groups
- unit: sec
- range: [0...2147483647]
Parameter
type: optional parameter with default
<Igmp::multicastCapacityUnCfgSourceReserveTime>
value: 0
Format:
time to reserve the unused
- time to reserve
unconfigured groups
- unit: sec
- range: [0...2147483647]

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.5 Multicast Channel Configuration Command


Command Description
Obsolete command, replaced by configure mcast chn.
This command allows the operator to configure the multicast channel.
Note:Mcast channel can not be deleted when VlanSelection is enabled.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast ( no channel (grp-ip-addr) src-ip-addr <Ip::V4Address> ) | ( channel (grp-ip-addr) src-ip-addr
<Ip::V4Address> [ [ no ] dis-fast-change ] [ no pkg-mem-bitmap | pkg-mem-bitmap <Igmp::PkgMemBitMap> ] [
no name | name <Igmp::multicastSrcName> ] [ [ no ] guaranteed-serv ] [ no peak-bit-rate | peak-bit-rate
<Igmp::McastSrcEtherPeakBitRate> ] vlan-id <Igmp::McastSrcVLANID> [ no service-name | service-name
<Igmp::multicastSrcServiceName>
]
[
no
preview-duration
|
preview-duration
<Igmp::multicastSrcMaxPreDuration>
]
[
no
preview-number
|
preview-number
<Igmp::multicastSrcMaxPreNumber>
]
[
no
preview-blackout
|
preview-blackout
<Igmp::multicastSrcPreBlackout> ] )
Obsolete command, replaced by configure mcast chn.

Command Parameters
Table 27.5-1 "Multicast Channel Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22

src-ip-addr

Table 27.5-2 "Multicast Channel Configuration Command" Command Parameters


Parameter

Type

Description

[no] dis-fast-change

Parameter type: boolean

[no] pkg-mem-bitmap

Parameter type: <Igmp::PkgMemBitMap>


Format:
- a binary string
- length: 128

optional parameter
disable fast channel change
optional parameter with default
value: "01 : 00 : 00 : 00 : 00 : 00
: 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :

3HH-04416-EBAA-TCZZA 01

Released

739

27 Multicast Configuration Commands

Parameter

Type

[no] name

[no] guaranteed-serv

Description
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00"
indicates to which package(s) a
mcast channel belongs
optional parameter with default
value: ""
name of the mcast channel

Parameter type: <Igmp::multicastSrcName>


Format:
- a printable string
- length: x<=32
Parameter type: boolean

[no] peak-bit-rate

Parameter type: <Igmp::McastSrcEtherPeakBitRate>


Format:
- peak bit rate for transmit/downstream traffic
- unit: kbps
- range: [0...100000]

vlan-id

Parameter type: <Igmp::McastSrcVLANID>


Format:
- VLAN for this multicast source
- range: [1...4093]
Parameter type: <Igmp::multicastSrcServiceName>
Format:
- a printable string
- length: x<=32
Parameter type: <Igmp::multicastSrcMaxPreDuration>
Format:
- reasonable max duration for each preview per mcast grp
- unit: sec
- range: [1...6000]
Parameter type: <Igmp::multicastSrcMaxPreNumber>
Format:
- valid max no. of previews for each preview per mcast grp
- range: [1...100]
Parameter type: <Igmp::multicastSrcPreBlackout>
Format:
- valid preview Blackout Duration time of per mcast group
- unit: sec
- range: [0...7200]

[no] service-name

[no] preview-duration

[no] preview-number

[no] preview-blackout

740

Released

optional parameter
enable guaranteed service
optional parameter with default
value: 2125
The parameter is not visible
during modification.
ethernet peak bit rate for
downstream traffic
mandatory parameter
The parameter is not visible
during modification.
VLAN for this multicast channel
optional parameter with default
value: ""
name of service or service
provider of the mcast channel
optional parameter with default
value: 180
Maximum duration for each
preview per multicast channel
optional parameter with default
value: 3
Max number of previews for each
preview per mcast group
optional parameter with default
value: 0
Preview Blackout Duration time
of per multicast channel

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.6 Multicast Channel Package Members


Configuration Command
Command Description
This command allows the operator to configure the multicast channel package members.
A multicast channel can be member of maximum 20 packages or be member of all (1024) packages, any value in
between will be rejected.
Using this command packages will be added or removed from/to the list of packages of which the multicast channel
is currently a member.
If the multicast channel is member of all packages care must be taken when removing packages, meaning that the
command will only be accepted if after execution the multicast channel will be member of 20 packages or less.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast channel (grp-ip-addr)src-ip-addr <Ip::V4Address> ( no packagemember (package) ) | (
packagemember (package) )

Command Parameters
Table 27.6-1 "Multicast Channel Package Members Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
package member

src-ip-addr

(package)

3HH-04416-EBAA-TCZZA 01

Format:
- the package number
- range: [1...1024]

Released

741

27 Multicast Configuration Commands

27.7 Multicast Channel Configuration Command


Command Description
This command allows the operator to configure the multicast channel.
Note:Mcast channel can not be deleted when VlanSelection is enabled.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast ( no chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastChannelVlan> ) | ( chn
(grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastChannelVlan> [ no end-ip-addr | end-ip-addr
<Ip::V4Address> ] [ no mcast-svc-context | mcast-svc-context <Igmp::McastSvcCtxtName> ] [ [ no ]
dis-fast-change ] [ no name | name <Igmp::multicastSrcName> ] [ [ no ] guaranteed-serv ] [ no peak-bit-rate |
peak-bit-rate
<Igmp::McastSrcEtherPeakBitRate>
]
[
no
service-name
|
service-name
<Igmp::multicastSrcServiceName>
]
[
no
preview-duration
|
preview-duration
<Igmp::multicastSrcMaxPreDuration>
]
[
no
preview-number
|
preview-number
<Igmp::multicastSrcMaxPreNumber>
]
[
no
preview-blackout
|
preview-blackout
<Igmp::multicastSrcPreBlackout> ] )

Command Parameters
Table 27.7-1 "Multicast Channel Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
vlanid of the multicast channel
which is configured in it

src-ip-addr

vlan-id

Parameter type: <Igmp::McastChannelVlan>


Format:
- vlan id for multicast
- range: [1...4093]

Table 27.7-2 "Multicast Channel Configuration Command" Command Parameters


Parameter

Type

Description

[no] end-ip-addr

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

optional parameter with default


value: "0.0.0.0"
The parameter is not visible
during modification.
end ip address of the range of
multicast addresses starting from

742

Released

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

Parameter

Type

[no] mcast-svc-context

Parameter type: <Igmp::McastSvcCtxtName>


Format:
( name : <Qos::IgnoredQosProfileName>
| default )
Possible values:
- default : Default profile is associated
- name : Name of the multicast service context profile
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: boolean

[no] dis-fast-change
[no] name

[no] guaranteed-serv

Description

Parameter type: <Igmp::multicastSrcName>


Format:
- a printable string
- length: x<=32
Parameter type: boolean

[no] peak-bit-rate

Parameter type: <Igmp::McastSrcEtherPeakBitRate>


Format:
- peak bit rate for transmit/downstream traffic
- unit: kbps
- range: [0...100000]

[no] service-name

Parameter type: <Igmp::multicastSrcServiceName>


Format:
- a printable string
- length: x<=32
Parameter type: <Igmp::multicastSrcMaxPreDuration>
Format:
- reasonable max duration for each preview per mcast grp
- unit: sec
- range: [1...6000]
Parameter type: <Igmp::multicastSrcMaxPreNumber>
Format:
- valid max no. of previews for each preview per mcast grp
- range: [1...100]
Parameter type: <Igmp::multicastSrcPreBlackout>
Format:
- valid preview Blackout Duration time of per mcast group
- unit: sec
- range: [0...7200]

[no] preview-duration

[no] preview-number

[no] preview-blackout

3HH-04416-EBAA-TCZZA 01

the group address


optional parameter with default
value: "default"
Multicast Service Context Name

optional parameter
disable fast channel change
optional parameter with default
value: ""
name of the mcast channel
optional parameter
enable guaranteed service
optional parameter with default
value: 2125
The parameter is not visible
during modification.
ethernet peak bit rate for
downstream traffic
optional parameter with default
value: ""
name of service or service
provider of the mcast channel
optional parameter with default
value: 180
Maximum duration for each
preview per multicast channel
optional parameter with default
value: 3
Max number of previews for each
preview per mcast group
optional parameter with default
value: 0
Preview Blackout Duration time
of per multicast channel

Released

743

27 Multicast Configuration Commands

27.8 Multicast Channel Package Members


Configuration Command
Command Description
This command allows the operator to configure the multicast channel package members.
A multicast channel can be member of maximum 20 packages or be member of all (1024) packages, any value in
between will be rejected.
Using this command packages will be added or removed from/to the list of packages of which the multicast channel
is currently a member.
If the multicast channel is member of all packages care must be taken when removing packages, meaning that the
command will only be accepted if after execution the multicast channel will be member of 20 packages or less.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast chn (grp-ip-addr)src-ip-addr <Ip::V4Address>vlan-id <Igmp::McastChannelVlan> ( no
packagemember (package) ) | ( packagemember (package) )

Command Parameters
Table 27.8-1 "Multicast Channel Package Members Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr),range:0.0.0.0....22
vlanid of the multicast channel
which is configured in it

src-ip-addr

vlan-id

Parameter type: <Igmp::McastChannelVlan>


Format:
- vlan id for multicast
- range: [1...4093]
Format:
- the package number
- range: [1...1024]

(package)

744

Released

package member

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.9 Multicast Monitoring Source Configuration


Command
Command Description
This command allows the operator to configure on demand monitoring for a specified multicast stream.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast monitor ( no src (grp-ip-addr) src-ip-addr <Ip::V4Address> ) | ( src (grp-ip-addr) src-ip-addr
<Ip::V4Address> [ no loss-duration | loss-duration <Igmp::LossDuration> ] [ no loss-thresh-alert | loss-thresh-alert
<Igmp::LossThreshold> ] )

Command Parameters
Table 27.9-1 "Multicast Monitoring Source Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255,
except for 224.0.0.22)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

mcast src address in network-byte


order(big-endian)

src-ip-addr

Unicast IP address in case SSM


multicast channel, value 0.0.0.0
means ASM(any-src-ip-addr)

Table 27.9-2 "Multicast Monitoring Source Configuration Command" Command Parameters


Parameter

Type

Description

[no] loss-duration

Parameter type: <Igmp::LossDuration>


Format:
- duration
- unit: sec
- range: [5...2147483647]
Parameter type: <Igmp::LossThreshold>
Format:
- the threshold for loss of traffic alert, 0 - disable
- range: [0...4294967295]

optional parameter with default


value: 15
set the duration to count packets

[no] loss-thresh-alert

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0
set loss of traffic threshold, alert
generated if packet count is less
or equal to the threshold.

Released

745

27 Multicast Configuration Commands

27.10 Multicast Monitoring Channel Configuration


Command
Command Description
This command allows the operator to configure on demand monitoring for a specified multicast stream.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast monitor ( no chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastMonitorVlan>
) | ( chn (grp-ip-addr) src-ip-addr <Ip::V4Address> vlan-id <Igmp::McastMonitorVlan> [ no loss-duration |
loss-duration <Igmp::LossDuration> ] [ no loss-thresh-alert | loss-thresh-alert <Igmp::LossThreshold> ] )

Command Parameters
Table 27.10-1 "Multicast Monitoring Channel Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255,
except for 224.0.0.22)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Igmp::McastMonitorVlan>
Format:
- vlan id for multicast
- range: [0...4093]

mcast src address in network-byte


order(big-endian)

src-ip-addr
vlan-id

Unicast IP address in case SSM


multicast channel, value 0.0.0.0
means ASM(any-src-ip-addr)
vlanid of the multicast channel.
Value 0 means any VLAN ID

Table 27.10-2 "Multicast Monitoring Channel Configuration Command" Command Parameters


Parameter

Type

Description

[no] loss-duration

Parameter type: <Igmp::LossDuration>


Format:
- duration
- unit: sec
- range: [5...2147483647]
Parameter type: <Igmp::LossThreshold>
Format:
- the threshold for loss of traffic alert, 0 - disable
- range: [0...4294967295]

optional parameter with default


value: 15
set the duration to count packets

[no] loss-thresh-alert

746

Released

optional parameter with default


value: 0
set loss of traffic threshold, alert
generated if packet count is less
or equal to the threshold.

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.11 Multicast Static Branch Configuration


Command
Command Description
This command allow the operator to configure the static multicast branch. When at least one static multicast
branch is created, the corresponding static multicast root is created.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast static ( no branch (grp-ip-addr) src-ip-addr <Ip::V4Address> port <Itf::VlanPort> ) | ( branch
(grp-ip-addr) src-ip-addr <Ip::V4Address> port <Itf::VlanPort> )

Command Parameters
Table 27.11-1 "Multicast Static Branch Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating the multicast channel,
value
0.0.0.0
means
ASM(any-src-ip-addr),range:0.0.0.0....22
identification of the vlanport

src-ip-addr

port

3HH-04416-EBAA-TCZZA 01

Parameter type: <Itf::VlanPort>


Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

/
:
/
/
:
/
/
/

Released

747

27 Multicast Configuration Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

748

Released

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.12 SHub IGMP CAC Multicast System


Configuration Command
Command Description
This command allows the operator to configure the system-wide uplink CAC parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast shub [ active-streams <Igmp::MaxMcastLearn> ] [ no max-bw | max-bw
<Igmp::SystemMaxbandwidth> ] [ no max-no-rate-based | max-no-rate-based <Igmp::SystemMaxNoRateBased> ]

Command Parameters
Table 27.12-2 "SHub IGMP CAC Multicast System Configuration Command" Command
Parameters
Parameter

Type

Description

active-streams

Parameter type: <Igmp::MaxMcastLearn>


Format:
- maximum number of simultaneous active multicast streams
- range: [0...1024]

[no] max-bw

Parameter type: <Igmp::SystemMaxbandwidth>


Format:
- max bandwidth for the system
- unit: kbps
- range: [0...2147483647]
Parameter type: <Igmp::SystemMaxNoRateBased>
Format:
- max number for non configured entry
- range: [0...1024]

obsolete parameter that will be


ignored
maximum
number
of
simultaneous active multicast
streams
optional parameter with default
value: 0
maximum bandwidth for the
system

[no] max-no-rate-based

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 0
max no for non config entry,only
for dynamic mc stream

Released

749

27 Multicast Configuration Commands

27.13 SHub Static Multicast Streams Configuration


Command
Command Description
This command allows the operator to specify entries in the IP multicast table for a specific VLAN and multicast IP
address. This configuration applies to the SHub.
The bridge uses this information to determine how to propagate a received frame.
The configuration is used to prohibit flooding of unknown multicast traffic on the specific VLAN and multicast IP
address.
The IP multicast table can hold up to 1000 entries.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast shub ( no mcast-addr (mcast-addr) vlan-id <Vlan::VlanId> ) | ( mcast-addr (mcast-addr) vlan-id
<Vlan::VlanId> )

Command Parameters
Table 27.13-1 "SHub Static Multicast Streams Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(mcast-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Vlan::VlanId>
Format:
- vlan id
- range: [1...4093]

multicast ip address

vlan-id

750

Released

vlan id

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.14 SHub Static Multicast Egress Port


Configuration Command
Command Description
This command allows the operator to specify the ports to which the traffic related to the specified multicast IP
address is to be forwarded.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast shub mcast-addr (mcast-addr)vlan-id <Vlan::VlanId> ( no egress-port (port) ) | ( egress-port
(port) )

Command Parameters
Table 27.14-1 "SHub Static Multicast Egress Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(mcast-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Vlan::VlanId>
Format:
- vlan id
- range: [1...4093]
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : line board
- network : network port
- nt : active nt slot
- unassigned-link : unassigned external link
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number

multicast ip address

vlan-id

(port)

3HH-04416-EBAA-TCZZA 01

vlan id

egress port

Released

751

27 Multicast Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

752

Released

3HH-04416-EBAA-TCZZA

01

27 Multicast Configuration Commands

27.15 SHub IGMP CAC Multicast Sources


Configuration Command
Command Description
This command allows the operator to configure the CAC Multicast Source.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast shub ( no src (src) vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> ) | ( src (src)
vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> [ no eth-sus-bit-rate | eth-sus-bit-rate
<Igmp::McastSrcEtherSustainBitRate> ] [ [ no ] guaranteed-serv ] [ no bundle | bundle
<Igmp::IgnoredBundleName> ] )

Command Parameters
Table 27.15-1 "SHub IGMP CAC Multicast Sources Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(src)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Igmp::McastSrcVLANID>
Format:
- VLAN for this multicast source
- range: [1...4093]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

mcast src address in network-byte


order(big-endian)
vlan for this multicast source

vlan-id

ip-addr

ip address of the multicast server


in
network-byte
order
(big-endian)

Table 27.15-2 "SHub IGMP CAC Multicast Sources Configuration Command" Command
Parameters
Parameter

Type

Description

[no] eth-sus-bit-rate

Parameter type: <Igmp::McastSrcEtherSustainBitRate>


Format:
- sustainable bit rate for transmit/downstream traffic
- range: [0...100000]
Parameter type: boolean

optional parameter with default


value: 2125
sustainable
bit
rate
for
transmit/downstream traffic
optional parameter
enable guaranteed service
optional parameter with default
value: "none"
bundle name of this source

[no] guaranteed-serv
[no] bundle

3HH-04416-EBAA-TCZZA 01

Parameter type: <Igmp::IgnoredBundleName>


Format:
( none

Released

753

27 Multicast Configuration Commands

Parameter

Type

Description

| name : <Igmp::multicastSrcBundleName> )
Possible values:
- none : no bundle name to associate
- name : enter bundle name to be associated
Field type <Igmp::multicastSrcBundleName>
- the name of the bundle
- length: x<=32

754

Released

3HH-04416-EBAA-TCZZA

01

28- PPPoX-Relay Configuration Commands

28.1 PPPoX-Relay Configuration Command Tree


28.2 PPPoX Cross-connect Global Configuration
Command
28.3 PPPoX Cross-connect Engine Configuration
Command
28.4 PPPoX Cross-connect Engine Monitoring
Configuration Command
28.5 PPPCC Engine TCA Threshold Configuration
Command
28.6 PPPoX Cross-connect Client Port Configuration
Command
28.7 PPPoX Cross-connect Client Port Monitoring
Configuration Command

3HH-04416-EBAA-TCZZA 01

28-756
28-757
28-759
28-761
28-762
28-764
28-767

Released

755

28 PPPoX-Relay Configuration Commands

28.1 PPPoX-Relay Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoX-Relay Configuration Commands".

Command Tree
----configure
----pppox-relay
----cross-connect
----global-session
- [no] pado-timeout
- [no] pads-timeout
- [no] max-pad-attempts
- [no] trans-max-age
- [no] cc-max-age
----[no] engine
- (vlan-id)
- [no] mac-addr-conc
- [no] dslf-iwf-tag
- [no] max-payload-tag
- [no] name
- [no] lock
- [no] service-name
----[no] monitor
----tca
- [no] enable
- [no] tran-ageout-15min
- [no] sess-ageout-15min
- [no] tran-ageout-1day
- [no] sess-ageout-1day
----[no] client-port
- (port)
- vlan-id
- default-priority
- [no] max-cc
- [no] qos-profile
----[no] monitor

756

Released

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

28.2 PPPoX Cross-connect Global Configuration


Command
Command Description
This command allows the operator to specify the system-wide configuration parameters applicable to all PPP
sessions.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect global-session [ no pado-timeout | pado-timeout <PPPoX::PadTimeOut> ] [
no pads-timeout | pads-timeout <PPPoX::PadTimeOut> ] [ no max-pad-attempts | max-pad-attempts
<PPPoX::PadRRetrials> ] [ no trans-max-age | trans-max-age <PPPoX::TransactionMaxAge> ] [ no cc-max-age |
cc-max-age <PPPoX::CcMaxAge> ]

Command Parameters
Table 28.2-2 "PPPoX Cross-connect Global Configuration Command" Command Parameters
Parameter

Type

Description

[no] pado-timeout

Parameter type: <PPPoX::PadTimeOut>


Format:
- timeout for PAD-O PAD-S messages
- unit: sec
- range: [1...60]
Parameter type: <PPPoX::PadTimeOut>
Format:
- timeout for PAD-O PAD-S messages
- unit: sec
- range: [1...60]
Parameter type: <PPPoX::PadRRetrials>
Format:
- maximum number of PAD-R messages
- range: [1...16]
Parameter type: <PPPoX::TransactionMaxAge>
Format:
- maximum age of PPP transaction
- unit: sec
- range: [1...300]
Parameter type: <PPPoX::CcMaxAge>
Format:

optional parameter with default


value: 3
timeout for PAD-O message

[no] pads-timeout

[no] max-pad-attempts

[no] trans-max-age

[no] cc-max-age

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 3
timeout for PAD-S message
optional parameter with default
value: 10
maximum number of PAD-R
messages
optional parameter with default
value: 300
maximum age of PPP transaction
optional parameter with default
value: 300

Released

757

28 PPPoX-Relay Configuration Commands

Parameter

758

Released

Type

Description

- maximum age of PPP cross-connection


- range: [10...3000]

maximum age of PPP cross


connection

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

28.3 PPPoX Cross-connect Engine Configuration


Command
Command Description
This command allows the operator to configure the PPP cross-connect engine. The PPP cross-connect engine is
identified by a VLAN ID. The name is the name used to identify the PPP cross-connect engine. The lock command
locks or unlocks the PPP control plane. For example, if the control plane is unlocked, no new PPP
cross-connections can be established, but the existing connections remain until they are released by the PPP server
or client.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect ( no engine (vlan-id) ) | ( engine (vlan-id) [ [ no ] mac-addr-conc ] [ [ no ]
dslf-iwf-tag ] [ no max-payload-tag | max-payload-tag <PPPoX::MaxPayLoadTag> ] [ no name | name
<PPPoX::EngineName> ] [ [ no ] lock ] [ no service-name | service-name <PPPoX::EngineName> ] )

Command Parameters
Table 28.3-1 "PPPoX Cross-connect Engine Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan identity

Table 28.3-2 "PPPoX Cross-connect Engine Configuration Command" Command Parameters


Parameter

Type

Description

[no] mac-addr-conc

Parameter type: boolean

optional parameter
The parameter is not visible

3HH-04416-EBAA-TCZZA 01

Released

759

28 PPPoX-Relay Configuration Commands

Parameter

Type

Description

[no] dslf-iwf-tag

Parameter type: boolean

[no] max-payload-tag

Parameter type: <PPPoX::MaxPayLoadTag>


Format:
( insert
| no-insert )
Possible values:
- insert : add tag holding the MRU to PADI and PADR
messages
- no-insert : donot add tag holding the MRU to PADI and
PADR messages
Parameter type: <PPPoX::EngineName>
Format:
- Engine Name
- length: 1<=x<=32
Parameter type: boolean

[no] name

[no] lock
[no] service-name

760

Parameter type: <PPPoX::EngineName>


Format:
- Engine Name
- length: 1<=x<=32

Released

during modification.
enable
MAC
address
concentration
optional parameter
insert DSLF IWF Tag into
PPPoE Discovery packets
optional parameter with default
value: "no-insert"
insert:add tag holding the MRU
to PADI and PADR messages

optional parameter with default


value: ""
name to identify the engine
optional parameter
lock control plane engine
optional parameter with default
value: ""
service name issued by engine in
PAD-I message

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

28.4 PPPoX Cross-connect Engine Monitoring


Configuration Command
Command Description
This command allows the operator to configure the exception event counters for the PPP cross-connect engine.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect engine (vlan-id) ( no monitor ) | ( monitor )

Command Parameters
Table 28.4-1 "PPPoX Cross-connect Engine Monitoring Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan identity

3HH-04416-EBAA-TCZZA 01

Released

761

28 PPPoX-Relay Configuration Commands

28.5 PPPCC Engine TCA Threshold Configuration


Command
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per PPP CC Engine.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect engine (vlan-id) tca [ [ no ] enable ] [ no tran-ageout-15min |
tran-ageout-15min
<PPPoX::TcaThreshold>
]
[
no
sess-ageout-15min
|
sess-ageout-15min
<PPPoX::TcaThreshold> ] [ no tran-ageout-1day | tran-ageout-1day <PPPoX::TcaThreshold> ] [ no
sess-ageout-1day | sess-ageout-1day <PPPoX::TcaThreshold> ]

Command Parameters
Table 28.5-1 "PPPCC Engine TCA Threshold Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan identity

Table 28.5-2 "PPPCC Engine TCA Threshold Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] tran-ageout-15min

Parameter type: <PPPoX::TcaThreshold>

optional parameter
enable the reporting of TCA's for
this pppcc engine
optional parameter with default

762

Released

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

Parameter

[no] sess-ageout-15min

[no] tran-ageout-1day

[no] sess-ageout-1day

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
- value of the tca threshold for the pppcc engine
- range: [0...65535]
Parameter type: <PPPoX::TcaThreshold>
Format:
- value of the tca threshold for the pppcc engine
- range: [0...65535]
Parameter type: <PPPoX::TcaThreshold>
Format:
- value of the tca threshold for the pppcc engine
- range: [0...65535]
Parameter type: <PPPoX::TcaThreshold>
Format:
- value of the tca threshold for the pppcc engine
- range: [0...65535]

value: 0
configurable threshold for the
transaction ageout 15min counter
optional parameter with default
value: 0
configurable threshold for the
session ageout 15min counter
optional parameter with default
value: 0
configurable threshold for the
transaction ageout 1day counter
optional parameter with default
value: 0
configurable threshold for the
session ageout 1day counter

Released

763

28 PPPoX-Relay Configuration Commands

28.6 PPPoX Cross-connect Client Port


Configuration Command
Command Description
This command allows the operator to specify the PPP cross-connect client port. When creating a client port on a
vlan port, only a Cvlan may be used.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect ( no client-port (port) ) | ( client-port (port) vlan-id
<Vlan::StackedVlanSigned>
default-priority
<PPPoX::DefaultPriority>
[
no
max-cc
|
max-cc
<PPPoX::MaxNumPppCc> ] [ no qos-profile | qos-profile <PPPoX::QosProfileName> ] )

Command Parameters
Table 28.6-1 "PPPoX Cross-connect Client Port Configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>

764

Released

Description
client port identification
/
/
/
:
/
/
:
/
:
/
/
:
/
/

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

Resource Identifier

Type

Description

<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

3HH-04416-EBAA-TCZZA 01

Released

765

28 PPPoX-Relay Configuration Commands

Resource Identifier

Type

Description

Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 28.6-2 "PPPoX Cross-connect Client Port Configuration Command" Command Parameters
Parameter

Type

Description

vlan-id

Parameter type: <Vlan::StackedVlanSigned>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <PPPoX::DefaultPriority>
Format:
- indicates the p-bit for the client port
- range: [0...7]
Parameter type: <PPPoX::MaxNumPppCc>
Format:
- max no. of PPP cross connection on a port
- range: [1...64], [9...64] = 8 with MAC concentration.
Parameter type: <PPPoX::QosProfileName>
Format:
( none
| name : <PPPoX::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <PPPoX::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

mandatory parameter
The parameter is not visible
during modification.
associates client port to cc-engine

default-priority

[no] max-cc

[no] qos-profile

766

Released

mandatory parameter
indicates the p-bit for the client
port
optional parameter with default
value: 64
max no. of PPP cross connection
on a port
optional parameter with default
value: "none"
qos profile name associated with
client port

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

28.7 PPPoX Cross-connect Client Port Monitoring


Configuration Command
Command Description
This command allows the operator to configure the exception event counters for the PPP cross-connect client port.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect client-port (port) ( no monitor ) | ( monitor )

Command Parameters
Table 28.7-1 "PPPoX Cross-connect Client Port Monitoring Configuration Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>

3HH-04416-EBAA-TCZZA 01

Description
client port identification
/
/
/
:
/
/
:
/
:
/
/
:
/
/
:

Released

767

28 PPPoX-Relay Configuration Commands

Resource Identifier

Type

Description

| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity

768

Released

3HH-04416-EBAA-TCZZA

01

28 PPPoX-Relay Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

769

29- PPPoE Configuration Commands

29.1 PPPoE Configuration Command Tree


29.2 PPPoE Profile Configuration Command
29.3 PPPoE Client Interface Configuration Command

770

Released

29-771
29-772
29-774

3HH-04416-EBAA-TCZZA

01

29 PPPoE Configuration Commands

29.1 PPPoE Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoE Configuration Commands".

Command Tree
----configure
----pppoe-client
----[no] ppp-profile
- (name)
- [no] ipversion
- [no] authproto
- [no] mru
----[no] interface
- (ifindex)
- client-id
- profile-name
- username
- password
- [no] mac
- [no] pbit

3HH-04416-EBAA-TCZZA 01

Released

771

29 PPPoE Configuration Commands

29.2 PPPoE Profile Configuration Command


Command Description
This command allows the operator to configure PPP profile parameters.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppoe-client ( no ppp-profile (name) ) | ( ppp-profile (name) [ no ipversion | ipversion
<PPPoE::pppProfileIpMode> ] [ no authproto | authproto <PPPoE::pppProfileAuthenType> ] [ no mru | mru
<PPPoE::PppProfileMru> ] )

Command Parameters
Table 29.2-1 "PPPoE Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

name of the profile

Table 29.2-2 "PPPoE Profile Configuration Command" Command Parameters


Parameter

Type

Description

[no] ipversion

Parameter type: <PPPoE::pppProfileIpMode>


Format:
( none
| ipv4
| dual
| ipv6 )
Possible values:
- none : without NCP phase
- ipv4 : only specify ipv4 connection
- dual : specify both ipv4 and ipv6 connection
- ipv6 : only specify ipv6 connection
Parameter type: <PPPoE::pppProfileAuthenType>
Format:
( auto
| pap
| chap )
Possible values:
- auto : auto selected by ONU
- pap : only PAP negotiation

optional parameter with default


value: "ipv4"
specifying ip version during NCP
phase

[no] authproto

772

Released

optional parameter with default


value: "auto"
the type of PPP authentication
used

3HH-04416-EBAA-TCZZA

01

29 PPPoE Configuration Commands

Parameter
[no] mru

3HH-04416-EBAA-TCZZA 01

Type

Description

- chap : only CHAP negotiation


Parameter type: <PPPoE::PppProfileMru>
Format:
- the MRU of PPP
- range: [0...65535]

optional parameter with default


value: 1500
specifying MRU of PPP

Released

773

29 PPPoE Configuration Commands

29.3 PPPoE Client Interface Configuration


Command
Command Description
This command allows the operator to configure PPPoE client interface parameters.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> configure pppoe-client ( no interface (ifindex) client-id <PPPoE::ClientId> ) | ( interface (ifindex) client-id
<PPPoE::ClientId> profile-name <PPPoE::PppProfileName> username <PPPoE::UserName> password
<PPPoE::Password> [ no mac | mac <PPPoE::MacAddress> ] [ no pbit | pbit <PPPoE::PbitValue> ] )

Command Parameters
Table 29.3-1 "PPPoE Client Interface Configuration Command" Resource Parameters
Resource Identifier

Type

(ifindex)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier

774

Released

Description
interface index of the PPPoE
/ client port
/
:
/
/
:

3HH-04416-EBAA-TCZZA

01

29 PPPoE Configuration Commands

Resource Identifier

Type
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <PPPoE::ClientId>
Format:
- the PPPoE client id
- range: [1]

client-id

Description

the PPPoE client id

Table 29.3-2 "PPPoE Client Interface Configuration Command" Command Parameters


Parameter

Type

Description

profile-name

Parameter type: <PPPoE::PppProfileName>


Format:
name : <PPPoE::IgnoredPppProfileName>
Possible values:
- name : enter profile name to be associated
Field type <PPPoE::IgnoredPppProfileName>
- name of the PPP profile
- length: 1<=x<=64
Parameter type: <PPPoE::UserName>
Format:
- user name string
- length: x<=25
Parameter type: <PPPoE::Password>
Format:
- password string hidden from users
- length: x<=25
Parameter type: <PPPoE::MacAddress>
Format:
- a unicast mac-address (example : 00:01:02:03:04:05)
- length: 6

mandatory parameter
PPP profile name

username

password

[no] mac

[no] pbit

3HH-04416-EBAA-TCZZA 01

Parameter type: <PPPoE::PbitValue>


Format:
- the Pbit value
- range: [0...7]

mandatory parameter
user name for PPP authentication
mandatory parameter
password for PPP authentication
optional parameter with default
value: "00 : 00 : 00 : 00 : 00 :
00"
specify the client MAC address
for PPPoE frame
optional parameter with default
value: 0
the Pbit value for PPPoE frame

Released

775

30- DHCP Relay Configuration Commands

30.1 DHCP Relay Configuration Command Tree


30.2 DHCP Relay User Port Configuration Command
30.3 DHCP Relay Agent Configuration Command
30.4 DHCP Relay SHub Configuration Command
30.5 DHCP Relay SHub Server Configuration Command
per VRF
30.6 DHCP Relay SHub Agent Configuration Command per
VRF
30.7 DHCP Relay SHub Configuration Command per VRF
30.8 DHCP Relay SHub Server Configuration Command
per VRF
30.9 DHCP Relay SHub Agent Instances Configuration
Command per VRF
30.10 DHCP Relay SHub Server Configuration Command
per VRF and Agent instance
30.11 DHCP Relay SHub Agent Interface Association
Command
30.12 DHCP v6 Relay User Port Configuration Command

776

Released

30-777
30-779
30-782
30-784
30-785
30-786
30-788
30-789
30-790
30-792
30-793
30-794

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

30.1 DHCP Relay Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "DHCP Relay Configuration Commands".

Command Tree
----configure
----dhcp-relay
----[no] port-stats
- (port-interface)
----agent
- (vrfid)
- bcast-vlan
- [no] option-82
- [no] circuit-id
- [no] remote-id
- [no] client-hw-address
- [no] dhcp-linerate
----shub
- [no] relaying
----X [no] server
- (index)
- ip-addr
- server-name
----X agent
- (index)
- [no] enable-relaying
- [no] secs-threshold
- [no] hops-threshold
X [no] context-lifetime
- [no] agent-ip-addr
----instance
- (vrf-id)
- [no] relaying
- [no] secs-threshold
- [no] hops-threshold
- [no] agent-ip-addr
----[no] server
- (ip-addr)
- server-name
----[no] agent
- (ip-addr)
- [no] relaying
- name
- [no] secs-threshold
- [no] hops-threshold
----[no] server
- (ip-addr)
- name
----[no] interface
- (vlan-id)

3HH-04416-EBAA-TCZZA 01

Released

777

30 DHCP Relay Configuration Commands

- agent
----[no] v6-port-stats
- (port-interface)

778

Released

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

30.2 DHCP Relay User Port Configuration


Command
Command Description
This command allows the operator to configure the DHCP relay user port statistics.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay ( no port-stats (port-interface) ) | ( port-stats (port-interface) )

Command Parameters
Table 30.2-1 "DHCP Relay User Port Configuration Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
identification of the ip user
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface or vlan port
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

779

30 DHCP Relay Configuration Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id

780

Released

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::CVlan>


- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

781

30 DHCP Relay Configuration Commands

30.3 DHCP Relay Agent Configuration Command


vrfid
The vrfid is a unique value for each VRF assigned by the management.

bcast-vlan
The bcast-vlan is an index that represents a VLAN that is used for forwarding upstream broadcast DHCP packets
when the DHCP relay agent is disabled.The default value for the bcast-vlan is zero and is created whenever an
instances of VRF is formed.The operator cannot set a value of zero as the instance creation or deletion is depended
on the VRF instance created or deleted.

option-82
The operator can enable or disable option 82 information insertion in the upstream broadcast DHCP packets.

Command Description
This command allows the operator to configure the DHCP relay agent for each VRF interface.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay agent (vrfid) [ bcast-vlan <Dhcp::VlanId> ] [ [ no ] option-82 ] [ no circuit-id | circuit-id
<Dhcp::CircuitId> ] [ no remote-id | remote-id <Dhcp::RemoteId> ] [ no client-hw-address | client-hw-address
<Dhcp::ChaddrMode> ] [ no dhcp-linerate | dhcp-linerate <Dhcp::Dhcp-linerate> ]

Command Parameters
Table 30.3-1 "DHCP Relay Agent Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vrfid)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]

vrf index

Table 30.3-2 "DHCP Relay Agent Configuration Command" Command Parameters


Parameter

Type

Description

bcast-vlan

Parameter type: <Dhcp::VlanId>


Format:
(0

optional parameter
vlan used to forward upstream
bcast DHCP packets

782

Released

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

Parameter

Type

[no] option-82

| l2-vlan : <Eqpt::VlanId> )
Possible values:
- 0 : no interface type
- l2-vlan : a l2-vlan interface
Field type <Eqpt::VlanId>
- VLAN id
Parameter type: boolean

[no] circuit-id

[no] remote-id

[no] client-hw-address

[no] dhcp-linerate

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Dhcp::CircuitId>


Format:
( customer-id
| physical-id
| ccsa-format
| notadd )
Possible values:
- customer-id : add customer identity as circuitId
- physical-id : add physical line identity as circuitId
- ccsa-format : add circuitId in ccsa format
- notadd : not add circuitId
Parameter type: <Dhcp::RemoteId>
Format:
( customer-id
| notadd
| physical-id )
Possible values:
- customer-id : add customer identity as remoteId
- notadd : not add remoteId
- physical-id : add physical line identity as remoteId
Parameter type: <Dhcp::ChaddrMode>
Format:
( unchanged
| copysourcemac )
Possible values:
- unchanged : chaddr field of the dhcp message is kept
unmodified
- copysourcemac : mac addr of dslam is copied to chaddr
field of dhcp msg
Parameter type: <Dhcp::Dhcp-linerate>
Format:
( addactuallinerate
| notadd )
Possible values:
- addactuallinerate : add linerate for DHCP
- notadd : not add linerate for DHCP

optional parameter
enable option82
optional parameter with default
value: "notadd"
circuit id

optional parameter with default


value: "notadd"
remote id

optional parameter with default


value: "unchanged"
chaddr mode

optional parameter with default


value: "notadd"
enable line rate insertion for
DHCP protocol

Released

783

30 DHCP Relay Configuration Commands

30.4 DHCP Relay SHub Configuration Command


Command Description
This command allows the operator to configure the DHCP SHub parameters.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub [ [ no ] relaying ]

Command Parameters
Table 30.4-2 "DHCP Relay SHub Configuration Command" Command Parameters
Parameter

Type

Description

[no] relaying

Parameter type: boolean

optional parameter
enable relay agent

784

Released

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

30.5 DHCP Relay SHub Server Configuration


Command per VRF
Command Description
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>server.
This command allows the operator to configure the list of DHCP relay servers for a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub ( no server (index) ip-addr <Ip::V4Address> ) | ( server (index) ip-addr
<Ip::V4Address> server-name <Dhcp::RelayServerName> )
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>server.

Command Parameters
Table 30.5-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

the vrf id

ip-addr

IP address of the DHCP server

Table 30.5-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter

Type

Description

server-name

Parameter type: <Dhcp::RelayServerName>


Format:
- a printable string
- length: x<=32

mandatory parameter
The name of the Relay Server

3HH-04416-EBAA-TCZZA 01

Released

785

30 DHCP Relay Configuration Commands

30.6 DHCP Relay SHub Agent Configuration


Command per VRF
Command Description
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>.
This command allows the operator to configure the DHCP relay agent to a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub agent (index) [ [ no ] enable-relaying ] [ no secs-threshold | secs-threshold
<Dhcp::SecsThreshold> ] [ no hops-threshold | hops-threshold <Dhcp::HopThreshold> ] [ no context-lifetime |
context-lifetime <Dhcp::ContextLife> ] [ no agent-ip-addr | agent-ip-addr <Ip::V4Address> ]
Obsolete command, replaced by configure dhcp-relay shub instance <vrf-id>.

Command Parameters
Table 30.6-1 "DHCP Relay SHub Agent Configuration Command per VRF" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf id

Table 30.6-2 "DHCP Relay SHub Agent Configuration Command per VRF" Command Parameters
Parameter

Type

Description

[no] enable-relaying

Parameter type: boolean

[no] secs-threshold

Parameter type: <Dhcp::SecsThreshold>


Format:
- seconds threshold
- unit: second
- range: [0...5]
Parameter type: <Dhcp::HopThreshold>
Format:
- relay hops threshold
- range: [0...16]
Parameter type: <Dhcp::ContextLife>
Format:
- application context life-time for this vrf
- unit: seconds

optional parameter
enable relaying for this vrf
optional parameter with default
value: 0
the time within a request must be
answered

[no] hops-threshold

[no] context-lifetime

786

Released

optional parameter with default


value: 4
max nbr of hops the request may
go through
obsolete parameter that will be
ignored
availability of application context

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

Parameter
[no] agent-ip-addr

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [1...120]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

optional parameter with default


value: "0.0.0.0"
agent IP address

Released

787

30 DHCP Relay Configuration Commands

30.7 DHCP Relay SHub Configuration Command


per VRF
Command Description
This command allows the operator to configure the DHCP relay parameters for a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) [ [ no ] relaying ] [ no secs-threshold | secs-threshold
<Dhcp::SecsThreshold> ] [ no hops-threshold | hops-threshold <Dhcp::HopThreshold> ] [ no agent-ip-addr |
agent-ip-addr <Ip::V4Address> ]

Command Parameters
Table 30.7-1 "DHCP Relay SHub Configuration Command per VRF" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf id

Table 30.7-2 "DHCP Relay SHub Configuration Command per VRF" Command Parameters
Parameter

Type

Description

[no] relaying

Parameter type: boolean

[no] secs-threshold

Parameter type: <Dhcp::SecsThreshold>


Format:
- seconds threshold
- unit: second
- range: [0...5]
Parameter type: <Dhcp::HopThreshold>
Format:
- relay hops threshold
- range: [0...16]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

optional parameter
enable relay agent
optional parameter with default
value: 0
the time within a request must be
answered

[no] hops-threshold

[no] agent-ip-addr

788

Released

optional parameter with default


value: 4
max nbr of hops the request may
go through
optional parameter with default
value: "0.0.0.0"
agent IP address

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

30.8 DHCP Relay SHub Server Configuration


Command per VRF
Command Description
This command allows the operator to configure the list of DHCP relay servers for a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) ( no server (ip-addr) ) | ( server (ip-addr) server-name
<Dhcp::RelayServerName> )

Command Parameters
Table 30.8-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
- IPv4-address

the vrf id

(ip-addr)

IP address of the DHCP server

Table 30.8-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter

Type

Description

server-name

Parameter type: <Dhcp::RelayServerName>


Format:
- a printable string
- length: x<=32

mandatory parameter
The name of the Relay Server

3HH-04416-EBAA-TCZZA 01

Released

789

30 DHCP Relay Configuration Commands

30.9 DHCP Relay SHub Agent Instances


Configuration Command per VRF
Command Description
This command allows the operator to configure multiple DHCP relay agent instances for a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) ( no agent (ip-addr) ) | ( agent (ip-addr) [ [ no ] relaying ] name
<Dhcp::RelayAgentName> [ no secs-threshold | secs-threshold <Dhcp::SecsThreshold> ] [ no hops-threshold |
hops-threshold <Dhcp::HopThreshold> ] )

Command Parameters
Table 30.9-1 "DHCP Relay SHub Agent Instances Configuration Command per VRF " Resource
Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
- IPv4-address

the vrf id

(ip-addr)

IP address given to this interface

Table 30.9-2 "DHCP Relay SHub Agent Instances Configuration Command per VRF " Command
Parameters
Parameter

Type

Description

[no] relaying

Parameter type: boolean

name

Parameter type: <Dhcp::RelayAgentName>


Format:
- a printable string
- length: x<=32
Parameter type: <Dhcp::SecsThreshold>
Format:
- seconds threshold
- unit: second
- range: [0...5]
Parameter type: <Dhcp::HopThreshold>
Format:
- relay hops threshold

optional parameter
enable relay agent
mandatory parameter
the dhcp relay agent name

[no] secs-threshold

[no] hops-threshold

790

Released

optional parameter with default


value: 0
the time within a request must be
answered
optional parameter with default
value: 4
max nbr of hops the request may

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [0...16]

go through

Released

791

30 DHCP Relay Configuration Commands

30.10 DHCP Relay SHub Server Configuration


Command per VRF and Agent instance
Command Description
This command allows the operator to configure the list of DHCP relay servers for a particular VRF and a
particular DHCP relay Agent Instance.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub instance (vrf-id) agent (ip-addr) ( no server (ip-addr) ) | ( server (ip-addr) name
<Dhcp::RelayServerName> )

Command Parameters
Table 30.10-1 "DHCP Relay SHub Server Configuration Command per VRF and Agent instance"
Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Format:
- IPv4-address
Format:
- IPv4-address

the vrf id

(ip-addr)
(ip-addr)

IP address given to this interface


the servers ip-address

Table 30.10-2 "DHCP Relay SHub Server Configuration Command per VRF and Agent instance"
Command Parameters
Parameter

Type

Description

name

Parameter type: <Dhcp::RelayServerName>


Format:
- a printable string
- length: x<=32

mandatory parameter
the name of the Relay Server

792

Released

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

30.11 DHCP Relay SHub Agent Interface


Association Command
Command Description
This command allows the operator to associate a particular relay-agent instance for an IP interface.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub ( no interface (vlan-id) ) | ( interface (vlan-id) agent <Ip::V4Address> )

Command Parameters
Table 30.11-1 "DHCP Relay SHub Agent Interface Association Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

the vlan index

Table 30.11-2 "DHCP Relay SHub Agent Interface Association Command" Command Parameters
Parameter

Type

Description

agent

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

mandatory parameter
the associated ip address

3HH-04416-EBAA-TCZZA 01

Released

793

30 DHCP Relay Configuration Commands

30.12 DHCP v6 Relay User Port Configuration


Command
Command Description
This command allows the operator to configure the DHCP v6 relay user port statistics.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay ( no v6-port-stats (port-interface) ) | ( v6-port-stats (port-interface) )

Command Parameters
Table 30.12-1 "DHCP v6 Relay User Port Configuration Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>

794

Released

Description
identification of vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:

3HH-04416-EBAA-TCZZA

01

30 DHCP Relay Configuration Commands

Resource Identifier

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

795

31- OSPF Configuration Commands

31.1 OSPF Configuration Command Tree


31.2 OSPF Parameters Configuration Command
31.3 OSPF Area Configuration Command
31.4 OSPF Interface Configuration Command
31.5 OSPF Interface Timers Configuration Command
31.6 OSPF Interface MD5 Key Configuration Command
31.7 OSPF Interface Metric Configuration Command
31.8 OSPF Aggregate Configuration Command
31.9 OSPF External Aggregate Configuration Command
31.10 OSPF Stub Area Configuration Command
31.11 OSPF Interface Configuration Command
31.12 OSPF Interface Timers Configuration Command
31.13 OSPF Interface MD5 Key Configuration Command
31.14 OSPF Interface Metric Configuration Command
31.15 OSPF Stub Aggregate Configuration Command
31.16 OSPF NSSA Area Configuration Command
31.17 OSPF Interface Configuration Command
31.18 OSPF Interface Timers Configuration Command
31.19 OSPF Interface MD5 Key Configuration Command
31.20 OSPF Interface Metric Configuration Command
31.21 OSPF NSSA Aggregate Configuration Command
31.22 OSPF External Aggregate Configuration Command
31.23 OSPF Redistribution Configuration Command
31.24 OSPF Redistribution Route Configuration Command

796

Released

31-797
31-800
31-802
31-803
31-805
31-807
31-809
31-810
31-811
31-813
31-814
31-816
31-818
31-820
31-821
31-822
31-824
31-826
31-828
31-830
31-831
31-832
31-834
31-835

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.1 OSPF Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "OSPF Configuration Commands".

Command Tree
----configure
----[no] ospf
- [no] enable
- [no] router-id
- [no] as-border-router
- [no] enable-opaque-lsa
- [no] overflow-state-it
- [no] dis-rfc1583-comp
- [no] abr-type
X [no] passive-interface
----[no] area
- (area-id)
----[no] interface
- (ip-addr)
- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- [no] omit-advertise
----[no] extern-aggr-addr
- (dest-ip)
- [no] advertise
----[no] stub-area
- (area-id)
- [no] metric-type
- [no] metric
- [no] summary
----[no] interface
- (ip-addr)

3HH-04416-EBAA-TCZZA 01

Released

797

31 OSPF Configuration Commands

- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- [no] omit-advertise
----[no] nssa-area
- (area-id)
- [no] summary
- [no] translation
- [no] trans-itvl
- [no] asbr-rtr-trans
- [no] metric-type
----[no] interface
- (ip-addr)
- [no] disable
- [no] router-priority
- [no] passive
- [no] itf-type
- [no] authentication
----timers
- [no] transit-delay
- [no] retransmit-itvl
- [no] hello-interval
- [no] dead-interval
- [no] poll-interval
----[no] md5-key
- (index)
- key
- [no] accept-starts
- [no] generate-starts
----metric
- [no] value
----[no] aggregate-addr
- (dest-ip)
- lsa-type
- [no] omit-advertise
----[no] extern-aggr-addr
- (dest-ip)
- [no] advertise
----redistribution
- [no] enable
- [no] local
- [no] static

798

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

- [no] rip
----[no] route-destination
- (dest-ip)
- [no] metric-type
- [no] metric

3HH-04416-EBAA-TCZZA 01

Released

799

31 OSPF Configuration Commands

31.2 OSPF Parameters Configuration Command


Command Description
This command allows the operator to configure the OSPF parameters and attributes.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf [ [ no ] enable ] [ no router-id | router-id <Ip::V4Address> ] [ [ no ] as-border-router ] [ [ no ]
enable-opaque-lsa ] [ no overflow-state-it | overflow-state-it <Ospf::OvrflowIntrvl> ] [ [ no ] dis-rfc1583-comp ] [
no abr-type | abr-type <Ospf::AbrType> ] [ [ no ] passive-interface ]

Command Parameters
Table 31.2-2 "OSPF Parameters Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] router-id

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

[no] as-border-router

Parameter type: boolean

[no] enable-opaque-lsa

Parameter type: boolean

[no] overflow-state-it

Parameter type: <Ospf::OvrflowIntrvl>


Format:
- interval the router is in overflow state
- unit: sec
- range: [0...2147483647]
Parameter type: boolean

optional parameter
enables OSPF on the SHub
optional parameter with default
value: "0.0.0.0"
uniquely identifying the Shub in
the autonomous system
optional parameter
shub configured as a autonomous
system border router
optional parameter
enable opaque-capable for router
optional parameter with default
value: 120
time the router attempts to leave
the overflow state

[no] dis-rfc1583-comp
[no] abr-type

800

Parameter type: <Ospf::AbrType>


Format:
( standard
| cisco
| ibm )
Possible values:
- standard : standard abr
- cisco : cisco abr

Released

optional parameter
LSA advertisements compatible
with RFC 1583
optional parameter with default
value: "standard"
type of area border router

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

Type

[no] passive-interface

- ibm : ibm abr


Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

Description
obsolete parameter that will be
ignored
all new interfaces are by default
set to passive

Released

801

31 OSPF Configuration Commands

31.3 OSPF Area Configuration Command


Command Description
This command displays information about the configured parameters and cumulative statistics for the router's
attached areas.
The area identifier is a 32-bit represented in dotted decimal notation.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf ( no area (area-id) ) | ( area (area-id) )

Command Parameters
Table 31.3-1 "OSPF Area Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address

ospf area identifier

802

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.4 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no router-priority |
router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no authentication |
authentication <Ospf::AuthType> ] )

Command Parameters
Table 31.4-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.4-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] disable

Parameter type: boolean

[no] router-priority

Parameter type: <Ospf::Priority>


Format:
- priority used in router election algorithm
- range: [0...255]
Parameter type: boolean

optional parameter
disable interface
optional parameter with default
value: 1
priority used in router election
algorithm
optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
optional parameter with default
value: "broadcast"
ospf interface type

[no] passive

[no] itf-type

3HH-04416-EBAA-TCZZA 01

Parameter type: <Ospf::ITFType>


Format:
( broadcast
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access

Released

803

31 OSPF Configuration Commands

Parameter

Type
- point-point : point to point
- point-multipoint : point to multi point
Parameter type: <Ospf::AuthType>
Format:
( none
| md5
| plain : prompt
| plain : plain : <Ospf::Key> )
Possible values:
- none : no authentication
- plain : simple password
- md5 : md5 authentication
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8

[no] authentication

804

Released

Description
optional parameter with default
value: "none"
indicates the OSPF interface
authentication

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.5 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay> ] [ no
retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ] [ no
dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]

Command Parameters
Table 31.5-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.5-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter

Type

Description

[no] transit-delay

Parameter type: <Ospf::TransDelay>


Format:
- time to transmit link state packets
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::RetransIntvl>
Format:
- interval between LSA retransmission
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::HelloIntvl>
Format:
- interval between sending hello packets
- unit: sec
- range: [1...65535]
Parameter type: <Ospf::DeadIntvl>
Format:

optional parameter with default


value: 1
time to transmit link update
packets

[no] retransmit-itvl

[no] hello-interval

[no] dead-interval

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 5
interval
between
LSA
retransmission
optional parameter with default
value: 10
interval between sending hello
packets
optional parameter with default
value: 40

Released

805

31 OSPF Configuration Commands

Parameter

[no] poll-interval

806

Released

Type

Description

- interval when no hello pkts are received


- unit: sec
- range: [0...65535]
Parameter type: <Ospf::PollIntvl>
Format:
- time between hello pkts sent to neighbour
- unit: sec
- range: [0...65535]

interval when no hello pkts are


received
optional parameter with default
value: 120
time between hello pkts sent to
neighbour

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.6 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )

Command Parameters
Table 31.6-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address
Format:
- the number of the MD5 key
- range: [1...255]

ospf area identifier

(ip-addr)
(index)

ip address identifying
interface
the number of the md5 key

the

Table 31.6-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

Parameter type: <Ospf::AuthTypeMd5>


Format:
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )

mandatory parameter
the md5 key

[no] accept-starts

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "now"
when the key must be used to
accept

Released

807

31 OSPF Configuration Commands

Parameter

[no] generate-starts

Type

Description

Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )
Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

optional parameter with default


value: "now"
when the key must be used to
generate

Command Output
Table 31.6-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name
accept-expires

generate-expires

808

Released

Type

Description

Parameter type: <Ospf::MD5expiryDelay>


( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Parameter type: <Ospf::MD5expiryDelay>
( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

delay before the key expires for


accepting
This element is only shown in
detail mode.

delay before the key expires for


generating
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.7 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]

Command Parameters
Table 31.7-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.7-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter

Type

Description

[no] value

Parameter type: <Ospf::Metric>


Format:
- metric dependent on TOS
- range: [1...65535]

optional parameter with default


value: "10"
the value for the metric

3HH-04416-EBAA-TCZZA 01

Released

809

31 OSPF Configuration Commands

31.8 OSPF Aggregate Configuration Command


Command Description
This command allows the operator to configure an OSPF aggregate.
Inter-area route summarization is done on ABRs and it applies to routes from within the AS. It does not apply to
external routes injected into OSPF via redistribution. In order to take advantage of summarization, network
numbers in areas should be assigned in a contiguous way to be able to lump these addresses into one range.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no aggregate-addr (dest-ip) ) | ( aggregate-addr (dest-ip) [ [ no ] omit-advertise ] )

Command Parameters
Table 31.8-1 "OSPF Aggregate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

ospf area identifier

(dest-ip)

ip address and mask of the


destination route

Table 31.8-2 "OSPF Aggregate Configuration Command" Command Parameters


Parameter

Type

Description

[no] omit-advertise

Parameter type: boolean

optional parameter
do not advertise the aggregate
information of the subnet

810

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.9 OSPF External Aggregate Configuration


Command
Command Description
This command allows the operator to configure an OSPF aggregate from external autonomous system.
External route summarization is specific to external routes that are injected into OSPF via redistribution. Also,
make sure that external ranges that are being summarized are contiguous. Summarization overlapping ranges from
two different routers could cause packets to be sent to the wrong destination.
The "advertise" parameter in the command indicates what type of aggregation will be done :
advertise : Type5 external LSAs falling into the specified range are aggregated and advertised.
disable : Type5 external LSAs falling into the specified range are blocked.
allow-all : Type5 external LSAs falling into the specified range are aggregated and advertised. Type7 external
Aggregation is done for all attached NSSA areas.
deny-all : Type5 external LSAs falling into the specified range are blocked. No aggregation is done for Type7
external LSAs.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) ( no extern-aggr-addr (dest-ip) ) | ( extern-aggr-addr (dest-ip) [ no advertise |
advertise <Ospf::ExtAggregateEffect> ] )

Command Parameters
Table 31.9-1 "OSPF External Aggregate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

ospf area identifier

(dest-ip)

ip address and mask of the


destination route

Table 31.9-2 "OSPF External Aggregate Configuration Command" Command Parameters


Parameter

Type

Description

[no] advertise

Parameter type: <Ospf::ExtAggregateEffect>

optional parameter with default

3HH-04416-EBAA-TCZZA 01

Released

811

31 OSPF Configuration Commands

Parameter

Type

Description

Format:
value: "enable"
( enable
advertisement of the indicated
| disable
aggregate
| allow-all
| deny-all )
Possible values:
- enable : type5 lsa aggregation based on ASBR/ABR status
- disable : no type5 lsa aggregation based on ASBR/ABR
status
- allow-all : type5 lsa aggregation and type7 lsa aggregation
in all attached nssa areas
- deny-all : no type5 lsa nor type7 lsa aggregation

812

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.10 OSPF Stub Area Configuration Command


Command Description
This command allows the operator to configure the OSPF stub area.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf ( no stub-area (area-id) ) | ( stub-area (area-id) [ no metric-type | metric-type <Ospf::MetricType>
] [ no metric | metric <Ospf::StubMetric> ] [ [ no ] summary ] )

Command Parameters
Table 31.10-1 "OSPF Stub Area Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address

ospf area identifier

Table 31.10-2 "OSPF Stub Area Configuration Command" Command Parameters


Parameter

Type

Description

[no] metric-type

Parameter type: <Ospf::MetricType>


Format:
( ospf
| comparable-metric
| non-comparable )
Possible values:
- ospf : ospf metric
- comparable-metric : comparable cost
- non-comparable : non comparable
Parameter type: <Ospf::StubMetric>
Format:
- metric value
- range: [0...16777215]
Parameter type: boolean

optional parameter with default


value: "ospf"
type of metric advertised as a
default route

[no] metric

[no] summary

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 10
metric value
optional parameter
controls the import of summary
LSAs into stub areas

Released

813

31 OSPF Configuration Commands

31.11 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no
router-priority | router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no
authentication | authentication <Ospf::AuthType> ] )

Command Parameters
Table 31.11-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.11-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] disable

Parameter type: boolean

[no] router-priority

Parameter type: <Ospf::Priority>


Format:
- priority used in router election algorithm
- range: [0...255]
Parameter type: boolean

optional parameter
disable interface
optional parameter with default
value: 1
priority used in router election
algorithm
optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
optional parameter with default
value: "broadcast"
ospf interface type

[no] passive

[no] itf-type

814

Parameter type: <Ospf::ITFType>


Format:
( broadcast
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter
[no] authentication

3HH-04416-EBAA-TCZZA 01

Type
- point-point : point to point
- point-multipoint : point to multi point
Parameter type: <Ospf::AuthType>
Format:
( none
| md5
| plain : prompt
| plain : plain : <Ospf::Key> )
Possible values:
- none : no authentication
- plain : simple password
- md5 : md5 authentication
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8

Description
optional parameter with default
value: "none"
indicates the OSPF interface
authentication

Released

815

31 OSPF Configuration Commands

31.12 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay> ]
[ no retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ] [
no dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]

Command Parameters
Table 31.12-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.12-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter

Type

Description

[no] transit-delay

Parameter type: <Ospf::TransDelay>


Format:
- time to transmit link state packets
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::RetransIntvl>
Format:
- interval between LSA retransmission
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::HelloIntvl>
Format:
- interval between sending hello packets
- unit: sec
- range: [1...65535]
Parameter type: <Ospf::DeadIntvl>
Format:

optional parameter with default


value: 1
time to transmit link update
packets

[no] retransmit-itvl

[no] hello-interval

[no] dead-interval

816

Released

optional parameter with default


value: 5
interval
between
LSA
retransmission
optional parameter with default
value: 10
interval between sending hello
packets
optional parameter with default
value: 40

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

[no] poll-interval

3HH-04416-EBAA-TCZZA 01

Type

Description

- interval when no hello pkts are received


- unit: sec
- range: [0...65535]
Parameter type: <Ospf::PollIntvl>
Format:
- time between hello pkts sent to neighbour
- unit: sec
- range: [0...65535]

interval when no hello pkts are


received
optional parameter with default
value: 120
time between hello pkts sent to
neighbour

Released

817

31 OSPF Configuration Commands

31.13 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )

Command Parameters
Table 31.13-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address
Format:
- the number of the MD5 key
- range: [1...255]

ospf area identifier

(ip-addr)
(index)

ip address identifying
interface
the number of the md5 key

the

Table 31.13-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

Parameter type: <Ospf::AuthTypeMd5>


Format:
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )

mandatory parameter
the md5 key

[no] accept-starts

818

Released

optional parameter with default


value: "now"
when the key must be used to
accept

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

[no] generate-starts

Type

Description

Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )
Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

optional parameter with default


value: "now"
when the key must be used to
generate

Command Output
Table 31.13-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name
accept-expires

generate-expires

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ospf::MD5expiryDelay>


( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Parameter type: <Ospf::MD5expiryDelay>
( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

delay before the key expires for


accepting
This element is only shown in
detail mode.

delay before the key expires for


generating
This element is only shown in
detail mode.

Released

819

31 OSPF Configuration Commands

31.14 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]

Command Parameters
Table 31.14-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.14-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter

Type

Description

[no] value

Parameter type: <Ospf::Metric>


Format:
- metric dependent on TOS
- range: [1...65535]

optional parameter with default


value: "10"
the value for the metric

820

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.15 OSPF Stub Aggregate Configuration


Command
Command Description
This command allows the operator to configure an OSPF stub aggregate.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) ( no aggregate-addr (dest-ip) ) | ( aggregate-addr (dest-ip) [ [ no ]
omit-advertise ] )

Command Parameters
Table 31.15-1 "OSPF Stub Aggregate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

ospf area identifier

(dest-ip)

ip address and mask of the


destination route

Table 31.15-2 "OSPF Stub Aggregate Configuration Command" Command Parameters


Parameter

Type

Description

[no] omit-advertise

Parameter type: boolean

optional parameter
do not advertise the aggregate
information of the subnet

3HH-04416-EBAA-TCZZA 01

Released

821

31 OSPF Configuration Commands

31.16 OSPF NSSA Area Configuration Command


Command Description
This command allows the operator to configure the OSPF NSSA area.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf ( no nssa-area (area-id) ) | ( nssa-area (area-id) [ [ no ] summary ] [ no translation | translation
<Ospf::Trnsltn> ] [ no trans-itvl | trans-itvl <Ospf::TrnltnIntvl> ] [ [ no ] asbr-rtr-trans ] [ no metric-type |
metric-type <Ospf::MetricType> ] )

Command Parameters
Table 31.16-1 "OSPF NSSA Area Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address

ospf area identifier

Table 31.16-2 "OSPF NSSA Area Configuration Command" Command Parameters


Parameter

Type

Description

[no] summary

Parameter type: boolean

[no] translation

Parameter type: <Ospf::Trnsltn>


Format:
( always
| candidate )
Possible values:
- always : always
- candidate : candidate
Parameter type: <Ospf::TrnltnIntvl>
Format:
- time trsltr finds its service is not reqd
- unit: sec
- range: [0...65535]
Parameter type: boolean

optional parameter
controls the import of summary
LSAs into stub areas
optional parameter with default
value: "candidate"
NSSA routers ability to translate
Type-7 to Type-5 LSAs

[no] trans-itvl

[no] asbr-rtr-trans
[no] metric-type

822

Parameter type: <Ospf::MetricType>


Format:
( ospf
| comparable-metric

Released

optional parameter with default


value: 40
time trsltr finds its service is not
reqd
optional parameter
p-bit setting for the type-7 LSA
generated by ASBR
optional parameter with default
value: "ospf"
type of metric advertised as a
default route

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

Type

Description

| non-comparable )
Possible values:
- ospf : ospf metric
- comparable-metric : comparable cost
- non-comparable : non comparable

3HH-04416-EBAA-TCZZA 01

Released

823

31 OSPF Configuration Commands

31.17 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no interface (ip-addr) ) | ( interface (ip-addr) [ [ no ] disable ] [ no
router-priority | router-priority <Ospf::Priority> ] [ [ no ] passive ] [ no itf-type | itf-type <Ospf::ITFType> ] [ no
authentication | authentication <Ospf::AuthType> ] )

Command Parameters
Table 31.17-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.17-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] disable

Parameter type: boolean

[no] router-priority

Parameter type: <Ospf::Priority>


Format:
- priority used in router election algorithm
- range: [0...255]
Parameter type: boolean

optional parameter
disable interface
optional parameter with default
value: 1
priority used in router election
algorithm
optional parameter
sets the itf as passive and
overwrites the parameter at
instance level; by default will set
to 'non-passive'
optional parameter with default
value: "broadcast"
ospf interface type

[no] passive

[no] itf-type

824

Parameter type: <Ospf::ITFType>


Format:
( broadcast
| nbma
| point-point
| point-multipoint )
Possible values:
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter
[no] authentication

3HH-04416-EBAA-TCZZA 01

Type
- point-point : point to point
- point-multipoint : point to multi point
Parameter type: <Ospf::AuthType>
Format:
( none
| md5
| plain : prompt
| plain : plain : <Ospf::Key> )
Possible values:
- none : no authentication
- plain : simple password
- md5 : md5 authentication
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Key>
- authentication key
- length: x<=8

Description
optional parameter with default
value: "none"
indicates the OSPF interface
authentication

Released

825

31 OSPF Configuration Commands

31.18 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) timers [ no transit-delay | transit-delay <Ospf::TransDelay>
] [ no retransmit-itvl | retransmit-itvl <Ospf::RetransIntvl> ] [ no hello-interval | hello-interval <Ospf::HelloIntvl> ]
[ no dead-interval | dead-interval <Ospf::DeadIntvl> ] [ no poll-interval | poll-interval <Ospf::PollIntvl> ]

Command Parameters
Table 31.18-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.18-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter

Type

Description

[no] transit-delay

Parameter type: <Ospf::TransDelay>


Format:
- time to transmit link state packets
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::RetransIntvl>
Format:
- interval between LSA retransmission
- unit: sec
- range: [0...3600]
Parameter type: <Ospf::HelloIntvl>
Format:
- interval between sending hello packets
- unit: sec
- range: [1...65535]
Parameter type: <Ospf::DeadIntvl>
Format:

optional parameter with default


value: 1
time to transmit link update
packets

[no] retransmit-itvl

[no] hello-interval

[no] dead-interval

826

Released

optional parameter with default


value: 5
interval
between
LSA
retransmission
optional parameter with default
value: 10
interval between sending hello
packets
optional parameter with default
value: 40

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

[no] poll-interval

3HH-04416-EBAA-TCZZA 01

Type

Description

- interval when no hello pkts are received


- unit: sec
- range: [0...65535]
Parameter type: <Ospf::PollIntvl>
Format:
- time between hello pkts sent to neighbour
- unit: sec
- range: [0...65535]

interval when no hello pkts are


received
optional parameter with default
value: 120
time between hello pkts sent to
neighbour

Released

827

31 OSPF Configuration Commands

31.19 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key
<Ospf::AuthTypeMd5> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ] [ no generate-starts |
generate-starts <Ospf::MD5startDelay> ] )

Command Parameters
Table 31.19-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address
Format:
- the number of the MD5 key
- range: [1...255]

ospf area identifier

(ip-addr)
(index)

ip address identifying
interface
the number of the md5 key

the

Table 31.19-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

Parameter type: <Ospf::AuthTypeMd5>


Format:
( prompt
| plain : <Ospf::Md5Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Ospf::Md5Key>
- authentication key
- length: x<=16
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )

mandatory parameter
the md5 key

[no] accept-starts

828

Released

optional parameter with default


value: "now"
when the key must be used to
accept

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

[no] generate-starts

Type

Description

Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Ospf::MD5startDelay>
Format:
( now
| <Sys::Time> )
Possible values:
- now : the key will be used from now on
Field type <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

optional parameter with default


value: "now"
when the key must be used to
generate

Command Output
Table 31.19-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information
name
accept-expires

generate-expires

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ospf::MD5expiryDelay>


( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Parameter type: <Ospf::MD5expiryDelay>
( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

delay before the key expires for


accepting
This element is only shown in
detail mode.

delay before the key expires for


generating
This element is only shown in
detail mode.

Released

829

31 OSPF Configuration Commands

31.20 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) metric [ no value | value <Ospf::Metric> ]

Command Parameters
Table 31.20-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
- IPv4-address

ospf area identifier

(ip-addr)

ip address
interface

identifying

the

Table 31.20-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter

Type

Description

[no] value

Parameter type: <Ospf::Metric>


Format:
- metric dependent on TOS
- range: [1...65535]

optional parameter with default


value: "10"
the value for the metric

830

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.21 OSPF NSSA Aggregate Configuration


Command
Command Description
This command allows the operator to configure an OSPF nssa external link aggregate at the ABR.
The type7 LSAs are aggregated into one Type5 LSAs at the ABR. This ABR us referred as NSSA translator.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no aggregate-addr (dest-ip) lsa-type <Ospf::LSAType> ) | ( aggregate-addr
(dest-ip) lsa-type <Ospf::LSAType> [ [ no ] omit-advertise ] )

Command Parameters
Table 31.21-1 "OSPF NSSA Aggregate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ospf::LSAType>
Format:
( summary
| nssa-external )
Possible values:
- summary : type-3, summary link
- nssa-external : type-7, nssa external link

ospf area identifier

(dest-ip)

lsa-type

ip address and mask of the


destination route

type of address aggregate

Table 31.21-2 "OSPF NSSA Aggregate Configuration Command" Command Parameters


Parameter

Type

Description

[no] omit-advertise

Parameter type: boolean

optional parameter
do not advertise the aggregate
information of the subnet

3HH-04416-EBAA-TCZZA 01

Released

831

31 OSPF Configuration Commands

31.22 OSPF External Aggregate Configuration


Command
Command Description
This command allows the operator to configure an OSPF aggregate from external autonomous system.
External route summarization is specific to external routes that are injected into OSPF via redistribution. Also,
make sure that external ranges that are being summarized are contiguous. Summarization overlapping ranges from
two different routers could cause packets to be sent to the wrong destination.
The "advertise" parameter in the command indicates what type of aggregation will be done :
advertise : Type5 external LSAs falling into the specified range are aggregated and advertised.
disable : Type5 external LSAs falling into the specified range are blocked.
allow-all : Type5 external LSAs falling into the specified range are aggregated and advertised. Type7 external
Aggregation is done for all attached NSSA areas.
deny-all : Type5 external LSAs falling into the specified range are blocked. No aggregation is done for Type7
external LSAs.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) ( no extern-aggr-addr (dest-ip) ) | ( extern-aggr-addr (dest-ip) [ no advertise |
advertise <Ospf::ExtAggregateEffect> ] )

Command Parameters
Table 31.22-1 "OSPF External Aggregate Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

ospf area identifier

(dest-ip)

ip address and mask of the


destination route

Table 31.22-2 "OSPF External Aggregate Configuration Command" Command Parameters


Parameter

Type

Description

[no] advertise

Parameter type: <Ospf::ExtAggregateEffect>

optional parameter with default

832

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

Parameter

Type

Description

Format:
value: "enable"
( enable
advertisement of the indicated
| disable
aggregate
| allow-all
| deny-all )
Possible values:
- enable : type5 lsa aggregation based on ASBR/ABR status
- disable : no type5 lsa aggregation based on ASBR/ABR
status
- allow-all : type5 lsa aggregation and type7 lsa aggregation
in all attached nssa areas
- deny-all : no type5 lsa nor type7 lsa aggregation

3HH-04416-EBAA-TCZZA 01

Released

833

31 OSPF Configuration Commands

31.23 OSPF Redistribution Configuration


Command
Command Description
This command allows the operator to configure the redistribution of the OSPF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf redistribution [ [ no ] enable ] [ [ no ] local ] [ [ no ] static ] [ [ no ] rip ]

Command Parameters
Table 31.23-2 "OSPF Redistribution Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] local

Parameter type: boolean

[no] static

Parameter type: boolean

[no] rip

Parameter type: boolean

optional parameter
enable OSPF route redistribution
optional parameter
import local routes to OSPF
optional parameter
import static routes to OSPF
optional parameter
import rip routes to OSPF

834

Released

3HH-04416-EBAA-TCZZA

01

31 OSPF Configuration Commands

31.24 OSPF Redistribution Route Configuration


Command
Command Description
This command allows the operator to configure the redistribution of OSPF route parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf redistribution ( no route-destination (dest-ip) ) | ( route-destination (dest-ip) [ no metric-type |
metric-type <Ospf::RouteMetricType> ] [ no metric | metric <Ospf::RouteMetric> ] )

Command Parameters
Table 31.24-1 "OSPF Redistribution Route Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(dest-ip)

Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

ip address and mask of the


destination route

Table 31.24-2 "OSPF Redistribution Route Configuration Command" Command Parameters


Parameter

Type

Description

[no] metric-type

Parameter type: <Ospf::RouteMetricType>


Format:
( as-ext-type1
| as-ext-type2 )
Possible values:
- as-ext-type1 : asexttype1 metric type
- as-ext-type2 : asexttype2 metric type
Parameter type: <Ospf::RouteMetric>
Format:
- metric value for route before its advrtsd
- range: [1...16777215]

optional parameter with default


value: "as-ext-type2"
metric type applied to the router

[no] metric

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 10
metric value applied to the router

Released

835

32- RIP Configuration Commands

32.1 RIP Configuration Command Tree


32.2 RIP Common Configuration Command
32.3 RIP Redistribution Configuration Command
32.4 RIP Interface Configuration Command
32.5 RIP Interface Timers Configuration Command
32.6 RIP Interface MD5 Key Configuration Command
32.7 RIP Interface Route Map Command
32.8 RIP Route Aggregation Command
32.9 RIP Route Map Command

836

Released

32-837
32-838
32-839
32-840
32-842
32-843
32-845
32-847
32-848

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

32.1 RIP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "RIP Configuration Commands".

Command Tree
----configure
----[no] rip
X [no] max-peer
----redistribution
- [no] enable
- [no] default-metric
- [no] local
- [no] static
- [no] ospf
----[no] interface
- (ip-addr)
- [no] authentication
- default-metric
- [no] send
- [no] receive
- [no] split-horizon
- [no] egr-routemap-act
- [no] igr-routemap-act
----timers
- [no] update-timer
- [no] route-age-out
- [no] junk-collection
----[no] md5-key
- (index)
- key
- starts
- expires
----[no] route-map
- (map-index)
- direction
- ip-addr
- [no] action
- [no] prefix-match
----[no] aggregation
- (ip-addr)
----X [no] route-map
- (vlan-id)
- sub-index
- ip-addr
- [no] direction
- [no] deny

3HH-04416-EBAA-TCZZA 01

Released

837

32 RIP Configuration Commands

32.2 RIP Common Configuration Command


Command Description
This command allows the operator to specify global parameters for the RIP protocol.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip [ no max-peer | max-peer <Rip::Rip2Peer> ]

Command Parameters
Table 32.2-2 "RIP Common Configuration Command" Command Parameters
Parameter

Type

Description

[no] max-peer

Parameter type: <Rip::Rip2Peer>


Format:
- max nbr of peers
- range: [1...25]

obsolete parameter that will be


ignored
max nbr of peer conversing with
RIP2 simultaneously

838

Released

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

32.3 RIP Redistribution Configuration Command


Command Description
This command allows the operator to configure RIP redistribution.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip redistribution [ [ no ] enable ] [ no default-metric | default-metric <Rip::RouteMetric> ] [ [ no ] local
] [ [ no ] static ] [ [ no ] ospf ]

Command Parameters
Table 32.3-2 "RIP Redistribution Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] default-metric

[no] local

Parameter type: <Rip::RouteMetric>


Format:
- metric
- range: [1...16]
Parameter type: boolean

[no] static

Parameter type: boolean

[no] ospf

Parameter type: boolean

optional parameter
enable RIP route redistribution
optional parameter with default
value: 3
default metric used for the
imported routes
optional parameter
import local routes to RIP
optional parameter
import static routes to RIP
optional parameter
import ospf routes to RIP

3HH-04416-EBAA-TCZZA 01

Released

839

32 RIP Configuration Commands

32.4 RIP Interface Configuration Command


Command Description
This command allows the user to configure RIP interface parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip ( no interface (ip-addr) ) | ( interface (ip-addr) [ no authentication | authentication <Rip::AuthType>
] default-metric <Rip::DefMetric> [ no send | send <Rip::ConfSend> ] [ no receive | receive <Rip::ConfRcv> ] [ no
split-horizon | split-horizon <Rip::SpltHorizon> ] [ no egr-routemap-act | egr-routemap-act
<Rip::EgrRouteMapAction> ] [ no igr-routemap-act | igr-routemap-act <Rip::IngrRouteMapAction> ] )

Command Parameters
Table 32.4-1 "RIP Interface Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

interface IP address

Table 32.4-2 "RIP Interface Configuration Command" Command Parameters


Parameter

Type

Description

[no] authentication

Parameter type: <Rip::AuthType>


Format:
( none
| md5
| plain : prompt
| plain : plain : <Rip::Key> )
Possible values:
- none : no authentication
- plain : simple password
- md5 : md5 authentication
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Rip::Key>
- authentication key
- length: 1<=x<=16
Parameter type: <Rip::DefMetric>
Format:
- default metric
- range: [0...15]
Parameter type: <Rip::ConfSend>

optional parameter with default


value: "none"
authentication method

default-metric

[no] send

840

Released

mandatory parameter
metric used for default route in
RIP updates
optional parameter with default

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

Parameter

[no] receive

[no] split-horizon

[no] egr-routemap-act

[no] igr-routemap-act

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( disable
| rip1
| rip1-compatible
| rip2 )
Possible values:
- disable : don't send any packets
- rip1 : rip version 1
- rip1-compatible : rip version 1 comptible
- rip2 : rip version 2
Parameter type: <Rip::ConfRcv>
Format:
( rip1
| rip2
| rip1-or-rip2
| disable )
Possible values:
- rip1 : accept rip1 packets
- rip2 : accept rip2 packets
- rip1-or-rip2 : accept rip1 or rip2 packets
- disable : don't receive packets
Parameter type: <Rip::SpltHorizon>
Format:
( enable
| poison-reverse
| disable )
Possible values:
- enable : enable split horizon
- poison-reverse : split horizon with Poison Reverse
- disable : disable split horizon
Parameter type: <Rip::EgrRouteMapAction>
Format:
( permit
| deny )
Possible values:
- permit : advertise the route map
- deny : do not advertise the route map
Parameter type: <Rip::IngrRouteMapAction>
Format:
( permit
| deny )
Possible values:
- permit : accept the route
- deny : discard the route

value: "rip1-compatible"
RIP version used for sending RIP
packets

optional parameter with default


value: "rip1-or-rip2"
RIP version used for accepting
RIP packets

optional parameter with default


value: "enable"
split horizon status used in the
system

optional parameter with default


value: "permit"
action applied if route to be
advertised didnot match any
egress route map entry
optional parameter with default
value: "permit"
action applied if received route
didnot match any ingress route
map entry

Released

841

32 RIP Configuration Commands

32.5 RIP Interface Timers Configuration Command


Command Description
This command allows the user to configure RIP interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) timers [ no update-timer | update-timer <Rip::UpdateTmr> ] [ no route-age-out |
route-age-out <Rip::RouteAgeTmr> ] [ no junk-collection | junk-collection <Rip::GrbTmr> ]

Command Parameters
Table 32.5-1 "RIP Interface Timers Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

interface IP address

Table 32.5-2 "RIP Interface Timers Configuration Command" Command Parameters


Parameter

Type

Description

[no] update-timer

Parameter type: <Rip::UpdateTmr>


Format:
- update timer
- unit: secs
- range: [10...3600]
Parameter type: <Rip::RouteAgeTmr>
Format:
- route age timer
- unit: secs
- range: [30...500]
Parameter type: <Rip::GrbTmr>
Format:
- garbage collection timer
- unit: secs
- range: [120...180]

optional parameter with default


value: 30
interval between RIP updates in
secs

[no] route-age-out

[no] junk-collection

842

Released

optional parameter with default


value: 180
time for unrefreshed route to be
put in garbage in secs
optional parameter with default
value: 120
lifetime of route in garbage bin in
secs

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

32.6 RIP Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure a MD5 key for a RIP interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) ( no md5-key (index) ) | ( md5-key (index) key <Rip::AuthTypeMD5> starts
<Rip::MD5startDelay> expires <Rip::MD5expiryDelay> )

Command Parameters
Table 32.6-1 "RIP Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Format:
- the number of the MD5 key
- range: [0...255]

interface IP address

(index)

the number of the md5 key

Table 32.6-2 "RIP Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

Parameter type: <Rip::AuthTypeMD5>


Format:
( prompt
| plain : <Rip::Key> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Rip::Key>
- authentication key
- length: 1<=x<=16
Parameter type: <Rip::MD5startDelay>
Format:
( now
| <Sys::Time> )
Possible values:
- now : the key will be used from now on
Field type <Sys::Time>

mandatory parameter
the md5 key

starts

3HH-04416-EBAA-TCZZA 01

mandatory parameter
when the key must be used

Released

843

32 RIP Configuration Commands

Parameter

Type
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Rip::MD5expiryDelay>
Format:
( never
| <Rip::MD5expiryDelay> )
Possible values:
- never : the key will never expire
Field type <Rip::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

expires

844

Released

Description
mandatory parameter
delay before the key expires

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

32.7 RIP Interface Route Map Command


Command Description
This command allows the user to define an ingress or egress route map for routes redistributed from or to RIP over
an Interface.
If the action value is permit then it means:
1.If a received route matches the criteria of this route map filter, it will be occupied
2.If a route that is about to be published matches the criteria of the route map filter, it will be advertised
If the action value is deny then it means:
1. If a received route matches the criteria of the route map filter it will be discarded
2. If the route that is about to be published matches the criteria of the route map filter , it will not be advertised

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) ( no route-map (map-index) direction <Rip::NewRouteMapDirection> ) | (
route-map (map-index) direction <Rip::NewRouteMapDirection> ip-addr <Ip::AddressAndIpMaskFull> [ no
action | action <Rip::NewRouteMapAction> ] [ no prefix-match | prefix-match <Rip::NewRouteMapMatch> ] )

Command Parameters
Table 32.7-1 "RIP Interface Route Map Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Format:
- identifies the route map index
- range: [1...400]
Parameter type: <Rip::NewRouteMapDirection>
Format:
( egress
| ingress )
Possible values:
- egress : filter applied to advertised routes
- ingress : filter applied to received routes

interface IP address

(map-index)
direction

identifies the route map index


identifies the direction

Table 32.7-2 "RIP Interface Route Map Command" Command Parameters


Parameter

Type

Description

ip-addr

Parameter type: <Ip::AddressAndIpMaskFull>


Format:

mandatory parameter
The parameter is not visible

3HH-04416-EBAA-TCZZA 01

Released

845

32 RIP Configuration Commands

Parameter

[no] action

[no] prefix-match

846

Released

Type

Description

<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Rip::NewRouteMapAction>
Format:
( permit
| deny )
Possible values:
- permit : accept/advertise the route
- deny : discard/do not advertise the route
Parameter type: <Rip::NewRouteMapMatch>
Format:
( exact
| longest )
Possible values:
- exact : the route shall exactly match
- longest : the longest prefix match

during modification.
IP address or subnet

optional parameter with default


value: "permit"
The parameter is not visible
during modification.
specifes the action to be
allowed(permit/deny)
optional parameter with default
value: "exact"
The parameter is not visible
during modification.
specifies how the route shall
match the ip-address and subnet
in this filter

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

32.8 RIP Route Aggregation Command


Command Description
This command allows the user to add or delete a route aggregation.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip ( no aggregation (ip-addr) ) | ( aggregation (ip-addr) )

Command Parameters
Table 32.8-1 "RIP Route Aggregation Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

aggregated IP
subnetmask

3HH-04416-EBAA-TCZZA 01

Released

address

847

and

32 RIP Configuration Commands

32.9 RIP Route Map Command


Command Description
Obsolete command, replaced by configure rip interface (ip-addr) route-map.
This command allows the user to define a route map.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip ( no route-map (vlan-id) sub-index <Rip::SubIndex> ) | ( route-map (vlan-id) sub-index
<Rip::SubIndex> ip-addr <Ip::AddressAndIpMaskFull> [ no direction | direction <Rip::RouteMapDirection> ] [ [
no ] deny ] )
Obsolete command, replaced by configure rip interface (ip-addr) route-map.

Command Parameters
Table 32.9-1 "RIP Route Map Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Rip::SubIndex>
Format:
- identifies the rule for each ip-address
- range: [1...128]

interface IP address

sub-index

identifies the
ip-address

rule

for

each

Table 32.9-2 "RIP Route Map Command" Command Parameters


Parameter

Type

Description

ip-addr

Parameter type: <Ip::AddressAndIpMaskFull>


Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Rip::RouteMapDirection>
Format:
transmit
Possible values:
- transmit : route map in transmitting direction

mandatory parameter
The parameter is not visible
during modification.
IP address of subnet that can be
allowed/disallowed

[no] direction

848

Released

optional parameter with default


value: "transmit"
The parameter is not visible
during modification.
Direction in which the RIP routes
are advertised.

3HH-04416-EBAA-TCZZA

01

32 RIP Configuration Commands

Parameter

Type

Description

[no] deny

Parameter type: boolean

optional parameter
The parameter is not visible
during modification.
deny route map

3HH-04416-EBAA-TCZZA 01

Released

849

33- Cluster Management Configure Commands

33.1 Cluster Management Configure Command Tree


33.2 Cluster System Configuration Command
33.3 Cluster Neighbor Discovery Configuration Command
33.4 Cluster Topology Collection Configuration Command
33.5 Cluster Port Configuration Command

850

Released

33-851
33-852
33-853
33-854
33-855

3HH-04416-EBAA-TCZZA

01

33 Cluster Management Configure Commands

33.1 Cluster Management Configure Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Cluster Management Configure Commands".

Command Tree
----configure
----cluster
----system
- [no] name
- role
----neighbour
- [no] discov-mode-off
- [no] interval
- [no] hold-time
----collection
- [no] collect-sys-off
- [no] hop-delay
- [no] port-delay
- [no] scope
- [no] interval
- [no] manual
----[no] port
- (port)
- [no] discov-port-off
- [no] collect-port-off

3HH-04416-EBAA-TCZZA 01

Released

851

33 Cluster Management Configure Commands

33.2 Cluster System Configuration Command


Command Description
This command allows the operator to configure the parameters of an NE on the system level

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure cluster system [ no name | name <Cluster::ClusterName> ] [ role <Cluster::ClusterRole> ]

Command Parameters
Table 33.2-2 "Cluster System Configuration Command" Command Parameters
Parameter

Type

Description

[no] name

Parameter type: <Cluster::ClusterName>


Format:
- the cluster name
- length: x<=255
Parameter type: <Cluster::ClusterRole>
Format:
( command
| member
| backup
| candidate )
Possible values:
- command : act as a command node
- member : act as a member node
- backup : act as a backup node
- candidate : act as a candidate node

optional parameter with default


value: ""
the cluster name

role

852

Released

optional parameter
the cluster role

3HH-04416-EBAA-TCZZA

01

33 Cluster Management Configure Commands

33.3 Cluster Neighbor Discovery Configuration


Command
Command Description
This command allows the operator to configure the neighbor discovery on system level

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure cluster neighbour [ [ no ] discov-mode-off ] [ no interval | interval <Cluster::DiscoveryInterval> ] [ no
hold-time | hold-time <Cluster::DiscoveryHoldTime> ]

Command Parameters
Table 33.3-2 "Cluster Neighbor Discovery Configuration Command" Command Parameters
Parameter

Type

Description

[no] discov-mode-off

Parameter type: boolean

[no] interval

Parameter type: <Cluster::DiscoveryInterval>


Format:
- the neighbour discovery interval
- range: [1...2147483647]
Parameter type: <Cluster::DiscoveryHoldTime>
Format:
- the neighbour discovery hold time
- range: [1...255]

optional parameter
neighbour discovery in the NE is
disabled
optional parameter with default
value: 60
the neighbour discovery interval

[no] hold-time

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 180
the neighbour discovery hold
time

Released

853

33 Cluster Management Configure Commands

33.4 Cluster Topology Collection Configuration


Command
Command Description
This command allows the operator to configure the topology collection on system level

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure cluster collection [ [ no ] collect-sys-off ] [ no hop-delay | hop-delay <Cluster::CollectionHopDelay> ] [
no port-delay | port-delay <Cluster::CollectionPortDelay> ] [ no scope | scope <Cluster::CollectionScope> ] [ no
interval | interval <Cluster::CollectionInterval> ] [ [ no ] manual ]

Command Parameters
Table 33.4-2 "Cluster Topology Collection Configuration Command" Command Parameters
Parameter

Type

Description

[no] collect-sys-off

Parameter type: boolean

[no] hop-delay

Parameter type: <Cluster::CollectionHopDelay>


Format:
- time of the collection hop delay
- range: [1...65535]
Parameter type: <Cluster::CollectionPortDelay>
Format:
- time of the collection port delay
- range: [1...65535]
Parameter type: <Cluster::CollectionScope>
Format:
- the collection scope of the cluster
- range: [1...10]
Parameter type: <Cluster::CollectionInterval>
Format:
- the topology collection interval
- range: [0...2147483647]
Parameter type: boolean

optional parameter
topology collection in the NE is
disabled
optional parameter with default
value: 200
the topology collection hop delay

[no] port-delay

[no] scope

[no] interval

[no] manual

854

Released

optional parameter with default


value: 20
the topology collection port delay
optional parameter with default
value: 3
the topology collection scope
optional parameter with default
value: 0
the topology collection interval
optional parameter
the manual topology collection in
the NE is enabled

3HH-04416-EBAA-TCZZA

01

33 Cluster Management Configure Commands

33.5 Cluster Port Configuration Command


Command Description
This command allows the operator to configure the parameter on the port level

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure cluster ( no port (port) ) | ( port (port) [ [ no ] discov-port-off ] [ [ no ] collect-port-off ] )

Command Parameters
Table 33.5-1 "Cluster Port Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

index of a port

Table 33.5-2 "Cluster Port Configuration Command" Command Parameters


Parameter

Type

Description

[no] discov-port-off

Parameter type: boolean

[no] collect-port-off

Parameter type: boolean

optional parameter
neighbour discovery in the port is
disabled
optional parameter
topology collection in the NE is
disabled

3HH-04416-EBAA-TCZZA 01

Released

855

34- XDSL Bonding Configuration Commands

34.1 XDSL Bonding Configuration Command Tree


34.2 XDSL Bonding Assembly Timer Configuration
Command
34.3 xDSL Bonding Group Profile Configuration Command
34.4 xDSL Bonding Group Rtx Profile Configuration
Command
34.5 xDSL Bonding Configuration Command
34.6 xDSL Bonding Configuration Command
34.7 xDSL Bonding Board Configuration Command
34.8 xDSL Bonding Board Vectoring Fallback
Configuration Command

856

Released

34-857
34-859
34-860
34-863
34-867
34-869
34-870
34-871

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.1 XDSL Bonding Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "XDSL Bonding Configuration Commands".

Command Tree
----configure
----xdsl-bonding
- group-assembly-time
----[no] group-profile
- (index)
- name
- (scope)
- version
- [no] min-bitrate-up
- [no] min-bitrate-down
- [no] plan-bitrate-up
- [no] plan-bitrate-down
- [no] max-bitrate-up
- [no] max-bitrate-down
- [no] max-delay-down
- [no] max-delay-up
- [no] imp-noise-prot-dn
- [no] imp-noise-prot-up
- [no] delay-opt-mode-ds
- [no] grp-assembly-time
- [no] active
----[no] group-rtx-profile
- (index)
- name
- version
- [no] rtx-mode-dn
- [no] rtx-mode-up
- [no] min-exp-thrpt-dn
- [no] min-exp-thrpt-up
- [no] plan-exp-thrpt-dn
- [no] plan-exp-thrpt-up
- [no] max-exp-thrpt-dn
- [no] max-exp-thrpt-up
- [no] max-net-rate-dn
- [no] max-net-rate-up
- [no] min-delay-dn
- [no] min-delay-up
- [no] max-delay-dn
- [no] max-delay-up
- [no] min-inp-shine-dn
- [no] min-inp-shine-up
- [no] min-inp-rein-dn
- [no] min-inp-rein-up
- [no] int-arr-time-dn
- [no] int-arr-time-up

3HH-04416-EBAA-TCZZA 01

Released

857

34 XDSL Bonding Configuration Commands

- [no] shine-ratio-dn
- [no] shine-ratio-up
- [no] leftr-thresh-dn
- [no] leftr-thresh-up
- [no] active
----group
- (bonding-group-idx)
- [no] group-profile
- [no] group-rtx-profile
X [no] admin-up
- [no] up
----[no] link
- (bonding-link-id)
----board
- (board-index)
----vect-fallback
- [no] group-profile
- [no] group-rtx-profile

858

Released

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.2 XDSL Bonding Assembly Timer Configuration


Command
Command Description
This node provides the provisioning of the bonding group assembly timeout. Default value is zero ('0', represents
an infinite time ), and will have as consequence that the bonding group will not come up till all lines in this bonding
group are up. This parameter may be overruled by the grp-assembly-time parameter on bonding group-profile
level.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding group-assembly-time <Xdsl::SignedIntegerSEC>

Command Parameters
Table 34.2-2 "XDSL Bonding Assembly Timer Configuration Command" Command Parameters
Parameter

Type

Description

group-assembly-time

Parameter type: <Xdsl::SignedIntegerSEC>


Format:
- second
- unit: sec
- range: [0...65535]

optional parameter
Max waiting period for group to
become operational

3HH-04416-EBAA-TCZZA 01

Released

859

34 XDSL Bonding Configuration Commands

34.3 xDSL Bonding Group Profile Configuration


Command
Command Description
This command allows to manage the xDSL bonding group profile. A profile can be created in one step with all the
necessary parameters and making it active. It can also be created in several steps by specifying a few parameters in
each step and make the profile active in the last step.
DESCRIPTION FOR THE COMMAND PARAMETER-SCOPE:The combination scope+profile must be
unique.Typically local-profile must be used especially when configuring via CLI.Use of network-profile is
depreciated.The network-profile was foreseen to allow management agents to define network-wide unique
profiles,independent of what local profiles may have been created.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding ( no group-profile (index) ) | ( group-profile (index) name <AsamProfileName> (scope)
version <SignedInteger> [ no min-bitrate-up | min-bitrate-up <Xdsl::BondingBitRate> ] [ no min-bitrate-down |
min-bitrate-down <Xdsl::BondingBitRate> ] [ no plan-bitrate-up | plan-bitrate-up <Xdsl::BondingBitRate> ] [ no
plan-bitrate-down | plan-bitrate-down <Xdsl::BondingBitRate> ] [ no max-bitrate-up | max-bitrate-up
<Xdsl::BondingBitRate> ] [ no max-bitrate-down | max-bitrate-down <Xdsl::BondingBitRate> ] [ no
max-delay-down | max-delay-down <Xdsl::InterleavingDelay> ] [ no max-delay-up | max-delay-up
<Xdsl::InterleavingDelay> ] [ no imp-noise-prot-dn | imp-noise-prot-dn <Xdsl::ImpNoiseProtection> ] [ no
imp-noise-prot-up | imp-noise-prot-up <Xdsl::ImpNoiseProtection> ] [ no delay-opt-mode-ds | delay-opt-mode-ds
<Xdsl::BondingGroupDelayOptimMode>
]
[
no
grp-assembly-time
|
grp-assembly-time
<Xdsl::BondingGroupProfileAssemblyTimer> ] [ [ no ] active ] )

Command Parameters
Table 34.3-1 "xDSL Bonding Group Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- bonding group profile index
- range: [1...100]

index of the profile

Table 34.3-2 "xDSL Bonding Group Profile Configuration Command" Command Parameters
Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]

mandatory parameter
name of the profile

860

Released

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

Parameter
(scope)

version
[no] min-bitrate-up

[no] min-bitrate-down

[no] plan-bitrate-up

[no] plan-bitrate-down

[no] max-bitrate-up

[no] max-bitrate-down

[no] max-delay-down

[no] max-delay-up

[no] imp-noise-prot-dn

[no] imp-noise-prot-up

3HH-04416-EBAA-TCZZA 01

Type
- length: 1<=x<=32
Format:
( local-profile
| network-profile )
Possible values:
- local-profile : the local profile
- network-profile : the network profile
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::InterleavingDelay>
Format:
- a delay time period
- unit: msec
- range: [1...63]
Parameter type: <Xdsl::InterleavingDelay>
Format:
- a delay time period
- unit: msec
- range: [1...63]
Parameter type: <Xdsl::ImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: 1/10 symbols
- range: [0...160]
Parameter type: <Xdsl::ImpNoiseProtection>
Format:

Description
mandatory parameter
scope of the profile

mandatory parameter
version maintained by manager,
usually 1 for new profile
optional parameter with default
value: 64
minimum upstream bit rate to be
maintained
optional parameter with default
value: 1024
minimum downstream bit rate to
be maintained
optional parameter with default
value: 128
planned bitrate in upstream
optional parameter with default
value: 1536
planned bitrate in downstream
optional parameter with default
value: 640
maximum bitrate in upstream
optional parameter with default
value: 6144
maximum bitrate in downstream
optional parameter with default
value: 16
maximum delay for interleaving
function in downstream
optional parameter with default
value: 16
maximum delay for interleaving
function in upstream
optional parameter with default
value: 0
minimum
impulse
noise
protection in downstream
optional parameter with default
value: 0

Released

861

34 XDSL Bonding Configuration Commands

Parameter

[no] delay-opt-mode-ds

[no] grp-assembly-time

[no] active

862

Released

Type

Description

- minimum impulse noise protection


- unit: 1/10 symbols
- range: [0...160]
Parameter type: <Xdsl::BondingGroupDelayOptimMode>
Format:
( none
| by-co
| by-cpe )
Possible values:
- none : no downstream delay optimization
- by-co : the downstream optimization is done by the co
- by-cpe : the downstream optimization is done by the
cpe(option not yet supported)
Parameter
type:
<Xdsl::BondingGroupProfileAssemblyTimer>
Format:
( infinity
| <Xdsl::BondingAssemblyTimer>
| use-system )
Possible values:
- infinity : wait forever, special value 0
- use-system : use system wide parameter, special value
65535
Field type <Xdsl::BondingAssemblyTimer>
- value of the assembly timer
- unit: sec
- range: [1...65534]
Parameter type: boolean

minimum
impulse
protection in upstream

noise

optional parameter with default


value: "none"
identifies the mode of the
downstream delay optimization

optional parameter with default


value: "use-system"
Max waiting period for group to
become operational

optional parameter
to activate the profile

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.4 xDSL Bonding Group Rtx Profile


Configuration Command
Command Description
This command allows the operator to configure the bonding group RTX profile which can be used to configure the
modem for each contributing physical line of the bonding group
RTX downstream/upstream parameters will have effect on lines supporting RTX, only when the retransmission
feature in downstream/upstream is not "forbidden"

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding ( no group-rtx-profile (index) ) | ( group-rtx-profile (index) name <AsamProfileName> [
version <SignedInteger> ] [ no rtx-mode-dn | rtx-mode-dn <Xdsl::RtxMode> ] [ no rtx-mode-up | rtx-mode-up
<Xdsl::RtxMode> ] [ no min-exp-thrpt-dn | min-exp-thrpt-dn <Xdsl::BondingBitRate> ] [ no min-exp-thrpt-up |
min-exp-thrpt-up <Xdsl::BondingBitRate> ] [ no plan-exp-thrpt-dn | plan-exp-thrpt-dn <Xdsl::BondingBitRate> ] [
no plan-exp-thrpt-up | plan-exp-thrpt-up <Xdsl::BondingBitRate> ] [ no max-exp-thrpt-dn | max-exp-thrpt-dn
<Xdsl::BondingBitRate> ] [ no max-exp-thrpt-up | max-exp-thrpt-up <Xdsl::BondingBitRate> ] [ no
max-net-rate-dn | max-net-rate-dn <Xdsl::BondingBitRate> ] [ no max-net-rate-up | max-net-rate-up
<Xdsl::BondingBitRate> ] [ no min-delay-dn | min-delay-dn <Xdsl::RtxMinDelay> ] [ no min-delay-up |
min-delay-up <Xdsl::RtxMinDelay> ] [ no max-delay-dn | max-delay-dn <Xdsl::RtxMaxDelay> ] [ no
max-delay-up | max-delay-up <Xdsl::RtxMaxDelay> ] [ no min-inp-shine-dn | min-inp-shine-dn
<Xdsl::ShineImpNoiseProtection> ] [ no min-inp-shine-up | min-inp-shine-up <Xdsl::ShineImpNoiseProtection> ]
[ no min-inp-rein-dn | min-inp-rein-dn <Xdsl::ReinImpNoiseProtection> ] [ no min-inp-rein-up | min-inp-rein-up
<Xdsl::ReinImpNoiseProtection> ] [ no int-arr-time-dn | int-arr-time-dn <Xdsl::RtxInterArrivalTime> ] [ no
int-arr-time-up | int-arr-time-up <Xdsl::RtxInterArrivalTime> ] [ no shine-ratio-dn | shine-ratio-dn
<Xdsl::RtxShineRatio> ] [ no shine-ratio-up | shine-ratio-up <Xdsl::RtxShineRatio> ] [ no leftr-thresh-dn |
leftr-thresh-dn <Xdsl::RtxLeftrThreshold> ] [ no leftr-thresh-up | leftr-thresh-up <Xdsl::RtxLeftrThreshold> ] [ [ no
] active ] )

Command Parameters
Table 34.4-1 "xDSL Bonding Group Rtx Profile Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...128]

index of the profile

Table 34.4-2 "xDSL Bonding Group Rtx Profile Configuration Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

863

34 XDSL Bonding Configuration Commands

Parameter

Type

Description

name

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <SignedInteger>
Format:
- a signed integer
Parameter type: <Xdsl::RtxMode>
Format:
( forbidden
| preferred
| forced
| testmode )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
Parameter type: <Xdsl::RtxMode>
Format:
( forbidden
| preferred
| forced
| testmode )
Possible values:
- forbidden : retransmission forbidden in down/upstream
- preferred : retransmission preferred in down/upstream
- forced : retransmission forced in down/upstream
- testmode : retransmission testmode in down/upstream
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:

mandatory parameter
profile name

version
[no] rtx-mode-dn

[no] rtx-mode-up

[no] min-exp-thrpt-dn

[no] min-exp-thrpt-up

[no] plan-exp-thrpt-dn

[no] plan-exp-thrpt-up

[no] max-exp-thrpt-dn

[no] max-exp-thrpt-up

864

Released

optional parameter
version maintained by manager,
usually 1 for new profile
optional parameter with default
value: "preferred"
retransmission
mode
in
downstream

optional parameter with default


value: "preferred"
retransmission mode in upstream

optional parameter with default


value: 64
minimum expected throughput
for downstream direction
optional parameter with default
value: 64
minimum expected throughput
for upstream direction
optional parameter with default
value: 128
planned expected throughput for
downstream direction
optional parameter with default
value: 128
planned expected throughput for
upstream direction
optional parameter with default
value: 2147483647
maximum expected throughput
for downstream direction
optional parameter with default
value: 2147483647

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

Parameter

[no] max-net-rate-dn

[no] max-net-rate-up

[no] min-delay-dn

Type

Description

- a bonding bit rate value


- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::BondingBitRate>
Format:
- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]
Parameter type: <Xdsl::RtxMinDelay>
Format:
- a delay time period
- unit: msec
- range: [0...63]

maximum expected throughput


for upstream direction

[no] min-delay-up

Parameter type: <Xdsl::RtxMinDelay>


Format:
- a delay time period
- unit: msec
- range: [0...63]

[no] max-delay-dn

Parameter type: <Xdsl::RtxMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [2...63]

[no] max-delay-up

Parameter type: <Xdsl::RtxMaxDelay>


Format:
- a delay time period
- unit: msec
- range: [2...63]

[no] min-inp-shine-dn

Parameter type: <Xdsl::ShineImpNoiseProtection>


Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...63]
Parameter type: <Xdsl::ShineImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...63]
Parameter type: <Xdsl::ReinImpNoiseProtection>
Format:
- minimum impulse noise protection
- unit: DMT symbols
- range: [0...7]
Parameter type: <Xdsl::ReinImpNoiseProtection>
Format:
- minimum impulse noise protection

[no] min-inp-shine-up

[no] min-inp-rein-dn

[no] min-inp-rein-up

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 2147483647
maximum net data rate for
downstream direction
optional parameter with default
value: 2147483647
maximum net data rate for
upstream direction
optional parameter with default
value: 0
minimum instantaneous delay
allowed (due to the effect of
retransmission) for downstream
direction
optional parameter with default
value: 0
minimum instantaneous delay
allowed (due to the effect of
retransmission) for upstream
direction
optional parameter with default
value: 12
maximum instantaneous delay
allowed(due to the effect of
retransmission) for downstream
direction Special value 0 means
no delay bounds
optional parameter with default
value: 12
maximum instantaneous delay
allowed (due to the effect of
retransmission) for upstream
direction Special value 0 means
no delay bounds
optional parameter with default
value: 8
minimum
impulse
noise
protection against shine for
downstream direction
optional parameter with default
value: 8
minimum
impulse
noise
protection against shine for
upstream direction
optional parameter with default
value: 0
minimum
impulse
noise
protection against rein for
downstream direction
optional parameter with default
value: 0
minimum
impulse
noise

Released

865

34 XDSL Bonding Configuration Commands

Parameter
[no] int-arr-time-dn

[no] int-arr-time-up

[no] shine-ratio-dn

[no] shine-ratio-up

[no] leftr-thresh-dn

[no] leftr-thresh-up

[no] active

866

Released

Type

Description

- unit: DMT symbols


- range: [0...7]
Parameter type: <Xdsl::RtxInterArrivalTime>
Format:
( derivedfrom100hz
| derivedfrom120hz )
Possible values:
- derivedfrom100hz : inter-arrival time derived from 100hz
- derivedfrom120hz : inter-arrival time derived from 120hz
Parameter type: <Xdsl::RtxInterArrivalTime>
Format:
( derivedfrom100hz
| derivedfrom120hz )
Possible values:
- derivedfrom100hz : inter-arrival time derived from 100hz
- derivedfrom120hz : inter-arrival time derived from 120hz
Parameter type: <Xdsl::RtxShineRatio>
Format:
- shine ratio
- unit: 1/1000
- range: [0...100]
Parameter type: <Xdsl::RtxShineRatio>
Format:
- shine ratio
- unit: 1/1000
- range: [0...100]
Parameter type: <Xdsl::RtxLeftrThreshold>
Format:
- near-end defect threshold
- unit: 1/100
- range: [0,1...99]
Parameter type: <Xdsl::RtxLeftrThreshold>
Format:
- near-end defect threshold
- unit: 1/100
- range: [0,1...99]
Parameter type: boolean

protection against rein for


upstream direction
optional parameter with default
value: "derivedfrom100hz"
assumed inter-arrival time for
rein protection for downstream
direction
optional parameter with default
value: "derivedfrom100hz"
assumed inter-arrival time for
rein protection for upstream
direction
optional parameter with default
value: 10
shine ratio for downstream
direction
optional parameter with default
value: 10
shine ratio for upstream direction
optional parameter with default
value: 0
threshold for declaring a near-end
defect in downstream direction
optional parameter with default
value: 0
threshold for declaring a near-end
defect in upstream direction
optional parameter
to activate the profile

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.5 xDSL Bonding Configuration Command


Command Description
This command allows to configure a bonding group, which consists of assigning a predefined bonding group
profile and optional assigning a group rtx-profile.
Configuring bonding group will fail when a service is already configured on the secondary DSL line of the bonding
group

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
>
configure
xdsl-bonding
group
(bonding-group-idx)
[
no
group-profile
|
group-profile
<Xdsl::GroupProfileIndexWithRemove> ] [ no group-rtx-profile | group-rtx-profile <Xdsl::LineRtxProfile> ] [ [ no
] admin-up ] [ [ no ] up ]

Command Parameters
Table 34.5-1 "xDSL Bonding Configuration Command" Resource Parameters
Resource Identifier

Type

(bonding-group-idx)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 34.5-2 "xDSL Bonding Configuration Command" Command Parameters


Parameter

Type

Description

[no] group-profile

Parameter type: <Xdsl::GroupProfileIndexWithRemove>


Format:
( none
| <Xdsl::GroupProfileIndexWithRemove>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::GroupProfileIndexWithRemove>

optional parameter with default


value: "none"
a valid profile index for the
interface

3HH-04416-EBAA-TCZZA 01

Released

867

34 XDSL Bonding Configuration Commands

Parameter

Type

[no] admin-up

- bonding group profile index


- range: [0...100]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::LineRtxProfile>
Format:
( none
| <Xdsl::RtxProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no profile to associate
- name : profile name
Field type <Xdsl::RtxProfilePointer>
- profile index
- range: [0...128]
Field type <PrintableString>
- printable string
Parameter type: boolean

[no] up

Parameter type: boolean

[no] group-rtx-profile

Description

optional parameter with default


value: "none"
a valid bonding group rtx profile
index for the interface

obsolete parameter replaced by


parameter "up"
set the admin-state of the group
to up
optional parameter
The parameter is not visible
during creation.
admin-state of the group to up

Command Output
Table 34.5-3 "xDSL Bonding Configuration Command" Display parameters
Specific Information
name

Type

Description

group-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

group-rtx-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

name of the group profile


This element is only shown in
detail mode.
name of the bonding group rtx
profile
This element is only shown in
detail mode.

868

Released

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.6 xDSL Bonding Configuration Command


Command Description
This node provides the provisoning of the bonding group, which consists of adding/removing links to/from the
bonding group.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding group (bonding-group-idx) ( no link (bonding-link-id) ) | ( link (bonding-link-id) )

Command Parameters
Table 34.6-1 "xDSL Bonding Configuration Command" Resource Parameters
Resource Identifier

Type

(bonding-group-idx)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
a bonding link interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

(bonding-link-id)

3HH-04416-EBAA-TCZZA 01

Description

Released

869

34 XDSL Bonding Configuration Commands

34.7 xDSL Bonding Board Configuration Command


Command Description
This command allows the operator to configure xdsl bonding parameters related with a specific board.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding board (board-index)

Command Parameters
Table 34.7-1 "xDSL Bonding Board Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

board index

870

Released

3HH-04416-EBAA-TCZZA

01

34 XDSL Bonding Configuration Commands

34.8 xDSL Bonding Board Vectoring Fallback


Configuration Command
Command Description
This command allows the operator to configure per board the profile selection in case the bonding group enters the
vectoring fallback mode.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding board (board-index) vect-fallback [ no group-profile | group-profile
<Xdsl::VectFbGroupProfileIndex> ] [ no group-rtx-profile | group-rtx-profile <Xdsl::VectFbGroupRtxProfile> ]

Command Parameters
Table 34.8-1 "xDSL Bonding Board Vectoring Fallback Configuration Command" Resource
Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

board index

Table 34.8-2 "xDSL Bonding Board Vectoring Fallback Configuration Command" Command
Parameters
Parameter

Type

Description

[no] group-profile

Parameter type: <Xdsl::VectFbGroupProfileIndex>


Format:
( group-level
| <Xdsl::VectFbGroupProfilePointer>
| name : <PrintableString> )
Possible values:
- group-level : use the original group profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbGroupProfilePointer>

optional parameter with default


value: "group-level"
a valid profile index for the
interface

3HH-04416-EBAA-TCZZA 01

Released

871

34 XDSL Bonding Configuration Commands

Parameter

Type

[no] group-rtx-profile

Description

- bonding group profile index


- range: [1...100]
Field type <PrintableString>
- printable string
Parameter type: <Xdsl::VectFbGroupRtxProfile>
Format:
( none
| group-level
| <Xdsl::VectFbRtxProfilePointer>
| name : <PrintableString> )
Possible values:
- none : no fallback profile to associate
- group-level : use the original group rtx profile in fallback
mode
- name : profile name
Field type <Xdsl::VectFbRtxProfilePointer>
- a profile index value
- range: [0...128]
Field type <PrintableString>
- printable string

optional parameter with default


value: "group-level"
a valid bonding group rtx profile
index for the interface

Command Output
Table 34.8-3 "xDSL Bonding Board Vectoring Fallback Configuration Command" Display
parameters
Specific Information
name

Type

Description

group-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

group-rtx-profile-name

Parameter type: <Xdsl::IgnoredPrintableString>


- ignored printable string

name of the group profile


This element is only shown in
detail mode.
name of the bonding group rtx
profile
This element is only shown in
detail mode.

872

Released

3HH-04416-EBAA-TCZZA

01

35- CPE Remote Configuration Commands

35.1 CPE Remote Configuration Command Tree


35.2 CPE Remote Management System Configuration
Commands
35.3 CPE Manager Configuration Command
35.4 CPE IPProxy Session Configuration Command
35.5 CPE IPProxy Shub Vlan Configuration Command

3HH-04416-EBAA-TCZZA 01

35-874
35-875
35-876
35-877
35-878

Released

873

35 CPE Remote Configuration Commands

35.1 CPE Remote Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "CPE Remote Configuration Commands".

Command Tree
----configure
----cpe-management
- [no] proxy-mode
X vlan-id
----[no] manager
- (address)
----X [no] session
- (dslport)
- connection
----shub
----[no] vlan-id
- (vlan-id)

874

Released

3HH-04416-EBAA-TCZZA

01

35 CPE Remote Configuration Commands

35.2 CPE Remote Management System


Configuration Commands
Command Description
This command allows to configure CPE Remote Management System;

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure cpe-management [ no proxy-mode | proxy-mode <CpeProxy::SystemMode> ] [ vlan-id
<CpeProxy::VlanIndex> ]

Command Parameters
Table 35.2-2 "CPE Remote Management System Configuration Commands" Command Parameters
Parameter

Type

Description

[no] proxy-mode

Parameter type: <CpeProxy::SystemMode>


Format:
( snmp
| none )
Possible values:
- snmp : this mode is relaying SNMP messages
- none : disables the cpeproxy
Parameter type: <CpeProxy::VlanIndex>
Format:
- cpe ipproxy vlan number
- range: [0...4093]

optional parameter with default


value: "none"
set the CPE Proxy mode

vlan-id

3HH-04416-EBAA-TCZZA 01

obsolete parameter that will be


ignored
configure the svlan number.

Released

875

35 CPE Remote Configuration Commands

35.3 CPE Manager Configuration Command


Command Description
This command allows to configure a CPE manager.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure cpe-management ( no manager (address) ) | ( manager (address) )

Command Parameters
Table 35.3-1 "CPE Manager Configuration Command " Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
<CpeProxy::IPaddress> : <CpeProxy::PortNumber>
Field type <CpeProxy::IPaddress>
- IP address of CPE Management Station
Field type <CpeProxy::PortNumber>
- cpe management station udp port number
- range: [1...65535]

the address of a CPE manager

876

Released

3HH-04416-EBAA-TCZZA

01

35 CPE Remote Configuration Commands

35.4 CPE IPProxy Session Configuration Command


Command Description
Obsolete command.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure cpe-management ( no session
<CpeProxy::cpeIpProxySessionProtocolPort> )

(dslport)

session

(dslport)

connection

Obsolete command.

Command Parameters
Table 35.4-1 "CPE IPProxy Session Configuration Command " Resource Parameters
Resource Identifier

Type

(dslport)

Format:
identification of port to which the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / CPE is connected
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 35.4-2 "CPE IPProxy Session Configuration Command " Command Parameters
Parameter

Type

connection

Parameter
<CpeProxy::cpeIpProxySessionProtocolPort>
Format:
- cpe ipproxy port number
- range: [0,13410...13457]

3HH-04416-EBAA-TCZZA 01

Description
type: mandatory parameter
protocol port for ipproxy session.

Released

877

35 CPE Remote Configuration Commands

35.5 CPE IPProxy Shub Vlan Configuration


Command
Command Description
This command allows to configure a cpe management shub vlan.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure cpe-management shub ( no vlan-id (vlan-id) ) | ( vlan-id (vlan-id) )

Command Parameters
Table 35.5-1 "CPE IPProxy Shub Vlan Configuration Command " Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- cpe ipproxy shub vlan number
- range: [1...4093]

configure the cpe management


shub vlan number

878

Released

3HH-04416-EBAA-TCZZA

01

36- SHDSL Configuration Commands

36.1 SHDSL Configuration Command Tree


36.2 SHDSL Span Configuration Command
36.3 SHDSL Unit Configuration Command
36.4 SHDSL Segment Configuration Command

3HH-04416-EBAA-TCZZA 01

36-880
36-882
36-887
36-889

Released

879

36 SHDSL Configuration Commands

36.1 SHDSL Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "SHDSL Configuration Commands".

Command Tree
----configure
----shdsl
----span
- (if-index)
- [no] active
- [no] admin-up
- [no] repeaters
- [no] op-mode
- [no] spectral-profile
- [no] wire-mode
- [no] mgmt-by-stu-r
- [no] regi-set
- [no] min-line-rate
- [no] max-line-rate
- [no] margin-down-worst
- [no] margin-down-curr
- [no] margin-up-worst
- [no] margin-up-curr
- [no] probe
- [no] tc-pam-sele
- [no] efm-hs-sele
- [no] bonding-rate-mode
- [no] min-rate-link1
- [no] max-rate-link1
- [no] min-rate-link2
- [no] max-rate-link2
- [no] min-rate-link3
- [no] max-rate-link3
- [no] min-rate-link4
- [no] max-rate-link4
- [no] tc-pam-link1
- [no] tc-pam-link2
- [no] tc-pam-link3
- [no] tc-pam-link4
- [no] ctc
----unit
- (if-index)
- unit-id
- [no] loop-attenuation
- [no] snr-margin
- [no] loopback-timeout
----segment
- (if-index)
- unit-id
- side

880

Released

3HH-04416-EBAA-TCZZA

01

36 SHDSL Configuration Commands

- [no] loopback
- [no] pbo-mode

3HH-04416-EBAA-TCZZA 01

Released

881

36 SHDSL Configuration Commands

36.2 SHDSL Span Configuration Command


Command Description
This command allows the operator to manage the SHDSL span profile.
The lines, which you can configure, are calculated via the next formula: m*n + 1
o where m is the number of pairs per modem
o where n is from 0 till 24/m - 1
Mixing of different "wire mode" on the same LT is possible as long as the lines are not occupied yet.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure shdsl span (if-index) [ [ no ] active ] [ [ no ] admin-up ] [ no repeaters | repeaters
<Shdsl::SpanConfNumRepeaters> ] [ no op-mode | op-mode <Shdsl::SpanOperationalMode> ] [ no spectral-profile
| spectral-profile <Shdsl::SpanSpectralProfile> ] [ no wire-mode | wire-mode <Shdsl::SpanWireMode> ] [ [ no ]
mgmt-by-stu-r ] [ no regi-set | regi-set <Shdsl::SpanRegionalSetting> ] [ no min-line-rate | min-line-rate
<Shdsl::BitRate> ] [ no max-line-rate | max-line-rate <Shdsl::BitRate> ] [ no margin-down-worst |
margin-down-worst
<Shdsl::NoiseMarginWC>
]
[
no
margin-down-curr
|
margin-down-curr
<Shdsl::NoiseMarginCC> ] [ no margin-up-worst | margin-up-worst <Shdsl::NoiseMarginWC> ] [ no
margin-up-curr | margin-up-curr <Shdsl::NoiseMarginCC> ] [ no probe | probe <Shdsl::SpanLineProbeEnable> ] [
no tc-pam-sele | tc-pam-sele <Shdsl::SpanTCPAMSelection> ] [ no efm-hs-sele | efm-hs-sele
<Shdsl::SpanEFMHandshakeSelection>
]
[
no
bonding-rate-mode
|
bonding-rate-mode
<Shdsl::SpanBondingRateControlMode> ] [ no min-rate-link1 | min-rate-link1 <Shdsl::BitRate> ] [ no
max-rate-link1 | max-rate-link1 <Shdsl::BitRate> ] [ no min-rate-link2 | min-rate-link2 <Shdsl::BitRate> ] [ no
max-rate-link2 | max-rate-link2 <Shdsl::BitRate> ] [ no min-rate-link3 | min-rate-link3 <Shdsl::BitRate> ] [ no
max-rate-link3 | max-rate-link3 <Shdsl::BitRate> ] [ no min-rate-link4 | min-rate-link4 <Shdsl::BitRate> ] [ no
max-rate-link4
|
max-rate-link4
<Shdsl::BitRate>
]
[
no
tc-pam-link1
|
tc-pam-link1
<Shdsl::SpanTCPAMSelection> ] [ no tc-pam-link2 | tc-pam-link2 <Shdsl::SpanTCPAMSelection> ] [ no
tc-pam-link3 | tc-pam-link3 <Shdsl::SpanTCPAMSelection> ] [ no tc-pam-link4 | tc-pam-link4
<Shdsl::SpanTCPAMSelection> ] [ no ctc | ctc <Shdsl::SpanCTCEnable> ]

Command Parameters
Table 36.2-1 "SHDSL Span Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

882

Released

Description

3HH-04416-EBAA-TCZZA

01

36 SHDSL Configuration Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Table 36.2-2 "SHDSL Span Configuration Command" Command Parameters


Parameter

Type

Description

[no] active

Parameter type: boolean

[no] admin-up

Parameter type: boolean

[no] repeaters

Parameter type: <Shdsl::SpanConfNumRepeaters>


Format:
- the number of SRUs to be configured for this span
- range: [0...8]
Parameter type: <Shdsl::SpanOperationalMode>
Format:
( native
| ima
| efm )
Possible values:
- native : the operational mode is native
- ima : the operational mode is ima
- efm : the operational mode is efm
Parameter type: <Shdsl::SpanSpectralProfile>
Format:
( symmetric
| asymmetric )
Possible values:
- symmetric : the spectral mode is symmetric
- asymmetric : the spectral mode is asymmetric
Parameter type: <Shdsl::SpanWireMode>
Format:
( two-wire
| four-wire
| six-wire
| eight-wire )
Possible values:
- two-wire : the M-pair operation is one-pair
- four-wire : the M-pair operation is two-pair
- six-wire : the M-pair operation is three-pair
- eight-wire : the M-pair operation is four-pair
Parameter type: boolean

optional parameter
set the span-profile active
optional parameter
admin status is up
optional parameter with default
value: 0
number of repeaters

[no] op-mode

[no] spectral-profile

[no] wire-mode

[no] mgmt-by-stu-r
[no] regi-set

[no] min-line-rate

3HH-04416-EBAA-TCZZA 01

Parameter type: <Shdsl::SpanRegionalSetting>


Format:
( annex-a/f
| annex-b/g )
Possible values:
- annex-a/f : Annex A/F Region 1
- annex-b/g : Annex B/G Region 2
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec

optional parameter with default


value: "native"
span operational mode

optional parameter with default


value: "symmetric"
spectral mode

optional parameter with default


value: "two-wire"
M-pair operation wire mode

optional parameter
enable the STU-R initiated
management flow
optional parameter with default
value: "annex-b/g"
the number specifies regional
setting

optional parameter with default


value: 192
the minimum requested data rate

Released

883

36 SHDSL Configuration Commands

Parameter

Type

Description

[no] max-line-rate

Parameter type: <Shdsl::BitRate>


Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::NoiseMarginWC>
Format:
- a noise margin value of worst conditions
- unit: db
- range: [-11...10]
Parameter type: <Shdsl::NoiseMarginCC>
Format:
- a noise margin value of current conditions
- unit: db
- range: [-11,0...10]
Parameter type: <Shdsl::NoiseMarginWC>
Format:
- a noise margin value of worst conditions
- unit: db
- range: [-11...10]
Parameter type: <Shdsl::NoiseMarginCC>
Format:
- a noise margin value of current conditions
- unit: db
- range: [-11,0...10]
Parameter type: <Shdsl::SpanLineProbeEnable>
Format:
( disable
| enable )
Possible values:
- disable : disable the line probe
- enable : enable the line probe
Parameter type: <Shdsl::SpanTCPAMSelection>
Format:
( auto
| tc-pam32
| tc-pam16 )
Possible values:
- auto : auto-tcPam selection
- tc-pam32 : tcPam32 selection
- tc-pam16 : tcPam16 selection
Parameter type: <Shdsl::SpanEFMHandshakeSelection>
Format:
( auto
| ieee
| itu
| not-applicable )
Possible values:
- auto : auto select ieee/itu according to cpe
- ieee : ieee 2base-tl
- itu : itu-t g.991.2 ptm 64/65otc
- not-applicable : not-applicable for atm/ima mode
Parameter type: <Shdsl::SpanBondingRateControlMode>
Format:
( span-level
| link-level )
Possible values:
- span-level : bonding rate control mode is span level

optional parameter with default


value: 5696
the maximum requested data rate

[no] margin-down-worst

[no] margin-down-curr

[no] margin-up-worst

[no] margin-up-curr

[no] probe

[no] tc-pam-sele

[no] efm-hs-sele

[no] bonding-rate-mode

884

Released

optional parameter with default


value: -11
target relative margin in dwnstrm
for worst case noise
optional parameter with default
value: 5
relative margin in dwnstrm for
current noise condition
optional parameter with default
value: -11
target relative margin in upstrm
for worst case noise
optional parameter with default
value: 5
relative margin in upstrm for
current noise conditions
optional parameter with default
value: "enable"
the number enable/disable line
probe

optional parameter with default


value: "auto"
the
TC-PAM
modulation
selection for the span

optional parameter with default


value: "not-applicable"
the handshake mode selection for
the span

optional parameter with default


value: "span-level"
the bonding rate control mode on
the span

3HH-04416-EBAA-TCZZA

01

36 SHDSL Configuration Commands

Parameter
[no] min-rate-link1

[no] max-rate-link1

[no] min-rate-link2

[no] max-rate-link2

[no] min-rate-link3

[no] max-rate-link3

[no] min-rate-link4

[no] max-rate-link4

[no] tc-pam-link1

[no] tc-pam-link2

[no] tc-pam-link3

3HH-04416-EBAA-TCZZA 01

Type
- link-level : bonding rate control mode is span level
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::BitRate>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::SpanTCPAMSelection>
Format:
( auto
| tc-pam32
| tc-pam16 )
Possible values:
- auto : auto-tcPam selection
- tc-pam32 : tcPam32 selection
- tc-pam16 : tcPam16 selection
Parameter type: <Shdsl::SpanTCPAMSelection>
Format:
( auto
| tc-pam32
| tc-pam16 )
Possible values:
- auto : auto-tcPam selection
- tc-pam32 : tcPam32 selection
- tc-pam16 : tcPam16 selection
Parameter type: <Shdsl::SpanTCPAMSelection>
Format:
( auto
| tc-pam32
| tc-pam16 )
Possible values:

Description
optional parameter with default
value: 192
the minimum requested data rate
of link 1
optional parameter with default
value: 5696
the maximum requested data rate
of link 1
optional parameter with default
value: 192
the minimum requested data rate
of link 2
optional parameter with default
value: 5696
the maximum requested data rate
of link 2
optional parameter with default
value: 192
the minimum requested data rate
of link 3
optional parameter with default
value: 5696
the maximum requested data rate
of link 3
optional parameter with default
value: 192
the minimum requested data rate
of link 4
optional parameter with default
value: 5696
the maximum requested data rate
of link 4
optional parameter with default
value: "auto"
the
TC-PAM
modulation
selection for the link 1

optional parameter with default


value: "auto"
the
TC-PAM
modulation
selection for the link 2

optional parameter with default


value: "auto"
the
TC-PAM
modulation
selection for the link 3

Released

885

36 SHDSL Configuration Commands

Parameter

Type

[no] tc-pam-link4

[no] ctc

886

Description

- auto : auto-tcPam selection


- tc-pam32 : tcPam32 selection
- tc-pam16 : tcPam16 selection
Parameter type: <Shdsl::SpanTCPAMSelection>
Format:
( auto
| tc-pam32
| tc-pam16 )
Possible values:
- auto : auto-tcPam selection
- tc-pam32 : tcPam32 selection
- tc-pam16 : tcPam16 selection
Parameter type: <Shdsl::SpanCTCEnable>
Format:
( disable
| enable )
Possible values:
- disable : disable the cross-talk cancellation
- enable : enable the cross-talk cancellation

Released

optional parameter with default


value: "auto"
the
TC-PAM
modulation
selection for the link 4

optional parameter with default


value: "disable"
enable the cross-talk cancellation
for the span

3HH-04416-EBAA-TCZZA

01

36 SHDSL Configuration Commands

36.3 SHDSL Unit Configuration Command


Command Description
This command allows the operator to manage the SHDSL unit profile in one SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure shdsl unit (if-index) unit-id <Shdsl::UnitId> [ no loop-attenuation | loop-attenuation
<Shdsl::UnitLoopAttenThreshold> ] [ no snr-margin | snr-margin <Shdsl::UnitSnrMarginThreshold> ] [ no
loopback-timeout | loopback-timeout <Shdsl::UnitLoopbackTimeout> ]

Command Parameters
Table 36.3-1 "SHDSL Unit Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1

unit-id

3HH-04416-EBAA-TCZZA 01

Description

Released

887

36 SHDSL Configuration Commands

Resource Identifier

Type

Description

- sru-2 : the SHDSL unit is SRU-2


- sru-3 : the SHDSL unit is SRU-3
- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8

Table 36.3-2 "SHDSL Unit Configuration Command" Command Parameters


Parameter

Type

Description

[no] loop-attenuation

Parameter type: <Shdsl::UnitLoopAttenThreshold>


Format:
- a loop attenuation threshold value for an SHDSL unit
- unit: db
- range: [0...127]
Parameter type: <Shdsl::UnitSnrMarginThreshold>
Format:
- an SNR margin threshold value for an SHDSL unit
- unit: db
- range: [0...15]
Parameter type: <Shdsl::UnitLoopbackTimeout>
Format:
- a loopback timeout duration value for an SHDSL unit
- unit: min
- range: [0...4095]

optional parameter with default


value: 0
the loop attenuation threshold
value

[no] snr-margin

[no] loopback-timeout

888

Released

optional parameter with default


value: 0
the snr margin threshold value
optional parameter with default
value: 0
the loopback timeout value

3HH-04416-EBAA-TCZZA

01

36 SHDSL Configuration Commands

36.4 SHDSL Segment Configuration Command


Command Description
This command allows the operator to manage the SHDSL segment points on either sides of an SHDSL unit.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure shdsl segment (if-index) unit-id <Shdsl::UnitId> side <Shdsl::SegmentSide> [ no loopback | loopback
<Shdsl::SegmentTermLoopbackConf> ] [ no pbo-mode | pbo-mode <Shdsl::SegmentTermPowerBackoff> ]

Command Parameters
Table 36.4-1 "SHDSL Segment Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2

unit-id

3HH-04416-EBAA-TCZZA 01

Description

Released

889

36 SHDSL Configuration Commands

Resource Identifier

Type

side

- sru-3 : the SHDSL unit is SRU-3


- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side

Description

the particular side of an SHDSL


unit in an SHDSL segment

Table 36.4-2 "SHDSL Segment Configuration Command" Command Parameters


Parameter

Type

Description

[no] loopback

Parameter type: <Shdsl::SegmentTermLoopbackConf>


Format:
( none
| normal )
Possible values:
- none : no loopback
- normal : normal loopback
Parameter type: <Shdsl::SegmentTermPowerBackoff>
Format:
( default
| selected
| disabled )
Possible values:
- default : the default mode
- selected : the selected mode
- disabled : disable PBO

optional parameter with default


value: "none"
the loopback mode for the
associated side

[no] pbo-mode

890

Released

optional parameter with default


value: "default"
the power backoff mode for the
associated side

3HH-04416-EBAA-TCZZA

01

37- IMA Configuration Commands

37.1 IMA Configuration Command Tree


37.2 IMA Group Configuration Commands
37.3 IMA Link Configuration Commands

3HH-04416-EBAA-TCZZA 01

37-892
37-893
37-895

Released

891

37 IMA Configuration Commands

37.1 IMA Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "IMA Configuration Commands".

Command Tree
----configure
----ima
----group
- (if-index)
- [no] activate
- [no] admin-up
- [no] min-tx-links
- [no] min-rx-links
- near-end-ima-id
----[no] link
- (link-if-index)
- grp-index

892

Released

3HH-04416-EBAA-TCZZA

01

37 IMA Configuration Commands

37.2 IMA Group Configuration Commands


Command Description
This command allows the operator to manage the IMA group profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure ima group (if-index) [ [ no ] activate ] [ [ no ] admin-up ] [ no min-tx-links | min-tx-links
<Ima::GroupMinNumTxLinks> ] [ no min-rx-links | min-rx-links <Ima::GroupMinNumRxLinks> ] [
near-end-ima-id <Ima::GroupTxImaId> ]

Command Parameters
Table 37.2-1 "IMA Group Configuration Commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 37.2-2 "IMA Group Configuration Commands" Command Parameters


Parameter

Type

Description

[no] activate
[no] admin-up

Parameter type: boolean


Parameter type: boolean

[no] min-tx-links

Parameter type: <Ima::GroupMinNumTxLinks>


Format:
- a mininum number of transmit links required to be active
- range: [1...8]
Parameter type: <Ima::GroupMinNumRxLinks>
Format:
- a mininum number of receive links required to be active
- range: [1...32]
Parameter type: <Ima::GroupTxImaId>
Format:

optional parameter
optional parameter
admin status is up
optional parameter with default
value: 1
the mininum number of transmit
links
optional parameter with default
value: 1
the mininum number of receive
links
optional parameter
the imd id used by the near-end

[no] min-rx-links

near-end-ima-id

3HH-04416-EBAA-TCZZA 01

Released

893

37 IMA Configuration Commands

Parameter

894

Released

Type

Description

- an imd id used by the near-end ima function


- range: [0...255]

ima function

3HH-04416-EBAA-TCZZA

01

37 IMA Configuration Commands

37.3 IMA Link Configuration Commands


Command Description
This command allows the operator to manage the IMA link profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure ima ( no link (link-if-index) ) | ( link (link-if-index) grp-index <Itf::ImaLine> )

Command Parameters
Table 37.3-1 "IMA Link Configuration Commands" Resource Parameters
Resource Identifier

Type

(link-if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 37.3-2 "IMA Link Configuration Commands" Command Parameters


Parameter

Type

grp-index

Parameter type: <Itf::ImaLine>


mandatory parameter
Format:
logical interface number assigned
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / to this IMA grp Link
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

3HH-04416-EBAA-TCZZA 01

Description

Released

895

38- L2CP Configuration Commands

38.1 L2CP Configuration Command Tree


38.2 L2CP Configuration Command
38.3 L2CP Session Configuration Command
38.4 L2CP User Port Partition Configuration Command

896

Released

38-897
38-898
38-899
38-902

3HH-04416-EBAA-TCZZA

01

38 L2CP Configuration Commands

38.1 L2CP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "L2CP Configuration Commands".

Command Tree
----configure
----l2cp
- [no] partition-type
----[no] session
- (index)
- bras-ip-address
- [no] gsmp-version
- [no] gsmp-sub-version
- [no] encap-type
- [no] topo-discovery
- [no] layer2-oam
- [no] alive-timer
- [no] port-reprt-shaper
- [no] aggr-reprt-shaper
- [no] tcp-retry-time
- [no] gsmp-retry-time
- [no] dslam-name
- [no] partition-id
- [no] window-size
- [no] tcp-port
- [no] vrf-id
- [no] sig-partition-id
----[no] user-port
- (user-port)
- partition-id

3HH-04416-EBAA-TCZZA 01

Released

897

38 L2CP Configuration Commands

38.2 L2CP Configuration Command


Command Description
This command allows the operator to configure the L2CP parameters.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure l2cp [ no partition-type | partition-type <L2cp::PartitionType> ]

Command Parameters
Table 38.2-2 "L2CP Configuration Command" Command Parameters
Parameter

Type

Description

[no] partition-type

Parameter type: <L2cp::PartitionType>


Format:
( no-partition
| fixed-assigned )
Possible values:
- no-partition : no partitioning is supported
- fixed-assigned : partitioning is supported

optional parameter with default


value: "no-partition"
partition type

898

Released

3HH-04416-EBAA-TCZZA

01

38 L2CP Configuration Commands

38.3 L2CP Session Configuration Command


Command Description
This command allows the operator to configure the L2CP session parameters for a given session id.
In current version, ISAM supports L2CP only on top of TCP/IP; as result of this command, ISAM shall start a TCP
connection to a BRAS identified by a configured IP address. Then depending on the setting of the GSMP Retry
Timer, the ISAM shall start the GSMP Adjacency Protocol to setup a L2CP session with that BRAS.
This means:
if TCP Retry Timer is zero, ISAM shall not start the TCP connection. If TCP Retry Timer is not zero, ISAM
shall start the setup of a TCP connection to a BRAS whose IP address must be configured too. In no way the
ISAM accepts that a (unknown) BRAS tries to start a TCP connection
if GSMP Retry Timer is zero, ISAM shall not start the GSMP Adjacency Protocol but instead be prepared to
handle GSMP Adjacency Protocol messages from that BRAS. If GSMP Retry Timer is not zero, ISAM shall start
the GSMP Adjacency Protocol in addition to being prepared to handle GSMP Adjacency Protocol messages
from that BRAS

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure l2cp ( no session (index) ) | ( session (index) bras-ip-address <L2cp::InetAddress> [ no gsmp-version |
gsmp-version <L2cp::Version> ] [ no gsmp-sub-version | gsmp-sub-version <L2cp::SubVersion> ] [ no encap-type
| encap-type <L2cp::EncapType> ] [ no topo-discovery | topo-discovery <L2cp::AccessTopologyDiscovery> ] [ no
layer2-oam | layer2-oam <L2cp::Layer2OAM> ] [ no alive-timer | alive-timer <L2cp::AliveTimer> ] [ no
port-reprt-shaper | port-reprt-shaper <L2cp::ReportShaper> ] [ no aggr-reprt-shaper | aggr-reprt-shaper
<L2cp::AggrReportShaper> ] [ no tcp-retry-time | tcp-retry-time <L2cp::TcpRetryTimer> ] [ no gsmp-retry-time |
gsmp-retry-time <L2cp::GsmpRetryTimer> ] [ no dslam-name | dslam-name <L2cp::DslamName> ] [ no
partition-id | partition-id <L2cp::PartitionId2> ] [ no window-size | window-size <L2cp::WindowSize> ] [ no
tcp-port | tcp-port <L2cp::InetPortNumber> ] [ no vrf-id | vrf-id <L2cp::VrfIndex> ] [ [ no ] sig-partition-id ] )

Command Parameters
Table 38.3-1 "L2CP Session Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- identity of the l2cp session
- range: [1...255]

index to the l2cp session table

Table 38.3-2 "L2CP Session Configuration Command" Command Parameters


Parameter

Type

Description

bras-ip-address

Parameter type: <L2cp::InetAddress>

mandatory parameter

3HH-04416-EBAA-TCZZA 01

Released

899

38 L2CP Configuration Commands

Parameter

Type

Description

Format:
- IPv4-address

The parameter is not visible


during modification.
IPv4 address used for the L2cp
session peer
optional parameter with default
value: 3
The parameter is not visible
during modification.
version of gsmp protocol
optional parameter with default
value: 1
The parameter is not visible
during modification.
sub version of gsmp protocol
optional parameter with default
value: "tcp"
The parameter is not visible
during modification.
encapsulation type
optional parameter with default
value: "enabled"
The parameter is not visible
during modification.
topology discovery capability

[no] gsmp-version

Parameter type: <L2cp::Version>


Format:
- version of the GSMP protocol
- range: [3]

[no] gsmp-sub-version

Parameter type: <L2cp::SubVersion>


Format:
- sub version of the GSMP protocol
- range: [1]

[no] encap-type

Parameter type: <L2cp::EncapType>


Format:
tcp
Possible values:
- tcp : tcp encapsulation type
Parameter type: <L2cp::AccessTopologyDiscovery>
Format:
( disabled
| enabled )
Possible values:
- disabled : no topology discovery
- enabled : topology discovery
Parameter type: <L2cp::Layer2OAM>
optional parameter with default
Format:
value: "enabled"
( disabled
The parameter is not visible
| enabled )
during modification.
Possible values:
layer2 OAM is supported
- disabled : no layer2 oam
- enabled : layer2 oam
Parameter type: <L2cp::AliveTimer>
optional parameter with default
Format:
value: 250
- adjacency protocol watchdog alive time
adjacency protocol watchdog
- unit: 100 msec
alive time.
- range: [1...255]
Parameter type: <L2cp::ReportShaper>
optional parameter with default
Format:
value: 10
- time between two EventReport msgs related to same port, The parameter is not visible
should be >= aggr-reprt-shaper
during modification.
- unit: 100 msec
time between 2 EventReport
- range: [1...255]
msgs on the same port, should be
>= aggr-reprt-shaper
Parameter type: <L2cp::AggrReportShaper>
optional parameter with default
Format:
value: 10
- time between two EventReport msgs related to any port
The parameter is not visible
- unit: 10 msec
during modification.
- range: [1...2550]
time between 2 EventReport
msgs on any port
Parameter type: <L2cp::TcpRetryTimer>
optional parameter with default
Format:
value: 10
- time between 2 TCP connection setup attempts.
time between 2 TCP connection
- unit: 100 msec
setup attempts
- range: [0...255]
Parameter type: <L2cp::GsmpRetryTimer>
optional parameter with default

[no] topo-discovery

[no] layer2-oam

[no] alive-timer

[no] port-reprt-shaper

[no] aggr-reprt-shaper

[no] tcp-retry-time

[no] gsmp-retry-time

900

Released

3HH-04416-EBAA-TCZZA

01

38 L2CP Configuration Commands

Parameter

[no] dslam-name

[no] partition-id

[no] window-size

[no] tcp-port

[no] vrf-id

[no] sig-partition-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
- time between 2 GSMP/L2CP connection setup attempts.
- unit: 100 msec
- range: [0...255]
Parameter type: <L2cp::DslamName>
Format:
- a mac-address (example : 01:02:03:04:05:06)
- length: 6

value: 10
time between 2 GSMP/L2CP
connection setup attempts

optional parameter with default


value: "00 : 00 : 00 : 00 : 00 :
00"
The parameter is not visible
during modification.
l2cp name of the DSLAM
Parameter type: <L2cp::PartitionId2>
optional parameter with default
Format:
value: 0
- partition id
The parameter is not visible
- range: [0...127]
during modification.
identity for this session's specific
DSLAM partition
Parameter type: <L2cp::WindowSize>
optional parameter with default
Format:
value: 10
- max no.of unacknow req msgs to be transmtted in a The parameter is not visible
window
during modification.
- range: [10]
max no.of unacknow req msgs to
be transmtted in a window
Parameter type: <L2cp::InetPortNumber>
optional parameter with default
Format:
value: 6068
- tcp port number
The parameter is not visible
- range: [0...65535]
during modification.
tcp port number of the session
established to the peer.
Parameter type: <L2cp::VrfIndex>
optional parameter with default
Format:
value: 0
- the VRF ID which uniquely identify a VRF
The parameter is not visible
- range: [0]
during modification.
vrf to be used to obtain
connectivity to the peer.
Parameter type: boolean
optional parameter
The parameter is not visible
during modification.
indicates if partition ID is
signalled

Released

901

38 L2CP Configuration Commands

38.4 L2CP User Port Partition Configuration


Command
Command Description
This command allows the operator to configure the partition id for the given user-port.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure l2cp ( no user-port (user-port) partition-id <L2cp::PartitionId> ) | ( user-port (user-port) partition-id
<L2cp::PartitionId> )

Command Parameters
Table 38.4-1 "L2CP User Port Partition Configuration Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <L2cp::PartitionId>
partition id
Format:
- partition id
- range: [1...127]

partition-id

902

Released

Description

3HH-04416-EBAA-TCZZA

01

39- Voice Configuration Commands

39.1 Voice Configuration Command Tree


39.2 Voice Sip Server Configuration Commands
39.3 Voice Sip LineId Syntax Profile Configuration
Commands
39.4 Voice Sip User Agent Configuration Commands
39.5 Sip Voice Service Provider Configuration Commands
39.6 Voice Sip User Agent Access Point Configuration
Command
39.7 Voice Sip Dial Plan Configuration Commands
39.8 Voice Sip Dial Plan Digitmap Configuration
Commands
39.9 Voice Sip Termination Configuration Commands
39.10 Voice Sip Termination TCA Threshold Configuration
Command
39.11 Sip Voice Register Configuration Commands
39.12 Voice Sip Transport Configuration Commands
39.13 Voice Sip Redundancy Table Configuration
Commands
39.14 Voice Sip System Session Timer Configuration
Commands
39.15 Voice Sip DNS Server Configuration Commands
39.16 Voice Sip DHCP Authentication Params
Configuration Commands
39.17 Voice Sip Restoration Failover/Failback Type/Mode
Configuration Commands
39.18 Voice Statistics Configure Command
39.19 Voice Cluster Configuration Commands
39.20 Voice Megaco IP Configuration Commands
39.21 Voice Megaco Equipment Configuration Commands
39.22 Voice Megaco Equipment Board Configuration
Commands
39.23 Voice Megaco Equipment Termination Configuration
Commands
39.24 Voice Megaco Termination Configuration
Commands
39.25 Voice Megaco Media Gateway Configuration
Commands
39.26 Voice Megaco Signal Gateway Configuration
Commands

3HH-04416-EBAA-TCZZA 01

39-904
39-910
39-913
39-915
39-918
39-924
39-926
39-928
39-929
39-934
39-936
39-938
39-940
39-944
39-946
39-948
39-950
39-951
39-952
39-953
39-955
39-957
39-959
39-963
39-965
39-976

Released

903

39 Voice Configuration Commands

39.1 Voice Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Voice Configuration Commands".

Command Tree
----configure
----voice
----sip
----[no] server
- (name)
- [no] admin-status
- address
- [no] port
- [no] server-role
- [no] priority
- [no] weight
- [no] site
- [no] transproto
- [no] dnsname-type
- admin-domain-name
----lineid-syn-prof
- (name)
- [no] syntax-pattern
- [no] pots-syntax
----[no] user-agent
- (name)
- [no] ip-addr-policy
- [no] ip-config-mode
- [no] signal-gateway-ip
- signal-vlan-id
- [no] signal-dscp
- [no] signal-pbits
- [no] signal-link-mtu
- [no] rtp-gateway-ip
- rtp-vlan-id
- [no] rtp-dscp
- [no] rtp-pbits
- [no] rtp-link-mtu
- [no] dhcp-optreq-list
- [no] admin-status
----vsp
- (name)
- [no] domain-name
- [no] admin-status
- [no] tinfo
- [no] ta4
- [no] ttir1
- [no] t-acm-delta
- [no] access-held-time
- [no] awaiting-time

904

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

- [no] digit-send-mode
- [no] overlap-484-act
- [no] dmpm-intdgt-expid
- [no] dial-start-timer
- [no] dial-long-timer
- [no] dial-short-timer
- [no] uri-type
- [no] rfc2833-pl-type
- [no] rfc2833-process
- [no] min-data-jitter
- [no] init-data-jitter
- [no] max-data-jitter
- [no] release-mode
- [no] dyn-pt-nego-type
- [no] vbd-g711a-pl-type
- [no] vbd-g711u-pl-type
- [no] vbd-mode
- [no] warmline-dl-timer
- [no] timer-b
- [no] timer-f
- [no] timer-t1
- [no] timer-t2
- [no] reg-sub
- [no] sub-period
- [no] sub-head-start
- [no] t38-same-udp
- [no] dhcp-option82
----user-agent-ap
- (ua-name)
- slot-id
- signal-ip
- rtp-ip
- [no] dhcp-fqdn
- [no] dhcp-customer-id
- [no] admin-status
----[no] dialplan
- (name)
- [no] pre-activated
- [no] static-prefix
- [no] static-suffix
- [no] digitmap-mode
----[no] digitmap
- (name)
- type
- rule
- [no] access-type
----[no] termination
- (if-index)
- [no] directory-number
- [no] user-name
- [no] display-name
- [no] uri
- [no] direct-uri
- [no] line-feed
- [no] md5-realm
- [no] md5-password
- [no] admin-status
- [no] clip-mode
- [no] anti-tapping

3HH-04416-EBAA-TCZZA 01

Released

905

39 Voice Configuration Commands

- [no] impedance
- [no] rx-gain
- [no] tx-gain
- [no] warmline-service
- [no] linesig-remanswer
- [no] line-id
- [no] force-hold
- [no] callwait-service
- [no] callhold-service
- [no] callconf-service
- [no] calltras-service
- [no] testaccessstate
- [no] busyoverwrite
- [no] accessontimeout
----tca
- [no] enable
- [no] high-jbfl
- [no] low-jbfl
----register
- (provider-name)
- [no] register-uri
- [no] register-intv
- [no] reg-retry-intv
- [no] reg-prev-ava-intv
- [no] reg-head-start
- [no] reg-start-min
----[no] transport
- (trans-protocol)
- provider-name
- [no] admin-status
- [no] port-rcv
- [no] tcp-idle-time
- [no] max-out-udp-size
----redundancy
- (admin-domain-name)
- [no] support-redun
- [no] dns-purge-timer
- [no] dns-ini-retr-int
- [no] dns-max-retr-nbr
- [no] fg-monitor-method
- [no] fg-monitor-int
- [no] bg-monitor-method
- [no] bg-monitor-int
- [no] stable-obs-period
- [no] fo-hystersis
- [no] del-upd-threshold
- [no] auto-server-fo
- [no] auto-server-fb
- [no] auto-sos-fo
- [no] auto-sos-fb
- [no] rtry-after-thrsh
- [no] options-max-fwd
- [no] dns-redun-mode
----system
----session-timer
X [no] enable
- [no] status
- [no] min-se-time

906

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

- [no] se-time
- [no] admin-status
----[no] dnsserver
- (name)
- [no] admin-status
- address
- [no] priority
- [no] site
- admin-domain-name
- [no] port
----[no] dhcp-authent-para
- (ua-name)
- secret-id
- [no] key
- [no] action-type
----redundancy-cmd
- (domain-name)
- [no] start-time
- [no] end-time
- fail-x-type
----statistics
----stats-config
- [no] per-line
- [no] per-board
- [no] per-system
- [no] per-call
- [no] out-any-rsp
- [no] out-180-rsp
- [no] out-200-rsp
- [no] in-any-rsp
- [no] in-180-rsp
----cluster
- (cluster-id)
----ip
- ivps-ip
- netmask
- router-ip
- vlan-id
- [no] private-ip
- [no] private-netmask
- [no] private-vlan-id
----[no] equipment
- (equip-id)
- asam-id
- ip-address
- [no] next-hop
----[no] board
- (board-id)
- planned-type
- lanx-port
----[no] termination
- (port-id)
- [no] type
- [no] isdn-codec
- [no] switch-type
- [no] activate-type
- termination-id
- media-gateway-id
- [no] admin-status

3HH-04416-EBAA-TCZZA 01

Released

907

39 Voice Configuration Commands

- [no] line-feed
- [no] rx-gain
- [no] tx-gain
- [no] impedance
- [no] rtp-dscp
- [no] rtp-pbits
- [no] clip-mode
- [no] metering-type
- [no] directory-number
----tca
- [no] tca-enable
- [no] rtp-pktloss-thres
- [no] rtp-jitter-thres
- [no] rtp-delay-thres
----[no] media-gateway
- (media-gateway-id)
- [no] name
- ip-address
- netmask
- [no] udp-port
- [no] router-ip
- vlan-id
- [no] mgc-type
- prim-mgc-ip
- [no] mgc-id
- [no] prim-mgc-udp
- [no] sec-mgc-ip
- [no] sec-mgc-udp
- [no] tert-mgc-ip
- [no] tert-mgc-udp
- [no] quat-mgc-ip
- [no] quat-mgc-udp
- [no] esa-mgc-service
- [no] mg-mid-type
- [no] mg-domain-name
- [no] svcreason-format
- [no] mg-profile-name
- [no] admin-status
- [no] termid-type
- [no] pstn-term-format
- isdn-term-format
- isdn-suffix1
- isdn-suffix2
- [no] max-transhandling
- [no] max-network-delay
- [no] max-retrans
- [no] red-bat-delay
- [no] release-delay
- [no] release-type
- [no] wt-rls-delay
- [no] active-heartbeat
- [no] passive-heartbeat
- [no] retrans
- [no] max-waiting-delay
- [no] prov-rpl-time
- [no] signal-dscp
- [no] signal-pbits
- [no] rtp-dscp

908

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

- [no] rtp-pbits
- [no] event-req-id
- [no] stml-stdsg-evt
- [no] al-of-evt
- [no] al-on-evt
- [no] al-of-strict-evt
- [no] al-on-strict-evt
- [no] mg-overload-evt
- [no] mg-dummy-evt
- [no] rfc2833-pl-type
- [no] rfc2833-process
- [no] dial-start-timer
- [no] dial-long-timer
- [no] dial-short-timer
- [no] min-data-jitter
- [no] init-data-jitter
- [no] max-data-jitter
- [no] ephe-term-prefix
- [no] ephe-term-min
- [no] ephe-term-max
----[no] signal-gateway
- (signal-gateway-id)
- prim-asp-ip
- prim-sctp-port
- sec-asp-ip
- [no] sec-sctp-port
- tert-asp-ip
- [no] tert-sctp-port
- quat-asp-ip
- [no] quat-sctp-port
- ip-address
- sgi-user-label
- sgi-mgi
- [no] admin-status

3HH-04416-EBAA-TCZZA 01

Released

909

39 Voice Configuration Commands

39.2 Voice Sip Server Configuration Commands


Command Description
This command allows the operator to manage the Voice Sip Server profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no server (name) ) | ( server (name) [ no admin-status | admin-status
<Sip::ServerAdminStatus> ] address <Sip::ServerAddr> [ no port | port <Sip::ServerPort> ] [ no server-role |
server-role <Sip::ServerRole> ] [ no priority | priority <Sip::ServerPriority> ] [ no weight | weight
<Sip::ServerWeight> ] [ no site | site <Sip::ServerSite> ] [ no transproto | transproto <Sip::ServerTransproto> ] [ no
dnsname-type | dnsname-type <Sip::DnsDomNameType> ] admin-domain-name <Sip::AdminDomName> )

Command Parameters
Table 39.2-1 "Voice Sip Server Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies this voice server
- length: x<=32

uniquely identify of this voice


server

Table 39.2-2 "Voice Sip Server Configuration Commands" Command Parameters


Parameter

Type

Description

[no] admin-status

Parameter type: <Sip::ServerAdminStatus>


Format:
( up
| down )
Possible values:
- up : unlock the sip server
- down : lock the sip server
Parameter type: <Sip::ServerAddr>
Format:
( ipv4 : <Ip::V4Address>
| dns : <Sip::ServerAddr> )
Possible values:
- ipv4 : the address type of the server is ipv4
- dns : the address type of the server is DNS
Field type <Ip::V4Address>
- IPv4-address
Field type <Sip::ServerAddr>
- name of the SipServer that can be resolved to an IP address
via a DNS Server

optional parameter with default


value: "down"
administrative status of this sip
server

address

910

Released

mandatory parameter
The address(ipv4 or DNS or
FQDN) of this SIP server

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter
[no] port

[no] server-role

[no] priority

[no] weight

[no] site

[no] transproto

3HH-04416-EBAA-TCZZA 01

Type

Description

- length: 7<=x<=64
Parameter type: <Sip::ServerPort>
optional parameter with default
Format:
value: 5060
- the SIP server port
port of voice server
- range: [1...65534]
Parameter type: <Sip::ServerRole>
optional parameter with default
Format:
value: "proxy-server"
( proxy-server
The role of voice application
| registrar-server
server. When redundancy is
| registrar-and-proxy )
DISABLED, the operator can
Possible values:
configure 3 different server roles,
- proxy-server : proxy server
role = Proxy server, role =
- registrar-server : registrar server
Registrar server, role = Proxy
- registrar-and-proxy : served as a registrarServer and a server AND Registrar server.
proxyServer
System will behave in accordance
with configured role. When
redundancy is ENABLED, the
system always assume role =
Proxy server AND Registrar
server, irrespective of what has
been configured by the operator.
Thus the system always behaves
according to the role =
proxyAndRegistrarServer(20),
and does not look at the value
been configured by the operator
Parameter type: <Sip::ServerPriority>
optional parameter with default
Format:
value: 100
- the SIP server priority
The priority of voice application
- range: [0...65535]
server
Parameter type: <Sip::ServerWeight>
optional parameter with default
Format:
value: 100
- the SIP server weight
The weight of voice application
- range: [0...65535]
server
Parameter type: <Sip::ServerSite>
optional parameter with default
Format:
value: "primary-site"
( primary-site
The site of voice application
| geo-backup-site
server
| sos-backup-site )
Possible values:
- primary-site : the server belongs to the GEO primary site
- geo-backup-site : the server belongs to the GEO secondary
site
- sos-backup-site : the server belongs to the SOS secondary
site
Parameter type: <Sip::ServerTransproto>
optional parameter with default
Format:
value: "udp"
( udp
The transport protocol of voice
| tcp
application server
| both )
Possible values:
- udp : the transport protocol used in connecting to the server
is UDP
- tcp : the transport protocol used in connecting to the server
is TCP
- both : the transport protocol used in connecting to the
server is TCP and UDP

Released

911

39 Voice Configuration Commands

Parameter

Type

Description

[no] dnsname-type

Parameter type: <Sip::DnsDomNameType>


Format:
( none
| dn
| fqdn )
Possible values:
- none : If sipServerAddrType is provisioned with value
ipv4, this object should set to none
- dn : If sipServerAddrType is provisioned with value dns, it
means the sipserver address is provisoned with DNS.
- fqdn : If sipServerAddrType is provisioned with value dns,
it means the sipserver address is provisoned with FQDN.
Parameter type: <Sip::AdminDomName>
Format:
- uniquely name of this element
- length: x<=32

optional parameter with default


value: "none"
The clarification of whether a
Domain Name (dn) or Fully
qualified Domain Name (fqdn)
was provisioned for the object
sipServerAddr.

admin-domain-name

912

Released

mandatory parameter
The administrative domain name
of the (farm of) SIP First hop(s).
The administrative domain might
be the VoIP Access Seeker
Network or the Connectivity
Serving Network.

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.3 Voice Sip LineId Syntax Profile Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip LineId Syntax profile. This command can help operator
to get different types of sip termination contact-user-info: physicallineid or terminationuriordn. If the syntax is
'physicalLineId', then the system will construct a value according the syntax as specified in the next parameters
(depending of the type of line being pots or isdn). In case the value is 'terminationuriordn', then the value will be
taken from the corresponding parameter of the SipTermination object (chapter 38.9): the uri will be taken firstly if
it is valid, otherwise the dn can be taken. The keywords apply to the profile syntax include: "Access_Node_ID",
"Rack", "Frame", "Slot", "ShSlt", "Port","ShPrt", "Channel". The sip termination contact-user-info can be learned
using the show command: show voice sip termination.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip lineid-syn-prof (name) [ no syntax-pattern | syntax-pattern <SIP::LineIdSyntaxPattern> ] [ no
pots-syntax | pots-syntax <SIP::PotsSyntax> ]

Command Parameters
Table 39.3-1 "Voice Sip LineId Syntax Profile Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the lineid syntax profile name, can only be profile1
- length: x<=32

uniquely identify of this lineid


syntax profile, can only be
profile1

Table 39.3-2 "Voice Sip LineId Syntax Profile Configuration Commands" Command Parameters
Parameter

Type

Description

[no] syntax-pattern

Parameter type: <SIP::LineIdSyntaxPattern>


Format:
( rpregisterdialog
| rpregister
| physicallineid
| terminationuriordn )
Possible values:
- rpregisterdialog : random per register and dialog
- rpregister : random per register
- physicallineid : physical line id
- terminationuriordn : termination uri
Parameter type: <SIP::PotsSyntax>

optional parameter with default


value: "terminationuriordn"
pattern of the sip LineID Syntax

[no] pots-syntax

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

913

39 Voice Configuration Commands

Parameter

914

Released

Type

Description

Format:
- syntax of the POTS SIP LineID
- length: x<=128

value:
"al/Channel/Port/Slot/Frame/Rack/Acce
syntax of the Pots sip LineID

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.4 Voice Sip User Agent Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip user agent profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no user-agent (name) ) | ( user-agent (name) [ no ip-addr-policy | ip-addr-policy
<Sip::IpAddrPolicy> ] [ no ip-config-mode | ip-config-mode <Sip::IpConfigMode> ] [ no signal-gateway-ip |
signal-gateway-ip <Sip::UserAgentIpAddr> ] signal-vlan-id <Sip::UserAgentVlanId> [ no signal-dscp | signal-dscp
<Sip::UserAgentSignalDscp> ] [ no signal-pbits | signal-pbits <Sip::UserAgentSignalPbits> ] [ no signal-link-mtu |
signal-link-mtu <Sip::UserAgentLinkMTU> ] [ no rtp-gateway-ip | rtp-gateway-ip <Sip::UserAgentIpAddr> ] [
rtp-vlan-id <Sip::UserAgentVlanId> ] [ no rtp-dscp | rtp-dscp <Sip::UserAgentRtpDscp> ] [ no rtp-pbits | rtp-pbits
<Sip::UserAgentRtpPbits> ] [ no rtp-link-mtu | rtp-link-mtu <Sip::UserAgentLinkMTU> ] [ no dhcp-optreq-list |
dhcp-optreq-list
<Sip::UserAgentDHCPOptionReqList>
]
[
no
admin-status
|
admin-status
<Sip::UserAgentAdminStatus> ] )

Command Parameters
Table 39.4-1 "Voice Sip User Agent Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies the User Agent
- length: 1<=x<=32

uniquely identify of this user


agent

Table 39.4-2 "Voice Sip User Agent Configuration Commands" Command Parameters
Parameter

Type

Description

[no] ip-addr-policy

Parameter type: <Sip::IpAddrPolicy>


Format:
( distributed
| centralized )
Possible values:
- distributed : the ip address policy of the user agent
operation is to use an IP address per Voice LT, not
applicable for NGVR
- centralized : the ip address policy of the user agent
operation is to use a single IP address for the ISAM Voice
and NGVR
Parameter type: <Sip::IpConfigMode>

optional parameter with default


value: "distributed"
The ip address policy of the sip
user agent

[no] ip-config-mode

3HH-04416-EBAA-TCZZA 01

optional parameter with default

Released

915

39 Voice Configuration Commands

Parameter

[no] signal-gateway-ip

signal-vlan-id

Description

Format:
( dhcp
| manual )
Possible values:
- dhcp : the ip config mode of the user agent operation is to
obtain an IP address via dhcp
- manual : the status of the user agent operation is to get an
IP address via manual configuration
Parameter type: <Sip::UserAgentIpAddr>
Format:
- IPv4-address

value: "dhcp"
The ip config mode of the sip
user agent, conditionally be used
when
ip-address-policy
is
distributed

Parameter type: <Sip::UserAgentVlanId>


Format:
- vlan id
- range: [1...4092]
Parameter type: <Sip::UserAgentSignalDscp>
Format:
- dscp mark for rtp or rtcp packets
- range: [0...63]
Parameter type: <Sip::UserAgentSignalPbits>
Format:
- the dot-1p bit value
- range: [0...7]
Parameter type: <Sip::UserAgentLinkMTU>
Format:
- linkMTU value of signal-vlan
- range: [576...1500]
Parameter type: <Sip::UserAgentIpAddr>
Format:
- IPv4-address

[no] signal-dscp

[no] signal-pbits

[no] signal-link-mtu

[no] rtp-gateway-ip

rtp-vlan-id

[no] rtp-dscp

[no] rtp-pbits

[no] rtp-link-mtu

[no] dhcp-optreq-list

916

Type

Released

optional parameter with default


value: "0.0.0.0"
IP address of the signal gateway,
must be set when manual mode
and
ip-address-policy
is
distributed, otherwise it is
optional
mandatory parameter
vlan id for signaling packet
optional parameter with default
value: 46
dscp mark for sip signalling
packets
optional parameter with default
value: 6
802.1p bits for sip signalling
packets.
optional parameter with default
value: 1500
linkmtu for signaling vlan

Parameter type: <Sip::UserAgentVlanId>


Format:
- vlan id
- range: [1...4092]
Parameter type: <Sip::UserAgentRtpDscp>
Format:
- dscp mark for rtp or rtcp packets
- range: [0...63]
Parameter type: <Sip::UserAgentRtpPbits>
Format:
- the dot-1p bit value
- range: [0...7]
Parameter type: <Sip::UserAgentLinkMTU>
Format:
- linkMTU value of signal-vlan
- range: [576...1500]
Parameter type: <Sip::UserAgentDHCPOptionReqList>
Format:
- this attribute is defined for future usage

optional parameter with default


value: "0.0.0.0"
IP address of the associated voice
default gateway, must be set
when
manual
mode
and
ip-address-policy is distributed,
otherwise it is optional
optional parameter
vlan id for rtp traffic
optional parameter with default
value: 46
dscp mark for rtp or rtcp packets
optional parameter with default
value: 6
802.1p bits rtp or rtcp packets
optional parameter with default
value: 1500
linkmtu for voice vlan, only be
used when rtp-vlan != signal-vlan
optional parameter with default
value: "1,3,6,120"
this attribute is defined for future

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter
[no] admin-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- length: x<=63
Parameter type: <Sip::UserAgentAdminStatus>
Format:
( up
| down )
Possible values:
- up : unlock the sip user agent
- down : lock the sip user agent

usage
optional parameter with default
value: "down"
administrative status of this sip
user agent

Released

917

39 Voice Configuration Commands

39.5 Sip Voice Service Provider Configuration


Commands
Command Description
This command allows the operator to configure the Voice Service Provider.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip vsp (name) [ no domain-name | domain-name <Sip::VspDomainName> ] [ no admin-status |
admin-status <Sip::VspAdminStatus> ] [ no tinfo | tinfo <Sip::VspTinfo> ] [ no ta4 | ta4 <Sip::VspTa4> ] [ no ttir1
| ttir1 <Sip::VspTtir1> ] [ no t-acm-delta | t-acm-delta <Sip::VspTAcmDelta> ] [ no access-held-time |
access-held-time <Sip::VSPAccessHeldTimer> ] [ no awaiting-time | awaiting-time <Sip::VSPAwaitingTimer> ] [
no digit-send-mode | digit-send-mode <Sip::VSPDigitSendingMode> ] [ no overlap-484-act | overlap-484-act
<Sip::VSPOverlap484Action> ] [ no dmpm-intdgt-expid | dmpm-intdgt-expid <Sip::VSPDMPMIntDgtExpid> ] [
no dial-start-timer | dial-start-timer <Sip::VSPDialStartTimer> ] [ no dial-long-timer | dial-long-timer
<Sip::VSPDialLongTimer> ] [ no dial-short-timer | dial-short-timer <Sip::VSPDialShortTimer> ] [ no uri-type |
uri-type <Sip::VSPURIType> ] [ no rfc2833-pl-type | rfc2833-pl-type <Sip::VSPRfc2833PayloadType> ] [ no
rfc2833-process | rfc2833-process <Sip::VSPRfc2833Process> ] [ no min-data-jitter | min-data-jitter
<Sip::VSPDataJitter> ] [ no init-data-jitter | init-data-jitter <Sip::VSPDataJitter> ] [ no max-data-jitter |
max-data-jitter <Sip::VSPDataJitter> ] [ no release-mode | release-mode <Sip::VSPReleaseMode> ] [ no
dyn-pt-nego-type | dyn-pt-nego-type <Sip::VSPDynamicPTNegoType> ] [ no vbd-g711a-pl-type |
vbd-g711a-pl-type <Sip::VSPVbdG711APayloadType> ] [ no vbd-g711u-pl-type | vbd-g711u-pl-type
<Sip::VSPVbdG711UPayloadType> ] [ no vbd-mode | vbd-mode <Sip::VSPVbdMode> ] [ no warmline-dl-timer |
warmline-dl-timer <Sip::VSPWarmlineDelayTimer> ] [ no timer-b | timer-b <Sip::CommonCfgTimerB> ] [ no
timer-f | timer-f <Sip::CommonCfgTimerF> ] [ no timer-t1 | timer-t1 <Sip::CommonCfgTimerT1> ] [ no timer-t2 |
timer-t2 <Sip::CommonCfgTimerT2> ] [ no reg-sub | reg-sub <Sip::VSPRegSubscribe> ] [ no sub-period |
sub-period <Sip::VSPSubscribePeriod> ] [ no sub-head-start | sub-head-start <Sip::VSPSubscribeHeadStart> ] [ no
t38-same-udp | t38-same-udp <Sip::VSPT38withSameUDP> ] [ no dhcp-option82 | dhcp-option82
<Sip::DHCPOption82> ]

Command Parameters
Table 39.5-1 "Sip Voice Service Provider Configuration Commands" Resource Parameters
Resource Identifier

Type

(name)

Format:
uniquely identify of this sip voice
- uniquely identify of this SIP voice service provider, can service provider, can only be
only be vsp1
vsp1

Description

Table 39.5-2 "Sip Voice Service Provider Configuration Commands" Command Parameters

918

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

[no] domain-name

Parameter type: <Sip::VspDomainName>


Format:
- domain name of the SIP VSP
- length: x<=64
Parameter type: <Sip::VspAdminStatus>
Format:
( up
| down )
Possible values:
- up : unlock the sip Vsp
- down : lock the sip Vsp
Parameter type: <Sip::VspTinfo>
Format:
- tinfo of this SIP voice service provider
- range: [1...3600000]

optional parameter with default


value: ""
domain name of the sip Vsp

[no] admin-status

[no] tinfo

[no] ta4

[no] ttir1

[no] t-acm-delta

[no] access-held-time

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "down"
administrative status of this sip
voice service provider

optional parameter with default


value: 1000
value of tinfo in milli-second of
this sip voice service provider,
the timer to collect digits before
an INVITE is sent to reduce the
amount of INVITE requests sent
as defined in ETSI TS 183 036
V0.10.1
Parameter type: <Sip::VspTa4>
optional parameter with default
Format:
value: 4000
- Ta4 timer expire of this SIP VSP
value of Ta4 timer expire in
- unit: millisecond
milli-second. The timer Ta4 starts
- range: [1...3600000]
on receipt of first dialed digit. If
the dialed digits are not matched
with digitmap, the expiry of Ta4
will trigger the sending of initial
INVITE.
Parameter type: <Sip::VspTtir1>
optional parameter with default
Format:
value: 100
- ttir1 of this SIP voice service provider
value of ttir1 in milli-second of
- range: [1...3600000]
this sip voice service provider, in
the
case
'from-change'
is
indicated, UA has to wait for an
UPDATE, the timer assures that
the call can continue if the
UPDATE is missing as defined in
ETSI TS 183 036 V0.10.1
Parameter type: <Sip::VspTAcmDelta>
optional parameter with default
Format:
value: 18000
- T-acm-delta timer expire of this SIP VSP
value of T-acm-delta timer expire
- unit: millisecond
in milli-second. The timer
- range: [1...3600000]
T-acm-delta starts on the
situation that T-interdigit timer
expires and there is INVITE
transaction ongoing. The system
will start T-acm-delta. The expiry
of T-acm-delta will end the
attemp of the call establishment.
Parameter type: <Sip::VSPAccessHeldTimer>
optional parameter with default
Format:
value: 600
- Value of access-held-timer expires which is used in the this value is used in the release
release control procedure.
control procedure. it is started
- unit: second
when receiving INVITE with No
- range: [1...65535]
Ring and no SDP and stopped
when sending 200 OK (INVITE).

Released

919

39 Voice Configuration Commands

Parameter

Type

Description

[no] awaiting-time

Parameter type: <Sip::VSPAwaitingTimer>


Format:
- value of awaiting-timer expires which is used in the release
control procedure.
- unit: second
- range: [1...65535]

[no] digit-send-mode

Parameter type: <Sip::VSPDigitSendingMode>


Format:
( en-bloc
| overlap-invite
| overlap-indialog )
Possible values:
- en-bloc : en-block mode
- overlap-invite : overlap-invite mode
- overlap-indialog : overlap-indialog mode
Parameter type: <Sip::VSPOverlap484Action>
Format:
( release-call
| continue )
Possible values:
- release-call : terminate the call.
- continue : continue the digit collection for the call attempt.
Parameter type: <Sip::VSPDMPMIntDgtExpid>
Format:
( send-invite
| release-call )
Possible values:
- send-invite : send out invite with the collected digits.
- release-call : terminate the call.
Parameter type: <Sip::VSPDialStartTimer>
Format:
- Dialing start timer in second
- unit: second
- range: [1...60]
Parameter type: <Sip::VSPDialLongTimer>
Format:
- dialing long timer in second
- unit: second
- range: [1...60]
Parameter type: <Sip::VSPDialShortTimer>
Format:
- dialing short timer in second
- unit: second
- range: [1...60]
Parameter type: <Sip::VSPURIType>
Format:
( sip-uri
| tel-uri )
Possible values:
- sip-uri : sip-uri mode
- tel-uri : tel-uri mode
Parameter type: <Sip::VSPRfc2833PayloadType>
Format:
- payload type of rfc2833
- range: [96...127]

optional parameter with default


value: 60
this value is used in the release
control procedure. it is started
when receiving 200 OK (Bye)
with X-Service-indicator and
stopped when receiving INVITE
with No Ring and No SDP.
optional parameter with default
value: "en-bloc"
digit sending mode of this sip
voice service provider

[no] overlap-484-act

[no] dmpm-intdgt-expid

[no] dial-start-timer

[no] dial-long-timer

[no] dial-short-timer

[no] uri-type

[no] rfc2833-pl-type

920

Released

optional parameter with default


value: "release-call"
release call or not when 484 is
received for INVITE before early
dialog is established for digit
sending in overlap dialing
in-dialog method.
optional parameter with default
value: "send-invite"
The action if inter-digit timer
expired when digitmap partial
matched.
optional parameter with default
value: 10
Default maximum waiting time in
seconds for dialing the first digit
optional parameter with default
value: 20
Default maximum waiting time in
seconds for dialing when no
matching found in the digitmap
optional parameter with default
value: 5
Default maximum waiting time in
seconds for dialing when
matching found in the digitmap
optional parameter with default
value: "sip-uri"
uri type of this sip voice service
provider

optional parameter with default


value: 96
payload type of rfc2833

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

[no] rfc2833-process

Parameter type: <Sip::VSPRfc2833Process>


Format:
( audio
| rfc2833
| both
| mandatory-audio )
Possible values:
- audio : processing procedure is audio
- rfc2833 : processing procedure is rfc2833
- both : processing procedure is both
- mandatory-audio : processing procedure is audio first
Parameter type: <Sip::VSPDataJitter>
Format:
- data jitter buffer for calls working in rtp mode in
millisecond
- unit: millisecond
- range: [0...200]
Parameter type: <Sip::VSPDataJitter>
Format:
- data jitter buffer for calls working in rtp mode in
millisecond
- unit: millisecond
- range: [0...200]
Parameter type: <Sip::VSPDataJitter>
Format:
- data jitter buffer for calls working in rtp mode in
millisecond
- unit: millisecond
- range: [0...200]
Parameter type: <Sip::VSPReleaseMode>
Format:
( normal
| caller
| callee
| both )
Possible values:
- normal : sending BYE immediately, applicable for the
normal call release procedure
- caller : postpone BYE until access-held-time times out for
caller, only postpone BYE in case the subscriber is caller
- callee : postpone BYE until access-held-time times out for
callee, only postpone BYE in case the subscriber is callee
- both : postpone BYE until access-held-time times out for
caller and callee, postpone BYE in case the subscriber is
caller or callee
Parameter type: <Sip::VSPDynamicPTNegoType>
Format:
( far-end
| asymmetric )
Possible values:
- far-end : negotiate with supported by far-end
- asymmetric : negotiate with different payload type for
sending and receiving
Parameter type: <Sip::VSPVbdG711APayloadType>
Format:
- dynamic payload type of Vbd G711A
- range: [96...127]

optional parameter with default


value: "audio"
processing procedure for the dtmf
event tones

[no] min-data-jitter

[no] init-data-jitter

[no] max-data-jitter

[no] release-mode

[no] dyn-pt-nego-type

[no] vbd-g711a-pl-type

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 50
minimum jitter buffer for data
calls working in rtp mode
optional parameter with default
value: 50
initial jitter buffer for data calls
working in rtp mode
optional parameter with default
value: 50
maximum jitter buffer for data
calls working in rtp mode
optional parameter with default
value: "normal"
send BYE immediately or not
after caller/callee/both onhook

optional parameter with default


value: "far-end"
how to negotiate dynamic
payload type

optional parameter with default


value: 97
dynamic payload type of vbd
g711a

Released

921

39 Voice Configuration Commands

Parameter

Type

Description

[no] vbd-g711u-pl-type

Parameter type: <Sip::VSPVbdG711UPayloadType>


Format:
- dynamic payload type of Vbd G711U
- range: [96...127]
Parameter type: <Sip::VSPVbdMode>
Format:
( autoswitch
| renegotiation
| v152fb-autoswitch
| v152fb-reneg )
Possible values:
- autoswitch : auto switch without negotiation
- renegotiation : renegotiation
- v152fb-autoswitch : V152. If V152 neogtionation fails, act
as autoswitch
- v152fb-reneg : V152. If V152 neogtionation fails, act as
renegotiation
Parameter type: <Sip::VSPWarmlineDelayTimer>
Format:
- warmline delay timer in second
- unit: second
- range: [1...60]
Parameter type: <Sip::CommonCfgTimerB>
Format:
- value of SIP CommonCfgTimerB for rfc4780
- unit: millisecond
- range: [2000...64000]

optional parameter with default


value: 98
dynamic payload type of vbd
g711u
optional parameter with default
value: "autoswitch"
vbd negotiation mode

[no] vbd-mode

[no] warmline-dl-timer

[no] timer-b

[no] timer-f

Parameter type: <Sip::CommonCfgTimerF>


Format:
- value of SIP CommonCfgTimerF for rfc4780
- unit: millisecond
- range: [2000...64000]

[no] timer-t1

Parameter type: <Sip::CommonCfgTimerT1>


Format:
- value of SIP CommonCfgTimerT1 for rfc4780
- unit: millisecond
- range: [200...1000]

[no] timer-t2

Parameter type: <Sip::CommonCfgTimerT2>


Format:
- value of SIP CommonCfgTimerT2 for rfc4780
- unit: millisecond
- range: [200...10000]

[no] reg-sub

Parameter type: <Sip::VSPRegSubscribe>


Format:

922

Released

optional parameter with default


value: 4
warmline-delay-timer,range from
1 to 60 sec
optional parameter with default
value: "32000"
This object reflects the maximum
time a SIP entity will wait to
receive a response to an INVITE.
The timer is started upon
transmission of the initial
INVITE request.
optional parameter with default
value: "32000"
This object reflects the maximum
time a SIP entity will wait to
receive a final response to a
non-INVITE request. The timer
is started upon transmission of
the initial request.
optional parameter with default
value: "500"
This object reflects the T1 timer
for a SIP entity. T1 is an estimate
of the round-trip time (RTT)
between the client and server
transactions.
optional parameter with default
value: "4000"
This object reflects the T2 timer
for a SIP entity. T2 is the
maximum retransmit interval for
non-INVITE
requests
and
INVITE responses. It is used in
various parts of the protocol to
reset other Timer* objects to this
value.
optional parameter with default
value: "disable"

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] sub-period

[no] sub-head-start

[no] t38-same-udp

[no] dhcp-option82

3HH-04416-EBAA-TCZZA 01

Type

Description

( disable
| enable )
Possible values:
- disable : do not send reg SUBSCRIBE
- enable : send reg SUBSCRIBE
Parameter type: <Sip::VSPSubscribePeriod>
Format:
- This object indicates subscription expiration time that the
client will propose by including it in an Expires header of a
SUBSCRIBE request. If this property is set to a value of
zero, the client SHALL NOT refresh a subscription even if
the server specifies an expiration interval. Accept value
greater than or equal to 60 [0|(60..86400)]
- unit: second
- range: [0...86400]

This object indicates whether the


system should send the reg
SUBSCRIBE method.

optional parameter with default


value: 3600
This object indicates subscription
expiration time that the client will
propose by including it in an
Expires header of a SUBSCRIBE
request. If this property is set to a
value of zero, the client SHALL
NOT refresh a subscription even
if the server specifies an
expiration interval.
Parameter type: <Sip::VSPSubscribeHeadStart>
optional parameter with default
Format:
value: 600
- This object indicates number of seconds prior to expiration This object indicates number of
of a subscription at which the client sends a SUBSCRIBE seconds prior to expiration of a
request to refresh the subscription. Accept value greater than subscription at which the client
or equal to 60 [0|(32..86400)]
sends a SUBSCRIBE request to
- unit: second
refresh the subscription.
- range: [0...86400]
Parameter type: <Sip::VSPT38withSameUDP>
optional parameter with default
Format:
value: "disable"
( disable
Whether T38 use same UDP port
| enable )
with voice,disable(1),enable(2)
Possible values:
- disable : T38 use different port as voice
- enable : T38 use same port as voice
Parameter type: <Sip::DHCPOption82>
optional parameter with default
Format:
value: "disable"
( enable
dhcp option82 mode
| disable )
Possible values:
- enable : enable to send option 82 in DHCP mode
- disable : disable to send option 82 in DHCP mode

Released

923

39 Voice Configuration Commands

39.6 Voice Sip User Agent Access Point


Configuration Command
Command Description
This command allows the operator to configure the Voice Sip User Agent Access Point. This command depends on
the Voice Sip UserAgent Configuration command. When a SIP User Agent is created/deleted, the user agent access
point(s) will be created/deleted automatically according to the SIP UA ip-address-policy. The user agent access
point(s) can be learned using the show command: show voice sip user-agent-ap.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip user-agent-ap (ua-name) slot-id <SIP::SlotIndex> [ signal-ip <SIP::IpAddressAndMask> ] [
rtp-ip <SIP::IpAddressAndMask> ] [ no dhcp-fqdn | dhcp-fqdn <Sip::UaApDHCPFQDN> ] [ no dhcp-customer-id
| dhcp-customer-id <Sip::UaApDHCPCustomerID> ] [ no admin-status | admin-status <Sip::UaApAdminStatus> ]

Command Parameters
Table 39.6-1 "Voice Sip User Agent Access Point Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(ua-name)

Format:
- uniquely identifies the User Agent
- length: 1<=x<=32
Parameter type: <SIP::SlotIndex>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt
| ntio
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt : nt-slot
- ntio : ntio-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

uniquely identify of the user


agent

slot-id

924

Released

slot id associated with this user


agent access point

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Table 39.6-2 "Voice Sip User Agent Access Point Configuration Command" Command Parameters
Parameter

Type

Description

signal-ip

Parameter type: <SIP::IpAddressAndMask>


Format:
<Ip::V4Address> / <Sip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Sip::PrefixLength>
- prefix length of the subnet
- range: [0...32]
Parameter type: <SIP::IpAddressAndMask>
Format:
<Ip::V4Address> / <Sip::PrefixLength>
Field type <Ip::V4Address>
- IPv4-address
Field type <Sip::PrefixLength>
- prefix length of the subnet
- range: [0...32]
Parameter type: <Sip::UaApDHCPFQDN>
Format:
- the string for FQDN in Option81 When UA send out
DHCP request
- length: x<=255
Parameter type: <Sip::UaApDHCPCustomerID>
Format:
- the string for Customer id in Option82 When UA send out
DHCP request
- length: x<=64
Parameter type: <Sip::UaApAdminStatus>
Format:
( up
| down )
Possible values:
- up : unlock the sip Ua AccessPoint
- down : lock the sip Ua AccessPoint

optional parameter
signalling ip address and prefix
length of the sip user agent access
point

rtp-ip

[no] dhcp-fqdn

[no] dhcp-customer-id

[no] admin-status

3HH-04416-EBAA-TCZZA 01

optional parameter
rtp ip address and prefix length of
the sip user agent access point

optional parameter with default


value: ""
the FQDN in Option81 When UA
send out DHCP request
optional parameter with default
value: "Physical-ID"
the Customer id in Option82
When UA send out DHCP
request
optional parameter with default
value: "down"
administrative status of this sip
user agent access point

Released

925

39 Voice Configuration Commands

39.7 Voice Sip Dial Plan Configuration Commands


Command Description
This command allows the operator to manage the Voice Sip dial plan profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no dialplan (name) ) | ( dialplan (name) [ no pre-activated | pre-activated
<Sip::DialPlanPreActivated> ] [ no static-prefix | static-prefix <Sip::DialPlanStaticPrefix> ] [ no static-suffix |
static-suffix <Sip::DialPlanStaticSuffix> ] [ no digitmap-mode | digitmap-mode <Sip::DialPlanDigitMapMode> ] )

Command Parameters
Table 39.7-1 "Voice Sip Dial Plan Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies the dial plan
- length: 1<=x<=32

unique identity of a voice sip dial


plan

Table 39.7-2 "Voice Sip Dial Plan Configuration Commands" Command Parameters
Parameter

Type

Description

[no] pre-activated

Parameter type: <Sip::DialPlanPreActivated>


Format:
( on
| off )
Possible values:
- on : Prefix activated of dial plan is on
- off : Prefix activated of dial plan is off
Parameter type: <Sip::DialPlanStaticPrefix>
Format:
- static prefix added to all valid DNs
- length: x<=32
Parameter type: <Sip::DialPlanStaticSuffix>
Format:
- static suffix added to all valid DNs
- length: x<=32
Parameter type: <Sip::DialPlanDigitMapMode>
Format:
( maximum
| minimum )
Possible values:
- maximum : standard match mode

optional parameter with default


value: "off"
identify the status for sip dial
plan prefix

[no] static-prefix

[no] static-suffix

[no] digitmap-mode

926

Released

optional parameter with default


value: ""
identify static prefix(area code)
added to valid DNs
optional parameter with default
value: ""
identify static suffix(area code)
added all valid DNs
optional parameter with default
value: "maximum"
identify the digit match mode for
dial plan

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

- minimum : system should send out INVITE immediately


when an exact full match dial string is deteced

3HH-04416-EBAA-TCZZA 01

Released

927

39 Voice Configuration Commands

39.8 Voice Sip Dial Plan Digitmap Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip dialplan digitmap profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
>
configure
voice
sip
(
no
digitmap
(name)
type
<Sip::DialPlanDigitmapType>
<Sip::DialPlanDigitmapValue> ) | ( digitmap (name) type <Sip::DialPlanDigitmapType>
<Sip::DialPlanDigitmapValue> [ no access-type | access-type <Sip::DialPlanDigitmapAccessType> ] )

rule
rule

Command Parameters
Table 39.8-1 "Voice Sip Dial Plan Digitmap Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies the dial plan
- length: 1<=x<=32
Parameter type: <Sip::DialPlanDigitmapType>
Format:
regular
Possible values:
- regular : digitmap type
Parameter type: <Sip::DialPlanDigitmapValue>
Format:
- identity the value of digitmap
- length: 1<=x<=100

identify voice application dial


plan within the scope

type

rule

identify the type of sip dial plan


digitmap

identify the value of sip dial plan


digitmap

Table 39.8-2 "Voice Sip Dial Plan Digitmap Configuration Commands" Command Parameters
Parameter

Type

Description

[no] access-type

Parameter type: <Sip::DialPlanDigitmapAccessType>


Format:
allowed
Possible values:
- allowed : the digitmap can be used

optional parameter with default


value: "allowed"
The parameter is not visible
during creation.
The access type of digitmap

928

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.9 Voice Sip Termination Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip termination profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no termination (if-index) ) | ( termination (if-index) [ no directory-number |
directory-number <Sip::TermDnumber> ] [ no user-name | user-name <Sip::TermUserName> ] [ no display-name |
display-name <Sip::TermUserName> ] [ no uri | uri <Sip::TermUri> ] [ no direct-uri | direct-uri <Sip::TermUri> ] [
no line-feed | line-feed <Sip::TermLineCharacter> ] [ no md5-realm | md5-realm <Sip::MD5Realm> ] [ no
md5-password | md5-password <Security::Password4> ] [ no admin-status | admin-status <Sip::TermAdminStatus>
] [ no clip-mode | clip-mode <Sip::TermETSIClipDataMode> ] [ no anti-tapping | anti-tapping
<Sip::TermAntiTapping> ] [ no impedance | impedance <Sip::TermImpedance> ] [ no rx-gain | rx-gain
<Sip::TermRxGain> ] [ no tx-gain | tx-gain <Sip::TermTxGain> ] [ no warmline-service | warmline-service
<Sip::TermWarmlineService>
]
[
no
linesig-remanswer
|
linesig-remanswer
<Sip::TermLineSignalOnRemoteAnswer> ] [ no line-id | line-id <Sip::TermLineId> ] [ no force-hold | force-hold
<Sip::TermService> ] [ no callwait-service | callwait-service <Sip::TermSupplementaryService> ] [ no
callhold-service | callhold-service <Sip::TermSupplementaryService> ] [ no callconf-service | callconf-service
<Sip::TermSupplementaryService> ] [ no calltras-service | calltras-service <Sip::TermSupplementaryService> ] [
no testaccessstate | testaccessstate <Sip::TestAccessState> ] [ no busyoverwrite | busyoverwrite
<Sip::TestAccessBusyOverWrite> ] [ no accessontimeout | accessontimeout <Sip::TestAccessonTimeout> ] )

Command Parameters
Table 39.9-1 "Voice Sip Termination Configuration Commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
The unique internal identifier of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the termination port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

3HH-04416-EBAA-TCZZA 01

Description

Released

929

39 Voice Configuration Commands

Table 39.9-2 "Voice Sip Termination Configuration Commands" Command Parameters


Parameter

Type

Description

[no] directory-number

Parameter type: <Sip::TermDnumber>


Format:
- identify the DN of the subscriber line
- length: x<=32
Parameter type: <Sip::TermUserName>
Format:
- identify the user name for this port
- length: x<=64
Parameter type: <Sip::TermUserName>
Format:
- identify the user name for this port
- length: x<=64
Parameter type: <Sip::TermUri>
Format:
- SIP uri by which the user agent identifies subscriber line
- length: x<=80
Parameter type: <Sip::TermUri>
Format:
- SIP uri by which the user agent identifies subscriber line
- length: x<=80

optional parameter with default


value: ""
identify the directory (telephone)
number of the subscriber line
optional parameter with default
value: ""
identify the user name for this
termination port
optional parameter with default
value: ""
display name for this termination
port
optional parameter with default
value: ""
sip uri by which user agent
identifies subscriber line
optional parameter with default
value: ""
a call will be automatically
established to this SIP-URI after
an off-hook
optional parameter with default
value: "25"
the
characteristic
of
the
subscriber line

[no] user-name

[no] display-name

[no] uri

[no] direct-uri

[no] line-feed

Parameter type: <Sip::TermLineCharacter>


Format:
( 25
| 40 )
Possible values:
- 25 : the line character of this port is 25, unit: ma
- 40 : the line character of this port is 40, unit: ma
Parameter type: <Sip::MD5Realm>
Format:
- the string for MD5
- length: x<=64
Parameter type: <Security::Password4>
Format:
( prompt
| plain : <Security::PlainPassword4> )
Possible values:
- prompt : prompts the operator for a password
- plain : the password in plain text
Field type <Security::PlainPassword4>
- the string for MD5
- length: x<=64
Parameter type: <Sip::TermAdminStatus>
Format:
( up
| down )
Possible values:
- up : unlock the sip application server
- down : lock the sip application server
Parameter type: <Sip::TermETSIClipDataMode>
Format:
( cdevalue
| fsk
| dtmf )
Possible values:

[no] md5-realm

[no] md5-password

[no] admin-status

[no] clip-mode

930

Released

optional parameter with default


value: ""
realm identifier corrsponding to
service provider domain
optional parameter with default
value: "plain : "
the password associated with the
user

optional parameter with default


value: "down"
identify the status of this port
administration

optional parameter with default


value: "cdevalue"
the etsi clip data transmission
protocol of this sip termination

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] anti-tapping

[no] impedance

[no] rx-gain

3HH-04416-EBAA-TCZZA 01

Type

Description

- cdevalue : cde configuration will be applied for etsi clip


- fsk : fsk will be applied for etsi clip
- dtmf : dtmf will be applied for etsi clip
Parameter type: <Sip::TermAntiTapping>
Format:
( enable
| disable )
Possible values:
- enable : Enable Anti-Tapping service
- disable : Disable Anti-Tapping service
Parameter type: <Sip::TermImpedance>
Format:
( default
| 200
| 220
| 220minisplitter
| 270
| 300
| 370
| 600
| 900
| 370minisplitter
| 600splitter
| 370nvlsasplitter
| 370skinnysplitter
| 270duratelsplitter
| 2703msplitter
| reserv3
| reserv17
| reserv18 )
Possible values:
- default : the impedance is default vaule
- 200 : the line impedance is 200 ohm
- 220 : the line impedance is 220 ohm
- 220minisplitter : the line impedance is 220 ohm+
miniSplitter
- 270 : the line impedance is 270 ohm
- 300 : the line impedance is 300 ohm
- 370 : the line impedance is 370 ohm
- 600 : the line impedance is 600 ohm
- 900 : the line impedance is 900 ohm
- 370minisplitter : the line impedance is 370 ohm+
miniSplitter
- 600splitter : the line impedance is 600 ohm+splitter
- 370nvlsasplitter : the line impedance is 370 ohm+
NVLSASplitter
- 370skinnysplitter : the line impedance is 370 ohm+
SkinnySplitter
- 270duratelsplitter : the line impedance is 270 ohm+
DuratelSplitter
- 2703msplitter : the line impedance is 270 ohm+
3MDplitter
- reserv3 : reserved for future use 3
- reserv17 : reserved for future use 17
- reserv18 : reserved for future use 18
Parameter type: <Sip::TermRxGain>
Format:

optional parameter with default


value: "disable"
enable/disable the anti-tapping
service of this sip termination

optional parameter with default


value: "default"
configure the line impedance of
this sip termination

optional parameter with default


value: "0"

Released

931

39 Voice Configuration Commands

Parameter
[no] tx-gain

[no] warmline-service

[no] linesig-remanswer

[no] line-id

[no] force-hold

[no] callwait-service

[no] callhold-service

[no] callconf-service

932

Released

Type

Description

- the line rx_gain range -14...6


- range: [-14...6]
Parameter type: <Sip::TermTxGain>
Format:
- the line tx_gain range -14...6
- range: [-14...6]
Parameter type: <Sip::TermWarmlineService>
Format:
( disabled
| activated
| subscribed )
Possible values:
- disabled : When warmline-service=disabled and direct-uri
is null, warmline service is controlled by SIP Service
Profile. The SSP will tell whether this service is controlled
by UA-Profile or the MIB disable value is applied (e.g.
when the IMS core does not support the UA-profile
approach).
- activated : Warmline is activated
- subscribed : Warmline is controlled by subscriber
Parameter type: <Sip::TermLineSignalOnRemoteAnswer>
Format:
( no-signal
| line-reversal
| single-meteringpulse )
Possible values:
- no-signal : send no signal
- line-reversal : send line reversal signal
- single-meteringpulse : send single metering pulse signal
Parameter type: <Sip::TermLineId>
Format:
- identify the line id for this port
- length: x<=63
Parameter type: <Sip::TermService>
Format:
( disable
| enable )
Possible values:
- disable : field is disabled
- enable : field is enabled
Parameter type: <Sip::TermSupplementaryService>
Format:
( disabled
| activated )
Possible values:
- disabled : the service is disabled
- activated : the service is activated
Parameter type: <Sip::TermSupplementaryService>
Format:
( disabled
| activated )
Possible values:
- disabled : the service is disabled
- activated : the service is activated
Parameter type: <Sip::TermSupplementaryService>
Format:
( disabled

configure the line rx_gain of this


sip termination
optional parameter with default
value: "0"
configure the line tx_gain of this
sip termination
optional parameter with default
value: "disabled"
warmline administrative status

optional parameter with default


value: "no-signal"
line signal on remote answer

optional parameter with default


value: ""
identify the line id for this
termination port
optional parameter with default
value: "disable"
force hold functionality

optional parameter with default


value: "disabled"
callwaiting administrative status

optional parameter with default


value: "disabled"
callhold administrative status

optional parameter with default


value: "disabled"
callconference
administrative

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] calltras-service

[no] testaccessstate

[no] busyoverwrite

[no] accessontimeout

3HH-04416-EBAA-TCZZA 01

Type

Description

| activated )
Possible values:
- disabled : the service is disabled
- activated : the service is activated
Parameter type: <Sip::TermSupplementaryService>
Format:
( disabled
| activated )
Possible values:
- disabled : the service is disabled
- activated : the service is activated
Parameter type: <Sip::TestAccessState>
Format:
( on
| off )
Possible values:
- on : turn on TestAccessState
- off : turn off TestAccessState
Parameter type: <Sip::TestAccessBusyOverWrite>
Format:
( true
| false )
Possible values:
- true : enable TestAccessBusyOverWrite parameter
- false : disable TestAccessBusyOverWrite parameter
Parameter type: <Sip::TestAccessonTimeout>
Format:
- value of test access on expires.
- unit: second
- range: [0...300]

status

optional parameter with default


value: "disabled"
calltransfer administrative status

optional parameter with default


value: "off"
test access status

optional parameter with default


value: "false"
test access busyoverwrite

optional parameter with default


value: "120"
time to go until test access
timeout. In case test access state
is off, the value will be 0. In case
test access state is on, this
parameter is optional with default
initial value 120. The value will
start counting down, until value 0
and test access state will be off
again.

Released

933

39 Voice Configuration Commands

39.10 Voice Sip Termination TCA Threshold


Configuration Command
Command Description
This command allows the operator to enable/disable tca or configure the high/low threshold for jitter buffer fill
level of the sip termination.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip termination (if-index) tca [ [ no ] enable ] [ no high-jbfl | high-jbfl <Sip::JBFL> ] [ no
low-jbfl | low-jbfl <Sip::JBFL> ]

Command Parameters
Table 39.10-1 "Voice Sip Termination TCA Threshold Configuration Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
The unique internal identifier of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the termination port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 39.10-2 "Voice Sip Termination TCA Threshold Configuration Command" Command
Parameters
Parameter

Type

[no] enable

Parameter type: boolean

optional parameter
Enable the reporting of tca for sip
termination
Parameter type: <Sip::JBFL>
optional parameter with default
Format:
value: 90
- average of jitter buffer fill level percentage for the the high threshould for jitter
termination
buffer fill level. it can not be
- unit: percentage
smaller than low-jbfl. 100 mean

[no] high-jbfl

934

Description

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

- range: [0...100]
[no] low-jbfl

3HH-04416-EBAA-TCZZA 01

that this parameter shall be


omitted by the system.
Parameter type: <Sip::JBFL>
optional parameter with default
Format:
value: 80
- average of jitter buffer fill level percentage for the the low threshould for jitter
termination
buffer fill level. it can not be
- unit: percentage
bigger than high-jbfl. 0 mean that
- range: [0...100]
this parameter shall be omitted by
the system.

Released

935

39 Voice Configuration Commands

39.11 Sip Voice Register Configuration Commands


Command Description
This command allows the operator to configure the SIP Voice Register parameters .

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip register (provider-name) [ no register-uri | register-uri <Sip::RegisterUri> ] [ no register-intv |
register-intv <Sip::RegisterIntv> ] [ no reg-retry-intv | reg-retry-intv <Sip::RegisterRetryIntv> ] [ no
reg-prev-ava-intv | reg-prev-ava-intv <Sip::RegisterPrevAvaIntv> ] [ no reg-head-start | reg-head-start
<Sip::RegisterHeadStart> ] [ no reg-start-min | reg-start-min <Sip::RegisterStartMin> ]

Command Parameters
Table 39.11-1 "Sip Voice Register Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(provider-name)

Format:
- provider name,Currently support only vsp1
- length: x<=32

uniquely
identify
provider name

register

Table 39.11-2 "Sip Voice Register Configuration Commands" Command Parameters


Parameter

Type

Description

[no] register-uri

Parameter type: <Sip::RegisterUri>


Format:
- The registration URI to be used by all SIP terminations that
have a service agreement with this SIP Voice Service
provider
- length: x<=80
Parameter type: <Sip::RegisterIntv>
Format:
- The registration expiration time that UA will propose in
the Expires header of a REGISTER request, unless the value
is 0. If the value is set to 0 the UA shall not refresh a
registration even if the server specifies an expiration
interval. Accept value greater than or equal to 60
[0|(60..86400)]
- unit: second
- range: [0...86400]
Parameter type: <Sip::RegisterRetryIntv>
Format:
- The interval between successive registration retries after a
failed registration. The value of 0 shall disable registration

optional parameter with default


value: ""
The registration URI to be used
by all SIP terminations that have
a service agreement with this SIP
Voice Service provider.
optional parameter with default
value: 3600
The registration expiration time
that UA will propose in the
Expires header of a REGISTER
request, unless the value is 0. If
the value is set to 0 the UA shall
not refresh a registration even if
the server specifies an expiration
interval.
optional parameter with default
value: 60
The interval between successive
registration retries after a failed

[no] register-intv

[no] reg-retry-intv

936

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] reg-prev-ava-intv

[no] reg-head-start

[no] reg-start-min

3HH-04416-EBAA-TCZZA 01

Type

Description

retry
- unit: second
- range: [0...86400]
Parameter type: <Sip::RegisterPrevAvaIntv>
Format:
- The magnitude of time interval that must be awaited before
the system is allowed to initiate another register request.
- unit: millisecond
- range: [100...32000]
Parameter type: <Sip::RegisterHeadStart>
Format:
- The time prior to expiration of a registration at which the
UA sends a registration refresh. If the value of
register_head_start is greater than one-half of the value for
register_period, then the register_head_start value will be
ignored and a timer equal to one-half of the value for
register_period will be used for this function,a value 0
means register_head_start will not be used
- unit: second
- range: [0...86400]

registration. The value of 0 shall


disable registration retry.

Parameter type: <Sip::RegisterStartMin>


Format:
- The time prior to expiration of a registration at which a
registration refresh is sent, if the value of register_head_start
is greater than one-half of the value for the Expires value
received in the 200 OK response to last REGISTER request
for this line (either the Expires parameter in the Contact
header or, if that is not present, in an Expires header), then
the register_head_start value is ignored and a timer equal to
one-half of the value for register_period is used for this
function
- unit: percentage
- range: [30...70]

optional parameter with default


value: 500
the magnitude of time interval
that must be awaited before the
system is allowed to initiate
another register request.
optional parameter with default
value: 600
The time prior to expiration of a
registration at which the UA
sends a registration refresh,if the
value of register_head_start is
greater than one-half of the value
for register_period, then the
register_head_start value will be
ignored and a timer equal to
one-half of the value for
register_period will be used for
this function,a value 0 means,
this value will not be used,valid
input would be [0,32..86400]
optional parameter with default
value: 50
The time prior to expiration of a
registration
at
which
a
registration refresh is sent. If the
value of register_head_start is
greater than one-half of the value
for the Expires value received in
the 200 OK response to last
REGISTER request for this line
(either the Expires parameter in
the Contact header or, if that is
not present, in an Expires
header),
then
the
register_head_start
value
is
ignored and a timer equal to
one-half of the value for
register_period is used for this
function.

Released

937

39 Voice Configuration Commands

39.12 Voice Sip Transport Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip Transport params.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no transport (trans-protocol) provider-name <Sip::TransportProviderName> ) | ( transport
(trans-protocol) provider-name <Sip::TransportProviderName> [ no admin-status | admin-status
<Sip::TransportAdminStatus> ] [ no port-rcv | port-rcv <Sip::TransportPortRcv> ] [ no tcp-idle-time | tcp-idle-time
<Sip::TransportTCPIdleTime> ] [ no max-out-udp-size | max-out-udp-size <Sip::TransportMaxOutgUdpReqSize>
])

Command Parameters
Table 39.12-1 "Voice Sip Transport Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(trans-protocol)

Format:
( udp
| tcp
| udp_tcp )
Possible values:
- udp : transport protocol is udp
- tcp : transport protocol is support tcp
- udp_tcp : transport protocol is udp and tcp
Parameter type: <Sip::TransportProviderName>
Format:
- provider name,Currently supports only vsp1
- length: x<=32

Terminations will use this


transport for establishing the calls

provider-name

uniquely
identify
provider name

transport

Table 39.12-2 "Voice Sip Transport Configuration Commands" Command Parameters


Parameter

Type

Description

[no] admin-status

Parameter type: <Sip::TransportAdminStatus>


Format:
( up
| down )
Possible values:
- up : unlock the dns server
- down : lock the dns server

optional parameter with default


value: "down"
change administrative status

938

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

[no] port-rcv

Parameter type: <Sip::TransportPortRcv>


Format:
- Defines transport protocol port the UserAgent has to listen
to for incoming SIP requests.
- range: [0...65534]
Parameter type: <Sip::TransportTCPIdleTime>
Format:
- Define the max time period that a TCP shall be kept alive
without exchanging any msg.
- unit: second
- range: [32...3600]
Parameter type: <Sip::TransportMaxOutgUdpReqSize>
Format:
- Define the maximum SIP message size that can be sent
over UDP
- range: [576...65535]

optional parameter with default


value: 5060
Defines transport protocol port
the User Agent has to listen to for
incoming SIP requests.
optional parameter with default
value: 64
Define the max time period that a
TCP shall be kept alive without
exchanging any msg.

[no] tcp-idle-time

[no] max-out-udp-size

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 65535
Define the maximum SIP
message size that can be sent
over UDP

Released

939

39 Voice Configuration Commands

39.13 Voice Sip Redundancy Table Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip Redundancy table.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip redundancy (admin-domain-name) [ no support-redun | support-redun
<Sip::NetwRedunSupported> ] [ no dns-purge-timer | dns-purge-timer <Sip::NetwRedunDnsPurgeTimer> ] [ no
dns-ini-retr-int | dns-ini-retr-int <Sip::NetwRedunDnsInitRetranTimer> ] [ no dns-max-retr-nbr | dns-max-retr-nbr
<Sip::NetwRedunDnsMaxRetrNbr>
]
[
no
fg-monitor-method
|
fg-monitor-method
<Sip::NetwRedunFgMonitorMethod> ] [ no fg-monitor-int | fg-monitor-int <Sip::NetwRedunFgMonitorInt> ] [ no
bg-monitor-method | bg-monitor-method <Sip::NetwRedunBgMonitorMethod> ] [ no bg-monitor-int |
bg-monitor-int
<Sip::NetwRedunBgMonitorInt>
]
[
no
stable-obs-period
|
stable-obs-period
<Sip::NetwRedunStableObsPeriod> ] [ no fo-hystersis | fo-hystersis <Sip::NetwRedunFailoverHystersis> ] [ no
del-upd-threshold | del-upd-threshold <Sip::NetwRedunDeliUpdThreshold> ] [ no auto-server-fo | auto-server-fo
<Sip::NetwRedunAutoFailOver> ] [ no auto-server-fb | auto-server-fb <Sip::NetwRedunAutoFailBack> ] [ no
auto-sos-fo | auto-sos-fo <Sip::NetwRedunAutoFailOver> ] [ no auto-sos-fb | auto-sos-fb
<Sip::NetwRedunAutoSosFailback> ] [ no rtry-after-thrsh | rtry-after-thrsh <Sip::NetwRedunRetryAfterThreshold>
] [ no options-max-fwd | options-max-fwd <Sip::NetwRedunOPTIONSMaxForward> ] [ no dns-redun-mode |
dns-redun-mode <Sip::NetwRedundnsredunmode> ]

Command Parameters
Table 39.13-1 "Voice Sip Redundancy Table Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(admin-domain-name)

Format:
- uniquely name of this element
- length: x<=32

The administrative domain name


of the (farm of) SIP First hop(s)

Table 39.13-2 "Voice Sip Redundancy Table Configuration Commands" Command Parameters
Parameter

Type

Description

[no] support-redun

Parameter type: <Sip::NetwRedunSupported>


Format:
( enable
| disable )
Possible values:
- enable : support Redundancy
- disable : doesn't supprot Redundancy

optional parameter with default


value: "disable"
This
object
allows
the
administrator to define whether
the Voice Service Provider
network supports redundancy or
not.

940

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

[no] dns-purge-timer

Parameter type: <Sip::NetwRedunDnsPurgeTimer>


Format:
- Expire of the DNS Purge Timer, a value 0 means that the
DNS purge timer is disabled
- unit: second
- range: [0...86400]
Parameter type: <Sip::NetwRedunDnsInitRetranTimer>
Format:
- Initial DNS retransmission Interval
- unit: milliseconds
- range: [200...1000]
Parameter type: <Sip::NetwRedunDnsMaxRetrNbr>
Format:
- Maximum DNS retransmission times
- range: [0...4]
Parameter type: <Sip::NetwRedunFgMonitorMethod>
Format:
( register-method
| options-method
| passive-heartbeat )
Possible values:
- register-method : Foreground Service Healthy Monitoring
mode : register-method
- options-method : Foreground Service Healthy Monitoring
mode : options-method
- passive-heartbeat : Foreground Service Healthy
Monitoring mode : passive-heartbeat
Parameter type: <Sip::NetwRedunFgMonitorInt>
Format:
- The Foreground healthy monitoring interval, range is
[0,32..3600],0 means disable.
- unit: second
Parameter type: <Sip::NetwRedunBgMonitorMethod>
Format:
options-method
Possible values:
- options-method : Background Service Healthy Monitoring
mode : options-method
Parameter type: <Sip::NetwRedunBgMonitorInt>
Format:
- The Background healthy monitoring interval,range is
[0,60..86400], 0 means disable.
- unit: second
Parameter type: <Sip::NetwRedunStableObsPeriod>
Format:
- Configurable stable operation observation period, a value 0
means that the Stable-Operation Observation Period is
disabled
- unit: second
- range: [0...86400]
Parameter type: <Sip::NetwRedunFailoverHystersis>
Format:
- Fail-Over Hysteresis Threshold, a value 0 means that the
Fail-Over Hysteresis is disabled
- range: [0...5]
Parameter type: <Sip::NetwRedunDeliUpdThreshold>
Format:

optional parameter with default


value: 86400
Expire of the DNS Purge Timer,
a value 0 means that the DNS
purge timer is disabled.

[no] dns-ini-retr-int

[no] dns-max-retr-nbr

[no] fg-monitor-method

[no] fg-monitor-int

[no] bg-monitor-method

[no] bg-monitor-int

[no] stable-obs-period

[no] fo-hystersis

[no] del-upd-threshold

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 500
The
initial
DNS
query
retransmission interval(in ms).
optional parameter with default
value: 2
The maximum DNS query
retransmission times.
optional parameter with default
value: "register-method"
The
Foreground
healthy
monitoring method.

optional parameter with default


value: 90
The
Foreground
healthy
monitoring interval, range is
[0,32..3600],0 means disable.
optional parameter with default
value: "options-method"
The
Background
healthy
monitoring method.
optional parameter with default
value: 3600
The
Background
healthy
monitoring interval,range is
[0,60..86400], 0 means disable.
optional parameter with default
value: 21600
Configurable stable operation
observation period, a value 0
means that the Stable-Operation
Observation Period is disabled.
optional parameter with default
value: 0
The Fail-Over hysteresis,a value
0 means that the Fail-Over
Hysteresis is disabled.
optional parameter with default
value: 0

Released

941

39 Voice Configuration Commands

Parameter

[no] auto-server-fo

[no] auto-server-fb

[no] auto-sos-fo

Description

- Autonomous Deliberate Fail-Back Threshold,a value 0


means that the deliberate update shall be triggered
immediately
- unit: second
- range: [0...86400]
Parameter type: <Sip::NetwRedunAutoFailOver>
Format:
( enable
| disable )
Possible values:
- enable : Support autonomous Fail-Over
- disable : Not support autonomous Fail-Over
Parameter type: <Sip::NetwRedunAutoFailBack>
Format:
- support/unsupport Autonomous SIP server Fail-Back, a
value 0 means disable this functionality, not 0 means that
SIP server Fail-Back is enabled. The value indicates the time
period by which the SIP server Fail-Back must be done
- unit: second
- range: [0...86400]

Autonomous
Deliberate
Fail-Back Threshold,a value 0
means that the deliberate update
shall be triggered immediately.

Parameter type: <Sip::NetwRedunAutoFailOver>


Format:
( enable
| disable )
Possible values:
- enable : Support autonomous Fail-Over
- disable : Not support autonomous Fail-Over
Parameter type: <Sip::NetwRedunAutoSosFailback>
Format:
- support/unsupport Autonomous SOS Fail-Back, a value 0
means disable this functionality,not 0 means that SIP SOS
Fail-Back is enabled. The value indicates the time period by
which the SIP SOS Fail-Back must be done
- unit: second
- range: [0...86400]

[no] auto-sos-fb

[no] rtry-after-thrsh

[no] options-max-fwd

[no] dns-redun-mode

942

Type

Released

Parameter type: <Sip::NetwRedunRetryAfterThreshold>


Format:
- Retry-after threshold.
- unit: milliseconds
- range: [0...30000]
Parameter type: <Sip::NetwRedunOPTIONSMaxForward>
Format:
- Max-Forward of FGHM, Value - 0: Must not forward this
OPTIONS, Value - 1: Allow to forward once.
- range: [0...1]
Parameter type: <Sip::NetwRedundnsredunmode>
Format:
( dns-redun-primary
| dns-redun-success )
Possible values:
- dns-redun-primary : dns redun mode is dns-redun-primary
- dns-redun-success : dns redun mode is dns-redun-success

optional parameter with default


value: "disable"
This
object
allows
to
enable/disable autonomous SIP
Server Fail-Over.
optional parameter with default
value: 0
This
object
allows
to
enable/disable autonomous SIP
Server Fail-Back.If value != 0,
the value indicates the time
period by which the SIP server
Fail-Back must be completed, a
value 0 means disable
optional parameter with default
value: "disable"
This
object
allows
to
enable/disable autonomous SOS
Fail-Over.
optional parameter with default
value: 0
This
object
allows
to
enable/disable autonomous SOS
Fail-Back.If value != 0, the value
indicates the time period by
which the SOS Fail-Back must be
completed,a value 0 means
disable
optional parameter with default
value: 0
The retry after Threshold.
optional parameter with default
value: 0
Max-forwarding is used to
configure max-forward attribute
for foreground health monitor
OPTIONS method.
optional parameter with default
value: "dns-redun-primary"
DNS
Redundancy
Mode,
dns-redun-primary means the
DNS query will be sent to
primary DNS server always
firstly,dns-redun-success Means
the DNS query will be sent to the
DNS server where the previous

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description
request was successfully respond.

3HH-04416-EBAA-TCZZA 01

Released

943

39 Voice Configuration Commands

39.14 Voice Sip System Session Timer


Configuration Commands
Command Description
this command allows the operator to manage the voice sip session timer profile. The timer is used to consult with
remote, and at last, if session timer was enabled, the refresh timer will be started by IPTK. The SIP Session Timer
feature adds the capability to periodically refresh SIP sessions by sending repeated INVITE requests. The repeated
INVITE requests, or re-INVITEs, are sent during an active call leg to allow user agents (UA) or SIP proxies to
determine the status of a SIP session. Without this keep alive mechanism, proxies that remember incoming and
outgoing requests (stateful proxies) may continue to retain call state needlessly. If a UA fails to send a BYE
message at the end of a session or if the BYE message is lost because of network problems, a stateful proxy does
not know that the session has ended. The re-INVITES ensure that active sessions stay active and completed sessions
are terminated.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip system session-timer [ [ no ] enable ] [ no status | status <Sip::SessionTimerAdminState> ] [
no
min-se-time
|
min-se-time
<Sip::SessionTimerMinSE>
]
[
no
se-time
|
se-time
<Sip::SessionTimerSessionExpire> ] [ no admin-status | admin-status <Sip::SysObjectsAdminStatus> ]

Command Parameters
Table 39.14-2 "Voice Sip System Session Timer Configuration Commands" Command Parameters
Parameter

Type

[no] enable

Parameter type: boolean

obsolete parameter replaced by


parameter "status"
Prefix activated of session timer
is enable
Parameter type: <Sip::SessionTimerAdminState>
optional parameter with default
Format:
value: "disable"
( enable
To configure the SIP Session
| disable
Timer feature capability. If it's
| enable-uas )
disable, shall not request session
Possible values:
expiration in initial INVITE
- enable : Prefix activated of session timer is enable
requests and 200 OK responses If
- disable : Prefix activated of session timer is disable
it's enable, shall request session
- enable-uas : Prefix activated of session timer is expiration in initial INVITE
enableAsUas
requests and 200 OK responses,
and in both cases, if an incoming
initial INVITE request contains a

[no] status

944

Description

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

[no] min-se-time

Parameter type: <Sip::SessionTimerMinSE>


Format:
- value of min-se when use session time
- unit: second
- range: [90...65535]

[no] se-time

Parameter type: <Sip::SessionTimerSessionExpire>


Format:
- value of session-expires when use sessiontime
- unit: second
- range: [90...65535]

[no] admin-status

Parameter type: <Sip::SysObjectsAdminStatus>


Format:
( up
| down )
Possible values:
- up : unlock the sipSysObjects
- down : lock the sipSysObjects

3HH-04416-EBAA-TCZZA 01

Description
session expiration header, but
does not include the refresher
value, then shall use uac for the
refresher parameter. If it's
enable-uas, shall request session
expiration in initial INVITE
requests and 200 OK responses,
and in both cases, if an incoming
initial INVITE request contains a
session header, but does not
include the refresher value, then
shall use uas for the refresher
parameter.
optional parameter with default
value: "90"
Minimum Session Expires time.
The lower bound for the session
refresh interval. Because of the
processing load of INVITE
requests, the SIP proxy, User
Agent Client and User Agent
Server can have a configured
minimum refresh timer value that
they can accept. It is conveyed in
the Min-SE header in the initial
INVITE request. When making a
call, the presence of the Min-SE
header informs the UAS and any
proxy of the minimum value that
the UAC accepts for the session
timer duration, in units of
delta-seconds.
optional parameter with default
value: "1800"
Session Expires Time. The upper
bound for the session refresh
interval. It is conveyed in the
Session-Expires header in the
initial INVITE request. If a
session refresh request is not
received before the interval
passes, the session is considered
terminated.
optional parameter with default
value: "down"
The administrative status of this
sipSysObjects

Released

945

39 Voice Configuration Commands

39.15 Voice Sip DNS Server Configuration


Commands
Command Description
This command allows the operator to manage the Voice Sip DNS Server profile.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no dnsserver (name) ) | ( dnsserver (name) [ no admin-status | admin-status
<Sip::sipDNSServerAdminStatus> ] address <Sip::sipDNSServerAddr> [ no priority | priority
<Sip::sipDNSServerPriority> ] [ no site | site <Sip::sipDNSServerSite> ] admin-domain-name
<Sip::AdminDomName> [ no port | port <Sip::sipDNSServerPort> ] )

Command Parameters
Table 39.15-1 "Voice Sip DNS Server Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies this voice dns server
- length: 1<=x<=32

uniquely identify of this sip DNS


server

Table 39.15-2 "Voice Sip DNS Server Configuration Commands" Command Parameters
Parameter

Type

Description

[no] admin-status

Parameter type: <Sip::sipDNSServerAdminStatus>


Format:
( up
| down )
Possible values:
- up : unlock the dns server
- down : lock the dns server
Parameter type: <Sip::sipDNSServerAddr>
Format:
ipv4 : <Ip::V4Address>
Possible values:
- ipv4 : the address type of the server is ipv4
Field type <Ip::V4Address>
- IPv4-address
Parameter type: <Sip::sipDNSServerPriority>
Format:
- the SIP dns server priority, lower value with higher priority

optional parameter with default


value: "down"
administrative status of this DNS
server

address

[no] priority

946

Released

mandatory parameter
The address(ipv4) of this DNS
server

optional parameter with default


value: 100
The priority of sip DNS

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter
[no] site

admin-domain-name

[no] port

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [0...65535]

server,lower value with higher


priority
optional parameter with default
value: "primary-site"
The site which the sip DSN
server is belonged to

Parameter type: <Sip::sipDNSServerSite>


Format:
( primary-site
| geo-backup-site )
Possible values:
- primary-site : the server belongs to the GEO primary site
- geo-backup-site : the server belongs to the GEO secondary
site
Parameter type: <Sip::AdminDomName>
Format:
- uniquely name of this element
- length: x<=32

Parameter type: <Sip::sipDNSServerPort>


Format:
- range: [1...65534]

mandatory parameter
The administrative domain name
of the DNS server. The
administrative domain might be
the VoIP Access Seeker Network
or the Connectivity Serving
Network.
optional parameter with default
value: 53
The remote port of sip DNS
server, a value 0 means use
default value 53

Released

947

39 Voice Configuration Commands

39.16 Voice Sip DHCP Authentication Params


Configuration Commands
Command Description
This command allows the operator to manage the Voice Sip DHCP authentication params.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip ( no dhcp-authent-para (ua-name) secret-id <Sip::DHCPAuthentParaSecretId> ) | (
dhcp-authent-para
(ua-name)
secret-id
<Sip::DHCPAuthentParaSecretId>
[
no
key
|
key
<Sip::DHCPAuthentParaKey> ] [ no action-type | action-type <Sip::DHCPAuthentParaActionType> ] )

Command Parameters
Table 39.16-1 "Voice Sip DHCP Authentication Params Configuration Commands" Resource
Parameters
Resource Identifier

Type

Description

(ua-name)

Format:
- uniquely identifies the User Agent
- length: 1<=x<=32
Parameter type: <Sip::DHCPAuthentParaSecretId>
Format:
- Unique identifier of the DHCP message authentication
parameter record
- range: [1...4294967295]

uniquely identify of the user


agent

secret-id

A unique identifier of the DHCP


message authentication parameter
record

Table 39.16-2 "Voice Sip DHCP Authentication Params Configuration Commands" Command
Parameters
Parameter

Type

Description

[no] key

Parameter type: <Sip::DHCPAuthentParaKey>


Format:
- DHCP secret key used for DHCP message authentication.
Every letter in key must be in '0'~'9', 'a'~'f', 'A'~'F' and the
string length must be even.
- length: x<=32

[no] action-type

Parameter type: <Sip::DHCPAuthentParaActionType>


Format:
( normal-req-key
| force-discover

optional parameter with default


value: ""
DHCP secret key used for DHCP
message authentication. Every
letter in key must be in '0'~'9',
'a'~'f', 'A'~'F' and the string length
must be even.
optional parameter with default
value: "normal-send-req"
the action type for the configured
DHCP secret keys

948

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

| force-request
| normal-force-dis
| normal-force-req )
Possible values:
- normal-req-key : used when send DHCP request, not used
for response
- force-discover : used when force renew received with this
key, will send DHCP discover
- force-request : used when force renew received with this
key, will send DHCP renew request
- normal-force-dis : used when send DHCP request, not used
for response, and when force renew received with this key,
will send DHCP discover
- normal-force-req : used when send DHCP request, not
used for response, and when force renew received with this
key, will send DHCP renew request

3HH-04416-EBAA-TCZZA 01

Released

949

39 Voice Configuration Commands

39.17 Voice Sip Restoration Failover/Failback


Type/Mode Configuration Commands
Command Description
This command allows the operator to change the Failover/Failback type or mode.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip redundancy-cmd (domain-name) [ no start-time | start-time <Sip::FailXStartTime> ] [ no
end-time | end-time <Sip::FailXEndTime> ] [ fail-x-type <Sip::FailXType> ]

Command Parameters
Table 39.17-1 "Voice Sip Restoration Failover/Failback Type/Mode Configuration Commands"
Resource Parameters
Resource Identifier

Type

Description

(domain-name)

Format:
- provider name,Currently supports only vsp1
- length: x<=32

uniquely identify
domain name

of

admin

Table 39.17-2 "Voice Sip Restoration Failover/Failback Type/Mode Configuration Commands"


Command Parameters
Parameter

Type

Description

[no] start-time

Parameter type: <Sip::FailXStartTime>


Format:
- an unsigned integer
Parameter type: <Sip::FailXEndTime>
Format:
- an unsigned integer
Parameter type: <Sip::FailXType>
Format:
( geo-fail-over
| geo-fail-back )
Possible values:
- geo-fail-over : geo fail over
- geo-fail-back : geo fail back

optional parameter with default


value: 0
Fail X start time.
optional parameter with default
value: 0
Fail X end time.
optional parameter
Fail X type, failover or failback.

[no] end-time
fail-x-type

950

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.18 Voice Statistics Configure Command


Command Description
Set statistics configuration.

User Level
The command can be accessed by operators with sip privileges, and executed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> configure voice sip statistics stats-config [ [ no ] per-line ] [ [ no ] per-board ] [ [ no ] per-system ] [ [ no ] per-call
] [ [ no ] out-any-rsp ] [ [ no ] out-180-rsp ] [ [ no ] out-200-rsp ] [ [ no ] in-any-rsp ] [ [ no ] in-180-rsp ]

Command Parameters
Table 39.18-2 "Voice Statistics Configure Command" Command Parameters
Parameter

Type

Description

[no] per-line

Parameter type: boolean

[no] per-board

Parameter type: boolean

[no] per-system

Parameter type: boolean

[no] per-call

Parameter type: boolean

[no] out-any-rsp

Parameter type: boolean

[no] out-180-rsp

Parameter type: boolean

[no] out-200-rsp

Parameter type: boolean

[no] in-any-rsp

Parameter type: boolean

[no] in-180-rsp

Parameter type: boolean

optional parameter
enable per line statistics function
optional parameter
enable per board statistics
function
optional parameter
enable per system statistics
function
optional parameter
enable per call statistics function
optional parameter
enable Arbitrary Response Mode
for out-going call answered
optional parameter
enable 180 Response Mode for
out-going call answered
optional parameter
enable 200 Response Mode for
out-going call answered
optional parameter
enable Arbitrary Response Mode
for in-coming call answered
optional parameter
enable 180 Response Mode for
in-coming call answered

3HH-04416-EBAA-TCZZA 01

Released

951

39 Voice Configuration Commands

39.19 Voice Cluster Configuration Commands


Command Description
This command allows the operator to manage the Voice Cluster.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id)

Command Parameters
Table 39.19-1 "Voice Cluster Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

952

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.20 Voice Megaco IP Configuration Commands


Command Description
This command allows the operator to manage the Voice Megaco xvps ip.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ip [ ivps-ip <Ip::V4Address> ] [ netmask <Ip::V4Address> ] [ router-ip
<Ip::V4Address> ] [ vlan-id <MEGACO::ivpsXLESVLAN> ] [ no private-ip | private-ip <Ip::V4Address> ] [ no
private-netmask | private-netmask <Ip::V4Address> ] [ no private-vlan-id | private-vlan-id
<MEGACO::ivpsPrivateVLAN> ]

Command Parameters
Table 39.20-1 "Voice Megaco IP Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

Table 39.20-2 "Voice Megaco IP Configuration Commands" Command Parameters


Parameter

Type

Description

ivps-ip

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

netmask

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

router-ip

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

optional parameter
xles ip address of this xvps
cluster.When operator configure
Ip parameters first time ,operator
should provide ivps-ip,netmask
and vlan-id at the same time.
optional parameter
xles ip subnet mask address of
this xvps cluster.When operator
configure Ip parameters first time
,operator
should
provide
ivps-ip,netmask and vlan-id at the
same time.
optional parameter
the next hop ip address of this
xvps
cluster.When
operator
configure Ip parameters first time
,operator
should
provide
ivps-ip,netmask and vlan-id at the

3HH-04416-EBAA-TCZZA 01

Released

953

39 Voice Configuration Commands

Parameter

Type

vlan-id

Parameter type: <MEGACO::ivpsXLESVLAN>


Format:
- the vlan id of xvps
- range: [0...4093]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

[no] private-ip

Description

[no] private-netmask

Parameter type: <Ip::V4Address>


Format:
- IPv4-address

[no] private-vlan-id

Parameter type: <MEGACO::ivpsPrivateVLAN>


Format:
- the private vlan id of xvps
- range: [0...4093]

954

Released

same time.
optional parameter
vlan id of voice xvps cluster
optional parameter with default
value: "0.0.0.0"
the private ip address of voice
xvps
cluster.When
operator
configure Ip parameters first time
,operator
should
provide
ivps-ip,netmask and vlan-id at the
same time.
optional parameter with default
value: "0.0.0.0"
the private ip subnet mask
address
of
voice
xvps
cluster.When operator configure
Ip parameters first time ,operator
should provide ivps-ip,netmask
and vlan-id at the same time.
optional parameter with default
value: 0
the private vlan of voice xvps
cluster.When operator configure
Ip parameters first time ,operator
should provide ivps-ip,netmask
and vlan-id at the same time.

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.21 Voice Megaco Equipment Configuration


Commands
Command Description
This command allows the operator to manage the Voice equipment.One ivps can manage at most 256
equipments,so the id of equipment is from 1 to 256.
If you want to configure a board or a termination ,you must configure a equipment first.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ( no equipment (equip-id) ) | ( equipment (equip-id) asam-id
<MEGACO::accessEquipmentAsamId> ip-address <Ip::V4Address> [ no next-hop | next-hop <Ip::V4Address> ] )

Command Parameters
Table 39.21-1 "Voice Megaco Equipment Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]

uniquely identify of this xvps


cluster

(equip-id)

uniquely
identify
equipment

of

this

Table 39.21-2 "Voice Megaco Equipment Configuration Commands" Command Parameters


Parameter

Type

Description

asam-id

Parameter type: <MEGACO::accessEquipmentAsamId>


Format:
- the equipment asam id of ne
- range: [a-zA-Z0-9-_./]
- length: x<=64
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

mandatory parameter
asam identify of this ne

ip-address

[no] next-hop

3HH-04416-EBAA-TCZZA 01

Parameter type: <Ip::V4Address>


Format:

mandatory parameter
The parameter is not visible
during modification.
the voice ip address of this
isam-v ne
optional parameter with default
value: "0.0.0.0"

Released

955

39 Voice Configuration Commands

Parameter

956

Released

Type

Description

- IPv4-address

the ip address of the next hop for


this isam-v ne

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.22 Voice Megaco Equipment Board


Configuration Commands
Command Description
This command allows the operator to manage the Voice board.Before you confiure a board,you must configure a
equipment first.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) ( no board (board-id) ) | ( board (board-id) planned-type
<Equipm::BoardFuncType> lanx-port <MEGACO::accessBoardLanxPort> )

Command Parameters
Table 39.22-1 "Voice Megaco Equipment Board Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number

uniquely identify of this xvps


cluster

(equip-id)
(board-id)

uniquely
identify
equipment

of

uniquely identify of this board.


the CLI slot numbering method is
based on logical concept.for XD
shelf, CLI logic slot-id(1 to 16) is
mapped to physical slot-id from 4
to 19. for FD shelf, CLI logic
slot-id(1 to 16) is mapped to
physical slot-id from 1 to 8 and
12 to 19. In extend-lt mode, the
slot-id range shall be 1 to 18.For
XD shelf, CLI logic slot-id(17 to
18) is mapped to physical slot-id
from 2 to 3. for FD shelf, CLI
logic slot-id(17 to 18) is mapped
to physical slot-id from 10 to 11

Table 39.22-2 "Voice Megaco Equipment Board Configuration Commands" Command Parameters

3HH-04416-EBAA-TCZZA 01

this

Released

957

39 Voice Configuration Commands

Parameter

Type

Description

planned-type

Parameter type: <Equipm::BoardFuncType>


Format:
( nbat-b
| nbat-a
| npot-a
| nvps-a
| polt-b
| npot-b
| npot-c
| ivps-b
| balt-a
| ivps-a
| polt-a
| isdn-24l
| pots-48l )
Possible values:
- nbat-b : ISDN Basic Access line termination board for FD
(4B3T)
- nbat-a : ISDN Basic Access line termination board for FD
- npot-a : 48 Pots Only LT board for FD
- nvps-a : Isam Voice Packet Server for FD
- polt-b : 48 Pots Only LT board for XD
- npot-b : 72 Pots Only LT board for FD
- npot-c : 48 Pots Only LT board for FD
- ivps-b : Isam Voice Packet Server for XD
- balt-a : 48 ISDN Only LT board for XD
- ivps-a : Isam Voice Packet Server for XD
- polt-a : 48 Pots Only LT board for XD
- isdn-24l : 24 ISDN LT board for XD/FD, only for
migration, can not be configured
- pots-48l : 48 Pots LT board for XD/FD, only for migration,
can not be configured
Parameter type: <MEGACO::accessBoardLanxPort>
Format:
- the logic slot of board
- range: [1...32]

mandatory parameter
the type of user board

lanx-port

958

Released

mandatory parameter
The parameter is not visible
during modification.
the logic slot of this board

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.23 Voice Megaco Equipment Termination


Configuration Commands
Command Description
This command allows the operator to manage the Voice termination.Before you configure a termination ,you must
configure a equipment first.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) ( no termination (port-id) ) | ( termination (port-id) [ no
type
|
type
<MEGACO::accTerminationUserPortType>
]
[
no
isdn-codec
|
isdn-codec
<MEGACO::IsdnCodecType> ] [ no switch-type | switch-type <MEGACO::accTerminationPacketSwitchType> ] [
no activate-type | activate-type <MEGACO::accTerminationL1ActivateType> ] [ termination-id
<MEGACO::accessTerminationId> ] media-gateway-id <MEGACO::MediaGatewayId> [ no admin-status |
admin-status
<MEGACO::accTerminationAdminStatus>
]
[
no
line-feed
|
line-feed
<MEGACO::accTerminationLineCharact> ] [ no rx-gain | rx-gain <MEGACO::accTerminationRxGain> ] [ no
tx-gain
|
tx-gain
<MEGACO::accTerminationTxGain>
]
[
no
impedance
|
impedance
<MEGACO::accTerminationImpedance> ] [ no rtp-dscp | rtp-dscp <MEGACO::accTerminationVoiceDscp> ] [ no
rtp-pbits | rtp-pbits <MEGACO::accTerminationVoiceDot1P> ] [ no clip-mode | clip-mode
<MEGACO::accTerminationETSIClipDataMode>
]
[
no
metering-type
|
metering-type
<MEGACO::accTerminationMeteringPulseType>
]
[
no
directory-number
|
directory-number
<MEGACO::accTerminationDirectoryNumber> ] )

Command Parameters
Table 39.23-1 "Voice Megaco Equipment Termination Configuration Commands" Resource
Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]
Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> /
<Eqpt::MegacoPortId>
Field type <Eqpt::RackId>
- the rack number

uniquely identify of this xvps


cluster

(equip-id)
(port-id)

3HH-04416-EBAA-TCZZA 01

uniquely
identify
equipment

of

this

unique
identifier
termination port

of

this

Released

959

39 Voice Configuration Commands

Resource Identifier

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

Table 39.23-2 "Voice Megaco Equipment Termination Configuration Commands" Command


Parameters
Parameter

Type

Description

[no] type

Parameter
type:
<MEGACO::accTerminationUserPortType>
Format:
( pstn
| isdn )
Possible values:
- pstn : the termination type is pstn
- isdn : the termination type is isdn
Parameter type: <MEGACO::IsdnCodecType>
Format:
( alaw
| ulaw )
Possible values:
- alaw : the codec type on TDM side of isdn is a_law
- ulaw : the codec type on TDM side of isdn is u_law
Parameter
type:
<MEGACO::accTerminationPacketSwitchType>
Format:
( enable
| disable )
Possible values:
- enable : the packet switch type is enable
- disable : the packet switch type is disable
Parameter
type:
<MEGACO::accTerminationL1ActivateType>
Format:
( permanent
| percall )
Possible values:
- permanent : the layer1 activate type is permanent
- percall : the layer1 activate type is percall
Parameter type: <MEGACO::accessTerminationId>
Format:
- the termination id
- range: [0...32767]
Parameter type: <MEGACO::MediaGatewayId>
Format:
- the media gateway table index
- range: [1]
Parameter type: <MEGACO::accTerminationAdminStatus>
Format:
( locked
| unlocked )
Possible values:
- locked : the admin status of termination is locked
- unlocked : the admin status of termination is unlocked
Parameter type: <MEGACO::accTerminationLineCharact>

optional parameter with default


value: "pstn"
The type of termination user port

[no] isdn-codec

[no] switch-type

[no] activate-type

termination-id

media-gateway-id

[no] admin-status

[no] line-feed

960

Released

optional parameter with default


value: "alaw"
the type of isdn codec on TDM
side

optional parameter with default


value: "disable"
The type of the packet switch
type, only for type isdn

optional parameter with default


value: "permanent"
The type of the layer1 activate
type, only for type isdn

optional parameter
The id of termination, if not
entered during creating, it will be
assigned by system
mandatory parameter
The id of media gateway
optional parameter with default
value: "locked"
The administrative status of
termination

optional parameter with default

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] rx-gain

[no] tx-gain

[no] impedance

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( 25
| 40 )
Possible values:
- 25 : the line character is 25 mA
- 40 : the line character is 40 mA
Parameter type: <MEGACO::accTerminationRxGain>
Format:
- the termination rx-gain
- range: [-14...6]
Parameter type: <MEGACO::accTerminationTxGain>
Format:
- the termination tx-gain
- range: [-14...6]
Parameter type: <MEGACO::accTerminationImpedance>
Format:
( default
| 200
| 220
| 220minisplitter
| 270
| 300
| 370
| 600
| 900
| 370minisplitter
| 600splitter
| 370nvlsasplitter
| 370skinnysplitter
| 270duratelsplitter
| 2703msplitter
| reserv3
| reserv17
| reserv18 )
Possible values:
- default : the impedance is default vaule
- 200 : the line impedance is 200 ohm
- 220 : the line impedance is 220 ohm
- 220minisplitter : the line impedance is 220 ohm+
miniSplitter
- 270 : the line impedance is 270 ohm
- 300 : the line impedance is 300 ohm
- 370 : the line impedance is 370 ohm
- 600 : the line impedance is 600 ohm
- 900 : the line impedance is 900 ohm
- 370minisplitter : the line impedance is 370 ohm+
miniSplitter
- 600splitter : the line impedance is 600 ohm+ Splitter
- 370nvlsasplitter : the line impedance is 370 ohm+
NVLSASplitter
- 370skinnysplitter : the line impedance is 370 ohm+
SkinnySplitter
- 270duratelsplitter : the line impedance is 270 ohm+
DuratelSplitter
- 2703msplitter : the line impedance is 270 ohm+
3MDplitter
- reserv3 : reserved for future use 3

value: "25"
The line character of this
termination, only for type pstn

optional parameter with default


value: "0"
The rx-gain of this termination,
only for type pstn
optional parameter with default
value: "0"
The tx-gain of this termination,
only for type pstn
optional parameter with default
value: "default"
The
impedance
of
this
termination, only for type pstn

Released

961

39 Voice Configuration Commands

Parameter

Type

[no] rtp-dscp

[no] rtp-pbits

[no] clip-mode

[no] metering-type

[no] directory-number

962

Released

Description

- reserv17 : reserved for future use 17


- reserv18 : reserved for future use 18
Parameter type: <MEGACO::accTerminationVoiceDscp>
Format:
- the termination voice dscp
- range: [-1...63]
Parameter type: <MEGACO::accTerminationVoiceDot1P>
Format:
- the termination voice p-bit
- range: [-1...7]
Parameter
type:
<MEGACO::accTerminationETSIClipDataMode>
Format:
( cdevalue
| fsk
| dtmf )
Possible values:
- cdevalue : cde configuration will be applied for etsi clip
- fsk : fsk will be applied for etsi clip
- dtmf : dtmf will be applied for etsi clip
Parameter
type:
<MEGACO::accTerminationMeteringPulseType>
Format:
( pulse
| polarityreverse )
Possible values:
- pulse : 12/16 KHz sine waveform pulse will be applied for
metering pulse
- polarityreverse : line polarity reverse pulse will be applied
for metering pulse
Parameter
type:
<MEGACO::accTerminationDirectoryNumber>
Format:
- the termination directory number.'#' is invalid character
- length: 1<=x<=16

optional parameter with default


value: "-1"
the voice dscp of termination
optional parameter with default
value: "-1"
the voice p-bit of termination
optional parameter with default
value: "cdevalue"
the etsi clip data transmission
protocol
of
this
access
termination,it can only be
configured in pstn line cards

optional parameter with default


value: "pulse"
the metering pulse type of this
access termination,it can only be
configured on pstn line

optional parameter with default


value: ""
the directory number of this
access termination,it can be
configured on pstn and ISDN BA
line

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.24 Voice Megaco Termination Configuration


Commands
Command Description
This command allows the operator to enable/disable tca or configure the threshold for rtp packetloss, jitter and
delay of the Voice termination.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) equipment (equip-id) termination (port-id) tca [ no tca-enable | tca-enable
<MEGACO::accTerminationTCAEnable>
]
[
no
rtp-pktloss-thres
|
rtp-pktloss-thres
<MEGACO::accTerminationRtpPacketLossTCAThreshold>
]
[
no
rtp-jitter-thres
|
rtp-jitter-thres
<MEGACO::accTerminationRtpJitterTCAThreshold>
]
[
no
rtp-delay-thres
|
rtp-delay-thres
<MEGACO::accTerminationRtpDelayTCAThreshold> ]

Command Parameters
Table 39.24-1 "Voice Megaco Termination Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]
Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> /
<Eqpt::MegacoPortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

uniquely identify of this xvps


cluster

(equip-id)
(port-id)

uniquely
identify
equipment

of

this

unique
identifier
termination port

of

this

Table 39.24-2 "Voice Megaco Termination Configuration Commands" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

963

39 Voice Configuration Commands

Parameter

Type

Description

[no] tca-enable

Parameter type: <MEGACO::accTerminationTCAEnable>


Format:
( enabled
| disabled )
Possible values:
- enabled : enable tca alarm report
- disabled : disable tca alarm report
Parameter
type:
<MEGACO::accTerminationRtpPacketLossTCAThreshold>
Format:
- the packet loss threshold for the termination
- range: [0...100]

optional parameter with default


value: "disabled"
Allows to enable/disable the
Threshold
Crossing
Alarm
feature for this termination

[no] rtp-pktloss-thres

[no] rtp-jitter-thres

[no] rtp-delay-thres

964

Released

optional parameter with default


value: 1
the rtp packet loss threshold of
this megaco termination,a value 0
means TCA_packetloss will be
disabled
Parameter
type: optional parameter with default
<MEGACO::accTerminationRtpJitterTCAThreshold>
value: 60
Format:
the rtp interarrival jitter threshold
- the interarrival jitter threshold for the termination
of this megaco termination,a
- unit: millisec
value 0 means TCA_jitter will be
- range: [0...2147483647]
disabled
Parameter
type: optional parameter with default
<MEGACO::accTerminationRtpDelayTCAThreshold>
value: 400
Format:
the rtp round trip delay threshold
- the round trip delay threshold for the termination
of this megaco termination,a
- unit: millisec
value 0 means TCA_delay will
- range: [0...2147483647]
be disabled

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

39.25 Voice Megaco Media Gateway Configuration


Commands
Command Description
This command allows the operator to manage the Voice Megaco media gateway.
- pstn-term-format: the termination id format pattern of pstn user.
If termid-type is hierarchy, It should be a string constructed according to the following rule:
[prefix][['Dslam_Id'][deli1]][['rack'][formater][deli2]]'shelf'[formater][deli3]'slot'[formater][deli4]'port'[formater]
and thereinto:
'Dslam_Id' is key to indicate whether the Dslam id should be filled into hierarchy termination id. It is optional.
'rack' is key to indicate whether the rack id should be filled into hierarchy termination id. It is optional.
'shelf' is key to indicate the shelf id. It is mandatory.
'slot' is key to indicate the slot id. It is mandatory.
'port' is key to indicate the port id. It is mandatory.
Each key should present only once and the order of the keys should keep as in the rule.
deli can be zero or several characters, be note that the char must be valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it. It must be
constructed by zero or at most five digits. The number of digits indicate the minimum width of the id
in the termination id, so if the width of the id is less than number of digits in formater, '0' is
filling at the beginning. The value that converted by the digits into a integer indicates the value of
the first device NO. in the termination id. If the no digit existing, it indicates that no format need to
be applied.
prefix is a string constructed by any character that is valid for MEGACO termination id.
At least one of the deli and the formater must be presenting after the key(exclude 'Dslam_Id').
for example:
format string port position termination id
(dslamid/rack/shelf/slot/port)
------------------------------------------------------------------AL/Dslam_Id/rack/shelf/slot/port nod01/1/1/1/1 AL/nod01/1/1/1/1
AL/Dslam_Id/shelf/slot/port nod01/1/1/1/1 AL/nod01/1/1/1
AL/rack/shelf/slot/port nod01/1/1/1/1 AL/1/1/1/1
AL/rack0/shelf0/slot0/port00 nod01/1/1/1/1 AL/0/0/0/00
ALDslam_Idrack0shelf0slot0port00 nod01/1/1/1/1 ALnod0100000
ALDslam_Idrack0shelf0slot0port0 nod01/1/1/1/12 ALnod0100012

3HH-04416-EBAA-TCZZA 01

Released

965

39 Voice Configuration Commands

------------------------------------------------------------------If the termid-type is flat,It should be a string constructed according to the following rule:
[prefix]['<tid'[formater]'>']
and thereinto:
prefix is a string construct by any character that is valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it.
It must be constructed by zero or at most five digits. The number of digits indicat the
minimum width of the id in the termination id,If contains no digit, it indicat that no
format need to be applied. for example:
format string port position termination id
(termination-id)
-----------------------------------------------AL/ 0 AL/0
AL 0 AL0
AL<tid000> 0 AL000
AL<tid000> 888 AL888
------------------------------------------------- isdn-term-format: the termination id format pattern of isdn user.
If termid-type is hierarchy, It should be a string constructed according to the following rule:
[prefix][['Dslam_Id'][deli1]][['rack'][formater][deli2]]'shelf'[formater][deli3]'slot'[formater]
[deli4]'port'[formater]][deli4]'channel'
and thereinto:
'Dslam_Id' is key to indicate whether the Dslam id should be filled into hierarchy termination id.
It is optional.
'rack' is key to indicate whether the rack id should be filled into hierarchy termination id.
It is optional.
'shelf' is key to indicate the shelf id. It is mandatory.
'slot' is key to indicate the slot id. It is mandatory.
'port' is key to indicate the port id. It is mandatory.
'channel' is key to indicate channel id. It is mandatory.
Each key should present only once and the order of the keys should keep as in the rule.
deli can be zero or several characters, be note that the char must be valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it. It must be
constructed by zero or at most five digits. The number of digits indicate the minimum width of the id
in the termination id, so if the width of the id is less than number of digits in formater, '0' is
filling at the beginning. The value that converted by the digits into a integer indicates the value of
the first device NO. in the termination id. If the no digit existing, it indicates that no format need to
be applied. suffix already includes delimiter, so deli4 is will be replaced by suffix.

966

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

prefix is a string constructed by any character that is valid for MEGACO termination id.
At least one of the deli and the formater must be presenting after the key(exclude 'Dslam_Id').
for example:
format string port position termination id
(dslamid/rack/shelf/slot/port suffix)
-------------------------------------------------------------------------------------BA/Dslam_Id/rack/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/nod01/1/1/1/1/B1
BA/Dslam_Id/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/nod01/1/1/1/B1
BA/rack/shelf/slot/port/channel nod01/1/1/1/1 /B1 BA/1/1/1/1/B1
BA/rack0/shelf0/slot0/port00/channel/channel nod01/1/1/1/1 /B1 BA/0/0/0/00/B1
BADslam_Idrack0shelf0slot0port00 nod01/1/1/1/1 /B1 BAnod0100000/B1
BADslam_Idrack0shelf0slot0port0/channel nod01/1/1/1/12 B1 BAnod0100012B1
------------------------------------------------------------------------------------If the termid-type is flat,It should be a string constructed according to the following rule:
[prefix]['<tid'[formater]'>']
and thereinto:
prefix is a string construct by any character that is valid for MEGACO termination id.
formater is a format string to indicate how ISAMV should format the id right before it.It must be
constructed by zero or at most five digits. The number of digits indicat the minimum width of the id
in the termination id,If contains no digit, it indicat that no format need to be applied. ISDN
termination id should not be zero because zero is reserved for special use of IID.
for example:
format string port position termination id
(termination-id sufix)
---------------------------------------------------BA/ 1 /B1 BA/1/B1
BA 1 /B1 BA1/B1
BA<tid000> 1 /B1 BA001/B1
BA<tid000> 888 /B1 BA888/B1
----------------------------------------------------

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ( no media-gateway (media-gateway-id) ) | ( media-gateway

3HH-04416-EBAA-TCZZA 01

Released

967

39 Voice Configuration Commands

(media-gateway-id) [ no name | name <MEGACO::mediaGatewayName> ] ip-address <Ip::V4Address> netmask


<Ip::V4Address> [ no udp-port | udp-port <MEGACO::mediaGatewayUDPPort> ] [ no router-ip | router-ip
<Ip::V4Address>
]
vlan-id
<MEGACO::mediaGatewayVLAN>
[
no
mgc-type
|
mgc-type
<MEGACO::mediaGatewayMgcType> ] prim-mgc-ip <Ip::V4Address> [ no mgc-id | mgc-id
<MEGACO::medGwyCtrlrCallServerId>
]
[
no
prim-mgc-udp
|
prim-mgc-udp
<MEGACO::medGwyCtrlrPrimaryUDPPort> ] [ no sec-mgc-ip | sec-mgc-ip <Ip::V4Address> ] [ no sec-mgc-udp |
sec-mgc-udp <MEGACO::medGwyCtrlrSecondaryUDPPort> ] [ no tert-mgc-ip | tert-mgc-ip <Ip::V4Address> ] [
no tert-mgc-udp | tert-mgc-udp <MEGACO::medGwyCtrlrTertiaryUDPPort> ] [ no quat-mgc-ip | quat-mgc-ip
<Ip::V4Address> ] [ no quat-mgc-udp | quat-mgc-udp <MEGACO::medGwyCtrlrQuaternaryUDPPort> ] [ no
esa-mgc-service | esa-mgc-service <MEGACO::mediaGatewayESAMgcService> ] [ no mg-mid-type |
mg-mid-type <MEGACO::mediaGatewayMidType> ] [ no mg-domain-name | mg-domain-name
<MEGACO::mediaGatewayDomainName>
]
[
no
svcreason-format
|
svcreason-format
<MEGACO::mediaGatewaySVCReasonFormat>
]
[
no
mg-profile-name
|
mg-profile-name
<MEGACO::mediaGatewayProfileName>
]
[
no
admin-status
|
admin-status
<MEGACO::mediaGatewayadminStatus> ] [ no termid-type | termid-type <MEGACO::mediaGwyTermFormat> ]
[ no pstn-term-format | pstn-term-format <MEGACO::mediaGwyPstnTermFormat> ] [ isdn-term-format
<MEGACO::mediaGwyIsdnTermFormat> ] [ isdn-suffix1 <MEGACO::mediaGwyIsdnSuffix> ] [ isdn-suffix2
<MEGACO::mediaGwyIsdnSuffix> ] [ no max-transhandling | max-transhandling <MEGACO::mediaGwyTMax>
] [ no max-network-delay | max-network-delay <MEGACO::mediaGwyMaxNetworkDelay> ] [ no max-retrans |
max-retrans
<MEGACO::mediaGwyMaxRetrans>
]
[
no
red-bat-delay
|
red-bat-delay
<MEGACO::mediaGwyRedBatteryDelay>
]
[
no
release-delay
|
release-delay
<MEGACO::mediaGwyReleaseDelay> ] [ no release-type | release-type <MEGACO::mediaGwyReleaseType> ] [
no wt-rls-delay | wt-rls-delay <MEGACO::mediaGwyWaitingReleaseDelay> ] [ no active-heartbeat |
active-heartbeat <MEGACO::mediaGwyHeartBeat> ] [ no passive-heartbeat | passive-heartbeat
<MEGACO::mediaGwyHeartBeat> ] [ no retrans | retrans <MEGACO::mediaGwyRetrans> ] [ no
max-waiting-delay | max-waiting-delay <MEGACO::mediaGwyMaxWaitingDelay> ] [ no prov-rpl-time |
prov-rpl-time
<MEGACO::mediaGwyProvResp>
]
[
no
signal-dscp
|
signal-dscp
<MEGACO::mediaGatewaySignDscp> ] [ no signal-pbits | signal-pbits <MEGACO::mediaGatewaySignDot1P> ] [
no rtp-dscp | rtp-dscp <MEGACO::mediaGatewayVoiceDscp> ] [ no rtp-pbits | rtp-pbits
<MEGACO::mediaGatewayVoiceDot1P> ] [ no event-req-id | event-req-id <MEGACO::medGwyEventRequestId>
] [ [ no ] stml-stdsg-evt ] [ [ no ] al-of-evt ] [ [ no ] al-on-evt ] [ [ no ] al-of-strict-evt ] [ [ no ] al-on-strict-evt ] [ [ no
] mg-overload-evt ] [ [ no ] mg-dummy-evt ] [ no rfc2833-pl-type | rfc2833-pl-type
<MEGACO::mediaGatewayRfc2833PayloadType>
]
[
no
rfc2833-process
|
rfc2833-process
<MEGACO::mediaGatewaytRfc2833Process>
]
[
no
dial-start-timer
|
dial-start-timer
<MEGACO::mediaGatewayDialStartTimer>
]
[
no
dial-long-timer
|
dial-long-timer
<MEGACO::mediaGatewayDialLongTimer>
]
[
no
dial-short-timer
|
dial-short-timer
<MEGACO::mediaGatewayDialShortTimer>
]
[
no
min-data-jitter
|
min-data-jitter
<MEGACO::mediaGatewayDataJitter>
]
[
no
init-data-jitter
|
init-data-jitter
<MEGACO::mediaGatewayDataJitter>
]
[
no
max-data-jitter
|
max-data-jitter
<MEGACO::mediaGatewayDataJitter>
]
[
no
ephe-term-prefix
|
ephe-term-prefix
<MEGACO::mediaGatewayEpheTermPrefix>
]
[
no
ephe-term-min
|
ephe-term-min
<MEGACO::mediaGatewayEpheTerm>
]
[
no
ephe-term-max
|
ephe-term-max
<MEGACO::mediaGatewayEpheTerm> ] )

Command Parameters
Table 39.25-1 "Voice Megaco Media Gateway Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- the media gateway table index
- range: [1]

uniquely identify of this xvps


cluster

(media-gateway-id)

uniquely identify of this media


gateway

Table 39.25-2 "Voice Megaco Media Gateway Configuration Commands" Command Parameters

968

Released

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

Description

[no] name

Parameter type: <MEGACO::mediaGatewayName>


Format:
- uniquely name of this media gateway
- length: 1<=x<=64

ip-address

Parameter type: <Ip::V4Address>


Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <MEGACO::mediaGatewayUDPPort>
Format:
- the udp port of media gateway
- range: [1025...65534]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

optional parameter with default


value: "AG"
device name of media gateway,
can be modified when mgi is
locked, this parameter will be
used for mg mid when
mg-mid-type select device-name.
only '*', '/', '_', '$', '@', 'ALPHA',
'DIGIT', '-', '.' are valid for
device-name.
mandatory parameter
the ip address of this media
gateway
mandatory parameter
the netmask of this media
gateway
optional parameter with default
value: 2944
the udp port of mgi

netmask
[no] udp-port

[no] router-ip

vlan-id

[no] mgc-type

3HH-04416-EBAA-TCZZA 01

Parameter type: <MEGACO::mediaGatewayVLAN>


Format:
- the vlan id of media gateway
- range: [1...4093]
Parameter type: <MEGACO::mediaGatewayMgcType>
Format:
( general
| lucent-fs5000
| alcatel-a5020
| alcatel-e10
| zte-zxss
| hw-soft3000
| siemens
| nortel
| ericsson
| meta-softswitch
| italtel
| comverse
| g6-gr303
| other-vendor3
| other-vendor4
| other-vendor16
| other-vendor17 )
Possible values:
- general : The type of mgc is general
- lucent-fs5000 : The type of mgc is lucent-fs5000
- alcatel-a5020 : The type of mgc is alcatel-a5020
- alcatel-e10 : The type of mgc is alcatel-e10
- zte-zxss : The type of mgc is zte-zxss
- hw-soft3000 : The type of mgc is hw-soft3000
- siemens : The type of mgc is siemens
- nortel : The type of mgc is nortel
- ericsson : The type of mgc is ericsson

optional parameter with default


value: "0.0.0.0"
the next hop ip address of media
gateway
mandatory parameter
the vlan id of this xvps cluster
optional parameter with default
value: "general"
the type of media gateway
controller

Released

969

39 Voice Configuration Commands

Parameter

Type

prim-mgc-ip
[no] mgc-id

[no] prim-mgc-udp

Parameter
<MEGACO::medGwyCtrlrPrimaryUDPPort>
Format:
- the primary udp port of media gateway controller
- range: [1...65534]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

[no] sec-mgc-ip

[no] sec-mgc-udp

Parameter
<MEGACO::medGwyCtrlrSecondaryUDPPort>
Format:
- the secondary udp port of media gateway controller
- range: [1...65534]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

[no] tert-mgc-ip

[no] tert-mgc-udp

Parameter
<MEGACO::medGwyCtrlrTertiaryUDPPort>
Format:
- the tertiary udp port of media gateway controller
- range: [1...65534]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

[no] quat-mgc-ip

[no] quat-mgc-udp

[no] esa-mgc-service

[no] mg-mid-type

970

Description

- meta-softswitch : The type of mgc is meta-softswitch


- italtel : The type of mgc is italtel
- comverse : The type of mgc is comverse
- g6-gr303 : The type of mgc is g6-gr303
- other-vendor3 : The type of mgc is other-vendor3
- other-vendor4 : The type of mgc is other-vendor4
- other-vendor16 : The type of mgc is other-vendor16
- other-vendor17 : The type of mgc is other-vendor17
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <MEGACO::medGwyCtrlrCallServerId>
Format:
- a signed integer

Released

mandatory parameter
the ip address of the primary
media gateway controller
optional parameter with default
value: 0
the identifier of the peer call
server
type: optional parameter with default
value: 2944
the udp port of primary mgc
optional parameter with default
value: "0.0.0.0"
the ip address of the secondary
media gateway controller
type: optional parameter with default
value: 2944
the udp port of secondary mgc
optional parameter with default
value: "0.0.0.0"
the ip address of the tertiary
media gateway controller
type: optional parameter with default
value: 2944
the udp port of tertiary mgc
optional parameter with default
value: "0.0.0.0"
the ip address of the quaternary
media gateway controller
type: optional parameter with default
value: 2944
the udp port of quaternary mgc

Parameter
<MEGACO::medGwyCtrlrQuaternaryUDPPort>
Format:
- the quaternary udp port of media gateway controller
- range: [1...65534]
Parameter
type:
<MEGACO::mediaGatewayESAMgcService>
Format:
( enable
| disable )
Possible values:
- enable : enable local ESA mgc service
- disable : disable local ESA mgc service
Parameter type: <MEGACO::mediaGatewayMidType>
Format:

optional parameter with default


value: "disable"
the state of local ESA mgc
service

optional parameter with default


value: "ipv4-port"

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] mg-domain-name

[no] svcreason-format

[no] mg-profile-name

[no] admin-status

[no] termid-type

[no] pstn-term-format

3HH-04416-EBAA-TCZZA 01

Type

Description

( ipv4
| ipv4-port
| domain-name
| domain-name-port
| device-name )
Possible values:
- ipv4 : The mg mid type is ipv4
- ipv4-port : The mg mid type is ipv4+port
- domain-name : The mg mid type is domain-name
- domain-name-port : The mg mid type is
domain-name+port
- device-name : The mg mid type is device-name
Parameter type: <MEGACO::mediaGatewayDomainName>
Format:
- domain name of this media gateway
- length: 1<=x<=255

the mid type of this media


gateway: if ipv4 is selected, the
MG ip-address will be used; if
ipv4-port is selected, the MG
ip-address + udp-port will be
used; if domain-name is selected,
the mg-domain-name will be
used; if domain-name-port is
selected, the mg-domain-name +
udp-port will be used; if
device-name is selected, the mg
name will be used for mg mid.
optional parameter with default
value: "isamv.alcatel-lucent.com"
the domain name of media
gateway,
used
when
mg-addr-type is domain-name or
domain-name-port.
only
'ALPHA','DIGIT', '-', '.' ,'@' are
valid for domainName; max
length is 255.
type: optional parameter with default
value: "with-quotation"
The format of service change
reason, which used in H248
service change.

Parameter
<MEGACO::mediaGatewaySVCReasonFormat>
Format:
( with-quotation
| without-quotation )
Possible values:
- with-quotation : the mg service change reason format is
with-quotation
- without-quotation : the mg service change reason format is
without-quotation
Parameter type: <MEGACO::mediaGatewayProfileName>
Format:
- profile name of this media gateway
- length: 1<=x<=64

Parameter type: <MEGACO::mediaGatewayadminStatus>


Format:
( locked
| unlocked )
Possible values:
- locked : The admin status is locked
- unlocked : The admin status is unlocked
Parameter type: <MEGACO::mediaGwyTermFormat>
Format:
( hierarchy
| flat )
Possible values:
- hierarchy : The termination id format is hierarchy
- flat : The termination id format is flat
Parameter type: <MEGACO::mediaGwyPstnTermFormat>
Format:
- the termination id format pattern of pstn user, the
termination id format type has two types:flat and
hierarchy.Flat
type:
example
AL;
AALN;length:
[1...10].Hierarchy
type:
example

optional parameter with default


value: "AGW"
profile name of this media
gateway. which used in h248
message service change. the max
number of the string is 64.
optional parameter with default
value: "locked"
the administrative status of this
media gateway

optional parameter with default


value: 2
termination id format

optional parameter with default


value: "AL"
the termination id format pattern
of pstn user

Released

971

39 Voice Configuration Commands

Parameter

Type

isdn-term-format

isdn-suffix1

isdn-suffix2

[no] max-transhandling

[no] max-network-delay

[no] max-retrans

[no] red-bat-delay

[no] release-delay

[no] release-type

[no] wt-rls-delay

[no] active-heartbeat

972

Released

Description

AL/Dslam_Id/rack/shelf/slot/port (Dslam_Id/rack optional)


length: [1...72].
- length: 1<=x<=72
Parameter type: <MEGACO::mediaGwyIsdnTermFormat>
Format:
- the termination id format pattern of isdn user, the
termination id format type has two types:flat and
hierarchy.Flat type: example BA;length: [1...10]. Hierarchy
type:
example
BA/Dslam_Id/rack/shelf/slot/port/channel(Dslam_Id/rack
optional) length:[1...72].
- length: 1<=x<=72
Parameter type: <MEGACO::mediaGwyIsdnSuffix>
Format:
- the suffix1 of the isdn user termination format
- length: 1<=x<=8
Parameter type: <MEGACO::mediaGwyIsdnSuffix>
Format:
- the suffix1 of the isdn user termination format
- length: 1<=x<=8
Parameter type: <MEGACO::mediaGwyTMax>
Format:
- the max time of mgc handling the transaction
- range: [1000...30000]

optional parameter
the termination id format pattern
of isdn user

optional parameter
the suffix1 of the isdn user
termination format
optional parameter
the suffix2 of the isdn user
termination format

optional parameter with default


value: 16000
the max time of mgc handling the
transaction,
the
unit
is
millisecond
type: optional parameter with default
value: 500
the max network delay time, the
unit is millisecond

Parameter
<MEGACO::mediaGwyMaxNetworkDelay>
Format:
- the max network delay time, the unit is millisecond
- range: [100...1000]
Parameter type: <MEGACO::mediaGwyMaxRetrans>
Format:
- the max retransimit times of the transaction, the unit is
times
- range: [7...11]
Parameter type: <MEGACO::mediaGwyRedBatteryDelay>
Format:
- the delay before MGI coming into reduced battery state
- range: [0...120000]
Parameter type: <MEGACO::mediaGwyReleaseDelay>
Format:
- the delay before mgi releasing all sessions
- unit: millisecond
- range: [0...900000]
Parameter type: <MEGACO::mediaGwyReleaseType>
Format:
( normal
| never )
Possible values:
- normal : release type is normal
- never : release type is never
Parameter
type:
<MEGACO::mediaGwyWaitingReleaseDelay>
Format:
- the delay after the graceful lock delay timer expired
- range: [0...3600000]
Parameter type: <MEGACO::mediaGwyHeartBeat>

optional parameter with default


value: 7
the max retransmit times of the
transaction
optional parameter with default
value: 70000
the delay before mgi coming into
reduced battery state
optional parameter with default
value: 600000
the delay before mgi releasing all
sessions
optional parameter with default
value: "normal"
the type of releasing the active
call

optional parameter with default


value: 0
the delay after the graceful lock
delay timer expired
optional parameter with default

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

[no] passive-heartbeat

[no] retrans

[no] max-waiting-delay

[no] prov-rpl-time

[no] signal-dscp

[no] signal-pbits

[no] rtp-dscp

[no] rtp-pbits

3HH-04416-EBAA-TCZZA 01

Type

Description

Format:
( fix : <MEGACO::mediaGwyHeartBeatInterval>
| dynamic )
Possible values:
- fix : The heart beat mode is fixed
- dynamic : The heart beat mode is dynamic
Field type <MEGACO::mediaGwyHeartBeatInterval>
- the heart beat interval value, if input less than 1s, it will be
set to 1s
- unit: 10 msec
- range: [0...65535]
Parameter type: <MEGACO::mediaGwyHeartBeat>
Format:
( fix : <MEGACO::mediaGwyHeartBeatInterval>
| dynamic )
Possible values:
- fix : The heart beat mode is fixed
- dynamic : The heart beat mode is dynamic
Field type <MEGACO::mediaGwyHeartBeatInterval>
- the heart beat interval value, if input less than 1s, it will be
set to 1s
- unit: 10 msec
- range: [0...65535]
Parameter type: <MEGACO::mediaGwyRetrans>
Format:
( fix : <MEGACO::mediaGwyRetransInterval>
| dynamic )
Possible values:
- fix : The re-transmission mode is fixed
- dynamic : The re-transmission mode is dynamic
Field type <MEGACO::mediaGwyRetransInterval>
- the heart beat interval value
- range: [100...4000]
Parameter type: <MEGACO::mediaGwyMaxWaitingDelay>
Format:
- max time to wait after a restart before contacting to the call
server.
- range: [0...120]
Parameter type: <MEGACO::mediaGwyProvResp>
Format:
- the time need to send a transaction pending
- range: [0...10000]

value: "fix : 0"


the active heart beat mode and
interval

Parameter type: <MEGACO::mediaGatewaySignDscp>


Format:
- the signaling dscp of media gateway
- range: [0...63]
Parameter type: <MEGACO::mediaGatewaySignDot1P>
Format:
- the signaling p-bit of media gateway
- range: [0...7]
Parameter type: <MEGACO::mediaGatewayVoiceDscp>
Format:
- the voice dscp of media gateway
- range: [0...63]
Parameter type: <MEGACO::mediaGatewayVoiceDot1P>
Format:

optional parameter with default


value: "dynamic"
the passive heart beat mode and
interval

optional parameter with default


value: "fix : 4000"
the retransmission mode and
interval

optional parameter with default


value: 5
max time to wait after a restart
before contacting to the call
server
optional parameter with default
value: 1000
the time need to send a
transaction pending since the
reception of the transaction
optional parameter with default
value: "0"
the signaling dscp of this media
gateway
optional parameter with default
value: "0"
the signaling p-bit of this media
gateway
optional parameter with default
value: "0"
the voice dscp of this media
gateway
optional parameter with default
value: "0"

Released

973

39 Voice Configuration Commands

Parameter

Type

Description

[no] stml-stdsg-evt

- the voice p-bit of media gateway


- range: [0...7]
Parameter type: <MEGACO::medGwyEventRequestId>
Format:
- the event request id of this media gateway
- range: [0...65535]
Parameter type: boolean

[no] al-of-evt

Parameter type: boolean

[no] al-on-evt

Parameter type: boolean

[no] al-of-strict-evt

Parameter type: boolean

[no] al-on-strict-evt

Parameter type: boolean

[no] mg-overload-evt

Parameter type: boolean

[no] mg-dummy-evt

Parameter type: boolean

[no] rfc2833-pl-type

Parameter
<MEGACO::mediaGatewayRfc2833PayloadType>
Format:
- payload type according to rfc2833
- range: [96...127]
Parameter
<MEGACO::mediaGatewaytRfc2833Process>
Format:
( audio
| rfc2833
| both )
Possible values:
- audio : processing procedure is audio
- rfc2833 : processing procedure is rfc2833
- both : processing procedure is both
Parameter
<MEGACO::mediaGatewayDialStartTimer>
Format:
- dialing start timer in second
- unit: second
- range: [0...99]
Parameter
<MEGACO::mediaGatewayDialLongTimer>
Format:
- dialing start long in second
- unit: second
- range: [1...60]
Parameter
<MEGACO::mediaGatewayDialShortTimer>
Format:
- dialing short timer in second
- unit: second

[no] event-req-id

[no] rfc2833-process

[no] dial-start-timer

[no] dial-long-timer

[no] dial-short-timer

974

Released

the voice p-bit of this media


gateway
optional parameter with default
value: 0
the event request id of this media
gateway
optional parameter
permit notify of stimal/stedsig
event
optional parameter
permit notify of al/of event
optional parameter
permit notify of al/on event
optional parameter
permit notify of al/of strict=state
event
optional parameter
permit notify of al/on strict=state
event
optional parameter
permit notify of ocp/mg_overload
event
optional parameter
dummy parameter for reserved
bit
type: optional parameter with default
value: 96
payload type according to
rfc2833
type: optional parameter with default
value: "audio"
processing procedure for the dtmf
event tones

type: optional parameter with default


value: 10
maximum waiting time for
dialing the first digit
type: optional parameter with default
value: 20
maximum waiting time for
dialing when no matching found
in the digitmap
type: optional parameter with default
value: 5
maximum waiting time for
dialing when matching found in
the digitmap

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter
[no] min-data-jitter

[no] init-data-jitter

[no] max-data-jitter

[no] ephe-term-prefix

[no] ephe-term-min

[no] ephe-term-max

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [1...60]
Parameter type: <MEGACO::mediaGatewayDataJitter>
Format:
- jitter buffer for data calls working in rtp mode
- unit: millisecond
- range: [0...200]
Parameter type: <MEGACO::mediaGatewayDataJitter>
Format:
- jitter buffer for data calls working in rtp mode
- unit: millisecond
- range: [0...200]
Parameter type: <MEGACO::mediaGatewayDataJitter>
Format:
- jitter buffer for data calls working in rtp mode
- unit: millisecond
- range: [0...200]
Parameter
type:
<MEGACO::mediaGatewayEpheTermPrefix>
Format:
- prefix to compose the ephemeral termination id
- length: 1<=x<=10
Parameter type: <MEGACO::mediaGatewayEpheTerm>
Format:
- ephemeral termination id
- range: [0...4294967295]
Parameter type: <MEGACO::mediaGatewayEpheTerm>
Format:
- ephemeral termination id
- range: [0...4294967295]

optional parameter with default


value: 50
minimum jitter buffer for data
calls working in rtp mode
optional parameter with default
value: 50
initial jitter buffer for data calls
working in rtp mode
optional parameter with default
value: 50
maximum jitter buffer for data
calls working in rtp mode
optional parameter with default
value: "E"
prefix to compose the ephemeral
termination id
optional parameter with default
value: 65536
minimum ephemeral termination
id
optional parameter with default
value: 72366
maximum ephemeral termination
id

Released

975

39 Voice Configuration Commands

39.26 Voice Megaco Signal Gateway Configuration


Commands
Command Description
This command allows the operator to manage the Voice Megaco signal gateway.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure voice cluster (cluster-id) ( no signal-gateway (signal-gateway-id) ) | ( signal-gateway
(signal-gateway-id)
prim-asp-ip
<Ip::V4Address>
prim-sctp-port
<MEGACO::signallingGatewayInterfacePrimarySCTPPort> [ sec-asp-ip <Ip::V4Address> ] [ no sec-sctp-port |
sec-sctp-port <MEGACO::signallingGatewayInterfaceSecondarySCTPPort> ] [ tert-asp-ip <Ip::V4Address> ] [ no
tert-sctp-port | tert-sctp-port <MEGACO::signallingGatewayInterfaceTertiarySCTPPort> ] [ quat-asp-ip
<Ip::V4Address>
]
[
no
quat-sctp-port
|
quat-sctp-port
<MEGACO::signallingGatewayInterfaceQuaternarySCTPPort> ] ip-address <Ip::V4Address> sgi-user-label
<MEGACO::signallingGatewayInterfaceUserLabel> sgi-mgi <MEGACO::MediaGatewayId> [ no admin-status |
admin-status <MEGACO::signallingGatewayInterfaceAdminStatus> ] )

Command Parameters
Table 39.26-1 "Voice Megaco Signal Gateway Configuration Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- the signal gateway table index
- range: [1]

uniquely identify of this xvps


cluster

(signal-gateway-id)

uniquely identify of this signal


gateway

Table 39.26-2 "Voice Megaco Signal Gateway Configuration Commands" Command Parameters
Parameter

Type

Description

prim-asp-ip

Parameter type: <Ip::V4Address>


Format:
- IPv4-address
Parameter
type:
<MEGACO::signallingGatewayInterfacePrimarySCTPPort>
Format:
- the sctp port of the primary asp
- range: [1...65534]

mandatory parameter
the primary asp ip

prim-sctp-port

976

Released

mandatory parameter
the sctp port of the primary asp

3HH-04416-EBAA-TCZZA

01

39 Voice Configuration Commands

Parameter

Type

sec-asp-ip

Parameter type: <Ip::V4Address>


optional parameter
Format:
the secondary asp ip
- IPv4-address
Parameter
type: optional parameter with default
<MEGACO::signallingGatewayInterfaceSecondarySCTPPort>value: 9900
Format:
the sctp port of the secondary asp
- the sctp port of the secondary asp
- range: [1...65534]
Parameter type: <Ip::V4Address>
optional parameter
Format:
the tertiary asp ip
- IPv4-address
Parameter
type: optional parameter with default
<MEGACO::signallingGatewayInterfaceTertiarySCTPPort> value: 9900
Format:
the sctp port of the tertiary asp
- the sctp port of the tertiary asp
- range: [1...65534]
Parameter type: <Ip::V4Address>
optional parameter
Format:
the quaternary asp ip
- IPv4-address
Parameter
type: optional parameter with default
<MEGACO::signallingGatewayInterfaceQuaternarySCTPPort>value: 9900
Format:
the sctp port of the quaternary asp
- the sctp port of the quaternary asp
- range: [1...65534]
Parameter type: <Ip::V4Address>
mandatory parameter
Format:
The parameter is not visible
- IPv4-address
during modification.
the ip address of this signal
gateway
Parameter
type: mandatory parameter
<MEGACO::signallingGatewayInterfaceUserLabel>
the user label of the signal
Format:
gateway interface
- the user label of the signal gateway interface
- length: 1<=x<=64
Parameter type: <MEGACO::MediaGatewayId>
mandatory parameter
Format:
The parameter is not visible
- the media gateway table index
during modification.
- range: [1]
The id of media gateway
associated with signal gateway
Parameter
type: optional parameter with default
<MEGACO::signallingGatewayInterfaceAdminStatus>
value: "locked"
Format:
The administrative status of
( locked
signal gateway
| unlocked )
Possible values:
- locked : the admin status of signal gateway is locked
- unlocked : the admin status of signal gateway is unlocked

[no] sec-sctp-port

tert-asp-ip
[no] tert-sctp-port

quat-asp-ip
[no] quat-sctp-port

ip-address

sgi-user-label

sgi-mgi

[no] admin-status

3HH-04416-EBAA-TCZZA 01

Description

Released

977

40- Debug Configuration Commands

40.1 Debug Configuration Command Tree


40.2 Protocol Tracing Configuration Command

978

Released

40-979
40-980

3HH-04416-EBAA-TCZZA

01

40 Debug Configuration Commands

40.1 Debug Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Debug Configuration Commands".

Command Tree
----configure
----debug-trace
----[no] protocol-trace
- (trace-subject)
- protocol
- syslog
- [no] events
- [no] packet-summary

3HH-04416-EBAA-TCZZA 01

Released

979

40 Debug Configuration Commands

40.2 Protocol Tracing Configuration Command


Command Description
This commands allows the operator to enable/disable protocol tracing. The operator can enter the protocol, port
and level of detail for which tracing can be enabled. It is mandatory to enable/disable atleast one of the tracings,
events or packet-summary.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure debug-trace ( no protocol-trace (trace-subject) protocol <Debug::Protocol> ) | ( protocol-trace
(trace-subject) protocol <Debug::Protocol> syslog <Debug::SyslogMsgType> [ [ no ] events ] [ [ no ]
packet-summary ] )

Command Parameters
Table 40.2-1 "Protocol Tracing Configuration Command" Resource Parameters
Resource Identifier

Type

(trace-subject)

Format:
subject for which tracing is
( dsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / enabled(e.g ADSL line,PVC)
<Eqpt::SlotId> / <Debug::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId>
/
<Debug::PortId>
:
<Eqpt::VpiMandatoryId> : <Eqpt::VciMandatoryId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Debug::PortId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- dsl-line : the xDSL line
- atm-pvc : the PVC of the ADSL line
- shdsl-line : a static shdsl line interface
- ethernet-line : a native ethernet line interface
- uni : GPON ONT uni interface
- voip : virtual uni identifier
Field type <Eqpt::RackId>
- the rack number

980

Released

Description

3HH-04416-EBAA-TCZZA

01

40 Debug Configuration Commands

Resource Identifier

Type
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Debug::PortId>
- the portId
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Debug::Protocol>
Format:
( igmp
| dhcp
| arp
| dhcpv6 )
Possible values:
- igmp : enable tracing for igmp protocol
- dhcp : enable tracing for dhcp protocol
- arp : enable tracing for arp protocol
- dhcpv6 : enable tracing for dhcpv6 protocol

protocol

Description

protocol to be traced

Table 40.2-2 "Protocol Tracing Configuration Command" Command Parameters


Parameter

Type

Description

syslog

mandatory parameter
The parameter is not visible
during modification.
msg type used to log trace msgs
to syslog

[no] events

Parameter type: <Debug::SyslogMsgType>


Format:
( tracing1
| tracing2
| tracing3 )
Possible values:
- tracing1 : msg type tracing1 used for syslog
- tracing2 : msg type tracing2 used for syslog
- tracing3 : msg type tracing3 used for syslog
Parameter type: boolean

[no] packet-summary

Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

optional parameter
enable events tracing
optional parameter
enable pkt summary tracing

Released

981

41- Ethernet User Ports Configuration Commands

41.1 Ethernet User Ports Configuration Command Tree


41.2 Ethernet Line Configuration Command
41.3 Ethernet Line TCA Threshold Configuration
Command
41.4 Ethernet Line Mau Configuration Command

982

Released

41-983
41-984
41-985
41-987

3HH-04416-EBAA-TCZZA

01

41 Ethernet User Ports Configuration Commands

41.1 Ethernet User Ports Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Ethernet User Ports Configuration Commands".

Command Tree
----configure
----ethernet
----line
- (if-index)
- port-type
- [no] admin-up
----tca-line-threshold
- [no] enable
- [no] los
- [no] fcs
- [no] rx-octets
- [no] tx-octets
- [no] los-day
- [no] fcs-day
- [no] rx-octets-day
- [no] tx-octets-day
----mau
- (index)
- type
- power
- [no] speed-auto-sense
- [no] autonegotiate
- [no] cap1000base-xfd
- [no] cap1000base-tfd

3HH-04416-EBAA-TCZZA 01

Released

983

41 Ethernet User Ports Configuration Commands

41.2 Ethernet Line Configuration Command


Command Description
This command allows the operator to configure the ethernet line.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure ethernet line (if-index) [ port-type <ETHITF::PortType> ] [ [ no ] admin-up ]

Command Parameters
Table 41.2-1 "Ethernet Line Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 41.2-2 "Ethernet Line Configuration Command" Command Parameters


Parameter

Type

Description

port-type

Parameter type: <ETHITF::PortType>


Format:
( uni
| nni
| hc-uni )
Possible values:
- uni : uni port type
- nni : nni port type
- hc-uni : hicap uni port type
Parameter type: boolean

optional parameter
the whole network service model
based on this interface

[no] admin-up

984

Released

optional parameter
admin status is up

3HH-04416-EBAA-TCZZA

01

41 Ethernet User Ports Configuration Commands

41.3 Ethernet Line TCA Threshold Configuration


Command
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per ethernet line.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure ethernet line (if-index) tca-line-threshold [ [ no ] enable ] [ no los | los <ETHITF::TcaThreshold> ] [ no
fcs | fcs <ETHITF::TcaThreshold> ] [ no rx-octets | rx-octets <ETHITF::TcaThresholdMB> ] [ no tx-octets |
tx-octets <ETHITF::TcaThresholdMB> ] [ no los-day | los-day <ETHITF::TcaThreshold> ] [ no fcs-day | fcs-day
<ETHITF::TcaThreshold> ] [ no rx-octets-day | rx-octets-day <ETHITF::TcaThresholdMB> ] [ no tx-octets-day |
tx-octets-day <ETHITF::TcaThresholdMB> ]

Command Parameters
Table 41.3-1 "Ethernet Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 41.3-2 "Ethernet Line TCA Threshold Configuration Command" Command Parameters
Parameter

Type

Description

[no] enable

Parameter type: boolean

[no] los

Parameter type: <ETHITF::TcaThreshold>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

optional parameter
enable the reporting of TCA's for
this ethernet line
optional parameter with default
value: 0
loss of signal error in 15 minute

3HH-04416-EBAA-TCZZA 01

Released

985

41 Ethernet User Ports Configuration Commands

Parameter

Type

Description

[no] fcs

Parameter type: <ETHITF::TcaThreshold>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

[no] rx-octets

Parameter type: <ETHITF::TcaThresholdMB>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

[no] tx-octets

Parameter type: <ETHITF::TcaThresholdMB>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

[no] los-day

Parameter type: <ETHITF::TcaThreshold>


Format:
- the tca threshold value (specify octets in MB), 0 - disable
Parameter type: <ETHITF::TcaThreshold>
Format:
- the tca threshold value (specify octets in MB), 0 - disable

optional parameter with default


value: 0
frame check sequence error in 15
minute
optional parameter with default
value: 0
received octets in 15 minute
(specify in MB)
optional parameter with default
value: 0
transmitted octets in 15 minute
(specify in MB)
optional parameter with default
value: 0
loss of signal error in 1 day
optional parameter with default
value: 0
frame check sequence error in 1
day
optional parameter with default
value: 0
received octets in 1 day (specify
in MB)
optional parameter with default
value: 0
transmitted octets in 1 day
(specify in MB)

[no] fcs-day

[no] rx-octets-day

Parameter type: <ETHITF::TcaThresholdMB>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

[no] tx-octets-day

Parameter type: <ETHITF::TcaThresholdMB>


Format:
- the tca threshold value (specify octets in MB), 0 - disable

986

Released

3HH-04416-EBAA-TCZZA

01

41 Ethernet User Ports Configuration Commands

41.4 Ethernet Line Mau Configuration Command


Command Description
This command allows the operator to configure the Mau. The configuration is specific per ethernet line.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure ethernet line (if-index) mau (index) [ type <Ether::MAUType> ] [ power <ETHITF::Power> ] [ [ no ]
speed-auto-sense ] [ [ no ] autonegotiate ] [ [ no ] cap1000base-xfd ] [ [ no ] cap1000base-tfd ]

Command Parameters
Table 41.4-1 "Ethernet Line Mau Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identify MAU, among others
- port to which the MAU is connected
connected to same interface
- range: [1...2147483647]

(index)

Description

Table 41.4-2 "Ethernet Line Mau Configuration Command" Command Parameters


Parameter

Type

Description

type

Parameter type: <Ether::MAUType>


Format:
( 10baset
| 100basetxhd
| 100basetxfd
| 100basefxhd
| 100basefxfd
| 1000basexhd
| 1000basexfd
| 1000baselxhd

optional parameter
the mau type

3HH-04416-EBAA-TCZZA 01

Released

987

41 Ethernet User Ports Configuration Commands

Parameter

Type

Description

[no] speed-auto-sense

| 1000baselxfd
| 1000basesxhd
| 1000basesxfd
| 1000basethd
| 1000basetfd
| 10gbaser
| 10gbaseer
| 10gbaselr
| 100basebx10d
| 100basebx10u
| 100baselx10
| 1000basebx10d
| 1000basebx10u
| 1000baselx10 )
Possible values:
- 10baset : UTP 10M
- 100basetxhd : UTP 100M half duplex
- 100basetxfd : UTP 100M full duplex
- 100basefxhd : X fiber over PMT half duplex
- 100basefxfd : X fiber over PMT full duplex
- 1000basexhd : PCS/PMA,unknown PMD, half duplex
- 1000basexfd : PCS/PMA,unknown PMD, full duplex
- 1000baselxhd : fiber over long-wavelength laser half
duplex
- 1000baselxfd : fiber over long-wavelength laser full duplex
- 1000basesxhd : fiber over short-wavelength laser half
duplex
- 1000basesxfd : fiber over short-wavelength laser full
duplex
- 1000basethd : UTP 1G half duplex
- 1000basetfd : UTP 1G full duplex
- 10gbaser : fiber 1OG ethernet
- 10gbaseer : fiber 1OG ethernet extended reach, 30km
- 10gbaselr : fiber 1OG ethernet long reach, 10km
- 100basebx10d : one single-mode fiber OLT long
wavelength, 10km, 100 base
- 100basebx10u : one single-mode fiber ONU, long
wavelength, 10km, 100 base
- 100baselx10 : two single-mode fibers over long
wavelength, 10km, 100 base
- 1000basebx10d : one single-mode fiber OLT over long
wavelength, 10km, 1000 base
- 1000basebx10u : one single-mode fiber ONU over long
wavelength, 10km, 1000 base
- 1000baselx10 : two single-mode fibers over long
wavelength, 10km, 1000 base
Parameter type: <ETHITF::Power>
Format:
( up
| down )
Possible values:
- up : up
- down : down
Parameter type: boolean

[no] autonegotiate

Parameter type: boolean

power

988

Released

optional parameter
the administrative status of sfp
power

optional parameter
enable auto-sensing fiber speed
on this port
optional parameter

3HH-04416-EBAA-TCZZA

01

41 Ethernet User Ports Configuration Commands

Parameter

Type

[no] cap1000base-xfd

Parameter type: boolean

[no] cap1000base-tfd

Parameter type: boolean

3HH-04416-EBAA-TCZZA 01

Description
enable auto-negotiation on this
port
optional parameter
advertise 1G optical
optional parameter
advertise 1G electrical

Released

989

42- Efm Oam Configuration Commands

42.1 Efm Oam Configuration Command Tree


42.2 Efm Oam Interface ConfigurationCommand

990

Released

42-991
42-992

3HH-04416-EBAA-TCZZA

01

42 Efm Oam Configuration Commands

42.1 Efm Oam Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "Efm Oam Configuration Commands".

Command Tree
----configure
----efm-oam
----interface
- (interface)
- [no] admin-up
- [no] passive-mode
- [no] keep-alive-intvl
- [no] response-intvl
- [no] data-length
- [no] bitrate
- [no] smac
- [no] dmac

3HH-04416-EBAA-TCZZA 01

Released

991

42 Efm Oam Configuration Commands

42.2 Efm Oam Interface ConfigurationCommand


Command Description
This command will allow the operator to enable/disable EFM OAM on the specified Ethernet-like interface and
configure the mode, alive timer and response timer intervals. In addition also the internal traffic generator data
applicable to this interface can be configured.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure efm-oam interface (interface) [ [ no ] admin-up ] [ [ no ] passive-mode ] [ no keep-alive-intvl |
keep-alive-intvl <Ether::KeepAliveTimeTicks> ] [ no response-intvl | response-intvl <Ether::ResponseTimeTicks>
] [ no data-length | data-length <Ether::TraffGenDataLengthType> ] [ no bitrate | bitrate
<Ether::TraffGenBitRateType> ] [ no smac | smac <Ether::MacAddr> ] [ no dmac | dmac <Ether::MacAddr> ]

Command Parameters
Table 42.2-1 "Efm Oam Interface ConfigurationCommand" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 42.2-2 "Efm Oam Interface ConfigurationCommand" Command Parameters


Parameter

Type

Description

[no] admin-up

Parameter type: boolean

[no] passive-mode

Parameter type: boolean

[no] keep-alive-intvl

Parameter type: <Ether::KeepAliveTimeTicks>


Format:
- a timeout value expressed in seconds
- unit: seconds
- range: [1...300]

optional parameter
enable efm oam
optional parameter
oam mode is passive
optional parameter with default
value: 300
keep alive time interval

992

Released

3HH-04416-EBAA-TCZZA

01

42 Efm Oam Configuration Commands

Parameter

Type

Description

[no] response-intvl

Parameter type: <Ether::ResponseTimeTicks>


Format:
- a timeout value expressed in seconds
- unit: seconds
- range: [2...10]
Parameter type: <Ether::TraffGenDataLengthType>
Format:
- A value of 1 up to 1500. Indicates length in bytes.
- unit: byte
- range: [1...1500]

optional parameter with default


value: 5
variable response interval

[no] data-length

[no] bitrate

[no] smac

[no] dmac

3HH-04416-EBAA-TCZZA 01

Parameter type: <Ether::TraffGenBitRateType>


Format:
( 100k
| 1m
| 10m
| 100m
| 1g )
Possible values:
- 100k : bitrate = 100K bit/sec
- 1m : bitrate = 1M bit/sec
- 10m : bitrate = 10M bit/sec
- 100m : bitrate = 100M bit/sec
- 1g : bitrate = 1G bit/sec
Parameter type: <Ether::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Ether::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

optional parameter with default


value: 10
Internal traffic generator data:
Length of datafield, in bytes, of
the to be generated test traffic.
Must be a value from 1 up to
1500.
optional parameter with default
value: "100k"
Internal traffic generator data:
Bitrate of the to be generated test
traffic.

optional parameter with default


value: "00 : 00 : 01 : 00 : 00 :
01"
Internal traffic generator data:
source MAC address.
optional parameter with default
value: "00 : 00 : 02 : 00 : 00 :
02"
Internal traffic generator data:
destination MAC address.

Released

993

43- CFM Configuration Commands

43.1 CFM Configuration Command Tree


43.2 Maintenance Domain Configuration Command
43.3 Maintenance Association Configuration Command
43.4 Maintenance Association End Point Configuration
Command
43.5 Remote Maintenance Association End Point
Configuration Command
43.6 Synthetic Loss Measurement configuration
Commands
43.7 CFM PM-Proactive test management Command
43.8 CFM PM Proactive test management Command

994

Released

43-995
43-996
43-998
43-1001
43-1004
43-1005
43-1006
43-1007

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

43.1 CFM Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "CFM Configuration Commands".

Command Tree
----configure
----cfm
----[no] domain
- (domain-index)
- name
- level
----[no] association
- (association-index)
- [no] bridgeport
- [no] vlan
- [no] mhf-creation
- name
- [no] ccm-interval
- [no] ccm-aware
- [no] ccm-admin-state
----[no] mep
- (mepid)
- location
- [no] cci-enable
- [no] ccm-priority
- [no] low-pri-defect
- [no] fng-alarm-time
- [no] fng-reset-time
- [no] slm-resp-enable
- [no] dm-resp-enable
- [no] lm-resp
- [no] slm-init-enable
- [no] lm-init
----[no] remote-mep
- (rmepid)
----slm
- [no] inactivity-time
----y1731pm
----[no] domain
- (domain-index)
- association
- mep
- session-id
- type
- target-mac
- [no] priority
- [no] adminup
- interval
- size
- measurement-intvl

3HH-04416-EBAA-TCZZA 01

Released

995

43 CFM Configuration Commands

43.2 Maintenance Domain Configuration Command


Command Description
This command is used to define a Maintenance Domain (MD) at particular maintenance level. There are 8 possible
levels. Note that once created, the MD cannot be modified. To modify, delete the entry and create a new one.
Note that, if an MD is deleted, any subtending Maintenance Associations (MAs), and their subtending Maintenance
Points (MPs), will be automatically deleted only if CCM Admin State is locked for all of the MAs.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm ( no domain (domain-index) ) | ( domain (domain-index) name <Cfm::FormatedName> level
<Cfm::MdLevelType> )

Command Parameters
Table 43.2-1 "Maintenance Domain Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]

Maintenance
index

Domain

(MD)

Table 43.2-2 "Maintenance Domain Configuration Command" Command Parameters


Parameter

Type

Description

name

Parameter type: <Cfm::FormatedName>


Format:
( dns : <Cfm::PrintableString>
| mac : <Cfm::MacAddress>
| string : <Cfm::PrintableString>
| none )
Possible values:
- dns : DNS name (e.g. alcatel.com)
- mac : MAC address plus 2 hex octets,
11:22:33:44:55:66:77:88
- string : A character string (e.g. operator)
- none : No MD name.
Field type <Cfm::PrintableString>
- all characters except for characters 0 to 31
- length: 1<=x<=43
Field type <Cfm::MacAddress>
MAC
address
plus
2
hex
octets,
11:22:33:44:55:66:77:88

mandatory parameter
The parameter is not visible
during modification.
Maintenance Domain (MD) name
type and unique name

996

Released

e.g.

e.g.

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

Parameter
level

3HH-04416-EBAA-TCZZA 01

Type

Description

- length: 8
Parameter type: <Cfm::MdLevelType>
Format:
- Maintenance Domain (MD) level
- range: [0...7]

mandatory parameter
The parameter is not visible
during modification.
Maintenance Domain (MD) level

Released

997

43 CFM Configuration Commands

43.3 Maintenance Association Configuration


Command
Command Description
This command is used to create or modify a Maintenance Association (MA). Only modification of the
MHFCreation is allowed. As a result, the VlanId has been made optional in the Command Syntax as VlanId is
mandatory for creation and is not applicable for modification. Each Maintenance Domain (MD) can have one or
more MAs.
Note that, if an MA is deleted, any subtending Maintenance Points (MPs) will automatically be deleted.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm domain (domain-index) ( no association (association-index) ) | ( association (association-index) [
no bridgeport | bridgeport <Cfm::InterfaceZeroIndex> ] [ no vlan | vlan <Vlan::StackedVlan> ] [ no mhf-creation |
mhf-creation <Cfm::CfmMhfCreationType> ] [ name <Cfm::MaFormatedName> ] [ no ccm-interval | ccm-interval
<Cfm::CfmMaCcmInterval> ] [ [ no ] ccm-aware ] [ no ccm-admin-state | ccm-admin-state
<Cfm::CfmMaCcmAdminState> ] )

Command Parameters
Table 43.3-1 "Maintenance Association Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]

Maintenance
index

(association-index)

Domain

(MD)

Maintenance Association (MA)


index. Unique within an MD

Table 43.3-2 "Maintenance Association Configuration Command" Command Parameters


Parameter

Type

[no] bridgeport

Parameter type: <Cfm::InterfaceZeroIndex>


optional parameter with default
Format:
value: "none"
( none
The parameter is not visible
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / during modification.
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> / IfIndex of UNI
<Eqpt::OntPortId> )
Possible values:

998

Released

Description

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

Parameter

[no] vlan

[no] mhf-creation

name

3HH-04416-EBAA-TCZZA 01

Type

Description

- none : no port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Cfm::CfmMhfCreationType>
Format:
( mhf-none
| mhf-default )
Possible values:
- mhf-none : No MHF creation for this VLAN ID
- mhf-default : MHF creation for this VLAN ID on related
bridge ports
Parameter type: <Cfm::MaFormatedName>
Format:
( pvid : <Cfm::MaNamePvid>
| string : <Cfm::MaNameCharstr>
| uint16 : <Cfm::MaNameUint16>
| vpnid : <Cfm::MaVpnid>
| icc : <Cfm::MaNameIcc> )
Possible values:
- pvid : [0...4094]
- string : Raw ascii up to 45 Characters, except the character
code 0-31(decimal) are not used
- uint16 : [0..65535]
- vpnid : RFC-2685 VPN ID Format(7 Octet):
xxx:xxxx,eg:000102:FFAA77BB,x is between 00 and FF
- icc : Raw ascii.exactly 13 characters,except the character
code 0-31(decimal) are not used
Field type <Cfm::MaNamePvid>

optional parameter with default


value: "stacked : 0 : 4097"
The parameter is not visible
during modification.
when vlan is not specified it will
be vlan Unaware MA

optional parameter with default


value: "mhf-none"
MIP Half Function (MHF)
creation control

optional parameter
Maintenance Association (MA)
name type and unique name

Released

999

43 CFM Configuration Commands

Parameter

Type

[no] ccm-interval

[no] ccm-aware
[no] ccm-admin-state

1000

Description

- MaName Pvid Range [0...4094]


- length: x<=4
Field type <Cfm::MaNameCharstr>
- Raw ascii up to 45 Characters, except the character code
0-31 decimal
- length: x<=45
Field type <Cfm::MaNameUint16>
- MaName Uint16 Range [0...65535]
- length: x<=5
Field type <Cfm::MaVpnid>
- MaName VpnId 7 Octet Format : xxx:xxxx, where x is a
between 00 and FF eg:11FF33:AABBCCDD
- length: 15
Field type <Cfm::MaNameIcc>
- MaName Icc Raw ascii exactly 13 characters
- length: 13
Parameter type: <Cfm::CfmMaCcmInterval>
Format:
(0
|1
| 10
| 60
| 600 )
Possible values:
- 0 : CCM CCM Rx disable
- 1 : CCM Interval 1 secs
- 10 : CCM Interval 10 secs
- 60 : CCM Interval 1 Min
- 600 : CCM Interval 10 Min
Parameter type: boolean

Released

Parameter type: <Cfm::CfmMaCcmAdminState>


Format:
( unlock
| lock )
Possible values:
- unlock : sets CCM AdminState to Lock
- lock : sets CCM AdminState to UnLock

optional parameter with default


value: "10"
MA CCM Interval

optional parameter
sets MA as CCMAware
optional parameter with default
value: "lock"
MA CCM AdminState

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

43.4 Maintenance Association End Point


Configuration Command
Command Description
This command is used to configure a Maintenance association End Point (MEP) within a Maintenance Association
(MA). Each MA can have zero or more MEPs. Once a MEP is created, it cannot be modified. To modify the MEP,
delete the entry and create a new one.
Note that there are correlations between a MEP and a VLAN port location. To create a MEP, the MEP's MA must
be associated with the port location's VLAN. Also if the port location is deleted, the related MEP(s) will
automatically be deleted.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm domain (domain-index) association (association-index) ( no mep (mepid) ) | ( mep (mepid)
location <Cfm::location> [ [ no ] cci-enable ] [ no ccm-priority | ccm-priority <Cfm::MepCcmPriority> ] [ no
low-pri-defect | low-pri-defect <Cfm::MepLowPriorityDefect> ] [ no fng-alarm-time | fng-alarm-time
<Cfm::MepFngAlarmTime> ] [ no fng-reset-time | fng-reset-time <Cfm::MepFngResetTime> ] [ [ no ]
slm-resp-enable ] [ [ no ] dm-resp-enable ] [ no lm-resp | lm-resp <Cfm::MepLmEnableDisable> ] [ [ no ]
slm-init-enable ] [ no lm-init | lm-init <Cfm::MepLmInitEnableDisable> ] )

Command Parameters
Table 43.4-1 "Maintenance Association End Point Configuration Command" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Format:
Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index. Unique within an MD
MD
- range: [1...4294967295]
Format:
MA End Point (MEP) ID. Unique
- MA End Point (MEP) ID. Unique within an MA
within an MA
- range: [1...8191]

(association-index)

(mepid)

Description

Table 43.4-2 "Maintenance Association End Point Configuration Command" Command


Parameters
Parameter

Type

Description

location

Parameter type: <Cfm::location>

mandatory parameter

3HH-04416-EBAA-TCZZA 01

Released

1001

43 CFM Configuration Commands

Parameter

Type

Description
The parameter is not visible
during modification.
Maintenance association End
Point (MEP) location

[no] cci-enable

Format:
( user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| slot : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Possible values:
- user : User bridge-port location
- slot : slot location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: boolean

[no] ccm-priority

Parameter type: <Cfm::MepCcmPriority>


Format:
- Priority value for CCMs transmitted by the MEP
- range: [0...7]
Parameter type: <Cfm::MepLowPriorityDefect>
Format:
( all-def
| mac-rem-err-xcon
| rem-err-xcon
| err-xcon
| xcon
| no-xcon )
Possible values:
all-def
:
For
DefRDICCM,
DefMACstatus,

[no] low-pri-defect

1002

Released

optional parameter
CCM generation is enabled on
the current MEP
optional parameter with default
value: 7UL
Priority
value
for
CCMs
transmitted by the MEP
optional parameter with default
value: "mac-rem-err-xcon"
The lowest priority defect that is
allowed to generate fault alarm

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

Parameter

[no] fng-alarm-time

[no] fng-reset-time

[no] slm-resp-enable
[no] dm-resp-enable
[no] lm-resp

[no] slm-init-enable
[no] lm-init

3HH-04416-EBAA-TCZZA 01

Type

Description

DefRemoteCCM,DefErrorCCM, and DefXconCCM


mac-rem-err-xcon
:
Only
DefMACstatus,
DefRemoteCCM,DefErrorCCM,
and
DefXconCCM
(default)
- rem-err-xcon : Only DefRemoteCCM, DefErrorCCM, and
DefXconCCM
- err-xcon : Only DefErrorCCM and DefXconCCM
- xcon : Only DefXconCCM
- no-xcon : No defects DefXcon or lower are to be reported
Parameter type: <Cfm::MepFngAlarmTime>
Format:
multiples
of
250
ticks
are
supported(250,500,750,1000).default = 250 ticks(2.5sec)
- unit: 1/100 sec
- range: [250...1000]
Parameter type: <Cfm::MepFngResetTime>
Format:
- multiples of 250 ticks are supported(250,500,750,1000).
default = 1000 ticks(10sec)
- unit: 1/100 sec
- range: [250...1000]
Parameter type: boolean
Parameter type: boolean

optional parameter with default


value: 250L
The time in ticks(1 tick = 10ms)
that defects must be present
before a Fault alarm is issued.
optional parameter with default
value: 1000L
The time in ticks (1tick = 10ms)
that defects must be absent before
re-enabling a Fault Alarm.
optional parameter
slm responder is enabled
current mep
optional parameter
dm responder is enabled
current mep
optional parameter with
value: "disable"
configure LM responder
current mep

on the
on the

Parameter type: <Cfm::MepLmEnableDisable>


default
Format:
( disable
on the
| enable-per-vlan
| enable-per-pbit )
Possible values:
- disable : lm responder is disabled on the current mep
- enable-per-vlan : lm responder is enabled per vlan on the
current mep
- enable-per-pbit : lm responder is enabled per vlan per pbit
on the current mep
Parameter type: boolean
optional parameter
slm initiator is enabled on the
current mep
Parameter type: <Cfm::MepLmInitEnableDisable>
optional parameter with default
Format:
value: "disable"
( disable
configure lm initiator on the
| enable-per-vlan
current mep
| enable-per-pbit )
Possible values:
- disable : lm initiator is disabled on the current mep
- enable-per-vlan : lm initiator is enabled per vlan on the
current mep
- enable-per-pbit : lm initiator is enabled per vlan per pbit on
the current mep

Released

1003

43 CFM Configuration Commands

43.5 Remote Maintenance Association End Point


Configuration Command
Command Description
This command is used to configure a Remote Maintenance association End Point (RMEP) within a Maintenance
Association (MA). Once a RMEP is created, it cannot be modified. To modify the RMEP, delete the entry and
create a new one.
Note

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm domain (domain-index) association (association-index) ( no remote-mep (rmepid) ) | ( remote-mep
(rmepid) )

Command Parameters
Table 43.5-1 "Remote Maintenance Association End Point Configuration Command" Resource
Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Format:
Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index. Unique within an MD
MD
- range: [1...4294967295]
Format:
Remote MA End Point (MEP)
- MA End Point (MEP) ID. Unique within an MA
ID. Unique within an MA
- range: [1...8191]

(association-index)

(rmepid)

1004

Released

Description

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

43.6 Synthetic Loss Measurement configuration


Commands
Command Description
This command can be used to configure the parameters for synthetic loss measurement

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm slm [ no inactivity-time | inactivity-time <Cfm::slmInactivityTime> ]

Command Parameters
Table 43.6-2 "Synthetic Loss Measurement configuration Commands" Command Parameters
Parameter

Type

Description

[no] inactivity-time

Parameter type: <Cfm::slmInactivityTime>


Format:
- inactivity time
- unit: seconds
- range: [10...100]

optional parameter with default


value: 100L
value of slm inactivity timer

3HH-04416-EBAA-TCZZA 01

Released

1005

43 CFM Configuration Commands

43.7 CFM PM-Proactive test management


Command
Command Description
This command is used to configure PM-Proactive tests.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm y1731pm

1006

Released

3HH-04416-EBAA-TCZZA

01

43 CFM Configuration Commands

43.8 CFM PM Proactive test management


Command
Command Description
This command is used to configure PM Proactive tests.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cfm y1731pm ( no domain (domain-index) association <Cfm::CfmMaIndexType> mep
<Cfm::MepIdType> session-id <Cfm::SessionIdType> ) | ( domain (domain-index) association
<Cfm::CfmMaIndexType> mep <Cfm::MepIdType> session-id <Cfm::SessionIdType> type <Cfm::PmTestType>
target-mac <Vlan::MacAddr> [ no priority | priority <Vlan::Priority> ] [ [ no ] adminup ] [ interval
<Cfm::PmIntervalType>
]
[
size
<Cfm::PmDataSizeType>
]
[
measurement-intvl
<Cfm::PmMeasurementIntervalType> ] )

Command Parameters
Table 43.8-1 "CFM PM Proactive test management Command" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain Index.
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association Index.
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance Association End
Format:
Point (MEP) ID. Unique within
- MA End Point (MEP) ID. Unique within an MA
an MA.
- range: [1...8191]
Parameter type: <Cfm::SessionIdType>
PM Proactive test SessionId.
Format:
- Session Id for PM proactive
- range: [1...960]

association

mep

session-id

Description

Table 43.8-2 "CFM PM Proactive test management Command" Command Parameters


Parameter

Type

Description

type

Parameter type: <Cfm::PmTestType>


Format:

mandatory parameter
The parameter is not visible

3HH-04416-EBAA-TCZZA 01

Released

1007

43 CFM Configuration Commands

Parameter

target-mac

[no] priority

Description

( single-ended-slm
| single-ended-lm )
Possible values:
- single-ended-slm : sets test type to SLM
- single-ended-lm : sets test type to LM
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

during modification.
Y1731 PM Test type

mandatory parameter
The parameter is not visible
during modification.
MAC address of the PM
responder(Target).
optional parameter with default
value: 7L
Priority. A 3 bit value to be used
in the VLAN tag.
optional parameter
optional parameter
Interval in which PM packets are
transmitted.1sec - 10sec for SLM,
60sec or 300sec for LM
optional parameter
Size of data TLV

Parameter type: <Vlan::Priority>


Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: boolean
Parameter type: <Cfm::PmIntervalType>
Format:
- PM interval (sec) SLM: [1...10] LM: [60 or 300]
- range: [1...10,60,300]
Parameter type: <Cfm::PmDataSizeType>
Format:
( not-applicable
| <Cfm::PmDataSize> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmDataSize>
- Datasize for the SLM proactive test
- range: [0...1500]
Parameter type: <Cfm::PmMeasurementIntervalType>
optional parameter
Format:
The time for which the synthetic
( not-applicable
loss
calculation
is
made
| <Cfm::PmMeasurementInterval> )
periodically.
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmMeasurementInterval>
- Measurement interval
- unit: seconds
- range: [60,300]

[no] adminup
interval

size

measurement-intvl

1008

Type

Released

3HH-04416-EBAA-TCZZA

01

44- Trouble-Shooting Configuration Commands

44.1 Trouble-Shooting Configuration Command Tree


44.2 Trouble-shooting Interface Configuration Commands

3HH-04416-EBAA-TCZZA 01

44-1010
44-1011

Released

1009

44 Trouble-Shooting Configuration Commands

44.1 Trouble-Shooting Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Trouble-Shooting Configuration Commands".

Command Tree
----configure
----trouble-shooting
----statistics
----[no] interface
- (if-index)

1010

Released

3HH-04416-EBAA-TCZZA

01

44 Trouble-Shooting Configuration Commands

44.2 Trouble-shooting Interface Configuration


Commands
Command Description
This command allows the operator to enable or disable the extensive trouble-shooting counters.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure trouble-shooting statistics ( no interface (if-index) ) | ( interface (if-index) )

Command Parameters
Table 44.2-1 "Trouble-shooting Interface Configuration Commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni

3HH-04416-EBAA-TCZZA 01

Description
interface index of the port
/
/
/
/
/

Released

1011

44 Trouble-Shooting Configuration Commands

Resource Identifier

Type

Description

- vuni : virtual uni identifier


Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

1012

Released

3HH-04416-EBAA-TCZZA

01

45- IPoA/E IW Configuration Commands

45.1 IPoA/E IW Configuration Command Tree


45.2 IPoA/E IW Interworking Port Configuration Command
45.3 IPoA/E IW Gateway Configuration Command

3HH-04416-EBAA-TCZZA 01

45-1014
45-1015
45-1017

Released

1013

45 IPoA/E IW Configuration Commands

45.1 IPoA/E IW Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "IPoA/E IW Configuration Commands".

Command Tree
----configure
----ipoa/e-iw
----[no] port
- (interworking-port)
- user-ip
- gw-ip
----[no] gateway
- (vlanid)
- gw-ip-addr

1014

Released

3HH-04416-EBAA-TCZZA

01

45 IPoA/E IW Configuration Commands

45.2 IPoA/E IW Interworking Port Configuration


Command
Command Description
This command allows the operator to configure the parameter on the IPOA L2 interworking port level

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ipoa/e-iw ( no port (interworking-port) ) | ( port (interworking-port) [ user-ip <Ip::V4AddressHex> ] [
gw-ip <Ip::V4AddressHex> ] )

Command Parameters
Table 45.2-1 "IPoA/E IW Interworking Port Configuration Command" Resource Parameters
Resource Identifier

Type

(interworking-port)

Format:
index
of
rack/shelf/slot/port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-bridgeport
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Table 45.2-2 "IPoA/E IW Interworking Port Configuration Command" Command Parameters


Parameter

Type

Description

user-ip

Parameter type: <Ip::V4AddressHex>


Format:
- IPv4-address
Parameter type: <Ip::V4AddressHex>
Format:

optional parameter
ip address for user

gw-ip

3HH-04416-EBAA-TCZZA 01

optional parameter
ip address for next-hop gateway

Released

1015

45 IPoA/E IW Configuration Commands

Parameter

Type

Description

- IPv4-address

1016

Released

3HH-04416-EBAA-TCZZA

01

45 IPoA/E IW Configuration Commands

45.3 IPoA/E IW Gateway Configuration Command


Command Description
This command allows the operator to configure gateway address per L2 forwarder vlan

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ipoa/e-iw ( no gateway (vlanid) ) | ( gateway (vlanid) gw-ip-addr <Ip::V4AddressHex> )

Command Parameters
Table 45.3-1 "IPoA/E IW Gateway Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

Table 45.3-2 "IPoA/E IW Gateway Configuration Command" Command Parameters


Parameter

Type

Description

gw-ip-addr

Parameter type: <Ip::V4AddressHex>


Format:
- IPv4-address

mandatory parameter
the gateway ip address

3HH-04416-EBAA-TCZZA 01

Released

1017

46- LineTest Configuration Commands

46.1 LineTest Configuration Command Tree


46.2 Megaco LineTest Session Configuration Command
46.3 Megaco LineTest Line Configuration Command
46.4 MEGACO LineTest Param Configuration Command
46.5 SINGLE LineTest Session Configuration Command
46.6 SINGLE LineTest Line Configuration Command
46.7 SINGLE LineTest Param Configuration Command

1018

Released

46-1019
46-1021
46-1025
46-1027
46-1032
46-1036
46-1038

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

46.1 LineTest Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "LineTest Configuration Commands".

Command Tree
----configure
----linetest
----cluster
- (cluster-id)
----ltsession
- (sessionid)
- session-cmd
- ownerid
- timeout-period
- line-num
- type-high
- type-low
- test-parm-num
- test-mode
- type-extend
----ltline
- (sessionid)
- lineid
- line-status
----ltparm
- (sessionid)
- test-name(unit)
- value1
- value2
- value3
- value4
- value5
- min-threshold
- max-threshold
- min-threshold2
- max-threshold2
----single
----ltsession
- (sessionid)
- session-cmd
- ownerid
- timeout-period
- line-num
- type-high
- type-low
- test-parm-num
- test-mode
- inactive-timer
- type-extend
- [no] group-opt

3HH-04416-EBAA-TCZZA 01

Released

1019

46 LineTest Configuration Commands

- [no] busy-overwrite
----ltline
- (sessionid)
- lineid
- line-status
----ltparm
- (sessionid)
- test-name(unit)
- value1
- value2
- value3
- value4
- value5
- min-threshold
- max-threshold

1020

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

46.2 Megaco LineTest Session Configuration


Command
Command Description
This command allows the operator to configure the MEGACO LineTest session parameters.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure linetest cluster (cluster-id) ltsession (sessionid) [ session-cmd <LineTest::SessCmdForConfig> ] [
ownerid <Gauge> ] [ timeout-period <LineTest::TimeOutPer> ] [ line-num <LineTest::LineNum> ] [ type-high
<LineTest::ltTypeHigh> ] [ type-low <LineTest::ltTypeLow> ] [ test-parm-num <LineTest::TestParmNum> ] [
test-mode <LineTest::TestModeForConfig> ] [ type-extend <LineTest::ltTypeExtend> ]

Command Parameters
Table 46.2-1 "Megaco LineTest Session Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- available session id
- range: [1]

uniquely identify of this xvps


cluster

(sessionid)

uniquely identify of session

Table 46.2-2 "Megaco LineTest Session Configuration Command" Command Parameters


Parameter

Type

Description

session-cmd

Parameter type: <LineTest::SessCmdForConfig>


Format:
( create
| starttest
| sendinfo
| startinfo
| destroy
| recv-subtest
| start-subtest
| repeat
| endtest )
Possible values:
- create : create a test session

optional parameter
the linetest session command

3HH-04416-EBAA-TCZZA 01

Released

1021

46 LineTest Configuration Commands

Parameter

Type

ownerid
timeout-period

line-num

type-high

type-low

1022

Description

- starttest : transfer data done, start a test


- sendinfo : start to transfer info data for an underway test
- startinfo : transfer info data done, start info operation
- destroy : destroy a test session
- recv-subtest : start to transfer the sub-test's data
- start-subtest : transfer sub-test's data done, start the sub-test
- repeat : repeat the last test
- endtest : end current test session
Parameter type: <Gauge>
Format:
- gauge
Parameter type: <LineTest::TimeOutPer>
Format:
- timeout period
- unit: second
- range: [0...4294967295]
Parameter type: <LineTest::LineNum>
Format:
- line number in the session of test
- range: [1...72]
Parameter type: <LineTest::ltTypeHigh>
Format:
( none
| group
| feeded-ac-vol
| foreign-ac-vol
| feeded-dc-vol
| foreign-dc-vol
| feeding-current
| resistance
| capacitance
| impedance
| low-capacit-phone
| dialton-delay
| msocket-detection )
Possible values:
- none : null
group
:
group
test,
HBit28/27/26/22/21/20/17/16/15/14/11/9/8
- feeded-ac-vol : feeded ac rms voltage test, HBit31/30/29
- foreign-ac-vol : foreign ac rms voltage test, HBit26/27/28
- feeded-dc-vol : feeded dc voltage test, HBit18/23/24/25
- foreign-dc-vol : foreign dc voltage test, HBit20/21/22
- feeding-current : feeding current test, HBit19
resistance
:
insulating
resistance
test,
HBit12/13/14/15/16/17(ISDN line test only support
HBit14/15/16/17)
- capacitance : capacitance test, HBit8/9/10/11
- impedance : impedance test, HBit4/5/6/7
- low-capacit-phone : low capacitance phone detect test,
HBit3
- dialton-delay : dial tone delay test of user circuit only in
idle , HBit1
- msocket-detection : termination (m socket detection) test,
HBit0
Parameter type: <LineTest::ltTypeLow>
Format:

Released

optional parameter
ownerid of the session
optional parameter
timeout period

optional parameter
line number in the session of test
optional parameter
indicate line test items

optional parameter
indicate line test items

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Parameter

test-parm-num

test-mode

type-extend

3HH-04416-EBAA-TCZZA 01

Type

Description

( none
| ac-current
| dc-current
| noise-level
| howler
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub
| isdn-loopback )
Possible values:
- none : null
- ac-current : ac current test normal test, LBit29/30/31
- dc-current : dc current test normal test, LBit28/27/26
- noise-level : noise level normal test, LBit24
- howler : howler test under normal test, LBit22
- status-monitored : status monitored test, LBit20
- cable-pair-ident : cable pair identification test, LBit19
- talking-father : talking test (father test item), LBit18
- line-reverse-sub : line reverse test, subtest of talking test,
LBit17
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test, LBit16
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test, LBit15
- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking
test, LBit14
- userloop-sub : resistance of user loop (rip-ring), subtest of
talking test, LBit13
- isdn-loopback : isdn loop back test, LBit10
Parameter type: <LineTest::TestParmNum>
Format:
- parameter lines number in the session of test
- range: [0...6]
Parameter type: <LineTest::TestModeForConfig>
Format:
( single
| interactive
| cablepair )
Possible values:
- single : the test will be end after one time
- interactive : the interactive test
- cablepair : the cable pair test
Parameter type: <LineTest::ltTypeExtend>
Format:
( none
| gr909-ringers
| gr909-dialtone-d
| gr909-roh
| gr909-hazardous-p
| gr909-femf
| gr909-resistive-f )
Possible values:

optional parameter
parameter lines number in the
session for test
optional parameter
test mode

optional parameter
indicate line test items

Released

1023

46 LineTest Configuration Commands

Parameter

Type

Description

- none : null
- gr909-ringers : ringers test, ExBit26
- gr909-dialtone-d : draw and break dial tone delay test,
ExBit25
- gr909-roh : receiver off hook test, ExBit24
- gr909-hazardous-p : hazardous potential test, ExBit23,
- gr909-femf : foreign electromotive force test, ExBit22
- gr909-resistive-f : resistive faults test, ExBit21

1024

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

46.3 Megaco LineTest Line Configuration


Command
Command Description
This command allows the operator to configure the MEGACO LineTest line parameters.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure linetest cluster (cluster-id) ltline (sessionid) lineid <Itf::LineTestMegacoLineId> [ line-status
<LineTest::LineStatusForConfig> ]

Command Parameters
Table 46.3-1 "Megaco LineTest Line Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- available session id
- range: [1]
Parameter type: <Itf::LineTestMegacoLineId>
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::NewSlotId> / <Eqpt::MegacoPortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

uniquely identify of this xvps


cluster

(sessionid)
lineid

uniquely identify of session


Identify of line

Table 46.3-2 "Megaco LineTest Line Configuration Command" Command Parameters


Parameter

Type

Description

line-status

Parameter type: <LineTest::LineStatusForConfig>

optional parameter

3HH-04416-EBAA-TCZZA 01

Released

1025

46 LineTest Configuration Commands

Parameter

Type

Description

Format:
status of line for test
( intest
| testover
| rstpartlyready )
Possible values:
- intest : put the line in test
- testover : the line tested, and the result is ready for polling,
it is read-only
- rstpartlyready : defined for dp/dtmf test

1026

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

46.4 MEGACO LineTest Param Configuration


Command
Command Description
This command allows the operator to manage megaco linetest parameters.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> configure linetest cluster (cluster-id) ltparm (sessionid) test-name(unit) <LineTest::TestTypeMegaco> [ value1
<LineTest::ExtRpVal> ] [ value2 <LineTest::ExtRpVal> ] [ value3 <LineTest::ExtRpVal> ] [ value4
<LineTest::ExtRpVal> ] [ value5 <LineTest::ExtRpVal> ] [ min-threshold <LineTest::TestThreshold> ] [
max-threshold <LineTest::TestThreshold> ] [ min-threshold2 <LineTest::TestThreshold> ] [ max-threshold2
<LineTest::TestThreshold> ]

Command Parameters
Table 46.4-1 "MEGACO LineTest Param Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- available session id
- range: [1...16]
Parameter type: <LineTest::TestTypeMegaco>
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)
| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)
| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)

uniquely identify of this xvps


cluster

(sessionid)
test-name(unit)

3HH-04416-EBAA-TCZZA 01

uniquely identify of session


test type

Released

1027

46 LineTest Configuration Commands

Resource Identifier

Type

Description

| resist-rt(ohm)
| resist-tg(ohm)
| resist-rg(ohm)
| resist-tbat(ohm)
| resist-rbat(ohm)
| capacitanc-tr(nf)
| capacitanc-rt(nf)
| capacitanc-tg(nf)
| capacitanc-rg(nf)
| impedance-tr(ohm)
| impedance-tg(ohm)
| impedance-rg(ohm)
| low-capacit-phone
| bat-imped-discard
| dialton-delay(ms)
| msocket-detection
| ac-current-tr(ua)
| ac-current-tg(ua)
| ac-current-rg(ua)
| dc-current-tr(ua)
| dc-current-tg(ua)
| dc-current-rg(ua)
| noise-lv-0.001dbm
| howler-test-park
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub(ohm)
| feeded-dc-tg(mv)
| feeded-dc-rg(mv)
| impedance-rt(ohm)
| isdn-loopback
| ringer-ren(1000ren)
| dialtone-delay-db(ms)
| gr909-roh
| gr909-hazardous-p
| gr909-femf
| gr909-resistive-f )
Possible values:
- feeded-ac-tr(mv) : feeded ac rms voltage of user line
(tip-ring)
- feeded-ac-tg(mv) : feeded ac rms voltage of user line
(tip-ground)
- feeded-ac-rg(mv) : feeded ac rms voltage of user line
(ring-ground)
- foreign-ac-tr(mv) : foreign ac rms voltage of user line
(tip-ring)
- foreign-ac-tg(mv) : foreign ac rms voltage of user line
(tip-ground)
- foreign-ac-rg(mv) : foreign ac rms voltage of user line
(ring-ground)
- feeded-dc-tr(mv) : feeded dc voltage of user line (tip-ring)
- foreign-dc-tr(mv) : foreign dc voltage of user line (tip-ring)

1028

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Resource Identifier

Type

Description

- foreign-dc-tg(mv) : foreign dc voltage of user line


(tip-ground)
- foreign-dc-rg(mv) : foreign dc voltage of user line
(ring-ground)
- feed-current(ua) : feeding current (tip-ring)
- feeded-dc-rt(mv) : feeded dc voltage of user line (ring-tip)
- resist-tr(ohm) : insulating resistance of user line (tip-ring)
- resist-rt(ohm) : insulating resistance of user line (ring-tip)
- resist-tg(ohm) : insulating resistance of user line
(tip-ground)
- resist-rg(ohm) : insulating resistance of user line
(ring-ground)
- resist-tbat(ohm) : insulating battery resistance of user line
(tip-bat)
- resist-rbat(ohm) : insulating battery resistance of user line
(ring-bat)
- capacitanc-tr(nf) : capacitance of user line (tip-ring)
- capacitanc-rt(nf) : capacitance of user line (ring-tip)
- capacitanc-tg(nf) : capacitance of user line (tip-ground)
- capacitanc-rg(nf) : capacitance of user line (ring-ground)
- impedance-tr(ohm) : impedance of user circuit (tip-ring)
- impedance-tg(ohm) : impedance of user circuit
(tip-ground)
- impedance-rg(ohm) : impedance of user circuit
(ring-ground)
- low-capacit-phone : low capacitance phone detect
- bat-imped-discard : battery impedance (ring-bat) discarded
- dialton-delay(ms) : dial tone delay of user circuit only in
idle
- msocket-detection : termination (m socket detection)
- ac-current-tr(ua) : ac current test normal test (tip-ring)
- ac-current-tg(ua) : ac current test normal test (tip-ground)
- ac-current-rg(ua) : ac current test normal test (ring-ground)
- dc-current-tr(ua) : dc current test normal test (tip-ring)
- dc-current-tg(ua) : dc current test normal test (tip-ground)
- dc-current-rg(ua) : dc current test normal test (ring-ground)
- noise-lv-0.001dbm : noise level normal test
- howler-test-park : howler test under normal test condition
only in parking
- status-monitored : status monitored test
- cable-pair-ident : cable pair identification test
- talking-father : talking test (father test item)
- line-reverse-sub : line reverse test, subtest of talking test
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test
- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking
test
- userloop-sub(ohm) : resistance of user loop (rip-ring),
subtest of talking test
- feeded-dc-tg(mv) : feeded dc voltage of user line
(tip-ground)
- feeded-dc-rg(mv) : feeded dc voltage of user line
(ring-ground)
- impedance-rt(ohm) : impedance of user circuit (ring-tip)
- isdn-loopback : isdn loop back test

3HH-04416-EBAA-TCZZA 01

Released

1029

46 LineTest Configuration Commands

Resource Identifier

Type

Description

- ringer-ren(1000ren) : gr909 ringer equivalency number


testing
- dialtone-delay-db(ms) : gr909 draw and break dial tone
delay testing
- gr909-roh : gr909 receiver off hook testing
- gr909-hazardous-p : gr909 Hazardous Potential testing
- gr909-femf : gr909 Foreign ElectroMotive Force testing
- gr909-resistive-f : gr909 resistive faults testing

Table 46.4-2 "MEGACO LineTest Param Configuration Command" Command Parameters


Parameter

Type

Description

value1

Parameter type: <LineTest::ExtRpVal>


Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]

optional parameter
test parameter value1

value2

value3

value4

value5

min-threshold

max-threshold

min-threshold2

max-threshold2

1030

Released

optional parameter
test parameter value2

optional parameter
test parameter value3

optional parameter
test parameter value4

optional parameter
test parameter value5

optional parameter
threshold min of this test type
optional parameter
threshold max of this test type
optional parameter
threshold2 min of this test type
optional parameter
threshold2 max of this test type

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

3HH-04416-EBAA-TCZZA 01

Released

1031

46 LineTest Configuration Commands

46.5 SINGLE LineTest Session Configuration


Command
Command Description
This command allows the operator to configure the single LineTest session parameters.

User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.

Command Syntax
The command has the following syntax:
> configure linetest single ltsession (sessionid) [ session-cmd <LineTest::SessCmdForConfig> ] [ ownerid
<Gauge> ] [ timeout-period <LineTest::TimeOutPer> ] [ line-num <LineTest::LineNum> ] [ type-high
<LineTest::ltTypeHigh> ] [ type-low <LineTest::ltTypeLowSip> ] [ test-parm-num <LineTest::TestParmNum> ] [
test-mode <LineTest::TestModeForConfig> ] [ inactive-timer <LineTest::InactTimer> ] [ type-extend
<LineTest::ltTypeExtendSip> ] [ no group-opt | group-opt <LineTest::ltGroupTestOpt> ] [ no busy-overwrite |
busy-overwrite <LineTest::ltBusyOverwriteFlag> ]

Command Parameters
Table 46.5-1 "SINGLE LineTest Session Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(sessionid)

Format:
- available session id
- range: [1...16]

uniquely identify of session

Table 46.5-2 "SINGLE LineTest Session Configuration Command" Command Parameters


Parameter

Type

Description

session-cmd

Parameter type: <LineTest::SessCmdForConfig>


Format:
( create
| starttest
| sendinfo
| startinfo
| destroy
| recv-subtest
| start-subtest
| repeat
| endtest )
Possible values:
- create : create a test session
- starttest : transfer data done, start a test

optional parameter
the linetest session command

1032

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Parameter

ownerid
timeout-period

line-num

type-high

type-low

3HH-04416-EBAA-TCZZA 01

Type

Description

- sendinfo : start to transfer info data for an underway test


- startinfo : transfer info data done, start info operation
- destroy : destroy a test session
- recv-subtest : start to transfer the sub-test's data
- start-subtest : transfer sub-test's data done, start the sub-test
- repeat : repeat the last test
- endtest : end current test session
Parameter type: <Gauge>
Format:
- gauge
Parameter type: <LineTest::TimeOutPer>
Format:
- timeout period
- unit: second
- range: [0...4294967295]
Parameter type: <LineTest::LineNum>
Format:
- line number in the session of test
- range: [1...72]
Parameter type: <LineTest::ltTypeHigh>
Format:
( none
| group
| feeded-ac-vol
| foreign-ac-vol
| feeded-dc-vol
| foreign-dc-vol
| feeding-current
| resistance
| capacitance
| impedance
| low-capacit-phone
| dialton-delay
| msocket-detection )
Possible values:
- none : null
group
:
group
test,
HBit28/27/26/22/21/20/17/16/15/14/11/9/8
- feeded-ac-vol : feeded ac rms voltage test, HBit31/30/29
- foreign-ac-vol : foreign ac rms voltage test, HBit26/27/28
- feeded-dc-vol : feeded dc voltage test, HBit18/23/24/25
- foreign-dc-vol : foreign dc voltage test, HBit20/21/22
- feeding-current : feeding current test, HBit19
resistance
:
insulating
resistance
test,
HBit12/13/14/15/16/17(ISDN line test only support
HBit14/15/16/17)
- capacitance : capacitance test, HBit8/9/10/11
- impedance : impedance test, HBit4/5/6/7
- low-capacit-phone : low capacitance phone detect test,
HBit3
- dialton-delay : dial tone delay test of user circuit only in
idle , HBit1
- msocket-detection : termination (m socket detection) test,
HBit0
Parameter type: <LineTest::ltTypeLowSip>
Format:
( none

optional parameter
ownerid of the session
optional parameter
timeout period

optional parameter
line number in the session of test
optional parameter
indicate line test items

optional parameter
indicate line test items

Released

1033

46 LineTest Configuration Commands

Parameter

Type

test-parm-num

test-mode

1034

Description

| ac-current
| dc-current
| noise-level
| howler
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub
| etsi-signature
| electronic-ringer
| longitudinal-current
| conductance
| susceptance
| iltf-hazardous-voltage )
Possible values:
- none : null
- ac-current : ac current test normal test, LBit29/30/31
- dc-current : dc current test normal test, LBit28/27/26
- noise-level : noise level normal test, LBit24
- howler : howler test under normal test, LBit22
- status-monitored : status monitored test, LBit20
- cable-pair-ident : cable pair identification test, LBit19
- talking-father : talking test (father test item), LBit18
- line-reverse-sub : line reverse test, subtest of talking test,
LBit17
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test, LBit16
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test, LBit15
- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking
test, LBit14
- userloop-sub : resistance of user loop (rip-ring), subtest of
talking test, LBit13
- etsi-signature : etsi signature test, including capacitance
and resistance, LBit12/11, for MELT only
- electronic-ringer : electronic ringer detect test, including
capacitance and resistance, LBit12/11, for NPOT-B only
- longitudinal-current : longitudinal current test, LBit9
- conductance : termination conductance test, LBit4/5/6,
only applicable for MELT
- susceptance : termination susceptance test, LBit1/2/3, only
applicable for MELT
- iltf-hazardous-voltage: hazardous voltage detection test,
LBit0, only applicable for MELT
Parameter type: <LineTest::TestParmNum>
Format:
- parameter lines number in the session of test
- range: [0...6]
Parameter type: <LineTest::TestModeForConfig>
Format:
( single
| interactive
| cablepair )

Released

optional parameter
parameter lines number in the
session for test
optional parameter
test mode

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Parameter

inactive-timer

type-extend

[no] group-opt

[no] busy-overwrite

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- single : the test will be end after one time
- interactive : the interactive test
- cablepair : the cable pair test
Parameter type: <LineTest::InactTimer>
Format:
- session inactive timer, 0 means never destroy the session
automatically
- unit: second
- range: [0,120...65535]
Parameter type: <LineTest::ltTypeExtendSip>
Format:
( none
| iltf-term-signature
| iltf-term-capacitiv
| iltf-ppa-test
| roh-test )
Possible values:
- none : null
- iltf-term-signature : galvanic signature detection, ExBit31,
only applicable for MELT
- iltf-term-capacitiv : end device capacitance >50nF
detection, ExBit30, only applicable for MELT
- iltf-ppa-test : ppa variant test, ExBit29, only applicable for
MELT
- roh-test : termination roh test, ExBit28, only applicable for
MELT
Parameter type: <LineTest::ltGroupTestOpt>
Format:
( none
| extended
| melt-collective )
Possible values:
- none : identifier group test normal report value
- extended : identifier group test extended report value
- melt-collective : identifier melt collective tests
Parameter type: <LineTest::ltBusyOverwriteFlag>
Format:
( true
| false )
Possible values:
- true : busy overwrite enable
- false : busy overwrite disable

optional parameter
session inactive timer

optional parameter
indicate line test items

optional parameter with default


value: "none"
indicate line test items

optional parameter with default


value: "false"
Session Busy Overwrite status

Released

1035

46 LineTest Configuration Commands

46.6 SINGLE LineTest Line Configuration


Command
Command Description
This command allows the operator to configure the single LineTest line parameters.

User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.

Command Syntax
The command has the following syntax:
> configure linetest single ltline
<LineTest::LineStatusForConfig> ]

(sessionid)

lineid

<Itf::LineTestSingleLineId>

line-status

Command Parameters
Table 46.6-1 "SINGLE LineTest Line Configuration Command" Resource Parameters
Resource Identifier

Type

(sessionid)

Format:
uniquely identify of session
- available session id
- range: [1...16]
Parameter type: <Itf::LineTestSingleLineId>
Identify of line
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

lineid

Description

Table 46.6-2 "SINGLE LineTest Line Configuration Command" Command Parameters


Parameter

Type

Description

line-status

Parameter type: <LineTest::LineStatusForConfig>


Format:
( intest
| testover

optional parameter
status of line for test

1036

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Parameter

Type

Description

| rstpartlyready )
Possible values:
- intest : put the line in test
- testover : the line tested, and the result is ready for polling,
it is read-only
- rstpartlyready : defined for dp/dtmf test

3HH-04416-EBAA-TCZZA 01

Released

1037

46 LineTest Configuration Commands

46.7 SINGLE LineTest Param Configuration


Command
Command Description
This command allows the operator to manage single linetest parameters.

User Level
The command can be accessed by operators with sip , xdsl privileges, and executed by operators with sip , xdsl
privileges.

Command Syntax
The command has the following syntax:
> configure linetest single ltparm (sessionid) test-name(unit) <LineTest::TestTypeSip> [ value1
<LineTest::ExtRpVal> ] [ value2 <LineTest::ExtRpVal> ] [ value3 <LineTest::ExtRpVal> ] [ value4
<LineTest::ExtRpVal> ] [ value5 <LineTest::ExtRpVal> ] [ min-threshold <LineTest::TestThreshold> ] [
max-threshold <LineTest::TestThreshold> ]

Command Parameters
Table 46.7-1 "SINGLE LineTest Param Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(sessionid)

Format:
- available session id
- range: [1...16]
Parameter type: <LineTest::TestTypeSip>
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)
| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)
| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)
| resist-rt(ohm)
| resist-tg(ohm)
| resist-rg(ohm)
| resist-tbat(ohm)

uniquely identify of session

test-name(unit)

1038

Released

test type

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Resource Identifier

Type
| resist-rbat(ohm)
| capacitanc-tr(nf)
| capacitanc-rt(nf)
| capacitanc-tg(nf)
| capacitanc-rg(nf)
| impedance-tr(ohm)
| impedance-tg(ohm)
| impedance-rg(ohm)
| low-capacit-phone
| bat-imped-discard
| dialton-delay(ms)
| msocket-detection
| ac-current-tr(ua)
| ac-current-tg(ua)
| ac-current-rg(ua)
| dc-current-tr(ua)
| dc-current-tg(ua)
| dc-current-rg(ua)
| noise-lv-0.001dbm
| howler-test-park
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub(ohm)
| capacit-sign(pf)
| resist-sign(ohm)
| feeded-dc-tg(mv)
| feeded-dc-rg(mv)
| impedance-rt(ohm)
| long-current(ua)
| diagnosis-caller
| diagnosis-callee
| conductance-tr(1/10us)
| conductance-tg(1/10us)
| conductance-rg(1/10us)
| susceptance-tr(1/10us)
| susceptance-tg(1/10us)
| susceptance-rg(1/10us)
| hazardous-volt(1/2)
| term-signature(1/0)
| term-capacitiv(1/0)
| ppa-test(ppa-variant)
| roh-test(1/0) )
Possible values:
- feeded-ac-tr(mv) : feeded ac rms voltage
(tip-ring)
- feeded-ac-tg(mv) : feeded ac rms voltage
(tip-ground)
- feeded-ac-rg(mv) : feeded ac rms voltage
(ring-ground)
- foreign-ac-tr(mv) : foreign ac rms voltage
(tip-ring)
- foreign-ac-tg(mv) : foreign ac rms voltage

3HH-04416-EBAA-TCZZA 01

Description

of user line
of user line
of user line
of user line
of user line

Released

1039

46 LineTest Configuration Commands

Resource Identifier

Type

Description

(tip-ground)
- foreign-ac-rg(mv) : foreign ac rms voltage of user line
(ring-ground)
- feeded-dc-tr(mv) : feeded dc voltage of user line (tip-ring)
- foreign-dc-tr(mv) : foreign dc voltage of user line (tip-ring)
- foreign-dc-tg(mv) : foreign dc voltage of user line
(tip-ground)
- foreign-dc-rg(mv) : foreign dc voltage of user line
(ring-ground)
- feed-current(ua) : feeding current (tip-ring)
- feeded-dc-rt(mv) : feeded dc voltage of user line (ring-tip)
- resist-tr(ohm) : insulating resistance of user line (tip-ring)
- resist-rt(ohm) : insulating resistance of user line (ring-tip)
- resist-tg(ohm) : insulating resistance of user line
(tip-ground)
- resist-rg(ohm) : insulating resistance of user line
(ring-ground)
- resist-tbat(ohm) : insulating battery resistance of user line
(tip-bat)
- resist-rbat(ohm) : insulating battery resistance of user line
(ring-bat)
- capacitanc-tr(nf) : capacitance of user line (tip-ring)
- capacitanc-rt(nf) : capacitance of user line (ring-tip)
- capacitanc-tg(nf) : capacitance of user line (tip-ground)
- capacitanc-rg(nf) : capacitance of user line (ring-ground)
- impedance-tr(ohm) : impedance of user circuit (tip-ring)
- impedance-tg(ohm) : impedance of user circuit
(tip-ground)
- impedance-rg(ohm) : impedance of user circuit
(ring-ground)
- low-capacit-phone : low capacitance phone detect
- bat-imped-discard : battery impedance (ring-bat) discarded
- dialton-delay(ms) : dial tone delay of user circuit only in
idle
- msocket-detection : termination (m socket detection)
- ac-current-tr(ua) : ac current test normal test (tip-ring)
- ac-current-tg(ua) : ac current test normal test (tip-ground)
- ac-current-rg(ua) : ac current test normal test (ring-ground)
- dc-current-tr(ua) : dc current test normal test (tip-ring)
- dc-current-tg(ua) : dc current test normal test (tip-ground)
- dc-current-rg(ua) : dc current test normal test (ring-ground)
- noise-lv-0.001dbm : noise level normal test
- howler-test-park : howler test under normal test condition
only in parking
- status-monitored : status monitored test
- cable-pair-ident : cable pair identification test
- talking-father : talking test (father test item)
- line-reverse-sub : line reverse test, subtest of talking test
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test
- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking
test
- userloop-sub(ohm) : resistance of user loop (rip-ring),
subtest of talking test
- capacit-sign(pf) : capacitance of etsi signature or electronic

1040

Released

3HH-04416-EBAA-TCZZA

01

46 LineTest Configuration Commands

Resource Identifier

Type

Description

ringer
- resist-sign(ohm) : resistance of etsi signature or electronic
ringer
- feeded-dc-tg(mv) : feeded dc voltage of user line
(tip-ground)
- feeded-dc-rg(mv) : feeded dc voltage of user line
(ring-ground)
- impedance-rt(ohm) : impedance of user circuit (ring-tip)
- long-current(ua) : difference between the currents on the
a-lead and the b-lead (longitudinal current)
- diagnosis-caller : H248 Voice Diagnosis Caller
- diagnosis-callee : H248 Voice Diagnosis Callee
- conductance-tr(1/10us): Conductance of user line
(Tip-Ring)
- conductance-tg(1/10us): Conductance of user line
(Tip-Ground)
- conductance-rg(1/10us): Conductance of user line
(Ring-Ground)
- susceptance-tr(1/10us): Susceptance of user line
(Tip-Ring)
- susceptance-tg(1/10us): Susceptance of user line
(Tip-Ground)
- susceptance-rg(1/10us): Susceptance of user line
(Ring-Ground)
- hazardous-volt(1/2) : whether voltage value is hazardous or
not(iltf-hazardous-voltage)
- term-signature(1/0) : whether termination signature is
detected(iltf-termination-signature)
- term-capacitiv(1/0) : whether termination capacitance is
detected(iltf-termination-capacitiv)
- ppa-test(ppa-variant) : test ppa variant(iltf-ppa)
- roh-test(1/0) : test termination roh

Table 46.7-2 "SINGLE LineTest Param Configuration Command" Command Parameters


Parameter

Type

Description

value1

Parameter type: <LineTest::ExtRpVal>


Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The

optional parameter
test parameter value1

value2

value3

value4

3HH-04416-EBAA-TCZZA 01

optional parameter
test parameter value2

optional parameter
test parameter value3

optional parameter
test parameter value4

Released

1041

46 LineTest Configuration Commands

Parameter

Type

value5

min-threshold

max-threshold

1042

Description

following is the max range.


- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
Format:
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]
Parameter type: <LineTest::TestThreshold>
Format:
- threshold of the test type
- range: [-2147483647...2147483647]

Released

optional parameter
test parameter value5

optional parameter
threshold min of this test type
optional parameter
threshold max of this test type

3HH-04416-EBAA-TCZZA

01

47- LACP Configuration Commands

47.1 LACP Configuration Command Tree


47.2 LACP general configuration command
47.3 LACP port configuration command
47.4 LACP group configuration command
47.5 LACP Group Port configuration command

3HH-04416-EBAA-TCZZA 01

47-1044
47-1045
47-1046
47-1047
47-1049

Released

1043

47 LACP Configuration Commands

47.1 LACP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "LACP Configuration Commands".

Command Tree
----configure
----link-agg
----general
- [no] priority
----port
- (port)
- [no] passive-lacp
- [no] short-timeout
- [no] actor-port-prio
----group
- (group)
- load-sharing-policy
- [no] max-active-port
- mode
----[no] port
- (port)

1044

Released

3HH-04416-EBAA-TCZZA

01

47 LACP Configuration Commands

47.2 LACP general configuration command


Command Description
This command allows the operator to configure the general LACP parameters.

User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> configure link-agg general [ no priority | priority <Lacp::SysPriority> ]

Command Parameters
Table 47.2-2 "LACP general configuration command" Command Parameters
Parameter

Type

Description

[no] priority

Parameter type: <Lacp::SysPriority>


Format:
- the lacp system priority
- range: [1...65535]

optional parameter with default


value: 1
the lacp system priority

3HH-04416-EBAA-TCZZA 01

Released

1045

47 LACP Configuration Commands

47.3 LACP port configuration command


Command Description
This command allows the operator to configure the link aggregation port parameters.

User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> configure link-agg port (port) [ [ no ] passive-lacp ] [ [ no ] short-timeout ] [ no actor-port-prio | actor-port-prio
<Lacp::ActorPortPriority> ]

Command Parameters
Table 47.3-1 "LACP port configuration command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 47.3-2 "LACP port configuration command" Command Parameters


Parameter

Type

Description

[no] passive-lacp

Parameter type: boolean

[no] short-timeout

Parameter type: boolean

[no] actor-port-prio

Parameter type: <Lacp::ActorPortPriority>


Format:
- la aggregate port priority
- range: [0...255]

optional parameter
set lacp inactive for the actor
optional parameter
short timeout for the lacp
protocol
optional parameter with default
value: "1"
port priority for the actor

1046

Released

3HH-04416-EBAA-TCZZA

01

47 LACP Configuration Commands

47.4 LACP group configuration command


Command Description
This command allows the operator to configure the link aggregation group parameters.

User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> configure link-agg group (group) [ load-sharing-policy <Lacp::LoadSharingPolicy> ] [ no max-active-port |
max-active-port <Lacp::MaxActivePort> ] [ mode <Lacp::Mode> ]

Command Parameters
Table 47.4-1 "LACP group configuration command" Resource Parameters
Resource Identifier

Type

(group)

Format:
interface index of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description
the

link

Table 47.4-2 "LACP group configuration command" Command Parameters


Parameter

Type

Description

load-sharing-policy

Parameter type: <Lacp::LoadSharingPolicy>


Format:
( mac-src
| mac-dst
| mac-src-dst
| ip-src
| ip-dst
| ip-src-dst )
Possible values:
- mac-src : source mac based
- mac-dst : destination mac based
- mac-src-dst : source and destination mac based
- ip-src : source ip based
- ip-dst : destination ip based

optional parameter
link aggregation load sharing
policy

3HH-04416-EBAA-TCZZA 01

Released

1047

47 LACP Configuration Commands

Parameter

Type

[no] max-active-port

mode

1048

Released

- ip-src-dst : source and destination ip based


Parameter type: <Lacp::MaxActivePort>
Format:
- max active port
- range: [1...8]
Parameter type: <Lacp::Mode>
Format:
( static
| dynamic )
Possible values:
- static : static mode
- dynamic : dynamic mode

Description
optional parameter with default
value: 8
the max active port number in a
LAG
optional parameter
lacp mode

3HH-04416-EBAA-TCZZA

01

47 LACP Configuration Commands

47.5 LACP Group Port configuration command


Command Description
This command allows the operator to add/remove link aggregation group member ports.

User Level
The command can be accessed by operators with lacp privileges, and executed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> configure link-agg group (group) ( no port (port) ) | ( port (port) )

Command Parameters
Table 47.5-1 "LACP Group Port configuration command" Resource Parameters
Resource Identifier

Type

(group)

Format:
interface index of the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
Interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

(port)

3HH-04416-EBAA-TCZZA 01

Description

Released

1049

link

48- MSTP Configuration Commands

48.1 MSTP Configuration Command Tree


48.2 MSTP general configuration Command
48.3 MSTP Instance configuration Command
48.4 MSTP Vlan-Instance Mapping configuration
Command
48.5 MSTP Port configuration Command
48.6 MSTP Port-Instance configuration Command

1050

Released

48-1051
48-1052
48-1054
48-1055
48-1056
48-1058

3HH-04416-EBAA-TCZZA

01

48 MSTP Configuration Commands

48.1 MSTP Configuration Command Tree


Description
This chapter gives an overview of nodes that are handled by "MSTP Configuration Commands".

Command Tree
----configure
----xstp
----general
- [no] enable-stp
- [no] priority
- [no] max-instance-num
- [no] max-age
- [no] hello-time
- [no] forward-delay
- [no] version
- [no] tx-hold-count
- [no] path-cost-type
- [no] max-hop-count
- region-name
- [no] region-version
- [no] config-id-sel
----[no] instance
- (instance)
- [no] priority
----[no] associate-vlan
- (vlan)
----port
- (port)
- [no] priority
- [no] enable-stp
- path-cost
- [no] edge-port
- [no] admin-p2p
- [no] hello-time
----port-instance
- (port)
- instance
- [no] priority
- [no] enable-stp
- path-cost

3HH-04416-EBAA-TCZZA 01

Released

1051

48 MSTP Configuration Commands

48.2 MSTP general configuration Command


Command Description
This command allows the operator to configure the general MSTP parameters .The configuration of the parameters
apply for the whole bridge.
The port, instance and port-instance specific MSTP parameters are in subsequent chapters.
The bridge max-age value should be less than or equal to (2 * ((forward-delay/100)-1) and should be greater than
or equal to (2 * ((Port hello-time/100) + 1)).
The bridge hello-time is only applicable when the version is stp/rstp, in case of version mstp the port hello-time is
used.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> configure xstp general [ [ no ] enable-stp ] [ no priority | priority <Mstp::StpPriority> ] [ no max-instance-num |
max-instance-num <Mstp::StpMaxInstanceNumber> ] [ no max-age | max-age <Mstp::StpMaxAge> ] [ no
hello-time | hello-time <Mstp::StpHelloTime> ] [ no forward-delay | forward-delay <Mstp::StpFwDelay> ] [ no
version | version <Mstp::StpProtVersion> ] [ no tx-hold-count | tx-hold-count <Mstp::StpTxHoldCount> ] [ no
path-cost-type | path-cost-type <Mstp::StpPathCostType> ] [ no max-hop-count | max-hop-count
<Mstp::StpMaxHopCount> ] [ region-name <Mstp::StpRegionName> ] [ no region-version | region-version
<Mstp::StpRegionVersion> ] [ no config-id-sel | config-id-sel <Mstp::StpConfigIdSelector> ]

Command Parameters
Table 48.2-2 "MSTP general configuration Command" Command Parameters
Parameter

Type

Description

[no] enable-stp

Parameter type: boolean

[no] priority

Parameter type: <Mstp::StpPriority>


Format:
- stp bridge priority(n*4096)
- range: [0...61440]
Parameter type: <Mstp::StpMaxInstanceNumber>
Format:
- the max spanning trees number
- range: [1...65]
Parameter type: <Mstp::StpMaxAge>
Format:
- stp bridge priority(n*100)
- unit: 10msec
- range: [600...4000]

optional parameter
all stp protocol operations start
optional parameter with default
value: 32768
stp bridge priority(n*4096)

[no] max-instance-num

[no] max-age

1052

Released

optional parameter with default


value: 65
the maximun number of spanning
trees to be allowed
optional parameter with default
value: 2000
stp
max-age
for
root-bridge(n*100)

3HH-04416-EBAA-TCZZA

01

48 MSTP Configuration Commands

Parameter

Type

Description

[no] hello-time

Parameter type: <Mstp::StpHelloTime>


Format:
- stp bridge hello time(n*100)
- unit: 10msec
- range: [100...1000]
Parameter type: <Mstp::StpFwDelay>
Format:
- stp bridge forward delay(n*100)
- unit: 10msec
- range: [400...3000]
Parameter type: <Mstp::StpProtVersion>
Format:
( stp-compatible
| rstp
| mstp )
Possible values:
- stp-compatible : spanning tree protocol IEEE 802.1D
- rstp : rapid spanning tree protocol IEEE 802.1w
- mstp : multiple spanning tree protocol IEEE 802.1s
Parameter type: <Mstp::StpTxHoldCount>
Format:
- maximum transmission rate limit
- range: [1...10]
Parameter type: <Mstp::StpPathCostType>
Format:
( 16-bit
| 32-bit )
Possible values:
- 16-bit : stp-8021d-1998 path cost
- 32-bit : stp-8021t-2001 path cost
Parameter type: <Mstp::StpMaxHopCount>
Format:
- maximum hop count value
- unit: 10msec
- range: [600...4000]
Parameter type: <Mstp::StpRegionName>
Format:
- name of the regions configuration
- length: x<=32
Parameter type: <Mstp::StpRegionVersion>
Format:
- version of the MSTP region
- range: [0...65535]
Parameter type: <Mstp::StpConfigIdSelector>
Format:
- configuration id format selector to identify the bridge
- range: [0...255]

optional parameter with default


value: 200
stp hello-time for bridge acting as
root(n*100)

[no] forward-delay

[no] version

[no] tx-hold-count

[no] path-cost-type

[no] max-hop-count

region-name

[no] region-version

[no] config-id-sel

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 1500
forward delay value (n*100)
optional parameter with default
value: "rstp"
spanning tree protocol version

optional parameter with default


value: 3
maximum transmission rate limit
optional parameter with default
value: "32-bit"
version of stp default path costs

optional parameter with default


value: 2000
max hop count(n*100)
optional parameter
name of regions configuration(by
default the bridge mac address)
optional parameter with default
value: 0
version of the MSTP region
optional parameter with default
value: 0
configuration id selector used to
identify the bridge

Released

1053

48 MSTP Configuration Commands

48.3 MSTP Instance configuration Command


Command Description
This command allows the operator to configure the MSTP parameters for a specific MSTP instance.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> configure xstp ( no instance (instance) ) | ( instance (instance) [ no priority | priority <Mstp::StpPriority> ] )

Command Parameters
Table 48.3-1 "MSTP Instance configuration Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...64]

MSTP instance

Table 48.3-2 "MSTP Instance configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Mstp::StpPriority>


Format:
- stp bridge priority(n*4096)
- range: [0...61440]

optional parameter with default


value: 32768
the Bridge Priority(n*4096)

1054

Released

3HH-04416-EBAA-TCZZA

01

48 MSTP Configuration Commands

48.4 MSTP Vlan-Instance Mapping configuration


Command
Command Description
This command allows the operator to map/unmap VLANs to a specific MSTP instance.The VLAN can be associated
with the MSTP instance without being configured first. One or more VLANs can be associated to an instance, but
one VLAN can not be assigned to different instances.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> configure xstp instance (instance) ( no associate-vlan (vlan) ) | ( associate-vlan (vlan) )

Command Parameters
Table 48.4-1 "MSTP Vlan-Instance Mapping configuration Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...64]
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

MSTP instance

(vlan)

3HH-04416-EBAA-TCZZA 01

vlan id to be associated with the


mstp instance

Released

1055

48 MSTP Configuration Commands

48.5 MSTP Port configuration Command


Command Description
This command allows the operator to configure the port parameters for the Common Instance.
By default mstp is disabled on the ports.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> configure xstp port (port) [ no priority | priority <Mstp::MstpPortPriority> ] [ [ no ] enable-stp ] [ path-cost
<Mstp::MstpPathCost> ] [ [ no ] edge-port ] [ no admin-p2p | admin-p2p <Mstp::MstpAdminP2PPort> ] [ no
hello-time | hello-time <Mstp::StpHelloTime> ]

Command Parameters
Table 48.5-1 "MSTP Port configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
Interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 48.5-2 "MSTP Port configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Mstp::MstpPortPriority>


Format:
- mstp port priority(n*16)
- range: [0...240]
Parameter type: boolean

optional parameter with default


value: 128
mstp port priority(n*16)

[no] enable-stp
path-cost

Parameter type: <Mstp::MstpPathCost>


Format:
- port path cost
- range: [1...200000000]
Parameter type: boolean

[no] edge-port

1056

Released

optional parameter
current Msti port state enabled
optional parameter
port path cost
optional parameter

3HH-04416-EBAA-TCZZA

01

48 MSTP Configuration Commands

Parameter

Type

[no] admin-p2p

Parameter type: <Mstp::MstpAdminP2PPort>


Format:
( force-true
| force-false
| auto )
Possible values:
- force-true : p2p link connection
- force-false : shared media connection
- auto : auto
Parameter type: <Mstp::StpHelloTime>
Format:
- stp bridge hello time(n*100)
- unit: 10msec
- range: [100...1000]

[no] hello-time

3HH-04416-EBAA-TCZZA 01

Description
port state enabled for the MSTP
optional parameter with default
value: "auto"
admin p2p status of the LAN
segment attached to the port

optional parameter with default


value: 200
port hello time(n*100)

Released

1057

48 MSTP Configuration Commands

48.6 MSTP Port-Instance configuration Command


Command Description
This command allows the operator to configure the MSTP parameters for a specific port-instance configuration. In
order to be able to configure the port-instance parameters, the port must be member of the vlan-port map.This
configuration applies to the Mstp.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> configure xstp port-instance (port) instance <Mstp::MstpInstance> [
<Mstp::MstpPortPriority> ] [ [ no ] enable-stp ] [ path-cost <Mstp::MstpPathCost> ]

no

priority

priority

Command Parameters
Table 48.6-1 "MSTP Port-Instance configuration Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Mstp::MstpInstance>
mstp instance
Format:
- MSTP Instance
- range: [1...64]

instance

Description

Table 48.6-2 "MSTP Port-Instance configuration Command" Command Parameters


Parameter

Type

Description

[no] priority

Parameter type: <Mstp::MstpPortPriority>


Format:
- mstp port priority(n*16)
- range: [0...240]
Parameter type: boolean

optional parameter with default


value: 128
mstp port priority(n*16)

[no] enable-stp
path-cost

1058

Parameter type: <Mstp::MstpPathCost>


Format:

Released

optional parameter
current Msti port state enabled
optional parameter
port path cost

3HH-04416-EBAA-TCZZA

01

48 MSTP Configuration Commands

Parameter

Type

Description

- port path cost


- range: [1...200000000]

3HH-04416-EBAA-TCZZA 01

Released

1059

49- Distributed Router Configuration Commands

49.1 Distributed Router Configuration Command Tree


49.2 Drouter IP Configuration Command
49.3 Inbound MPLS LSP Configuration Command
49.4 Static Outbound MPLS LSP Configuration Command
49.5 SDP Configuration Command

1060

Released

49-1061
49-1062
49-1064
49-1065
49-1067

3HH-04416-EBAA-TCZZA

01

49 Distributed Router Configuration Commands

49.1 Distributed Router Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Distributed Router Configuration Commands".

Command Tree
----configure
----dist-router
----[no] interface
- (lt-vlan)
- [no] addrtype
- ip-address
- [no] mpls
----mpls
----[no] interface
- (index)
- label-map
----[no] static-lsp
- (lsp-name)
- interface
- push
- [no] nexthopaddrtype
- nexthop
----[no] sdp
- (sdp-id)
- lsp-name

3HH-04416-EBAA-TCZZA 01

Released

1061

49 Distributed Router Configuration Commands

49.2 Drouter IP Configuration Command


Command Description
This command allows the operator to configure a distributed router IP interface on a linecard and assign an IP
address.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-router ( no interface (lt-vlan) ) | ( interface (lt-vlan) [ no addrtype | addrtype
<Drouter::IpAddressType> ] ip-address <Drouter::IntfAddAndMask> [ [ no ] mpls ] )

Command Parameters
Table 49.2-1 "Drouter IP Configuration Command" Resource Parameters
Resource Identifier

Type

(lt-vlan)

Format:
lt-vlan index
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot stacked
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Description

Table 49.2-2 "Drouter IP Configuration Command" Command Parameters


Parameter

Type

Description

[no] addrtype

Parameter type: <Drouter::IpAddressType>


Format:
( ipv4

optional parameter with default


value: "ipv4"
specify the type of IP address

1062

Released

3HH-04416-EBAA-TCZZA

01

49 Distributed Router Configuration Commands

Parameter

ip-address

[no] mpls

3HH-04416-EBAA-TCZZA 01

Type
| ipv6 )
Possible values:
- ipv4 : ipv4
- ipv6 : ipv6
Parameter type: <Drouter::IntfAddAndMask>
Format:
<Drouter::V4AddressHex> / <Drouter::PrefixLength>
Field type <Drouter::V4AddressHex>
- IP Address
Field type <Drouter::PrefixLength>
- prefix length of the subnet
- range: [1...31]
Parameter type: boolean

Description

mandatory parameter
specify IP Address

optional parameter
enable MPLS on the IP interface

Released

1063

49 Distributed Router Configuration Commands

49.3 Inbound MPLS LSP Configuration Command


Command Description
This command allows the operator to configure an inbound MPLS LSP, include the MPLS label of an incoming
MPLS tunnel.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-router mpls ( no interface (index) label-map <Drouter::InSegLabel> ) | ( interface (index)
label-map <Drouter::InSegLabel> )

Command Parameters
Table 49.3-1 "Inbound MPLS LSP Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
MPLS enabled ip interface index
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot stacked
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Drouter::InSegLabel>
Specify incoming MPLS label
Format:
- MPLS Insegment label
- range: [32...1023]

label-map

1064

Released

Description

3HH-04416-EBAA-TCZZA

01

49 Distributed Router Configuration Commands

49.4 Static Outbound MPLS LSP Configuration


Command
Command Description
This command allows the operator to configure a static outbound MPLS LSP, include the MPLS label and nexthop
of an outgoing MPLS tunnel.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-router mpls ( no static-lsp (lsp-name) ) | ( static-lsp (lsp-name) interface <Drouter::IfIndex> push
<Drouter::OutLabel> [ no nexthopaddrtype | nexthopaddrtype <Drouter::IpAddressType> ] nexthop
<Ip::V4AddressHex> )

Command Parameters
Table 49.4-1 "Static Outbound MPLS LSP Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(lsp-name)

Format:
- LSP name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

Administrative name for the LSP

Table 49.4-2 "Static Outbound MPLS LSP Configuration Command" Command Parameters
Parameter

Type

interface

Parameter type: <Drouter::IfIndex>


mandatory parameter
Format:
specify the outgoing interface
( slot-vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::UnstackedVlan>
| slot-stacked : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot stacked
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

3HH-04416-EBAA-TCZZA 01

Description

Released

1065

49 Distributed Router Configuration Commands

Parameter

Type

push

[no] nexthopaddrtype

nexthop

1066

Released

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Drouter::OutLabel>
Format:
- Out Label
- range: [1...1048575]
Parameter type: <Drouter::IpAddressType>
Format:
( ipv4
| ipv6 )
Possible values:
- ipv4 : ipv4
- ipv6 : ipv6
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

Description

mandatory parameter
specify the outgoing label
optional parameter with default
value: "ipv4"
specify the type of next hop IP
address

mandatory parameter
Next hop IP address

3HH-04416-EBAA-TCZZA

01

49 Distributed Router Configuration Commands

49.5 SDP Configuration Command


Command Description
This command allows the operator to configure an SDP(typically corresponding to an MPLS tunnel).

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-router ( no sdp (sdp-id) ) | ( sdp (sdp-id) lsp-name <Drouter::MplsLspName> )

Command Parameters
Table 49.5-1 "SDP Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(sdp-id)

Format:
- SDP ID
- range: [1...17407]

SDP Identifier

Table 49.5-2 "SDP Configuration Command" Command Parameters


Parameter

Type

Description

lsp-name

Parameter type: <Drouter::MplsLspName>


Format:
- LSP name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

mandatory parameter
LSP name to set the LSP list

3HH-04416-EBAA-TCZZA 01

Released

1067

50- Distributed Service Configuration Commands

50.1 Distributed Service Configuration Command Tree


50.2 Distributed Service Configuration Command
50.3 SDP Binding Configuration Command
50.4 APIPE SDP Binding Configuration Command
50.5 VCL Binding Configuration Command

1068

Released

50-1069
50-1070
50-1072
50-1073
50-1074

3HH-04416-EBAA-TCZZA

01

50 Distributed Service Configuration Commands

50.1 Distributed Service Configuration Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Distributed Service Configuration Commands".

Command Tree
----configure
----[no] dist-service
- (service-id)
- [no] service-type
- [no] qos-profile
----[no] sdp
- (spoke-sdp-id)
- egress-vc-label
- ingress-vc-label
----apipe-sdp
- (spoke-sdpid)
- [no] max-cells
- [no] max-delay
----[no] apipe-pvc
- (atm-pvc)
- in-mapped-vpi
- in-mapped-vci
- out-mapped-vpi
- out-mapped-vci

3HH-04416-EBAA-TCZZA 01

Released

1069

50 Distributed Service Configuration Commands

50.2 Distributed Service Configuration Command


Command Description
This command allows the operator to configure a distributed service.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-service (service-id) [ no service-type | service-type <Drouter::ServiceType> ] [ no qos-profile |
qos-profile <Qos::QosSessionProfileName> ]

Command Parameters
Table 50.2-1 "Distributed Service Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(service-id)

Format:
- Service ID
- range: [1...2147483647]

Service Identifier

Table 50.2-2 "Distributed Service Configuration Command" Command Parameters


Parameter

Type

Description

[no] service-type

Parameter type: <Drouter::ServiceType>


Format:
( unknown
| epipe
| p3pipe
| tls
| vprn
| ies
| mirror
| apipe
| fpipe
| ipipe
| cpipe )
Possible values:
- unknown : unknown
- epipe : epipe
- p3pipe : p3pipe
- tls : tls
- vprn : vprn
- ies : ies
- mirror : mirror

optional parameter with default


value: "apipe"
Service type to be configured

1070

Released

3HH-04416-EBAA-TCZZA

01

50 Distributed Service Configuration Commands

Parameter

[no] qos-profile

3HH-04416-EBAA-TCZZA 01

Type

Description

- apipe : apipe
- fpipe : fpipe
- ipipe : ipipe
- cpipe : cpipe
Parameter type: <Qos::QosSessionProfileName>
optional parameter with default
Format:
value: "none"
( none
qos profile attached to the service
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

1071

50 Distributed Service Configuration Commands

50.3 SDP Binding Configuration Command


Command Description
This command allows the operator to associate an SDP(typically corresponding to an MPLS tunnel) to a service.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-service (service-id) ( no sdp (spoke-sdp-id) ) | ( sdp (spoke-sdp-id) egress-vc-label
<Drouter::EgressLabel> ingress-vc-label <Drouter::IngressLabel> )

Command Parameters
Table 50.3-1 "SDP Binding Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(service-id)

Format:
- Service ID
- range: [1...2147483647]
Format:
id : <Drouter::SdpId>
Possible values:
- id : SDP ID
Field type <Drouter::SdpId>
- SDP ID
- range: [1...17407]

Service Identifier

(spoke-sdp-id)

SDP Identifier

Table 50.3-2 "SDP Binding Configuration Command" Command Parameters


Parameter

Type

Description

egress-vc-label

Parameter type: <Drouter::EgressLabel>


Format:
- MPLS Egress label
- range: [1...1048575]
Parameter type: <Drouter::IngressLabel>
Format:
- MPLS ingress label
- range: [2048...18431]

mandatory parameter
MPLS label used by this device
to send packets out

ingress-vc-label

1072

Released

mandatory parameter
MPLS label used by the far-end
device

3HH-04416-EBAA-TCZZA

01

50 Distributed Service Configuration Commands

50.4 APIPE SDP Binding Configuration Command


Command Description
This command allows the operator to configure the particular association between an SDP(typically corresponding
to an MPLS tunnel) and an APIPE service, including the specific handling of upstream cell concatenation. It is
used to configure an ATM Pseudowire on a linecard.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-service (service-id) apipe-sdp (spoke-sdpid) [ no max-cells | max-cells <Drouter::MaxCells> ] [ no
max-delay | max-delay <Drouter::MaxDelay> ]

Command Parameters
Table 50.4-1 "APIPE SDP Binding Configuration Command" Resource Parameters
Resource Identifier

Type

Description

(service-id)

Format:
- Service ID
- range: [1...2147483647]
Format:
id : <Drouter::SdpId>
Possible values:
- id : SDP ID
Field type <Drouter::SdpId>
- SDP ID
- range: [1...17407]

Service Identifier

(spoke-sdpid)

SDP Identifier

Table 50.4-2 "APIPE SDP Binding Configuration Command" Command Parameters


Parameter

Type

Description

[no] max-cells

Parameter type: <Drouter::MaxCells>


Format:
- Maximum number of ATM cells to accumulate into a
MPLS packet
- range: [1...8]
Parameter type: <Drouter::MaxDelay>
Format:
- Maximum amount of time to wait while performing ATM
cell concatenation into an MPLS packet
- unit: msec
- range: [1...10]

optional parameter with default


value: 1
Maximum number of ATM cells
to accumulate into a MPLS
packet
optional parameter with default
value: 4
Maximum amount of time to wait
while performing ATM cell
concatenation into an MPLS
packet

[no] max-delay

3HH-04416-EBAA-TCZZA 01

Released

1073

50 Distributed Service Configuration Commands

50.5 VCL Binding Configuration Command


Command Description
This command allows the operator to configure an ATM cross-connect between an ATM PVC on the DSL line and
the ATM VPI/VCI value used in an ATM Pseudowire.

User Level
The command can be accessed by operators with drouter privileges, and executed by operators with drouter
privileges.

Command Syntax
The command has the following syntax:
> configure dist-service (service-id) ( no apipe-pvc (atm-pvc) ) | ( apipe-pvc (atm-pvc) in-mapped-vpi
<Drouter::InMappedVpi> in-mapped-vci <Drouter::InMappedVci> out-mapped-vpi <Drouter::OutMappedVpi>
out-mapped-vci <Drouter::OutMappedVci> )

Command Parameters
Table 50.5-1 "VCL Binding Configuration Command" Resource Parameters
Resource Identifier

Type

(service-id)

Format:
Service Identifier
- Service ID
- range: [1...2147483647]
Format:
atm pvc index
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(atm-pvc)

Description

Table 50.5-2 "VCL Binding Configuration Command" Command Parameters


Parameter

Type

Description

in-mapped-vpi

Parameter type: <Drouter::InMappedVpi>


Format:

mandatory parameter
atm inmapped vpi value for the

1074

Released

3HH-04416-EBAA-TCZZA

01

50 Distributed Service Configuration Commands

Parameter
in-mapped-vci

out-mapped-vpi

out-mapped-vci

3HH-04416-EBAA-TCZZA 01

Type

Description

- In-mapped VPI
- range: [0...255]
Parameter type: <Drouter::InMappedVci>
Format:
- In-mapped VCI
- range: [32...65535]
Parameter type: <Drouter::OutMappedVpi>
Format:
- Out-mapped VPI
- range: [0...255]
Parameter type: <Drouter::OutMappedVci>
Format:
- Out-mapped VCI
- range: [32...65535]

apipe service
mandatory parameter
atm inmapped vci value for the
apipe service
mandatory parameter
atm outmapped vpi value for the
apipe service
mandatory parameter
atm outmapped vci value for the
apipe service

Released

1075

51- Equipment Status Commands

51.1 Equipment Status Command Tree


51.2 Slot Status Command
51.3 Profile Description Command
51.4 Applique Status Command
51.5 Shelf Summary Status Command
51.6 Protection Element Status Command
51.7 Protection Group Status Command
51.8 External-link-host Status Commands
51.9 External-link-remote Status Commands
51.10 SFP/XFP Diagnostics Status Command
51.11 Sfp RSSI Configuration Command
51.12 Board Temperature Status Command
51.13 Board Planned Resource Command
51.14 Transceiver Inventory Status Command
51.15 NE Status Command
51.16 Rack Status Command
51.17 Shelf Status Command

1076

Released

51-1077
51-1078
51-1083
51-1084
51-1088
51-1090
51-1093
51-1096
51-1100
51-1103
51-1109
51-1110
51-1112
51-1114
51-1119
51-1121
51-1123

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.1 Equipment Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Equipment Status Commands".

Command Tree
----show
----equipment
----slot
- (slot)
----capab-profile
- (profilename)
----applique
- (applique)
----shelf-summary
- (shelf)
----protection-element
- (slot-id)
----protection-group
- (prot-group-id)
----external-link-host
- (faceplate-number)
----external-link-remote
- (exp-slot)
----diagnostics
----sfp
- (position)
----rssiprof
- (index)
----temperature
- (slot)
- sensor-id
----planned-resource
- (slot)
- resource-id
----transceiver-inventory
- (index)
----isam
----rack
- (rack)
----shelf
- (shelf)

3HH-04416-EBAA-TCZZA 01

Released

1077

51 Equipment Status Commands

51.2 Slot Status Command


Command Description
This commands shows the slot status. The following information is shown for each slot:
type : describes the type of the unit that is currently present in the slot.
capab-profile: capabilty profile assigned to the slot, applicable for line boards, NTIOs and mini-NT NRNT-A.
oper-status: describes whether the unit is able to perform its normal operation.
error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the unit.
manufacturer: provides an identification of the unit manufacturer.
inventory-pba: provides the Alcatel-Lucent Printed Board Assembly code of the unit.
inventory-fpba: provides the Alcatel-Lucent Printed Board Assembly code of the unit which also identifies the
boot software.
inventory-ics: provides the Item Change Status iteration code of the unit.
inventory-clei: provides the (USA) Common Language Equipment Identification code of the unit.
serial-no: provides the serial number of the board.
failed-test: provides identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment slot [ (slot) ]

Command Parameters
Table 51.2-1 "Slot Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>

the physical slot position

1078

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Resource Identifier

Type

Description

| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )


Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Command Output
Table 51.2-2 "Slot Status Command" Display parameters
Specific Information
name
planned-type

actual-type

oper-status
short name: enabled

error-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::BrdType>


Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::ActBoardType>
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::OperStatus>
( ( enabled | yes )
| ( disabled | no ) )
Possible values:
- enabled :
- yes :
- disabled :
- no :
Parameter type: <Equipm::OperError>
( no-error
| type-mismatch
| board-missing
| no-installation
| no-planned-board
| waiting-for-sw
| init-boot-failed
| init-download-failed
| init-connection-failed
| configuration-failed
| board-reset-protection
| invalid-parameter
| temperature-alarm

A string representing the board


that is planned in the slot.
This element is only shown in
detail mode.
A string representing the board
that is actually present in the slot.
This element is always shown.
Specifies whether the plug-in unit
is able to perform its normal
operation.
This element is always shown.

Specifies for what reason the


board is not operational. These
values correspond with the
alarms which are generated in
case of a failure.
This element is always shown.

Released

1079

51 Equipment Status Commands

name

Type
| tempshutdown
| defense
| board-not-licensed
| sem-power-fail
| sem-ups-fail
| incompatible-slot
| download-ongoing
| unknown-error )
Possible values:
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed:
- configuration-failed :
- board-reset-protection:
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- sem-power-fail :
- sem-ups-fail :
- incompatible-slot :
- download-ongoing :
- unknown-error :
Parameter type: <Equipm::AvailStatus>
( available
| in-test
| failed
| power-off
| not-installed
| offline
| dependency )
Possible values:
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
Parameter type: <Equipm::AlarmProf>
( none
| name : <PrintableString-0-32> )
Possible values:
- none : no profile name to associate
- name : profile name
Field type <PrintableString-0-32>
- a printable string
- length: x<=32
Parameter type: <Equipm::CapabilityProfile>
Data driven field type

availability

alarm-profile

capab-profile

1080

Released

Description

Specifies the state of the board. It


is set to available after a
successfull selftest of the board
(if applicable).
This element is always shown.

The name of the customized


alarm profile that is allocated to
the board, if any.
This element is only shown in
detail mode.

To display the configured profile


of the board.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

manufacturer

Type

Description

Possible values are depending on the actual configuration


and software.
The currently allowed values can be shown with online-help.
Parameter type: <PrintableString>
- printable string

This element is only shown in


detail mode.

mnemonic

Parameter type: <PrintableString>


- printable string

pba-code

Parameter type: <PrintableString>


- printable string

fpba-code

Parameter type: <PrintableString>


- printable string

fpba-ics

Parameter type: <PrintableString>


- printable string

clei-code

Parameter type: <PrintableString>


- printable string

serial-no

Parameter type: <PrintableString>


- printable string

failed-test

Parameter type: <Equipm::Octet-4>


- a binary string

lt-restart-time

Parameter type: <Equipm::restartTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

lt-restart-cause

Parameter type: <Equipm::eqptBoardLastRestartCause>


( poweron
| watchdog
| cold_reset
| warm_reset
| hot_reset
| hot_reload
| clean_data
| emergency_build
| poweron_reset
| commit_failure
| other )
Possible values:
- poweron : restart after power on

3HH-04416-EBAA-TCZZA 01

Specifies the company of the


board.
This element is only shown in
detail mode.
Specifies the name of the board.
This element is only shown in
detail mode.
Specifies the Alcatel-Lucent
printed board assembly code of
of the board.
This element is only shown in
detail mode.
Specifies the Alcatel-Lucent
printed board assembly code of
the board, which also identifies
the boot software.
This element is only shown in
detail mode.
pecifies the item change status
iteration code of the board.
This element is only shown in
detail mode.
Specifies the common language
equipment identification code of
the board.
This element is only shown in
detail mode.
Specifies the serial number of the
board.
This element is only shown in
detail mode.
Specifies the last failing test.
This element is only shown in
detail mode.
The last restart time.This element
is only supported on LTs, zero
will be returned in case of other
boards.
This element is only shown in
detail mode.
the cause of the most recent
restart of the board
This element is only shown in
detail mode.

Released

1081

51 Equipment Status Commands

name

Type

lt-restart-num
short name: restrt-cnt
mgnt-entity-oamipaddr

mgnt-entity-pairnum

dual-host-ip
dual-host-loc

1082

Released

Description

- watchdog : restart triggered by HW watchdog timeout


- cold_reset : HW reset of the board with selftest
- warm_reset : HW reset of the board without selftest
- hot_reset : operational SW restart without HW reset
- hot_reload : operational SW reload and restart without HW
reset
- clean_data : operational SW triggered HW reset with DB
clean
- emergency_build : cold reset when error escalation
mechanism keeps failing
- poweron_reset : operational SW triggered restart as
poweron
- commit_failure : restart due to new SW package commit
failure
- other : restart due to unknown reason
Parameter type: <Counter>
the number of times the board has
- 32 bit counter
restarted (It is only applicable for
LTs)
This element is always shown.
Parameter type: <Ip::V4Address>
an ip address is used to as the
- IPv4-address
oam ip.
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
the paired number on the xvps's
- a signed integer
shelf.
This element is only shown in
detail mode.
Parameter type: <Ip::V4Address>
the dual host ip address
- IPv4-address
This element is only shown in
detail mode.
Parameter type: <Equipm::Dualhost>
the dual host lsm location
( <Eqpt::RackId> / <Eqpt::ShelfId>
This element is only shown in
| none )
detail mode.
Possible values:
- none : no host lsm location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.3 Profile Description Command


Command Description
This commands displays the information related to a profile. The following information is shown for each profile:
profile-id : displays the profile-id associated with a profile name
description :displays the description of the profile.
board-type: displays the board type associated with a given profile

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment capab-profile [ (profilename) ]

Command Parameters
Table 51.3-1 "Profile Description Command" Resource Parameters
Resource Identifier

Type

(profilename)

Format:
the profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 51.3-2 "Profile Description Command" Display parameters
Specific Information
name
profile-id
description
board-type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfilePointer>


- a pointer to a profile or profile index
- range: [0...65535]
Parameter type: <PrintableString>
- printable string
Parameter type: <Equipm::Profile>
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

The
profile
id
of
the
corresponding profile name.
This element is always shown.
Description of the profile
This element is always shown.
Description of the profile
This element is always shown.

Released

1083

51 Equipment Status Commands

51.4 Applique Status Command


Command Description
This command shows the applique status. The following information is shown for each applique slot:
type: provides the type of the applique that is currently present in the slot.
oper-status: describes whether the applique is able to perform its normal operation.
error-status: describes the reason why the applique is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the applique.
manufacturer: provides an identification of the applique manufacturer.
inventory-pba: provides the Alcatel-Lucent Printed Board Assembly code of the applique.
inventory-fpba: provides the Alcatel-Lucent Printed Board Assembly code of the applique which also identifies
the boot software.
inventory-ics: provides the Item Change Status iteration code of the qpplique.
inventory-clei: provides the (USA) Common Language Equipment Identification code of the applique.
serial-no: provides the serial number of the applique.
failed-test: provides the identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment applique [ (applique) ]

Command Parameters
Table 51.4-1 "Applique Status Command" Resource Parameters
Resource Identifier

Type

Description

(applique)

Format:
( iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::AppliqueSlotId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- iont : an nt applique slot

the physical applique position

1084

Released

/
/

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Resource Identifier

Type

Description

- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::AppliqueSlotId>
- the applique slot number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number

Command Output
Table 51.4-2 "Applique Status Command" Display parameters
Specific Information
name
planned-type

actual-type

oper-status
short name: enabled

error-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::AppliqueType>


Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::AppliqueType>
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::OperStatus>
( ( enabled | yes )
| ( disabled | no ) )
Possible values:
- enabled :
- yes :
- disabled :
- no :
Parameter type: <Equipm::OperError>
( no-error
| type-mismatch
| board-missing
| no-installation
| no-planned-board
| waiting-for-sw
| init-boot-failed
| init-download-failed
| init-connection-failed
| configuration-failed
| board-reset-protection
| invalid-parameter
| temperature-alarm
| tempshutdown
| defense
| board-not-licensed
| sem-power-fail
| sem-ups-fail
| incompatible-slot
| download-ongoing

A string representing the board


that is planned in the slot.
This element is only shown in
detail mode.
A string representing the board
that is actually present in the slot.
This element is always shown.
Specifies whether the plug-in unit
is able to perform its normal
operation.
This element is always shown.

Specifies for what reason the


board is not operational. These
values correspond with the
alarms which are generated in
case of a failure.
This element is always shown.

Released

1085

51 Equipment Status Commands

name

Type
| unknown-error )
Possible values:
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed:
- configuration-failed :
- board-reset-protection:
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- sem-power-fail :
- sem-ups-fail :
- incompatible-slot :
- download-ongoing :
- unknown-error :
Parameter type: <Equipm::AvailStatus>
( available
| in-test
| failed
| power-off
| not-installed
| offline
| dependency )
Possible values:
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
Parameter type: <PrintableString>
- printable string

availability

manufacturer

mnemonic

Parameter type: <PrintableString>


- printable string

pba-code

Parameter type: <PrintableString>


- printable string

fpba-code

Parameter type: <PrintableString>


- printable string

1086

Released

Description

Specifies the state of the board. It


is set to available after a
successfull selftest of the board
(if applicable).
This element is always shown.

Specifies the company of the


board.
This element is only shown in
detail mode.
Specifies the name of the board.
This element is only shown in
detail mode.
Specifies the Alcatel-Lucent
Printed Board Assembly code of
of the board.
This element is only shown in
detail mode.
Specifies the Alcatel-Lucent
Printed Board Assembly code of
the board, which also identifies
the boot software.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

Type

Description

fpba-ics

Parameter type: <PrintableString>


- printable string

clei-code

Parameter type: <PrintableString>


- printable string

serial-no

Parameter type: <PrintableString>


- printable string

failed-test

Parameter type: <Equipm::Octet-4>


- a binary string

Specifies the item change status


iteration code of the board.
This element is only shown in
detail mode.
Specifies the common language
equipment identification code of
the board.
This element is only shown in
detail mode.
Specifies the serial number of the
board.
This element is only shown in
detail mode.
Specifies the last failing test.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1087

51 Equipment Status Commands

51.5 Shelf Summary Status Command


Command Description
This commands shows a summary of the slots in a shelf.
The least significant bit of the first byte shown corresponds to the slot position 1.

User Level
none

Command Syntax
The command has the following syntax:
> show equipment shelf-summary [ (shelf) ]

Command Parameters
Table 51.5-1 "Shelf Summary Status Command" Resource Parameters
Resource Identifier

Type

Description

(shelf)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

the physical shelf position

Command Output
Table 51.5-2 "Shelf Summary Status Command" Display parameters
Specific Information
name

Type

Description

changes

Parameter type: <Counter>


- 32 bit counter

occupied-slots

Parameter type: <Equipm::Octet-8>


- a binary string
- length: 8
Parameter type: <Equipm::Octet-8>
- a binary string
- length: 8

Number of configuration or status


changes for slots/boards within
this shelf.
This element is always shown.
Specifies the occupation of slots.
This element is only shown in
detail mode.
Specifies the administrative state
of the boards whether it is locked
or not.
This element is only shown in
detail mode.
Specifies the operational state of
the boards whether it is locked or

admin-unlocked

oper-unlocked

1088

Parameter type: <Equipm::Octet-8>


- a binary string

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

Type

Description

- length: 8

not.
This element is only shown in
detail mode.
Specifies the availability state of
the boards whether it is available
or not.
This element is only shown in
detail mode.
Specifies any mismatch between
the actual board-type and the
planned board-type.
This element is always shown.
Specifies the boards which
generated an alarm.
This element is always shown.

avail-boards

Parameter type: <Equipm::Octet-8>


- a binary string
- length: 8

mismatches

Parameter type: <Equipm::Octet-8>


- a binary string
- length: 8

alarms

Parameter type: <Equipm::Octet-8>


- a binary string
- length: 8

3HH-04416-EBAA-TCZZA 01

Released

1089

51 Equipment Status Commands

51.6 Protection Element Status Command


Command Description
This command shows the protected element-related parameter of the equipment.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment protection-element [ (slot-id) ]

Command Parameters
Table 51.6-1 "Protection Element Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Index in eqpt Prot Element Table

Command Output
Table 51.6-2 "Protection Element Status Command" Display parameters
Specific Information
name
standby-status

1090

Released

Type

Description

Parameter type: <Equipm::ProtElementStandbyStatus>


( providing-service
| hot-standby
| cold-standby
| idle )

The standby status of the


protection group element.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

group-id
redcy-ctrl-status

stdby-stat-chg-reason
short name:
stdby-chg-reas

3HH-04416-EBAA-TCZZA 01

Type
Possible values:
- providing-service : providing services
- hot-standby : hot standby
- cold-standby : cold standby
- idle : idle
Parameter type: <Equipm::ProtGroupId>
- index of protection group

Description

The belonged group id of


protection element.
This element is always shown.
the redcy ctrl status of the
protection group element.
This element is always shown.

Parameter type: <Equipm::ProtElementRedcyCtrlStatus>


( normal
| forced_active )
Possible values:
- normal : enables redundancy (active or standby)
- forced_active : forces the element to be active
Parameter
type: reason why the standby-status of
<Equipm::ProtElementStandByStatusChgReason>
the protection-group is changed
( none
This element is always shown.
| prot-grp-lckd
| forced-active
| ( peernt-link-unav | lk-unav )
| peer-lckd
| peer-not-plan
| peer-not-plugin
| db-not-sync
| shub-not-sync
| shub-sdkfail
| shub-recov-sdkfail
| shub-hwfail
| shub-dyn-syncfail
| shub-stat-syncfail
| shub-peer-commfail
| ( shub-failure | shub-fail )
| ( lk-grp-notavail | lk-grp-ntav )
| lt-not-enabled
| ( shub-higig-failure | shub-higig-fail )
| ( shub-discovery-failure | shub-disc-fail )
| ( shub-reconcile-failure | shub-recon-fail )
| ( dpoe-application-fail | dpoe-app-fail )
| ( dpoe-communicate-fail | dpoe-comm-fail )
| ( dpoe-synchronize-fail | dpoe-sync-fail )
| ( dpoe-unreachable | dpoe-unrchble ) )
Possible values:
- none : standby state is hot standby or not applicable
(default value)
- prot-grp-lckd : redundancy not enabled
- forced-active : active board is put to forced active
- peernt-link-unav : standby NT link not available
- lk-unav : standby NT link not available
- peer-lckd : standby board locked
- peer-not-plan : standby board not planned
- peer-not-plugin : standby board not plugged in
- db-not-sync : database not synchronized
- shub-not-sync : shub data not synchronized
- shub-sdkfail : stdby shub detected non-recov sdk failure
- shub-recov-sdkfail : stdby shub detected recov sdk failure
- shub-hwfail : stdby shub detected hw failure
- shub-dyn-syncfail : shub dynamic data not synchronized

Released

1091

51 Equipment Status Commands

name

Type

Description

- shub-stat-syncfail : shub static data not synchronized


- shub-peer-commfail : stdby shub lost communication with
active shub
- shub-failure : stdby shub not alive
- shub-fail : stdby shub not alive
- lk-grp-notavail : link group not available
- lk-grp-ntav : link group not available
- lt-not-enabled : LT not enabled in case of LT redundancy
- shub-higig-failure : shub HiGig failure
- shub-higig-fail : shub HiGig failure
- shub-discovery-failure: shub unable to discover its peer
- shub-disc-fail : shub unable to discover its peer
- shub-reconcile-failure: shub unable to synchronise with
peer
- shub-recon-fail : shub unable to synchronise with peer
- dpoe-application-fail : dpoe has detected application failure
- dpoe-app-fail : dpoe has detected application failure
- dpoe-communicate-fail : dpoe has lost communication with
active dpoe
- dpoe-comm-fail : dpoe has lost communication with active
dpoe
- dpoe-synchronize-fail : dpoe unable to synchronise with
peer
- dpoe-sync-fail : dpoe unable to synchronise with peer
- dpoe-unreachable : dpoe is unreachable
- dpoe-unrchble : dpoe is unreachable

1092

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.7 Protection Group Status Command


Command Description
This command shows the parameters related to protection groups.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment protection-group [ (prot-group-id) ]

Command Parameters
Table 51.7-1 "Protection Group Status Command" Resource Parameters
Resource Identifier

Type

Description

(prot-group-id)

Format:
- a signed integer

Index in eqpt Prot Group Table

Command Output
Table 51.7-2 "Protection Group Status Command" Display parameters
Specific Information
name
admin-status

service-status

eps-quenchfactor

prot-group-type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::PortGroupAdminStatus>


( unlock
| lock )
Possible values:
- unlock : unlock
- lock : lock
Parameter type: <Equipm::ServiceStatus>
( in-service
| not-in-service )
Possible values:
- in-service : the protection group is in service
- not-in-service : the protection group is not in service
Parameter type: <Equipm::TimeTicks>
- timer value for quench mechanish
- unit: 1/100 sec

distinguishes
the
administration-status
This element is always shown.

Parameter type: <Equipm::PortGroupType>


( one-plus-one
| one-for-n )

indicate the service status of


protection group, a protection
group and its elements are not
configurable when it is out of
service
This element is always shown.
timervalue
of
quenching
mechanism, 0 is valid value
This element is only shown in
detail mode.
distinguishes between 1+1 and
1:N protection groups
This element is always shown.

Released

1093

51 Equipment Status Commands

name

Type
Possible values:
- one-plus-one : one to one
- one-for-n : one to many
Parameter type: <Counter>
- 32 bit counter

prot-changes

Description

wrap around counter which


indicates the number of status
changes in this protection group
as well as the status changes for
the protecting elements within
this group
This element is only shown in
detail mode.
wrap around counter for the
number of switchovers being
performed
This element is only shown in
detail mode.
contains the reason of the last
switch over
This element is only shown in
detail mode.

switchover-count

Parameter type: <Counter>


- 32 bit counter

last-switchover-reason

Parameter type: <Equipm::SwitchOverReason>


( no-switch-over
| forced-active
| board-not-present
| extender-chain-failure
| link-failure
| watchdog-timeout
| file-system-corrupt
| configuration-mismatch
| board-unplanned
| board-locked
| shelf-defense
| revertive-switchover
| shub-pollfailure
| shub-hwfailure
| shub-sdkfailure
| dpoe-appfailure
| dpoe-unreachable )
Possible values:
- no-switch-over : no switch over has been performed yet
- forced-active : chain A is forced
- board-not-present : board is removed or not reachable
- extender-chain-failure: extender chain failure
- link-failure : link failure
- watchdog-timeout : redundancy watchdog
- file-system-corrupt : curruption of file system
- configuration-mismatch: mismatch in boardType or
Swversion
- board-unplanned : board has been unplanned
- board-locked : board has been locked
- shelf-defense : shelf-error detected by defense
- revertive-switchover : switchover because protected board
is operational again (in case of 1:N)
- shub-pollfailure : shub failure
- shub-hwfailure : active shub detected a hw failure
- shub-sdkfailure : active shub detected a sdk failure
- dpoe-appfailure : active dpoe detected application failure
- dpoe-unreachable : active dpoe is not reachable
Parameter type: <Equipm::BitMapType>
status bitmap: bit 0 set means no
( no-alarm
defect at all, bit 1 : if bit set, loss
| stand-by-degrd )
of switch-over capabilities alarm

alarm-bitmap

1094

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

oper-prot-element

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- no-alarm : no-alarm
- stand-by-degrd : standby degradation alarm

is set (excludes bit 0 setting),bit 2


.. 31 : reserved for future
extensions
This element is only shown in
detail mode.
only supported for 1:N protection
groups,indicates which element is
currently protected by the spare
element, value 0 means that
currently the spare element is not
protecting any element
This element is only shown in
detail mode.

Parameter type: <SignedInteger>


- a signed integer

Released

1095

51 Equipment Status Commands

51.8 External-link-host Status Commands


Command Description
This command allows the operator to show the host shelf's external-links status. The following information is
shown for each external-link:
The SHub/IHub port which the host external link is connected to
The downlink status
The slot id of the expansion shelf that is cabled to the host expansion board.
The output "none" for the display parameter "exp-slot" means the sfp is not connected to any rack/shelf/slot.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment external-link-host [ (faceplate-number) ]

Command Parameters
Table 51.8-1 "External-link-host Status Commands" Resource Parameters
Resource Identifier

Type

(faceplate-number)

Format:
the
external-link
( <Eqpt::ExtLinkFaceplateNumber>
number
| nt : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| nt : xfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-1 : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-1 : xfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-2 : sfp : <Eqpt::ShowExtLinkHostPortIndex>
| ntio-2 : xfp : <Eqpt::ShowExtLinkHostPortIndex> )
Possible values:
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::ShowExtLinkHostPortIndex>
- the external link faceplate number
Field type <Eqpt::ExtLinkFaceplateNumber>
- the external link faceplate number

Description
faceplate

Command Output
Table 51.8-2 "External-link-host Status Commands" Display parameters

1096

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Specific Information
name

Type

Description

shub-port

Parameter type: <Equipm::lanxPortNumber>


- a signed integer

downlink-status

Parameter type: <Equipm::HostSfpDownlinkStatus>


( ok
| sfp-not-present
| los
| tx-fail
| invalid-alcatel-id
| unknown
| sfp-control-fail
| uplink
| tx-fail-and-los )
Possible values:
- ok : the downlink is operational
- sfp-not-present : no sfp present for the downlink
- los : los is detected by the host for the downlink
- tx-fail : the downlink tx failed
- invalid-alcatel-id : the downlink sfp plugged does not have
a valid alcatel (-Lucent) id
- unknown : the host expansion card is planned but not
inserted
- sfp-control-fail : sfp not responding or i2c failure
- uplink : the sfp is configured as uplink
- tx-fail-and-los : the downlink tx failed and los detected by
the host for the downlink
Parameter type: <Equipm::ExpansionSlotIndex>
<Eqpt::ExpRack> / <Eqpt::ExpShelf> / <Eqpt::ExpSlot>
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::ExpSlot>
- the physical number of the slot within expansion shelf, 0
stands for no remote
Parameter type: <Equipm::SfpType>
( unknown
| 1000base-sx
| 1000base-lx
| 1000base-cx
| 1000base-t
| 100base-lx/lx10
| 100base-fx
| base-bx10
| base-px
| reserved
| 10gbase-ew
| 10gbase-lw
| 10gbase-sw
| 10gbase-lrm
| 10gbase-er
| 10gbase-lr
| 10gbase-sr
| 10gbase-sr-sw

the shub port which the host


external link is connected to
This element is always shown.
the host expansion card's external
downlink status
This element is always shown.

exp-slot

host-sfp-type

3HH-04416-EBAA-TCZZA 01

the slot id of the expansion shelf


that is cabled to the host
expansion board
This element is always shown.

the host shelf sfp type


This element is only shown in
detail mode.

Released

1097

51 Equipment Status Commands

name

Type

cabling-status

1098

Description

| 10gbase-sr-lw
| 10gbase-sr-ew
| 10gbase-lr-sw
| 10gbase-lr-lw
| 10gbase-lr-ew
| 10gbase-er-sw
| 10gbase-er-lw
| 10gbase-er-ew
| 10gbase-lrm-sw
| 10gbase-lrm-lw
| 10gbase-lrm-ew
| 2500base-sx
| 2500base-lx
| 2500base-bx )
Possible values:
- unknown : the sfp ethernet type is not known
- 1000base-sx : gigabit ethernet compliance code
- 1000base-lx : gigabit ethernet compliance code
- 1000base-cx : gigabit ethernet compliance code
- 1000base-t : gigabit ethernet compliance code
- 100base-lx/lx10 : gigabit ethernet compliance code
- 100base-fx : gigabit ethernet compliance code
- base-bx10 : gigabit ethernet compliance code
- base-px : gigabit ethernet compliance code
- reserved : reserved bit 8
- 10gbase-ew : 10 gigabit ethernet compliance code
- 10gbase-lw : 10 gigabit ethernet compliance code
- 10gbase-sw : 10 gigabit ethernet compliance code
- 10gbase-lrm : 10 gigabit ethernet compliance code
- 10gbase-er : 10 gigabit ethernet compliance code
- 10gbase-lr : 10 gigabit ethernet compliance code
- 10gbase-sr : 10 gigabit ethernet compliance code
- 10gbase-sr-sw : 10 gigabit ethernet compliance code
- 10gbase-sr-lw : 10 gigabit ethernet compliance code
- 10gbase-sr-ew : 10 gigabit ethernet compliance code
- 10gbase-lr-sw : 10 gigabit ethernet compliance code
- 10gbase-lr-lw : 10 gigabit ethernet compliance code
- 10gbase-lr-ew : 10 gigabit ethernet compliance code
- 10gbase-er-sw : 10 gigabit ethernet compliance code
- 10gbase-er-lw : 10 gigabit ethernet compliance code
- 10gbase-er-ew : 10 gigabit ethernet compliance code
- 10gbase-lrm-sw : 10 gigabit ethernet compliance code
- 10gbase-lrm-lw : 10 gigabit ethernet compliance code
- 10gbase-lrm-ew : 10 gigabit ethernet compliance code
- 2500base-sx : gigabit ethernet compliance code
- 2500base-lx : gigabit ethernet compliance code
- 2500base-bx : gigabit ethernet compliance code
Parameter type: <Equipm::SfpCableMismatch>
the host shelf cabling mismatch
( no-mismatch
This element is always shown.
| unexpected-lt
| assign-mismatch
| incompat-shelf )
Possible values:
- no-mismatch : no cabling mismatch is detected
- unexpected-lt : remote LT is detected at an unassigned
downlink SFP port
- assign-mismatch : the detected remote LT does not match

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

phy-address

3HH-04416-EBAA-TCZZA 01

Type

Description

the LT assigned to this host SFP


- incompat-shelf : the detected remote shelf does not match
the shelf type assigned to this host SFP
Parameter type: <Ip::PhysicalAddress>
the physical address of the
- media dependent physical address
remote interface cabled to host
- length: 8
shelf SFP
This element is only shown in
detail mode.

Released

1099

51 Equipment Status Commands

51.9 External-link-remote Status Commands


Command Description
This command allows the operator to show the remote shelves external-links status. The following information is
shown for each external-link:
The slot id of the expansion shelf
The link status
The faceplate number of the host external-link device in which the expansion shelf's external-link device is
cabled to

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment external-link-remote [ (exp-slot) ]

Command Parameters
Table 51.9-1 "External-link-remote Status Commands" Resource Parameters
Resource Identifier

Type

Description

(exp-slot)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::ExpSlotId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpSlotId>
- the expansion slot number

the physical
position

expansion

slot

Command Output
Table 51.9-2 "External-link-remote Status Commands" Display parameters
Specific Information
name
sfp-status

1100

Released

Type

Description

Parameter type: <Equipm::ExpSfpStatus>


( ok
| sfp-not-present
| los
| tx-fail
| invalid-alcatel-id
| unknown
| sfp-control-fail

the status of the expansion shelf


sfp
This element is always shown.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

host-sfp-faceplate-nbr

exp-sfp-type

3HH-04416-EBAA-TCZZA 01

Type

Description

| tx-fail-and-los )
Possible values:
- ok : the expansion shelf SFP is operational
- sfp-not-present : no sfp present
- los : los is detected by the expansion shelf sfp
- tx-fail : the expansion shelf tx failed
- invalid-alcatel-id : the expansion shelf sfp plugged does
not have a valid alcatel (-Lucent) id
- unknown : the status is not available or cannot be retrieved
- sfp-control-fail : sfp not responding or i2c failure
- tx-fail-and-los : the expansion shelf tx failed and los
detected by the expansion shelf sfp
Parameter type: <Equipm::FaceplateRemoteExtLinkIndex>
( <Eqpt::ExtLinkFaceplateNumber>
| nt : sfp : <Eqpt::ShowExtLinkRemotePortIndex>
| ntio-1 : sfp : <Eqpt::ShowExtLinkRemotePortIndex>
| ntio-1 : xfp : <Eqpt::ShowExtLinkRemotePortIndex>
| ntio-2 : sfp : <Eqpt::ShowExtLinkRemotePortIndex>
| ntio-2 : xfp : <Eqpt::ShowExtLinkRemotePortIndex>
| not-cabled )
Possible values:
- not-cabled : device is not cabled
- nt : nt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Eqpt::ShowExtLinkRemotePortIndex>
- host port number
Field type <Eqpt::ExtLinkFaceplateNumber>
- the external link faceplate number
Parameter type: <Equipm::SfpType>
( unknown
| 1000base-sx
| 1000base-lx
| 1000base-cx
| 1000base-t
| 100base-lx/lx10
| 100base-fx
| base-bx10
| base-px
| reserved
| 10gbase-ew
| 10gbase-lw
| 10gbase-sw
| 10gbase-lrm
| 10gbase-er
| 10gbase-lr
| 10gbase-sr
| 10gbase-sr-sw
| 10gbase-sr-lw
| 10gbase-sr-ew
| 10gbase-lr-sw
| 10gbase-lr-lw
| 10gbase-lr-ew
| 10gbase-er-sw

the faceplate number of the host


shelf external-link device which
the expansion shelf external-link
device is cabled to
This element is always shown.

the expansion shelf sfp type


This element is always shown.

Released

1101

51 Equipment Status Commands

name

Type

Description

| 10gbase-er-lw
| 10gbase-er-ew
| 10gbase-lrm-sw
| 10gbase-lrm-lw
| 10gbase-lrm-ew
| 2500base-sx
| 2500base-lx
| 2500base-bx )
Possible values:
- unknown : the sfp ethernet type is not known
- 1000base-sx : gigabit ethernet compliance code
- 1000base-lx : gigabit ethernet compliance code
- 1000base-cx : gigabit ethernet compliance code
- 1000base-t : gigabit ethernet compliance code
- 100base-lx/lx10 : gigabit ethernet compliance code
- 100base-fx : gigabit ethernet compliance code
- base-bx10 : gigabit ethernet compliance code
- base-px : gigabit ethernet compliance code
- reserved : reserved bit 8
- 10gbase-ew : 10 gigabit ethernet compliance code
- 10gbase-lw : 10 gigabit ethernet compliance code
- 10gbase-sw : 10 gigabit ethernet compliance code
- 10gbase-lrm : 10 gigabit ethernet compliance code
- 10gbase-er : 10 gigabit ethernet compliance code
- 10gbase-lr : 10 gigabit ethernet compliance code
- 10gbase-sr : 10 gigabit ethernet compliance code
- 10gbase-sr-sw : 10 gigabit ethernet compliance code
- 10gbase-sr-lw : 10 gigabit ethernet compliance code
- 10gbase-sr-ew : 10 gigabit ethernet compliance code
- 10gbase-lr-sw : 10 gigabit ethernet compliance code
- 10gbase-lr-lw : 10 gigabit ethernet compliance code
- 10gbase-lr-ew : 10 gigabit ethernet compliance code
- 10gbase-er-sw : 10 gigabit ethernet compliance code
- 10gbase-er-lw : 10 gigabit ethernet compliance code
- 10gbase-er-ew : 10 gigabit ethernet compliance code
- 10gbase-lrm-sw : 10 gigabit ethernet compliance code
- 10gbase-lrm-lw : 10 gigabit ethernet compliance code
- 10gbase-lrm-ew : 10 gigabit ethernet compliance code
- 2500base-sx : gigabit ethernet compliance code
- 2500base-lx : gigabit ethernet compliance code
- 2500base-bx : gigabit ethernet compliance code

1102

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.10 SFP/XFP Diagnostics Status Command


Command Description
This command allows the operator to read real-time diagnostic measurements from the A2 bank of a specified SFP
or lower data bank of XFP. The following information is shown for each specified sfp/xfp:
The slot index of the sfp
The number of the sfp cage
The diagnostics availability: For XFP, AO denotes the upper bank and A2 denotes the lower bank.
The Loss of Signal status
The Transmit Fault status
The transmit power (tx-power): This parameter displays the transmit power of the SFP/XFP.It is a string that
can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being transmitted by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.

The received power (rx-power): This parameter displays the received power of the SFP/XFP(not applicable for
pon ports). It is a string that can be one of the following possible values:
- A string containing power value ranging from "-40.00 dBm" to "8.16 dBm", in 0.01 dBm increments.
- "No Power" - When no optical power is being received by an sfp.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.

The transmit bias current (tx-bias-current) : This parameter displays the transmit bias current of the SFP/XFP.
It is a string that can be one of the following possible values:
- A string containing a current value ranging from "0.00 mA" to "131.10 mA", in 0.01 mA increments.
- "NotApplicable" - This is used for an electrical SFP.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.

The transceiver supply voltage (supply-voltage) : This parameter displays the transceiver supply voltage of the
SFP/XFP. It is a string that can be one of the following possible values:
- A string containing a voltage value ranging from "0.00 VDC" to "6.55 VDC", in 0.01 VDC increments.
- "NotAvailable" - The measurement could not be obtained.
- "Invalid" - The calibration calculation returned an invalid result.

The temperature : This parameter displays the temperature of the SFP/XFP. It is a string that can be one of the
following possible values:
- A string containing a temperature value ranging from "-128.00 degrees Celsius" to "128.00 degrees
Celsius" in 0.01 degrees Celsius increments.
- "NotAvailable" - The measurement could not be obtained.

temperature-tca : This parameter displays the freshly-measured temperature alarm/warning threshold crossing
status of the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold

voltage-tca : This parameter displays the freshly-measured voltage alarm/warning threshold crossing status of
the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:

3HH-04416-EBAA-TCZZA 01

Released

1103

51 Equipment Status Commands

"not-available" - the measurement could not be obtained


"normal-value" - No threshold crossing, present value is within the threshold
"low-warning-th" - Present value is greater than the low warning level threshold
"low-alarm-th" - Present value is greater than the low alarm level threshold
"high-warning-th" - Present value is greater than the high warning level threshold
"high-alarm-th" - Present value is greater than the high alarm level threshold

tx-power-tca : This parameter displays the freshly-measured tx-power alarm/warning threshold crossing status
of the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold

bias-current-tca : This parameter displays the freshly-measured bias-current alarm/warning threshold crossing
status of the specified SFP/SFP+/XFP. It is a string that can be one of the following possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold

rx-power-tca : This parameter displays the freshly-measured rx-power alarm/warning threshold crossing status
of the specified SFP/SFP+/XFP(not applicable for pon ports). It is a string that can be one of the following
possible values:
- "not-available" - the measurement could not be obtained
- "normal-value" - No threshold crossing, present value is within the threshold
- "low-warning-th" - Present value is greater than the low warning level threshold
- "low-alarm-th" - Present value is greater than the low alarm level threshold
- "high-warning-th" - Present value is greater than the high warning level threshold
- "high-alarm-th" - Present value is greater than the high alarm level threshold

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment diagnostics sfp [ (position) ]

Command Parameters
Table 51.10-1 "SFP/XFP Diagnostics Status Command" Resource Parameters
Resource Identifier

Type

(position)

Format:
( acu : <Eqpt::RackId>
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId>
<Eqpt::SfpCageNumber>

1104

Released

Description
/

<Eqpt::ShelfId>

the physical sfp or xfp cage


/ position

<Eqpt::ShelfId>

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Resource Identifier

Type

Description

| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : sfp :


<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : xfp :
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : qsfp :
<Eqpt::SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> /
<Eqpt::SfpCageNumber>
| nt : sfp : <Eqpt::SfpCageNumber>
| nt : xfp : <Eqpt::SfpCageNumber>
| nt : qsfp : <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> : sfp
: <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
xfp : <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
qsfp : <Eqpt::SfpCageNumber>
| ntio-1 : sfp : <Eqpt::SfpCageNumber>
| ntio-1 : xfp : <Eqpt::SfpCageNumber>
| ntio-1 : qsfp : <Eqpt::SfpCageNumber>
| ntio-2 : sfp : <Eqpt::SfpCageNumber>
| ntio-2 : xfp : <Eqpt::SfpCageNumber>
| ntio-2 : qsfp : <Eqpt::SfpCageNumber>
| nt-a : sfp : <Eqpt::SfpCageNumber>
| nt-a : xfp : <Eqpt::SfpCageNumber>
| nt-a : qsfp : <Eqpt::SfpCageNumber>
| nt-b : sfp : <Eqpt::SfpCageNumber>
| nt-b : xfp : <Eqpt::SfpCageNumber>
| nt-b : qsfp : <Eqpt::SfpCageNumber> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
- qsfp : QSFP port

3HH-04416-EBAA-TCZZA 01

Released

1105

51 Equipment Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SfpCageNumber>


- the SFP cage number
- range: [0...1023]

Command Output
Table 51.10-2 "SFP/XFP Diagnostics Status Command" Display parameters
Specific Information
name
diag-avail-status

los

tx-fault

tx-power

Type

Description

Parameter type: <Eqpt::SfpDiagAvailable>


( no-error
| cage-no-diag-supp
| cage-empty
| cage-no-a2-supp
| a0-read-failed
| a0-checksum-failed
| sfp-no-a2-supp
| a2-read-failed
| a2-checksum-failed )
Possible values:
- no-error : sfp diag is available
- cage-no-diag-supp : cage does not support diag
- cage-empty : cage is empty
- cage-no-a2-supp : cage does not support A2
- a0-read-failed : A0 read failed
- a0-checksum-failed : A0 checksum failed
- sfp-no-a2-supp : SFP does not support A2
- a2-read-failed : A2 read failed
- a2-checksum-failed : A2 checksum failed
Parameter type: <Eqpt::SfpDiagLos>
( los
| no-los
| not-available )
Possible values:
- los : loss of signal info
- no-los : no los
- not-available : not available
Parameter type: <Eqpt::SfpDiagTxFault>
( tx-fault
| no-tx-fault
| not-applicable
| not-available )
Possible values:
- tx-fault : transmit fault info
- no-tx-fault : no tx fault
- not-applicable : not applicable
- not-available : not available
Parameter type: <PrintableString>
- printable string

sfp/xfp diagnostics availability


status. for xfp, a0 denotes the
upper bank and a2 denotes the
lower bank
This element is always shown.

rx-power

Parameter type: <PrintableString>


- printable string

tx-bias-current

Parameter type: <PrintableString>


- printable string

1106

Released

loss of signal
This element is always shown.

sfp/xfp tx fault
This element is always shown.

the transmit power.


This element is only shown in
detail mode.
the received power - not
applicable for PON ports
This element is only shown in
detail mode.
the transmit bias current.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

Type

supply-voltage

Parameter type: <PrintableString>


- printable string

temperature

Parameter type: <PrintableString>


- printable string

temperature-tca

Parameter type: <Eqpt::Tca>


( high-alarm-th
| low-alarm-th
| high-warning-th
| low-warning-th
| normal-value
| not-available )
Possible values:
- high-alarm-th : Present value is greater than
configured/pre-set alarm value
- low-alarm-th : Present value is lower than
configured/pre-set alarm value
- high-warning-th : Present value is greater than
configured/pre-set warning value
- low-warning-th : Present value is lower than
configured/pre-set warning value
- normal-value : Present value is under normal limits
- not-available : Value is not available
Parameter type: <Eqpt::Tca>
( high-alarm-th
| low-alarm-th
| high-warning-th
| low-warning-th
| normal-value
| not-available )
Possible values:
- high-alarm-th : Present value is greater than
configured/pre-set alarm value
- low-alarm-th : Present value is lower than
configured/pre-set alarm value
- high-warning-th : Present value is greater than
configured/pre-set warning value
- low-warning-th : Present value is lower than
configured/pre-set warning value
- normal-value : Present value is under normal limits
- not-available : Value is not available
Parameter type: <Eqpt::Tca>
( high-alarm-th
| low-alarm-th
| high-warning-th
| low-warning-th
| normal-value
| not-available )
Possible values:
- high-alarm-th : Present value is greater than
configured/pre-set alarm value
- low-alarm-th : Present value is lower than
configured/pre-set alarm value
- high-warning-th : Present value is greater than
configured/pre-set warning value

voltage-tca

bias-current-tca

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
the transceiver supply voltage.
This element is only shown in
detail mode.
the temperature.
This element is only shown in
detail mode.
the temperature alarm or warning
This element is only shown in
detail mode.

the
the
the
the

the voltage alarm or warning


This element is only shown in
detail mode.

the
the
the
the

the bias-current alarm or warning


This element is only shown in
detail mode.

the
the
the

Released

1107

51 Equipment Status Commands

name

Type

tx-power-tca

rx-power-tca

rssi-profile-id

rssi-state

1108

Description

- low-warning-th : Present value is lower than the


configured/pre-set warning value
- normal-value : Present value is under normal limits
- not-available : Value is not available
Parameter type: <Eqpt::Tca>
( high-alarm-th
| low-alarm-th
| high-warning-th
| low-warning-th
| normal-value
| not-available )
Possible values:
- high-alarm-th : Present value is greater than the
configured/pre-set alarm value
- low-alarm-th : Present value is lower than the
configured/pre-set alarm value
- high-warning-th : Present value is greater than the
configured/pre-set warning value
- low-warning-th : Present value is lower than the
configured/pre-set warning value
- normal-value : Present value is under normal limits
- not-available : Value is not available
Parameter type: <Eqpt::Tca>
( high-alarm-th
| low-alarm-th
| high-warning-th
| low-warning-th
| normal-value
| not-available )
Possible values:
- high-alarm-th : Present value is greater than the
configured/pre-set alarm value
- low-alarm-th : Present value is lower than the
configured/pre-set alarm value
- high-warning-th : Present value is greater than the
configured/pre-set warning value
- low-warning-th : Present value is lower than the
configured/pre-set warning value
- normal-value : Present value is under normal limits
- not-available : Value is not available
Parameter type: <Eqpt::RssiProfileIndex>
- an unique index value for the rssi profile(21-200
configurable)
- range: [0...65535]
Parameter type: <Eqpt::RssiState>
( ( enable | yes )
| ( disable | no ) )
Possible values:
- enable :
- yes :
- disable :
- no :

Released

the temperature alarm or warning


This element is only shown in
detail mode.

the
temperature
alarm
or
warning-not applicable for PON
ports
This element is only shown in
detail mode.

an unique index of the rssi profile


This element is always shown.
to enable or disable the rssi
functionality on sfps for uplink
ports
This element is always shown.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.11 Sfp RSSI Configuration Command


Command Description
This command allows the operator to create and configure the RSSI parameters on SFPs.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment rssiprof [ (index) ]

Command Parameters
Table 51.11-1 "Sfp RSSI Configuration Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
an unique index of the rssi profile
- an unique index value for the rssi profile(21-200
configurable)
- range: [0...65535]

Description

Command Output
Table 51.11-2 "Sfp RSSI Configuration Command" Display parameters
Specific Information
name
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Eqpt::DisplayString>


- string to identify the rssi profile
- length: 1<=x<=16
Parameter type: <Eqpt::rssiRefCount>
- number of entities using this particular profile
- range: [0...65535]

A unique profile name


This element is always shown.
rssi profile reference count
This element is always shown.

Released

1109

51 Equipment Status Commands

51.12 Board Temperature Status Command


Command Description
This commands shows the board temperature status. The following information is shown for each thermal sensor:
act-temp : actual temperature of thermal sensor; expressed in degrees Celsius.
tca-low: low thresholds for the alarm "Temperature Exceeded"; expressed in degrees Celsius.
tca-high: high thresholds for the alarm "Temperature Exceeded"; expressed in degrees Celsius.
shut-low: low threshold for the alarm "Temperature Shutdown"; expressed in degrees Celsius.
shut-high: high threshold for the alarm "Temperature Shutdown"; expressed in degrees Celsius.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment temperature [ (slot) [ sensor-id <Equipm::SensorId> ] ]

Command Parameters
Table 51.12-1 "Board Temperature Status Command" Resource Parameters
Resource Identifier

Type

(slot)

Format:
the physical slot position
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- iont : an nt applique slot
- ctrl : ctrl-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>

1110

Released

Description

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Resource Identifier

Type

Description

sensor-id

- the LT slot number


Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Equipm::SensorId>
Format:
- the sensor id of a board
- range: [1...8]

the sensor id of a board

Command Output
Table 51.12-2 "Board Temperature Status Command" Display parameters
Specific Information
name

Type

Description

actual-temperature
short name: act-temp

Parameter type: <SignedInteger>


- a signed integer

tca-threshold-low
short name: tca-low

Parameter type: <SignedInteger>


- a signed integer

tca-threshold-high
short name: tca-high

Parameter type: <SignedInteger>


- a signed integer

shut-threshold-low
short name: shut-low

Parameter type: <SignedInteger>


- a signed integer

shut-threshold-high
short name: shut-high

Parameter type: <SignedInteger>


- a signed integer

actual temperature of thermal


sensor; expressed in degrees
Celsius.
This element is always shown.
Low thresholds for the alarm
"Temperature
Exceeded";
expressed in degrees Celsius.
This element is always shown.
High thresholds for the alarm
"Temperature
Exceeded";
expressed in degrees Celsius.
This element is always shown.
Low threshold for the alarm
"Temperature
Shutdown";
expressed in degrees Celsius.
This element is always shown.
High threshold for the alarm
"Temperature
Shutdown";
expressed in degrees Celsius.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1111

51 Equipment Status Commands

51.13 Board Planned Resource Command


Command Description
This commands shows the actual values of configured hardware resources on boards.. The following information is
shown for each resource:
current: The actual planned value for the resource
max-value: The maximum value that the board supports for this resource.
description: A string describing the planned resource for this board.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment planned-resource [ (slot) [ resource-id <SignedInteger> ] ]

Command Parameters
Table 51.13-1 "Board Planned Resource Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <SignedInteger>
Format:
- a signed integer

the physical slot position

resource-id

the planned resource id of a board

Command Output
Table 51.13-2 "Board Planned Resource Command" Display parameters
Specific Information
name

Type

Description

current-value
short name: cur-val

Parameter type: <SignedInteger>


- a signed integer

maximum-value

Parameter type: <SignedInteger>

The actual planned value for the


resource.
This element is always shown.
The maximum value that the

1112

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

Type

Description

short name: max-val

- a signed integer

description
short name: description

Parameter type: <PrintableString>


- printable string

board supports for this resource.


This element is always shown.
A string describing the planned
resource for this board.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1113

51 Equipment Status Commands

51.14 Transceiver Inventory Status Command


Command Description
This command retrieves the configuration data associated with SFP/SFP+/XFP.The following information is
shown for each specified sfp/sfp+/xfp:
For the following data, output "not-Available" implies that the the measurement could not be obtained.
inventory-status - the transceiver inventory status. For XFP, AO denotes the upper bank and A2 denotes the
lower bank.
alu-part-num - the alcatel lucent part number available in sfp or xfp eeprom
clei-code - the clei code available in sfp or xfp eeprom
tx-wavelength - the transmission wavelength available in sfp or xfp eeprom
fiber-type - the fiber type available in sfp or xfp eeprom
additional-info - the customer specific additional information of the specified sfp or sfp+ or xfp
mfg-name - the manufacturer name available in sfp or xfp eeprom
mfg-oui - the manufacturer code available in sfp or xfp eeprom
mfg-date - the manufacturer date available in sfp or xfp eeprom
vendor-serial-num - the vendor serial number available in sfp or xfp eeprom

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment transceiver-inventory [ (index) ]

Command Parameters
Table 51.14-1 "Transceiver Inventory Status Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
( acu : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SfpCageNumber>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : sfp
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : xfp
<Eqpt::SfpCageNumber>
| remote-sfp : <Eqpt::ExpRack> / <Eqpt::ExpShelf> : qsfp
<Eqpt::SfpCageNumber>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
<Eqpt::SfpCageNumber>
| nt : sfp : <Eqpt::SfpCageNumber>
| nt : xfp : <Eqpt::SfpCageNumber>
| nt : qsfp : <Eqpt::SfpCageNumber>

1114

Released

Description
the physical sfp or xfp cage
/ position
/
:
:
:
/

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

Resource Identifier

Type

Description

| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> : sfp


: <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
xfp : <Eqpt::SfpCageNumber>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
qsfp : <Eqpt::SfpCageNumber>
| ntio-1 : sfp : <Eqpt::SfpCageNumber>
| ntio-1 : xfp : <Eqpt::SfpCageNumber>
| ntio-1 : qsfp : <Eqpt::SfpCageNumber>
| ntio-2 : sfp : <Eqpt::SfpCageNumber>
| ntio-2 : xfp : <Eqpt::SfpCageNumber>
| ntio-2 : qsfp : <Eqpt::SfpCageNumber>
| nt-a : sfp : <Eqpt::SfpCageNumber>
| nt-a : xfp : <Eqpt::SfpCageNumber>
| nt-a : qsfp : <Eqpt::SfpCageNumber>
| nt-b : sfp : <Eqpt::SfpCageNumber>
| nt-b : xfp : <Eqpt::SfpCageNumber>
| nt-b : qsfp : <Eqpt::SfpCageNumber> )
Possible values:
- acu : acu slot
- iont : an nt applique slot
- remote-sfp : remote sfp
- nt : active nt slot
- lt : lt-slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ExpRack>
- the physical number of the expansion rack, 0 stands for no
remote
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack, 0
stands for no remote
Field type <Eqpt::EqSlotId>
- the equipment slot number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
- qsfp : QSFP port
Field type <Eqpt::SfpCageNumber>
- the SFP cage number
- range: [0...1023]

Command Output
Table 51.14-2 "Transceiver Inventory Status Command" Display parameters
Specific Information
name

Type

Description

inventory-status

Parameter type: <Eqpt::InvStatus>

transceiver inventory status. for

3HH-04416-EBAA-TCZZA 01

Released

1115

51 Equipment Status Commands

name

alu-part-num

Type

Description

( no-error
| cage-empty
| cage-no-a2-supp
| a0-read-failed
| a0-checksum-failed
| sfp-no-a2-supp
| a2-read-failed
| a2-checksum-failed )
Possible values:
- no-error : sfp inventory is available
- cage-empty : cage is empty
- cage-no-a2-supp : cage does not support A2
- a0-read-failed : A0 read failed
- a0-checksum-failed : A0 checksum failed
- sfp-no-a2-supp : SFP does not support A2
- a2-read-failed : A2 read failed
- a2-checksum-failed : A2 checksum failed
Parameter type: <PrintableString>
- printable string

xfp, a0 denotes the upper bank


and a2 denotes the lower bank
This element is always shown.

clei-code

Parameter type: <PrintableString>


- printable string

tx-wavelength

Parameter type: <PrintableString>


- printable string

fiber-type

Parameter type: <Eqpt::FiberType>


( single-mode
| multi-mode
| not-available )
Possible values:
- single-mode : single-mode fiber
- multi-mode : multi-mode
- not-available : fiber type is not available
Parameter type: <PrintableString>
- printable string

mfg-name

mfg-oui

Parameter type: <PrintableString>


- printable string

mfg-date

Parameter type: <PrintableString>


- printable string

vendor-serial-num

Parameter type: <PrintableString>


- printable string

additional-info

Parameter type: <PrintableString>


- printable string

1116

Released

the alcatel lucent part number


available in sfp or xfp eeprom
This element is always shown.
the clei code available in sfp or
xfp eeprom
This element is only shown in
detail mode.
the transmission wavelength
available in sfp or xfp eeprom
This element is always shown.
the fiber type available in sfp or
xfp eeprom.
This element is always shown.

the manufacturer name available


in sfp or xfp eeprom
This element is only shown in
detail mode.
the manufacturer code available
in sfp or xfp eeprom
This element is only shown in
detail mode.
the
manufacturer
date
in
dd/mm/yyyy format available in
sfp or xfp eeprom
This element is only shown in
detail mode.
the vendor serial number
available in sfp or xfp eeprom
This element is only shown in
detail mode.
the customer specific additional
information of the specified sfp
or sfp+ or xfp
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name

Type

Description

rssi-sfptype

Parameter type: <Eqpt::RssiSfpType>


( not-available
| px20
| px20plus
| prx_t1
| pr_t2
| prx_t3
| pr_t4
| bplusc
| bplusi
| cplusc
| cplusi
| e1t1_eth
| e3ds3_eth
| stm1oc3_eth
| e1t1_tdm
| 100base_fx
| 100base_lx
| 100base_bx10u
| 100base_bx10d
| 100base_tx
| 1000base_t
| 1000base_cx
| 1000base_sx
| 1000base_lx
| 1000base_bx10u
| 1000base_bx10d
| 1000base_bx40u
| 1000base_bx40d
| 1000base_ex
| 1000base_zx
| n1
| n2a
| n2b
| 1000base_vx
| 2500base
| 10gbase_sr
| 10gbase_lr
| 10gbase_lrm
| 10gbase_er
| 10gbase_sw
| 10gbase_lw
| 10gbase_ew
| 40gbase_sr4
| 40gbase_lr4
| 40gbase_cr4
| 10gbase_bx40u
| 10gbase_bx40d )
Possible values:
- not-available : fiber type is not available
- px20 : single-mode fiber
- px20plus : multi-mode
- prx_t1 : single-mode fiber
- pr_t2 : multi-mode
- prx_t3 : single-mode fiber
- pr_t4 : multi-mode
- bplusc : single-mode fiber

sfp type of ports wich configured


rssi profile
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1117

51 Equipment Status Commands

name

Type

Description

- bplusi : single-mode fiber


- cplusc : single-mode fiber
- cplusi : single-mode fiber
- e1t1_eth : Electrical E1/T1 Ethernet bridged SFP (Ethernet
over E1/T1 per GFP, HDLC or cHDLC encapsulation)
- e3ds3_eth : Electrical E3/DS3 Ethernet bridged SFP
(Ethernet over E3/DS2 per GFP, HDLC or cHDLC
encapsulation)
- stm1oc3_eth : Optical STM-1/OC3 Ethernet bridged SFP
(Ethernet over STM-1/OC3 per GFP encapsulation)
- e1t1_tdm : Electrical 2 x E1 TDM PW SFP (TDM E1 over
Ethernet per MEF8 encapsulation)
- 100base_fx : 100M multi-mode fiber
- 100base_lx : 100M long-reach single-mode fiber
- 100base_bx10u : 100M single-strand upstream
single-mode fiber
- 100base_bx10d : 100M single-strand downstream
single-mode fiber
- 100base_tx : 100M copper twisted-pair cable
- 1000base_t : 1G copper twisted-pair cable
- 1000base_cx : 1G copper twin-axial cable
- 1000base_sx : 1G short-reach multi-mode fiber
- 1000base_lx : 1G long-reach single-mode fiber
- 1000base_bx10u : 1G single-strand upstream single-mode
fiber
- 1000base_bx10d : 1G single-strand downstream
single-mode fiber
- 1000base_bx40u : 1G extended-reach upstream
single-mode fiber
- 1000base_bx40d : 1G extended-reach downstream
single-mode fiber
- 1000base_ex : 1G extended-reach 40km single-mode fiber
- 1000base_zx : 1G extended reach 70km single-mode fiber
- n1 : 10G GPON fiber
- n2a : 10G GPON fiber
- n2b : 10G GPON fiber
- 1000base_vx : 1G CWDM fiber
- 2500base : 2500M fiber
- 10gbase_sr : 10G short-reach multi-mode fiber
- 10gbase_lr : 10G long-reach single-mode fiber
- 10gbase_lrm : 10G long-reach multi-mode fiber
- 10gbase_er : 10G extended-reach single-mode fiber
- 10gbase_sw : 10G short-reach wan multi-mode fiber
- 10gbase_lw : 10G long-reach wan single-mode fiber
- 10gbase_ew : 10G extended-reach wan single-mode fiber
- 40gbase_sr4 : 40G short-reach multi-mode fiber
- 40gbase_lr4 : 40G long-reach single-mode fiber
- 40gbase_cr4 : 40G copper cable
- 10gbase_bx40u : 10G extended-reach upstream
single-mode fiber
- 10gbase_bx40d : 10G extended-reach downstream
single-mode fiber

1118

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.15 NE Status Command


Command Description
This command displays the status of the NE.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment isam

Command Output
Table 51.15-2 "NE Status Command" Display parameters
Specific Information
name
planned-type

actual-type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::SystemType>


Specifies the planned isam type.
( laus
This element is only shown in
| laeu
detail mode.
| leeu
| maus
| leus
| lneu
| leww
| lnww )
Possible values:
- laus : large ASAM US / ANSI market (6 racks, 3 shelves
per rack)
- laeu : large ASAM EU / ETSI market (6 racks, 3 shelves
per rack)
- leeu : large ISAM for EU / ETSI market
- maus : mini RAM ASAM for US / ANSI market
- leus : large ISAM for US / ANSI market
- lneu : new equipment practice (NEP)
- leww : large ISAM World wide
- lnww : large ISAM World wide
Parameter type: <Equipm::SystemType>
A string representing the system
( laus
type that is actually present.
| laeu
This element is always shown.
| leeu
| maus
| leus
| lneu
| leww

Released

1119

51 Equipment Status Commands

name

Type

description

1120

Description

| lnww )
Possible values:
- laus : large ASAM US / ANSI market (6 racks, 3 shelves
per rack)
- laeu : large ASAM EU / ETSI market (6 racks, 3 shelves
per rack)
- leeu : large ISAM for EU / ETSI market
- maus : mini RAM ASAM for US / ANSI market
- leus : large ISAM for US / ANSI market
- lneu : new equipment practice (NEP)
- leww : large ISAM World wide
- lnww : large ISAM World wide
Parameter type: <Description-127>
Specifies the location of the
- description to help the operator to identify the object
system.
- length: x<=127
This element is only shown in
detail mode.

Released

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.16 Rack Status Command


Command Description
This command shows the rack status.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment rack [ (rack) ]

Command Parameters
Table 51.16-1 "Rack Status Command" Resource Parameters
Resource Identifier

Type

Description

(rack)

Format:
<Eqpt::RackId>
Field type <Eqpt::RackId>
- the rack number

the rack identifier

Command Output
Table 51.16-2 "Rack Status Command" Display parameters
Specific Information
name
planned-type

actual-type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::RackType>


( altr-e
| altr-a
| not-planned
| not-allowed
| empty )
Possible values:
- altr-e : ISAM ETSI DSL line termination rack (2200mm)
- altr-a : ISAM ANSI DSL line termination rack
- not-planned : holder is not planned
- not-allowed : shelf is not allowed in this position
- empty : shelf is empty in this position
Parameter type: <Equipm::RackType>
( altr-e
| altr-a
| not-planned
| not-allowed

Specifies the planned rack type.


This element is only shown in
detail mode.

A string representing the racktype


that is actually present.
This element is always shown.

Released

1121

51 Equipment Status Commands

name

description

1122

Released

Type

Description

| empty )
Possible values:
- altr-e : ISAM ETSI DSL line termination rack (2200mm)
- altr-a : ISAM ANSI DSL line termination rack
- not-planned : holder is not planned
- not-allowed : shelf is not allowed in this position
- empty : shelf is empty in this position
Parameter type: <Description-127>
- description to help the operator to identify the object
- length: x<=127

Specifies the location of the rack.


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

51.17 Shelf Status Command


Command Description
This command shows the shelf status. The following information is shown in addition to configuration information:
oper-status: describes whether the board is able to perform its normal operation.
error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the board.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment shelf [ (shelf) ]

Command Parameters
Table 51.17-1 "Shelf Status Command" Resource Parameters
Resource Identifier

Type

Description

(shelf)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

a shelf identifier: <rack>/<shelf>

Command Output
Table 51.17-2 "Shelf Status Command" Display parameters
Specific Information
name
planned-type

actual-type

admin-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::ShelfType>


Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::ShelfType>
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Equipm::HolderAdminStatus>

Specifies the planned shelf type.


This element is only shown in
detail mode.
A string representing the
shelftype that is actually present
in the rack.
This element is always shown.
Specifies the shelf is locked or

Released

1123

51 Equipment Status Commands

name

Type

Description

short name: locked

( ( lock | yes )
| ( unlock | no ) )
Possible values:
- lock : the holder is locked
- yes : the holder is locked
- unlock : the holder is unlocked
- no : the holder is unlocked
Parameter type: <Equipm::OperStatus>
( ( enabled | yes )
| ( disabled | no ) )
Possible values:
- enabled :
- yes :
- disabled :
- no :
Parameter type: <Equipm::OperError>
( no-error
| type-mismatch
| board-missing
| no-installation
| no-planned-board
| waiting-for-sw
| init-boot-failed
| init-download-failed
| init-connection-failed
| configuration-failed
| board-reset-protection
| invalid-parameter
| temperature-alarm
| tempshutdown
| defense
| board-not-licensed
| sem-power-fail
| sem-ups-fail
| incompatible-slot
| download-ongoing
| unknown-error )
Possible values:
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed:
- configuration-failed :
- board-reset-protection:
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- sem-power-fail :
- sem-ups-fail :
- incompatible-slot :

not.
This element is only shown in
detail mode.

oper-status
short name: enabled

error-status

1124

Released

Specifies whether or not the shelf


is capable of performing its
normal functions.
This element is always shown.

Specifies for what reason the


shelf is not operational.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

51 Equipment Status Commands

name
availability

shelf-mode

class

serial-no

Type

variant

Parameter type: <Equipm::ShelfVariant>


- printable string

ics-code

Parameter type: <Equipm::ShelfICS>


- printable string

description

Parameter type: <Description-127>


- description to help the operator to identify the object
- length: x<=127

3HH-04416-EBAA-TCZZA 01

Description

- download-ongoing :
- unknown-error :
Parameter type: <Equipm::AvailStatus>
( available
| in-test
| failed
| power-off
| not-installed
| offline
| dependency )
Possible values:
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
Parameter type: <Equipm::HolderModeForShow>
( no-extended-lt-slots
| extended-lt-slots
| no-ntb-slot
| no-ntio-slots )
Possible values:
- no-extended-lt-slots : no extended lt slots
- extended-lt-slots : change to extended lt slots
- no-ntb-slot : use ntb slot as lt slot
- no-ntio-slots : not changeable
Parameter type: <Equipm::ShelfClass>
( main-iq-hcl
| ext-iq
| ext-hcl
| main-ethernet
| ext-ethernet )
Possible values:
- main-iq-hcl : main shelf - supports iq- and hcl-based traffic
- ext-iq : extension shelf - supports only iq-based traffic
- ext-hcl : extension shelf - support only hcs-based traffic
- main-ethernet : main shelf - supports ethernet-based traffic
- ext-ethernet : extension shelf - supports ethernet-based
traffic
Parameter type: <Equipm::ShelfSerial>
- printable string

Specifies whether the shelf is


available or not.
This element is always shown.

the shelf mode


This element is only shown in
detail mode.

Specifies
classification
of
shelves.
This element is only shown in
detail mode.

Specifies the serial number of the


shelf.
This element is only shown in
detail mode.
the ALU code of the shelf.
This element is only shown in
detail mode.
the item change status iteration
code of the shelf.
This element is only shown in
detail mode.
Specifies the location of the shelf.
This element is only shown in
detail mode.

Released

1125

52- Protection Group Status Commands

52.1 Protection Group Status Command Tree


52.2 Protection Group Status Command

1126

Released

52-1127
52-1128

3HH-04416-EBAA-TCZZA

01

52 Protection Group Status Commands

52.1 Protection Group Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Protection Group Status Commands".

Command Tree
----show
----port-protection
- (port)

3HH-04416-EBAA-TCZZA 01

Released

1127

52 Protection Group Status Commands

52.2 Protection Group Status Command


Command Description
This commands shows the protection group status. The following information is shown for each group :
first-port: describes the port index of the first port in the protection group.
paired-port: describes the port index of the paired port in the protection group.
first-state: describes the the operational status of the first port.
paired-state: describes the operational status of the paired port.
swo-reason: describes the reason for the last switchover.
num-swo: describes the number of switchovers that have occurred.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show port-protection (port)

Command Parameters
Table 52.2-1 "Protection Group Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
the port identifier of the first port
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / in the protection group.
<Eqpt::PonId>
Possible values:
- pon : pon-aid
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier

Description

Command Output
Table 52.2-2 "Protection Group Status Command" Display parameters
Specific Information
name
paired-port

1128

Type

Description

Parameter type: <RedPort::PairedPortIndex>


the port identifier of the paired
pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / port in the protection group.

Released

3HH-04416-EBAA-TCZZA

01

52 Protection Group Status Commands

name

port-state

paired-state

swo-reason

num-swo

3HH-04416-EBAA-TCZZA 01

Type

Description

<Eqpt::PonId>
Possible values:
- pon : pon-aid
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Parameter type: <RedPort::ProtectionStatus>
( ( active-up | act-up )
| ( active-down | act-down )
| ( inactive-up | inact-up )
| ( inactive-down | inact-down ) )
Possible values:
- active-up :
- act-up :
- active-down :
- act-down :
- inactive-up :
- inact-up :
- inactive-down :
- inact-down :
Parameter type: <RedPort::ProtectionStatus>
( ( active-up | act-up )
| ( active-down | act-down )
| ( inactive-up | inact-up )
| ( inactive-down | inact-down ) )
Possible values:
- active-up :
- act-up :
- active-down :
- act-down :
- inactive-up :
- inact-up :
- inactive-down :
- inact-down :
Parameter type: <RedPort::SwitchReason>
( no-switch-over
| port-admin-change
| forced-switch-over
| link-failure
| board-failure )
Possible values:
- no-switch-over : no switch over has been performed yet
- port-admin-change : port was set admin down
- forced-switch-over : operator requested switchover
- link-failure : link failure
- board-failure : board failure
Parameter type: <SignedInteger>
- a signed integer

This element is always shown.

specifies the status of the first


port in the protection group.
This element is always shown.

specifies the status of the paired


port in the protection group.
This element is always shown.

specifies the last switchover


reason.
This element is always shown.

specifies the number of times a


switchover occurred.
This element is always shown.

Released

1129

53- Trap Status Commands

53.1 Trap Status Command Tree


53.2 Trap Manager Queue Status Command

1130

Released

53-1131
53-1132

3HH-04416-EBAA-TCZZA

01

53 Trap Status Commands

53.1 Trap Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Trap Status Commands".

Command Tree
----show
----trap
----manager
- (address)

3HH-04416-EBAA-TCZZA 01

Released

1131

53 Trap Status Commands

53.2 Trap Manager Queue Status Command


Command Description
This command displays the status of the trap manager queue.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show trap manager [ (address) ]

Command Parameters
Table 53.2-1 "Trap Manager Queue Status Command" Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]

the IP address of the manager

Command Output
Table 53.2-2 "Trap Manager Queue Status Command" Display parameters
Specific Information
name
last-reset-time
buffer-status

1132

Released

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Trap::QueueStatus>
( no-traps-lost
| traps-lost )
Possible values:
- no-traps-lost : the queue did not overflow - no traps were
lost
- traps-lost : the queue did overflow - traps were lost

time when the buffer has been


reset.
This element is always shown.
specifies whether the trap buffer
is overflowed or not.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

54- Alarm Log Status Commands

54.1 Alarm Log Status Command Tree


54.2 Alarm Log Status Command
54.3 Equipment Alarm Log Status Command
54.4 Equipment Holder Alarm Log Status Command
54.5 Equipment Holder Extended Alarm Log Status
Command
54.6 Plug-in Unit Alarm Log Status Command
54.7 ATM Alarm Log Status Command
54.8 Ethernet Interface Alarm Log Status Command
54.9 Software Management Alarm Log Status Command
54.10 Temporal Filter Alarm Log Status Command
54.11 Spatial Filter Alarm Log Status Command
54.12 xDSL Common Alarm Log Status Command
54.13 xDSL Near-end Alarm Log Status Command
54.14 xDSL Far-end Alarm Log Status Command
54.15 TCA xDSL Alarm Log Status Command
54.16 Vectoring Line Alarm Log Status Command
54.17 Vectoring Board Alarm Log Status Command
54.18 Electrical-to-Optical Conversion Alarm Log Status
Command
54.19 Authentication Alarm Log Status Command
54.20 xDSL Bonding Alarm Log Status Command
54.21 Redundancy Alarm Log Status Command
54.22 Custom Alarm Log Status Command
54.23 SFP Alarm Log Status Command
54.24 Custom External Alarm Log Status Command
54.25 SFP RSSI for NT Alarm Log Status Command
54.26 PPP Cross-Connect Engine TCA Alarm Log Status
Command
54.27 2xE1/DS1 SFP Clock Alarm Log Status Command
54.28 2xE1/DS1 SFP Framer Alarm Log Status Command
54.29 Plug In Unit Extended Alarm Log Status Command
54.30 SIP Server Alarm Log Status Commands
54.31 SIP VSP Alarm Log Status Commands
54.32 SIP Dial Plan Alarm Log Status Commands
54.33 SIP Slot Alarm Log Status Commands
54.34 SIP Termination Alarm Log Status Commands
54.35 Megaco Media Gateway Alarm Log Status Command
54.36 Megaco Signaling Gateway Alarm Log Status
Command
54.37 Megaco Plug Unit Alarm Log Status Command
54.38 Megaco Termination Alarm Log Status Command
54.39 Megaco Signaling Lt Alarm Log Status Command
54.40 Shdsl Alarm Log Status Command
54.41 Shdsl Alarm Log Status Command
54.42 Ima-Group Alarm Log Status Command
54.43 Ima-Link Alarm Log Status Command
54.44 Ether-Tca Alarm Log Status Command
54.45 Ether-Sfp Alarm Log Status Command
54.46 Alarm Qos Slot Log Status Commands

3HH-04416-EBAA-TCZZA 01

54-1135
54-1138
54-1142
54-1145
54-1148
54-1152
54-1156
54-1158
54-1159
54-1162
54-1170
54-1178
54-1181
54-1184
54-1188
54-1194
54-1197
54-1200
54-1202
54-1204
54-1208
54-1210
54-1214
54-1218
54-1220
54-1225
54-1227
54-1230
54-1234
54-1238
54-1240
54-1242
54-1243
54-1245
54-1250
54-1252
54-1253
54-1255
54-1258
54-1260
54-1263
54-1266
54-1269
54-1272
54-1275
54-1278

Released

1133

54.47 Alarm Qos Queue Log Status Commands


54.48 Log File Transfer Server Alarm Log Status
Command
54.49 Log Lsm Redundancy Alarm Log Status Command
54.50 Log L2 Forward Alarm Log Status Command
54.51 External Device Alarm Log Status Command
54.52 LT CFM Alarm Log Status Command
54.53 Sync Clock Alarm Log Status Command
54.54 EFM-OAM Alarm Log Status Command
54.55 Alarm Table Alarm Log Status Command
54.56 Auto-Switch Alarm Log Status command

1134

Released

54-1281
54-1283
54-1285
54-1287
54-1290
54-1291
54-1293
54-1296
54-1298
54-1300

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.1 Alarm Log Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Alarm Log Status Commands".

Command Tree
----show
----alarm
----log
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
----misc
- (index)
----near-end
- (index)
----far-end
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)

3HH-04416-EBAA-TCZZA 01

Released

1135

54 Alarm Log Status Commands

----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi
- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----cfm

1136

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

- (index)
----sync
- (index)
----efm-oam
- (index)
----alarm-table
- (index)
----auto-switch
- (index)

3HH-04416-EBAA-TCZZA 01

Released

1137

54 Alarm Log Status Commands

54.2 Alarm Log Status Command


Command Description
This command displays the alarm log entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log table [ (index) ]

Command Parameters
Table 54.2-1 "Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.2-2 "Alarm Log Status Command" Display parameters
Specific Information
name
type

1138

Released

Type

Description

Parameter type: <Alarm::alarmType>


( equipment
| eqpt-holder
| plug-in-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| qos-queue
| temporal
| spatial
| ( software-mngt | sw-mgmt )
| xdsl
| xdsl-tca
| eo-conv
| authentication

unique id for an alarm.


This element is always shown.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

| bonding
| sfp
| shdsl-isam
| custom-ext-alarm
| plug-in-unit-ext
| sip-user-agent
| sip-plugin-unit
| sip-termination
| filetransfer
| external-device
| l2forward
| ether-tca
| ether-sfp
| megaco-media-gw
| megaco-sig-gw
| megaco-plug-unit
| megaco-term
| megaco-sig-lt
| eqpt-holder-ext
| lsmredundancy
| sync
| vect-line
| vect-board
| sip-dial-plan
| sip-vsp
| sip-server
| sfprssi
| sfpe1t1-framer
| sfpe1t1-clock
| pppcc-engine-tca
| cfm
| efm-oam
| alarm-table
| auto-switch )
Possible values:
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plug-in-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ima-group : ima-group alarms
- ima-link : ima-link alarms
- redundancy : redundancy alarms
- shdsl : shdsl alarms
- ether-itf : ethernet interface alarms
- traffic-overflow : Traffic overflow alarms
- qos-queue : qos queue alarms
- temporal : temporal alarms
- spatial : spatial alarms
- software-mngt : software management alarms
- sw-mgmt : software management alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related alarms
- bonding : bonding-group related alarms
- sfp : SFP related alarms

3HH-04416-EBAA-TCZZA 01

Released

1139

54 Alarm Log Status Commands

name

last-updated-on
log-info

Type

Description

- shdsl-isam : shdsl isam alarms


- custom-ext-alarm : customizable external alarms
- plug-in-unit-ext : other plugin unit alarms
- sip-user-agent : sip user agent related alarms
- sip-plugin-unit : sip plug in unit related alarms
- sip-termination : sip termination related alarms
- filetransfer : file transfer server alarms
- external-device : external device related alarms
- l2forward : l2forward related alarms
- ether-tca : ethernet threshold cross alarms
- ether-sfp : ethernet SFP related alarms
- megaco-media-gw : megaco media gateway related alarms
- megaco-sig-gw : megaco signaling gateway related alarms
- megaco-plug-unit : megaco plug unit related alarms
- megaco-term : megaco termination related alarms
- megaco-sig-lt : megaco signaling lt related alarms
- eqpt-holder-ext : other equipment holder alarms
- lsmredundancy : lsm redundancy alarms
- sync : synce and bits alarms
- vect-line : xDSL vectoring line alarms
- vect-board : xDSL vectoring board alarms
- sip-dial-plan : sip dial plan related alarms
- sip-vsp : sip vsp related alarms
- sip-server : sip server related alarms
- sfprssi : SFP RSSI related alarms
- sfpe1t1-framer : SFP 2e1t1 framer alarms
- sfpe1t1-clock : SFP 2e1t1 clock alarms
- pppcc-engine-tca : PPPOE Cross Connect Engine TCA
related alarm
- cfm : Cfm related alarms
- efm-oam : EFM-OAM related alarms
- alarm-table : alarm table related alarms
- auto-switch : auto-switch related alarms
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

network time in seconds when


the alarm was logged.
This element is always shown.
some additional information
about the table entry.
This element is always shown.

Only Show Details: alarm log table related information


name
Type
last-entry-index

Parameter type: <SignedInteger>


- a signed integer

log-was-reset-on

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-buffer-size

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed

1140

Released

Description
index of the last entry that was
added to the log table.
This element is only shown in
detail mode.
time when the alarm log was last
reset.
This element is only shown in
detail mode.
size of the internal log buffer.
This element is only shown in
detail mode.
specifies whether log table is
overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

- no : no buffer overflow

3HH-04416-EBAA-TCZZA 01

Released

1141

54 Alarm Log Status Commands

54.3 Equipment Alarm Log Status Command


Command Description
This command displays the equipment alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log equipment [ (index) ]

Command Parameters
Table 54.3-1 "Equipment Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.3-2 "Equipment Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
nt-disk

prev-status

1142

Description

Parameter type: <Alarm::ntDiskSpace>


( ( nintyfive-perc | 95%-full )
| ( less-nintyfive-perc | less-than-95% ) )
Possible values:
- nintyfive-perc : NT disk space is 95% full
- 95%-full : NT disk space is 95% full
- less-nintyfive-perc : NT disk space usage less that 95%
- less-than-95% : NT disk space usage less that 95%
Parameter type: <Alarm::ntDiskSpace>
( ( nintyfive-perc | 95%-full )
| ( less-nintyfive-perc | less-than-95% ) )
Possible values:
- nintyfive-perc : NT disk space is 95% full

Released

current status of nt disk space is


95% full or less than that
This element is only shown in
detail mode.

status of nt disk space with its


previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

persist-data

prev-status

sntp-comm

prev-status

preferred-mode
short name: pref-mode

prev-status

timing-reference
short name: time-ref

prev-status

connection-lost
short name: conn-lost

3HH-04416-EBAA-TCZZA 01

Type

Description

- 95%-full : NT disk space is 95% full


- less-nintyfive-perc : NT disk space usage less that 95%
- less-than-95% : NT disk space usage less that 95%
Parameter type: <Alarm::persistDataLoss>
( lost
| not-lost )
Possible values:
- lost : persistant data is lost
- not-lost : persistant data is not lost
Parameter type: <Alarm::persistDataLoss>
( lost
| not-lost )
Possible values:
- lost : persistant data is lost
- not-lost : persistant data is not lost
Parameter type: <Alarm::sntpCommLoss>
( lost
| not-lost )
Possible values:
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
Parameter type: <Alarm::sntpCommLoss>
( lost
| not-lost )
Possible values:
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
Parameter type: <Alarm::clkPrefMode>
( not-available
| available )
Possible values:
- not-available : Preferred timing mode is not available
- available : Preferred Timing mode available
Parameter type: <Alarm::clkPrefMode>
( not-available
| available )
Possible values:
- not-available : Preferred timing mode is not available
- available : Preferred Timing mode available
Parameter type: <Alarm::clkFreeMode>
( failed
| available )
Possible values:
- failed : System is in holdover or free-run mode
- available : System is not in holdover or free-run mode
Parameter type: <Alarm::clkFreeMode>
( failed
| available )
Possible values:
- failed : System is in holdover or free-run mode
- available : System is not in holdover or free-run mode
Parameter type: <Alarm::ShubLoc>
( lost
| not-lost )
Possible values:
- lost : NT shub communication lost
- not-lost : NT shub communication intact

current
status
specifying
persistant data is lost or not
This element is only shown in
detail mode.
status of persist-data with its
previous logged value.
This element is only shown in
detail mode.
current
status
of
sntp
communication is lost or not
This element is only shown in
detail mode.
status of sntp communication
with its previous logged value.
This element is only shown in
detail mode.
current status of preferred timing
mode
This element is only shown in
detail mode.
status of preferred timing mode
with its previous logged value.
This element is only shown in
detail mode.
current status of timing reference
This element is only shown in
detail mode.

status of timing reference with its


previous logged value
This element is only shown in
detail mode.
current status of nt shub
communication is lost or intact
This element is only shown in
detail mode.

Released

1143

54 Alarm Log Status Commands

name

Type

Description

prev-status

Parameter type: <Alarm::ShubLoc>


( lost
| not-lost )
Possible values:
- lost : NT shub communication lost
- not-lost : NT shub communication intact
Parameter type: <Alarm::BackPnlInv>
( invalid
| valid )
Possible values:
- invalid : BackPanel-type Invalid
- valid : BackPanel-type Valid
Parameter type: <Alarm::BackPnlInv>
( invalid
| valid )
Possible values:
- invalid : BackPanel-type Invalid
- valid : BackPanel-type Valid
Parameter type: <Alarm::SHubCfgLost>
( lost
| not-lost )
Possible values:
- lost : SHub configuration loss - recent changes lost
- not-lost : SHub configuration up to date
Parameter type: <Alarm::SHubCfgLost>
( lost
| not-lost )
Possible values:
- lost : SHub configuration loss - recent changes lost
- not-lost : SHub configuration up to date

status of nt shub communication


with its previous logged value.
This element is only shown in
detail mode.

back-pnl-inv
short name: bpnl-inv

prev-status

shub-conf-lost
short name: conf-lost

prev-status

1144

Released

current status of BackPanel-type


Invalid alarm.
This element is only shown in
detail mode.
status of BackPanel-type Invalid
alarm with its previous logged
value.
This element is only shown in
detail mode.
actual shub configuration may
differ from lanx database on nt
This element is only shown in
detail mode.
status of shub configuration lost
with its previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.4 Equipment Holder Alarm Log Status


Command
Command Description
This command displays the equipment holder alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log eqpt-holder [ (index) ]

Command Parameters
Table 54.4-1 "Equipment Holder Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.4-2 "Equipment Holder Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

shelf

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
specify which shelf the alarm
occurred on.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
rack-power

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::rackPower>


( failing
| ok )
Possible values:

Description
current status of rack power
alarm, indicating fuse is broken
or intact
This element is only shown in

Released

1145

54 Alarm Log Status Commands

name
prev-status

fan-unit1
short name: fan1

prev-status

fan-unit2
short name: fan2

prev-status

shelf-mismatch

prev-status

shelf-missing

prev-status

1146

Released

Type

Description

- failing : the fuse is broken


- ok : the fuse is intact
Parameter type: <Alarm::rackPower>
( failing
| ok )
Possible values:
- failing : the fuse is broken
- ok : the fuse is intact
Parameter type: <Alarm::fanUnit1>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 1 is failing
- fail : fan unit 1 is failing
- ok : fan unit 1 is ok
Parameter type: <Alarm::fanUnit1>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 1 is failing
- fail : fan unit 1 is failing
- ok : fan unit 1 is ok
Parameter type: <Alarm::fanUnit2>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 2 is failing
- fail : fan unit 2 is failing
- ok : fan unit 2 is ok
Parameter type: <Alarm::fanUnit2>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 2 is failing
- fail : fan unit 2 is failing
- ok : fan unit 2 is ok
Parameter type: <Alarm::shelfTypeMismatch>
( mismatch
| no-mismatch )
Possible values:
- mismatch : installed and planned shelf types are different
- no-mismatch : installed and planned shelf types are the
same
Parameter type: <Alarm::shelfTypeMismatch>
( mismatch
| no-mismatch )
Possible values:
- mismatch : installed and planned shelf types are different
- no-mismatch : installed and planned shelf types are the
same
Parameter type: <Alarm::shelfMissing>
( missing
| not-missing )
Possible values:
- missing : detected shelf now missing
- not-missing : detected shelf was missing, now reinserted
Parameter type: <Alarm::shelfMissing>

detail mode.
status of rack power alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of fan-unit1
This element is only shown in
detail mode.

status of fan-unit1 with its


previous logged value.
This element is only shown in
detail mode.

current status of fan-unit2


This element is only shown in
detail mode.

status of fan-unit2 with its


previous logged value.
This element is only shown in
detail mode.

current status specifies installed


and planned shelf types are
different
This element is only shown in
detail mode.
status of shelf-mismatch with its
previous logged value.
This element is only shown in
detail mode.

current status specifies once


inserted shelf has gone missing
This element is only shown in
detail mode.
status of shelf-missing with its

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

shelf-install-missing

prev-status

door

prev-status

ac-power-fail
short name: ac-pwr

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( missing
| not-missing )
Possible values:
- missing : detected shelf now missing
- not-missing : detected shelf was missing, now reinserted
Parameter type: <Alarm::shelfInstall>
( yes
| no )
Possible values:
- yes : shelf now installed
- no : shelf now not installed
Parameter type: <Alarm::shelfInstall>
( yes
| no )
Possible values:
- yes : shelf now installed
- no : shelf now not installed
Parameter type: <Alarm::door>
( ( failing | fail )
| ok )
Possible values:
- failing : the cabinet door is opened
- fail : the cabinet door is opened
- ok : the cabinet door is closed
Parameter type: <Alarm::door>
( ( failing | fail )
| ok )
Possible values:
- failing : the cabinet door is opened
- fail : the cabinet door is opened
- ok : the cabinet door is closed
Parameter type: <Alarm::acPowerFail>
( ( failing | fail )
| ok )
Possible values:
- failing : system AC power fails
- fail : system AC power fails
- ok : the system AC power works properly
Parameter type: <Alarm::acPowerFail>
( ( failing | fail )
| ok )
Possible values:
- failing : system AC power fails
- fail : system AC power fails
- ok : the system AC power works properly

previous logged value.


This element is only shown in
detail mode.
log status specifies shelf is
planned but not installed
This element is only shown in
detail mode.
status of shelf-install-missing
alarm with its previous logged
value.
This element is only shown in
detail mode.
current status of door alarm,
indicating the cabinet door is
opened
This element is only shown in
detail mode.
status of door power alarm with
its previous logged value.
This element is only shown in
detail mode.

current status of AC power


failure alarm, indicating the AC
Power is broken
This element is only shown in
detail mode.
status of AC power failure alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1147

54 Alarm Log Status Commands

54.5 Equipment Holder Extended Alarm Log Status


Command
Command Description
This command displays the equipment holder extended alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log eqpt-holder-ext [ (index) ]

Command Parameters
Table 54.5-1 "Equipment Holder Extended Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.5-2 "Equipment Holder Extended Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

shelf

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
specify which shelf the alarm
occurred on.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
ctl-com-fail

1148

Parameter type: <Alarm::ctlComFail>


( ( failing | fail )
| ok )
Possible values:

Released

Description
current status of shelf controller
communication failure.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

network-power-loss

prev-status

hw-fault

prev-status

bat-a-fault

prev-status

bat-b-fault

prev-status

3HH-04416-EBAA-TCZZA 01

Type
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
Parameter type: <Alarm::ctlComFail>
( ( failing | fail )
| ok )
Possible values:
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
Parameter type: <Alarm::netPwrFail>
( ( failing | fail )
| ok )
Possible values:
- failing : network power is failing
- fail : network power is failing
- ok : network power is ok
Parameter type: <Alarm::netPwrFail>
( ( failing | fail )
| ok )
Possible values:
- failing : network power is failing
- fail : network power is failing
- ok : network power is ok
Parameter type: <Alarm::hwFail>
( ( failing | fail )
| ok )
Possible values:
- failing : hardware is failing
- fail : hardware is failing
- ok : hardware is ok
Parameter type: <Alarm::hwFail>
( ( failing | fail )
| ok )
Possible values:
- failing : hardware is failing
- fail : hardware is failing
- ok : hardware is ok
Parameter type: <Alarm::batAFail>
( yes
| no )
Possible values:
- yes : Power Source Battery A Failure
- no : Power Source Battery A is OK
Parameter type: <Alarm::batAFail>
( yes
| no )
Possible values:
- yes : Power Source Battery A Failure
- no : Power Source Battery A is OK
Parameter type: <Alarm::batBFail>
( yes
| no )
Possible values:
- yes : Power Source Battery B Failure
- no : bfd stale entry not present
Parameter type: <Alarm::batBFail>

Description

status
of
shelf
controller
communication failure.
This element is only shown in
detail mode.

current status of network power


failure.
This element is only shown in
detail mode.

status of network power failure.


This element is only shown in
detail mode.

current status of hardware failure.


This element is only shown in
detail mode.

status of hardware failure.


This element is only shown in
detail mode.

current status of Power Source A


failure.
This element is only shown in
detail mode.
status of Power Source A failure.
This element is only shown in
detail mode.

current status of Power Source B


failure.
This element is only shown in
detail mode.
status of Power Source B failure.

Released

1149

54 Alarm Log Status Commands

name

network-power-loss-b

prev-status

sem-ac-power-fail

prev-status

sem-ups-fail

prev-status

dc-a-fail

prev-status

1150

Released

Type

Description

( yes
| no )
Possible values:
- yes : Power Source Battery B Failure
- no : bfd stale entry not present
Parameter type: <Alarm::netPwrFailB>
( ( failing | fail )
| no )
Possible values:
- failing : network power B is failing
- fail : network power B is failing
- no : network power B is ok
Parameter type: <Alarm::netPwrFailB>
( ( failing | fail )
| no )
Possible values:
- failing : network power B is failing
- fail : network power B is failing
- no : network power B is ok
Parameter type: <Alarm::semAcPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : AC power input is failing
- fail : AC power input is failing
- no : AC power input is ok
Parameter type: <Alarm::semAcPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : AC power input is failing
- fail : AC power input is failing
- no : AC power input is ok
Parameter type: <Alarm::semUpsFail>
( low
| no )
Possible values:
- low : voltage level low
- no : voltage level is ok
Parameter type: <Alarm::semUpsFail>
( low
| no )
Possible values:
- low : voltage level low
- no : voltage level is ok
Parameter type: <Alarm::dcAPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : Local DC A power input is failing
- fail : Local DC A power input is failing
- no : Local DC A power input is ok
Parameter type: <Alarm::dcAPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : Local DC A power input is failing

This element is only shown in


detail mode.

current status of Network Power


B failure.
This element is only shown in
detail mode.

status of Network Power B


failure.
This element is only shown in
detail mode.

current status of AC Power


failure.
This element is only shown in
detail mode.

status of AC Power failure.


This element is only shown in
detail mode.

current status of external power


supply low voltage failure.
This element is only shown in
detail mode.
status of external power supply
low voltage failure.
This element is only shown in
detail mode.
current status of local DC A
power failure.
This element is only shown in
detail mode.

status of local DC A power


failure.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
plan-power-mismatch

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- fail : Local DC A power input is failing


- no : Local DC A power input is ok
Parameter type: <Alarm::planPwrMismatch>
( mismatch
| no )
Possible values:
- mismatch : detected and planned power mode are in
mismatch
- no : planned and detected power mode are identic
Parameter type: <Alarm::planPwrMismatch>
( mismatch
| no )
Possible values:
- mismatch : detected and planned power mode are in
mismatch
- no : planned and detected power mode are identic

current status of detected and


planned power mode mismatch
failure.
This element is only shown in
detail mode.
status of detected and planned
power mode mismatch failure.
This element is only shown in
detail mode.

Released

1151

54 Alarm Log Status Commands

54.6 Plug-in Unit Alarm Log Status Command


Command Description
This command displays the plug-in unit alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log plug-in-unit [ (index) ]

Command Parameters
Table 54.6-1 "Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.6-2 "Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

board-position

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identify where the alarm has
occurred.
This element is only shown in
detail mode.

1152

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Only Show Details: current and previous alarm log status


name
Type
board-mismatch

prev-status

sw-download

prev-status

temperature

prev-status

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Alarm::boardMismatch>


( yes
| no )
Possible values:
- yes : planned and plugged-in types are different
- no : planned and plugged-in types are same
Parameter type: <Alarm::boardMismatch>
( yes
| no )
Possible values:
- yes : planned and plugged-in types are different
- no : planned and plugged-in types are same
Parameter type: <Alarm::swStatus>
( waiting
| completed )
Possible values:
- waiting : not able to download all the applicable SW files
- completed : download completed
Parameter type: <Alarm::swStatus>
( waiting
| completed )
Possible values:
- waiting : not able to download all the applicable SW files
- completed : download completed
Parameter type: <Alarm::tempStatus>
( above-thres
| below-thres )
Possible values:
- above-thres : temperature threshold on board exceeded
- below-thres : board temperature within threshold
Parameter type: <Alarm::tempStatus>
( above-thres

alarm specifing the planned and


plugged-in types are different
This element is only shown in
detail mode.
status of board-mismatch with its
previous logged value.
This element is only shown in
detail mode.
alarm specifing download of the
software is completed or not.
This element is only shown in
detail mode.
status of sw-download with its
previous logged value.
This element is only shown in
detail mode.
alarm
specifing
board
temperature is crossed the
threshold or not.
This element is only shown in
detail mode.
status of board temperature with
its previous logged value.

Released

1153

54 Alarm Log Status Commands

name

sem-power-fail

prev-status

sem-ups-fail

prev-status

temp-shutoff

prev-status

board-present

prev-status

board-inserted

1154

Released

Type

Description

| below-thres )
Possible values:
- above-thres : temperature threshold on board exceeded
- below-thres : board temperature within threshold
Parameter type: <Alarm::extPowerStatus>
( sem-power-fail
| sem-power-ok )
Possible values:
- sem-power-fail : SEM external power failure
- sem-power-ok : SEM external power ok
Parameter type: <Alarm::extPowerStatus>
( sem-power-fail
| sem-power-ok )
Possible values:
- sem-power-fail : SEM external power failure
- sem-power-ok : SEM external power ok
Parameter type: <Alarm::powerSupplyStatus>
( sem-ups-fail
| sem-ups-ok )
Possible values:
- sem-ups-fail : SEM external power supply failure
- sem-ups-ok : SEM external power supply ok
Parameter type: <Alarm::powerSupplyStatus>
( sem-ups-fail
| sem-ups-ok )
Possible values:
- sem-ups-fail : SEM external power supply failure
- sem-ups-ok : SEM external power supply ok
Parameter type: <Alarm::tempShutoffStatus>
( board-switched-off
| board-switched-on )
Possible values:
- board-switched-off : board switched off - excess
temperature
- board-switched-on : board switched on
Parameter type: <Alarm::tempShutoffStatus>
( board-switched-off
| board-switched-on )
Possible values:
- board-switched-off : board switched off - excess
temperature
- board-switched-on : board switched on
Parameter type: <Alarm::boardPresence>
( missing
| yes )
Possible values:
- missing : board was present, but now missing
- yes : board present
Parameter type: <Alarm::boardPresence>
( missing
| yes )
Possible values:
- missing : board was present, but now missing
- yes : board present
Parameter type: <Alarm::boardInsertion>
( never-inserted
| inserted )

This element is only shown in


detail mode.
alarm specifing SEM external
power failure.
This element is only shown in
detail mode.
status of SEM external power
with its previous logged value.
This element is only shown in
detail mode.
alarm specifing SEM external
power supply failure.
This element is only shown in
detail mode.
status of SEM external power
supply with its previous logged
value.
This element is only shown in
detail mode.
alarm specifing board is swiched
off
because
of
excess
temperature.
This element is only shown in
detail mode.
status of temp-shutoff with its
previous logged value.
This element is only shown in
detail mode.

indicates the presence of the


board.
This element is only shown in
detail mode.
status of board-present with its
previous logged value.
This element is only shown in
detail mode.
indicates the status of board was
inserted or not.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

board-init

prev-status

board-reset-cf

prev-status

shub-uplink

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- never-inserted : board was never inserted
- inserted : board was inserted
Parameter type: <Alarm::boardInsertion>
( never-inserted
| inserted )
Possible values:
- never-inserted : board was never inserted
- inserted : board was inserted
Parameter type: <Alarm::boardInit>
( failed
| completed )
Possible values:
- failed : board initialization failed
- completed : board initialization completed
Parameter type: <Alarm::boardInit>
( failed
| completed )
Possible values:
- failed : board initialization failed
- completed : board initialization completed
Parameter type: <Alarm::boardResetCommFail>
( yes
| ok )
Possible values:
- yes : board reset/communication failure occurred
- ok : no board reset/communication failure
Parameter type: <Alarm::boardResetCommFail>
( yes
| ok )
Possible values:
- yes : board reset/communication failure occurred
- ok : no board reset/communication failure
Parameter type: <Alarm::lanxuplinkbrkdwn>
( failure
| ok )
Possible values:
- failure : lanx uplink breakdown or removal
- ok : no breakdown or removal of lanx uplink
Parameter type: <Alarm::lanxuplinkbrkdwn>
( failure
| ok )
Possible values:
- failure : lanx uplink breakdown or removal
- ok : no breakdown or removal of lanx uplink

detail mode.
status of board-inserted with its
previous logged value.
This element is only shown in
detail mode.
specifies board initializaion is
sucessful or failed.
This element is only shown in
detail mode.
status of board-init with its
previous logged value.
This element is only shown in
detail mode.
indicates there has been a reset
and/or communication failure of
the board.
This element is only shown in
detail mode.
status of board-reset-cf with its
previous logged value.
This element is only shown in
detail mode.
indicates that lanx uplink
breakdown or removal.
This element is only shown in
detail mode.
status of shub-uplink with its
previous logged value.
This element is only shown in
detail mode.

Released

1155

54 Alarm Log Status Commands

54.7 ATM Alarm Log Status Command


Command Description
This command displays the ATM alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log atm [ (index) ]

Command Parameters
Table 54.7-1 "ATM Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.7-2 "ATM Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Equipm::AtmIndex>
identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::VpiVciValues>
identify where the alarm has
- the vpi and vci value (vpi/vci)
occurred.
This element is only shown in
detail mode.

port

vpi-vci

1156

Type

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

Only Show Details: current and previous alarm log status


name
Type
cell-dis-up

prev-status

cell-dis-down

prev-status

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Alarm::CellDiscardUpstream>


( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in upstream direction
- no-discard : no ATM cell discarded in upstream direction
Parameter type: <Alarm::CellDiscardUpstream>
( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in upstream direction
- no-discard : no ATM cell discarded in upstream direction
Parameter type: <Alarm::CellDiscardDownstream>
( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in downstream direction
- no-discard : no ATM cell discarded in downstream
direction
Parameter type: <Alarm::CellDiscardDownstream>
( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in downstream direction
- no-discard : no ATM cell discarded in downstream
direction

specifies ATM cell is discarded


or not in upstream direction.
This element is only shown in
detail mode.
status of cell-dis-up with its
previous logged value.
This element is only shown in
detail mode.
specifies ATM cell is discarded
or not in downstream direction.
This element is only shown in
detail mode.

status of cell-dis-down with its


previous logged value.
This element is only shown in
detail mode.

Released

1157

54 Alarm Log Status Commands

54.8 Ethernet Interface Alarm Log Status Command


Command Description
This command displays the ethernet interface alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ether-itf [ (index) ]

Command Parameters
Table 54.8-1 "Ethernet Interface Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.8-2 "Ethernet Interface Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

ether-ifindex

Parameter type: <Ether::InterfaceIndex>


- index of the collision interface
- range: [0...2147483647]

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identify where the alarm has
occurred.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
prev-status

1158

Parameter type: <Alarm::EtherLinkStatus>


( yes
| no )
Possible values:
- yes : board switched off - excess temperature
- no : board switched on

Released

Description
status of link-down with its
previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.9 Software Management Alarm Log Status


Command
Command Description
This command displays the software management Alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sw-mgmt [ (index) ]

Command Parameters
Table 54.9-1 "Software Management Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.9-2 "Software Management Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

board-position

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identifies the physical position of
the slot
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1159

54 Alarm Log Status Commands

name

Type

Description

- nt-a : nt-a slot


- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Only Show Details: current and previous alarm log status


name
Type
sw-rollback

prev-status

db-rollback

prev-status

xvps-inv-dbase

prev-status

inv-cde-file

1160

Description

Parameter type: <Alarm::SwRollback>


( yes
| no )
Possible values:
- yes : implicit software rollback performed
- no : no implicit software rollback
Parameter type: <Alarm::SwRollback>
( yes
| no )
Possible values:
- yes : implicit software rollback performed
- no : no implicit software rollback
Parameter type: <Alarm::DbRollback>
( yes
| no )
Possible values:
- yes : implicit database rollback performed
- no : no implicit database rollback
Parameter type: <Alarm::DbRollback>
( yes
| no )
Possible values:
- yes : implicit database rollback performed
- no : no implicit database rollback
Parameter type: <Alarm::XvpsInvalidDataBase>
( invalid
| valid )
Possible values:
- invalid : invalid xvps dbbase is detected
- valid : xvps dbase is valid
Parameter type: <Alarm::XvpsInvalidDataBase>
( invalid
| valid )
Possible values:
- invalid : invalid xvps dbbase is detected
- valid : xvps dbase is valid
Parameter type: <Alarm::XvpsInvalidCDEFile>
( invalid
| valid )
Possible values:

Released

specifies
implicit
software
rollback is performed or not.
This element is only shown in
detail mode.
status of sw-rollback with its
previous logged value.
This element is only shown in
detail mode.
specifies
implicit
database
rollback is performed or not.
This element is only shown in
detail mode.
status of db-rollback with its
previous logged value.
This element is only shown in
detail mode.
specifies implicit xvps dbase is
valid or not.
This element is only shown in
detail mode.
status of xvps-inv-dbase with its
previous logged value.
This element is only shown in
detail mode.
specifies implicit xvps dbase is
valid or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
prev-status

miss-cde-file

prev-status

cde-hash-error

prev-status

3HH-04416-EBAA-TCZZA 01

Type
- invalid : invalid xvps cde file is detected
- valid : xvps cde file is valid
Parameter type: <Alarm::XvpsInvalidCDEFile>
( invalid
| valid )
Possible values:
- invalid : invalid xvps cde file is detected
- valid : xvps cde file is valid
Parameter type: <Alarm::MissingCDEProfile>
( yes
| no )
Possible values:
- yes : cde profile is missed
- no : cde profile is exist
Parameter type: <Alarm::MissingCDEProfile>
( yes
| no )
Possible values:
- yes : cde profile is missed
- no : cde profile is exist
Parameter type: <Alarm::CDEProfileHashErr>
( yes
| no )
Possible values:
- yes : cde profile hash error
- no : cde profile hash correct
Parameter type: <Alarm::CDEProfileHashErr>
( yes
| no )
Possible values:
- yes : cde profile hash error
- no : cde profile hash correct

Description
status of inv-cde-file with its
previous logged value.
This element is only shown in
detail mode.
specifies cde profile is missed or
not.
This element is only shown in
detail mode.
status of miss-cde-file with its
previous logged value.
This element is only shown in
detail mode.
specifies cde profile no key.
This element is only shown in
detail mode.

status of cde-hash-error with its


previous logged value.
This element is only shown in
detail mode.

Released

1161

54 Alarm Log Status Commands

54.10 Temporal Filter Alarm Log Status Command


Command Description
This command displays the temporal filter alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log temporal [ (index) ]

Command Parameters
Table 54.10-1 "Temporal Filter Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.10-2 "Temporal Filter Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
tmp-filter1

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter1>
( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>

prev-status

tmp-filter2

1162

Released

Description
current status of temporal filter1
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter1 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter2

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

tmp-filter3

prev-status

tmp-filter4

prev-status

tmp-filter5

prev-status

tmp-filter6

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:

alarm is derived or not


This element is only shown in
detail mode.
status of temporal filter2 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter3
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter3 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter4
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter4 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter5
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter5 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter6
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter6 alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1163

54 Alarm Log Status Commands

name

Type
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter11>

tmp-filter7

prev-status

tmp-filter8

prev-status

tmp-filter9

prev-status

tmp-filter10

prev-status

tmp-filter11

prev-status

1164

Released

Description
current status of temporal filter7
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter7 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter8
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter8 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter9
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter9 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter10
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter10 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter11
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter11 alarm

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

tmp-filter12

prev-status

tmp-filter13

prev-status

tmp-filter14

prev-status

tmp-filter15

prev-status

tmp-filter16

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>
( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter13>
( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:

with its previous logged value.


This element is only shown in
detail mode.
current status of temporal filter12
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter12 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter13
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter13 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter14
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter14 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter15
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter15 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter16
alarm is derived or not
This element is only shown in
detail mode.

Released

1165

54 Alarm Log Status Commands

name

Type
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>

prev-status

tmp-filter17

prev-status

tmp-filter18

prev-status

tmp-filter19

prev-status

tmp-filter20

prev-status

tmp-filter21

1166

Released

Description
status of temporal filter16 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter17
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter17 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter18
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter18 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter19
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter19 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter20
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter20 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter21

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

tmp-filter22

prev-status

tmp-filter23

prev-status

tmp-filter24

prev-status

tmp-filter25

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:

alarm is derived or not


This element is only shown in
detail mode.
status of temporal filter21 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter22
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter22 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter23
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter23 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter24
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter24 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter25
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter25 alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1167

54 Alarm Log Status Commands

name

Type
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter30>

tmp-filter26

prev-status

tmp-filter27

prev-status

tmp-filter28

prev-status

tmp-filter29

prev-status

tmp-filter30

prev-status

1168

Released

Description
current status of temporal filter26
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter26 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter27
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter27 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter28
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter28 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter29
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter29 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of temporal filter30
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter30 alarm

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

tmp-filter31

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

with its previous logged value.


This element is only shown in
detail mode.
current status of temporal filter31
alarm is derived or not
This element is only shown in
detail mode.
status of temporal filter31 alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1169

54 Alarm Log Status Commands

54.11 Spatial Filter Alarm Log Status Command


Command Description
This command displays the spatial filter alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log spatial [ (index) ]

Command Parameters
Table 54.11-1 "Spatial Filter Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.11-2 "Spatial Filter Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
spa-filter1

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter1>
( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>

prev-status

spa-filter2

1170

Released

Description
current status of spatial filter1
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter1 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter2

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

spa-filter3

prev-status

spa-filter4

prev-status

spa-filter5

prev-status

spa-filter6

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:

alarm is derived or not


This element is only shown in
detail mode.
status of spatial filter2 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter3
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter3 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter4
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter4 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter5
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter5 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter6
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter6 alarm with
its previous logged value.
This element is only shown in
detail mode.

Released

1171

54 Alarm Log Status Commands

name

Type
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter11>

spa-filter7

prev-status

spa-filter8

prev-status

spa-filter9

prev-status

spa-filter10

prev-status

spa-filter11

prev-status

1172

Released

Description
current status of spatial filter7
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter7 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter8
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter8 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter9
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter9 alarm with
its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter10
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter10 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter11
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter11 alarm

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

spa-filter12

prev-status

spa-filter13

prev-status

spa-filter14

prev-status

spa-filter15

prev-status

spa-filter16

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>
( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter13>
( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:

with its previous logged value.


This element is only shown in
detail mode.
current status of spatial filter12
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter12 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter13
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter13 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter14
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter14 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter15
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter15 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter16
alarm is derived or not
This element is only shown in
detail mode.

Released

1173

54 Alarm Log Status Commands

name

Type
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>

prev-status

spa-filter17

prev-status

spa-filter18

prev-status

spa-filter19

prev-status

spa-filter20

prev-status

spa-filter21

1174

Released

Description
status of spatial filter16 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter17
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter17 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter18
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter18 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter19
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter19 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter20
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter20 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter21

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

spa-filter22

prev-status

spa-filter23

prev-status

spa-filter24

prev-status

spa-filter25

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:

alarm is derived or not


This element is only shown in
detail mode.
status of spatial filter21 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter22
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter22 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter23
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter23 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter24
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter24 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter25
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter25 alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1175

54 Alarm Log Status Commands

name

Type
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter30>

spa-filter26

prev-status

spa-filter27

prev-status

spa-filter28

prev-status

spa-filter29

prev-status

spa-filter30

prev-status

1176

Released

Description
current status of spatial filter26
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter26 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter27
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter27 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter28
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter28 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter29
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter29 alarm
with its previous logged value.
This element is only shown in
detail mode.
current status of spatial filter30
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter30 alarm

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

spa-filter31

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

with its previous logged value.


This element is only shown in
detail mode.
current status of spatial filter31
alarm is derived or not
This element is only shown in
detail mode.
status of spatial filter31 alarm
with its previous logged value.
This element is only shown in
detail mode.

Released

1177

54 Alarm Log Status Commands

54.12 xDSL Common Alarm Log Status Command


Command Description
This command displays the xDSL common alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl misc [ (index) ]

Command Parameters
Table 54.12-1 "xDSL Common Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.12-2 "xDSL Common Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
line-config

1178

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::LineConfig>


( config-error

Released

Description
specifies
whether
line
configuration data is used or not.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

line-capacity

prev-status

xdsl-init

prev-status

peer-modem

prev-status

tpstc-mis

3HH-04416-EBAA-TCZZA 01

Type

Description

| config-ok )
Possible values:
- config-error : line configuration data cannot be used
- config-ok : Line configuration data OK
Parameter type: <Alarm::LineConfig>
( config-error
| config-ok )
Possible values:
- config-error : line configuration data cannot be used
- config-ok : Line configuration data OK
Parameter type: <Alarm::LineCapacity>
( below-requirement
| meets-requirement )
Possible values:
- below-requirement : line capacity not enough to set up
requested profile
- meets-requirement : line capacity enough to set up
requested profile
Parameter type: <Alarm::LineCapacity>
( below-requirement
| meets-requirement )
Possible values:
- below-requirement : line capacity not enough to set up
requested profile
- meets-requirement : line capacity enough to set up
requested profile
Parameter type: <Alarm::Initialization>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to comminication
problem
- successful : initialization successful
Parameter type: <Alarm::Initialization>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to comminication
problem
- successful : initialization successful
Parameter type: <Alarm::PeerModem>
( no
| yes )
Possible values:
- no : no peer modem detected
- yes : peer modem detected
Parameter type: <Alarm::PeerModem>
( no
| yes )
Possible values:
- no : no peer modem detected
- yes : peer modem detected
Parameter type: <Alarm::TpstcMis>
( yes
| no )
Possible values:
- yes : mismatch between the configured tps-tc mode and the

This element is only shown in


detail mode.
status of line-config with its
previous logged value.
This element is only shown in
detail mode.
specifies whether line capacity is
set up or not.
This element is only shown in
detail mode.

status of line-capacity with its


previous logged value.
This element is only shown in
detail mode.

specifies xdsl line initialization is


successful or not.
This element is only shown in
detail mode.

status of xdsl-init with its


previous logged value.
This element is only shown in
detail mode.

specifies whether peer modem


detected or not.
This element is only shown in
detail mode.
status of peer-modem with its
previous logged value.
This element is only shown in
detail mode.
mismatch between the configured
tps-tc mode and the mode
supported by the connected cpe
This element is only shown in
detail mode.

Released

1179

54 Alarm Log Status Commands

name

Type

prev-status

forced-rtx-init

prev-status

1180

Description

mode supported by the connected cpe


- no : no mismatch between the configured and the tpstc
mode supported by connected cpe
Parameter type: <Alarm::TpstcMis>
( yes
| no )
Possible values:
- yes : mismatch between the configured tps-tc mode and the
mode supported by the connected cpe
- no : no mismatch between the configured and the tpstc
mode supported by connected cpe
Parameter type: <Alarm::ForcedRtxInit>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to forced
retransmission
- successful : initialization successful
Parameter type: <Alarm::ForcedRtxInit>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to forced
retransmission
- successful : initialization successful

Released

status of tpstcmismatch with its


previous logged value
This element is only shown in
detail mode.

specifies forced rtx initialization


is successful or not
This element is only shown in
detail mode.

status of forced-rtx-init with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.13 xDSL Near-end Alarm Log Status Command


Command Description
This command displays the xDSL near-end alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl near-end [ (index) ]

Command Parameters
Table 54.13-1 "xDSL Near-end Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.13-2 "xDSL Near-end Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

port

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
Specifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Only Show Details: current and previous alarm log status


name
Type
los

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::NearEndLOS>


( yes

Description
specifies near end loss of signal
occured or not.

Released

1181

54 Alarm Log Status Commands

name

Type

prev-status

lof

prev-status

lom

prev-status

ese

prev-status

bitrate

prev-status

1182

Description

| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
Parameter type: <Alarm::NearEndLOS>
status of los with its previous
( yes
logged value.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
Parameter type: <Alarm::NearEndLOF>
specifies near end loss of frame
( yes
occured or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of frame occurred
- no : no near end loss of frame
Parameter type: <Alarm::NearEndLOF>
status of lof with its previous
( yes
logged value.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of frame occurred
- no : no near end loss of frame
Parameter type: <Alarm::NearEndLOM>
specifies near end loss of margin
( yes
occured or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of margin occurred
- no : no near end loss of margin
Parameter type: <Alarm::NearEndLOM>
status of lom with its previous
( yes
logged value.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of margin occurred
- no : no near end loss of margin
Parameter type: <Alarm::NearEndESE>
specifies near end excessive
( yes
severe errors occured or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end excessive severe errors occurred
- no : no near end excessive severe errors occurred
Parameter type: <Alarm::NearEndESE>
status of ese with its previous
( yes
logged value.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end excessive severe errors occurred
- no : no near end excessive severe errors occurred
Parameter type: <Alarm::NearEndBRthres>
specifies
whether
upstream
( below-plan
planned bitrate reached or not
| meets-plan )
after initialization.
Possible values:
This element is only shown in
- below-plan : upstream planned bitrate not reached after detail mode.
initialization
- meets-plan : upstream planned bitrate reached
Parameter type: <Alarm::NearEndBRthres>
status of bitrate with its previous
( below-plan
logged value.
| meets-plan )
This element is only shown in
Possible values:
detail mode.

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

ncd

prev-status

lcd

prev-status

vect-dle

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- below-plan : upstream planned bitrate not reached after


initialization
- meets-plan : upstream planned bitrate reached
Parameter type: <Alarm::NearEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no near end cell delineation
- cell-deline-occurred : near end cell delineation occurred
Parameter type: <Alarm::NearEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no near end cell delineation
- cell-deline-occurred : near end cell delineation occurred
Parameter type: <Alarm::NearEndLCD>
( yes
| no )
Possible values:
- yes : loss of near end cell deliniation
- no : no loss of near end cell deliniation
Parameter type: <Alarm::NearEndLCD>
( yes
| no )
Possible values:
- yes : loss of near end cell deliniation
- no : no loss of near end cell deliniation
Parameter type: <Alarm::NearEndVectDle>
( yes
| no )
Possible values:
- yes : loss of us signal due to disorderly leaving event
- no : no disorderly leaving detected
Parameter type: <Alarm::NearEndVectDle>
( yes
| no )
Possible values:
- yes : loss of us signal due to disorderly leaving event
- no : no disorderly leaving detected

specifies whether near end cell


delineation is occured or not.
This element is only shown in
detail mode.
status of ncd with its previous
logged value.
This element is only shown in
detail mode.
specifies whether loss of near end
cell deliniation is occured or not.
This element is only shown in
detail mode.
status of lcd with its previous
logged value.
This element is only shown in
detail mode.
specifies whether a disorderly
leaving event occured or not.
This element is only shown in
detail mode.
status of vect-dle with its
previous logged value.
This element is only shown in
detail mode.

Released

1183

54 Alarm Log Status Commands

54.14 xDSL Far-end Alarm Log Status Command


Command Description
This command displays the xDSL far-end alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl far-end [ (index) ]

Command Parameters
Table 54.14-1 "xDSL Far-end Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.14-2 "xDSL Far-end Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
los

1184

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::FarEndLOS>


( yes

Released

Description
specifies whether far end loss of
signal occured or not.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

lof

prev-status

lpr

prev-status

lol

prev-status

lom

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : far end loss of signal occurred
- no : no far end loss of signal
Parameter type: <Alarm::FarEndLOS>
( yes
| no )
Possible values:
- yes : far end loss of signal occurred
- no : no far end loss of signal
Parameter type: <Alarm::FarEndLOF>
( yes
| no )
Possible values:
- yes : far end loss of frame occurred
- no : no far end loss of frame
Parameter type: <Alarm::FarEndLOF>
( yes
| no )
Possible values:
- yes : far end loss of frame occurred
- no : no far end loss of frame
Parameter type: <Alarm::FarEndLPR>
( yes
| no )
Possible values:
- yes : far end loss of power detected
- no : no far end loss of power
Parameter type: <Alarm::FarEndLPR>
( yes
| no )
Possible values:
- yes : far end loss of power detected
- no : no far end loss of power
Parameter type: <Alarm::FarEndLOL>
( yes
| no )
Possible values:
- yes : far end loss of link detected
- no : no far end loss of link
Parameter type: <Alarm::FarEndLOL>
( yes
| no )
Possible values:
- yes : far end loss of link detected
- no : no far end loss of link
Parameter type: <Alarm::FarEndLOM>
( yes
| no )
Possible values:
- yes : far end loss of margin occurred
- no : no far end loss of margin
Parameter type: <Alarm::FarEndLOM>
( yes
| no )
Possible values:
- yes : far end loss of margin occurred

This element is only shown in


detail mode.
status of los with its previous
logged value.
This element is only shown in
detail mode.
specifies whether far end loss of
frame occured or not.
This element is only shown in
detail mode.
status of lof with its previous
logged value.
This element is only shown in
detail mode.
specifies whether far end loss of
power detected or not.
This element is only shown in
detail mode.
status of lpr with its previous
logged value.
This element is only shown in
detail mode.
specifies whether far end loss of
link detected or not.
This element is only shown in
detail mode.
status of lol with its previous
logged value.
This element is only shown in
detail mode.
specifies whether far end loss of
margin occured or not.
This element is only shown in
detail mode.
status of lom with its previous
logged value.
This element is only shown in
detail mode.

Released

1185

54 Alarm Log Status Commands

name

Type

ese

prev-status

bitrate

prev-status

ncd

prev-status

lcd

prev-status

upbo-vio

1186

Description

- no : no far end loss of margin


Parameter type: <Alarm::FarEndESE>
( yes
| no )
Possible values:
- yes : far end excessive severe errors occurred
- no : no far end excessive severe errors occurred
Parameter type: <Alarm::FarEndESE>
( yes
| no )
Possible values:
- yes : far end excessive severe errors occurred
- no : no far end excessive severe errors occurred
Parameter type: <Alarm::FarEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : downstream planned bitrate not reached after
initialization
- meets-plan : downstream planned bitrate reached
Parameter type: <Alarm::FarEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : downstream planned bitrate not reached after
initialization
- meets-plan : downstream planned bitrate reached
Parameter type: <Alarm::FarEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no far end cell delineation
- cell-deline-occurred : far end cell delineation occurred
Parameter type: <Alarm::FarEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no far end cell delineation
- cell-deline-occurred : far end cell delineation occurred
Parameter type: <Alarm::FarEndLCD>
( yes
| no )
Possible values:
- yes : loss of far end cell deliniation
- no : no loss of far end cell deliniation
Parameter type: <Alarm::FarEndLCD>
( yes
| no )
Possible values:
- yes : loss of far end cell deliniation
- no : no loss of far end cell deliniation
Parameter type: <Alarm::FarEndUPBO>
( yes
| no )
Possible values:
- yes : UPBO violation
- no : no UPBO violation

Released

specifies whether far end


excessive severe errors occured
or not.
This element is only shown in
detail mode.
status of ese with its previous
logged value.
This element is only shown in
detail mode.
specifies whether downstream
planned bitrate reached or not.
This element is only shown in
detail mode.

status of bitrate with its previous


logged value.
This element is only shown in
detail mode.

specifies whether far end cell


delineation occured or not.
This element is only shown in
detail mode.
status of ncd with its previous
logged value.
This element is only shown in
detail mode.
specifies there is loss of far end
cell deliniation or not.
This element is only shown in
detail mode.
status of lcd with its previous
logged value.
This element is only shown in
detail mode.
UPBO violation
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

cpe-pol

Parameter type: <Alarm::FarEndActFail>


( yes
| no )
Possible values:
- yes : activation failure due to CPE policing
- no : no activation failure due to CPE policing

activation failure due to CPE


policing
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1187

54 Alarm Log Status Commands

54.15 TCA xDSL Alarm Log Status Command


Command Description
This command displays the xDSL threshold cross alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl-tca [ (index) ]

Command Parameters
Table 54.15-1 "TCA xDSL Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.15-2 "TCA xDSL Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
identifies where the alarm
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
errored-secs

1188

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::ErroredSeconds>


( above-thres

Released

Description
number of errored seconds
exceeded or below threshold

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

es-in-a-day

prev-status

severely-es

prev-status

severely-es-in-a-day

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| below-thres )
Possible values:
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
Parameter type: <Alarm::ErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
Parameter type: <Alarm::ErroredSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds in a day, exceeded
threshold
- below-thres : number of errored seconds in a day, below
threshold
Parameter type: <Alarm::ErroredSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds in a day, exceeded
threshold
- below-thres : number of errored seconds in a day, below
threshold
Parameter type: <Alarm::SeverelyErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds exceeded
threshold
- below-thres : number of severely errored seconds below
threshold
Parameter type: <Alarm::SeverelyErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds exceeded
threshold
- below-thres : number of severely errored seconds below
threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,

This element is only shown in


detail mode.

status of errored-secs with its


previous logged value.
This element is only shown in
detail mode.

errored seconds in a day


exceeded or below threshold
This element is only shown in
detail mode.

status of es-in-a-day with its


previous logged value.
This element is only shown in
detail mode.

number of severely errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

status of severely-es with its


previous logged value.
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of severely-es-in-a-day
with its previous logged value.
This element is only shown in
detail mode.

Released

1189

54 Alarm Log Status Commands

name

Type

unavail-secs

prev-status

unavail-secs-in-a-day

prev-status

es

prev-status

fe-severely-es

1190

Released

Description

exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::UnavailableSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds exceeded
threshold
- below-thres : number of unavailable seconds below
threshold
Parameter type: <Alarm::UnavailableSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds exceeded
threshold
- below-thres : number of unavailable seconds below
threshold
Parameter type: <Alarm::UnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds in a day,
exceeded threshold
- below-thres : number of unavailable seconds in a day,
below threshold
Parameter type: <Alarm::UnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds in a day,
exceeded threshold
- below-thres : number of unavailable seconds in a day,
below threshold
Parameter type: <Alarm::FarEndErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds exceeded
threshold
- below-thres : number of far end errored seconds below
threshold
Parameter type: <Alarm::FarEndErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds exceeded
threshold
- below-thres : number of far end errored seconds below
threshold
Parameter type: <Alarm::FarEndSevErroredSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end severely errored seconds
exceeded threshold

number of unavailable seconds


exceeded or below threshold
This element is only shown in
detail mode.

status of unavail-secs with its


previous logged value.
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of unavail-secs-in-a-day
with its previous logged value.
This element is only shown in
detail mode.

number of far end errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

status of es with its previous


logged value.
This element is only shown in
detail mode.

number of far end severely


errored seconds exceeded or
below threshold
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
prev-status

fe-sev-es/day

prev-status

fe-unavail-secs

prev-status

fe-unavail-sec/day

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- below-thres : number of far end severely errored seconds


below threshold
Parameter type: <Alarm::FarEndSevErroredSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end severely errored seconds
exceeded threshold
- below-thres : number of far end severely errored seconds
below threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::FarEndUnavailSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds
exceeded threshold
- below-thres : number of far end unavailable seconds below
threshold
Parameter type: <Alarm::FarEndUnavailSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds
exceeded threshold
- below-thres : number of far end unavailable seconds below
threshold
Parameter type: <Alarm::FarEndUnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds in a
day, exceeded threshold
- below-thres : number of far end unavailable seconds in a
day, below threshold
Parameter type: <Alarm::FarEndUnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds in a
day, exceeded threshold
- below-thres : number of far end unavailable seconds in a

status of fe-severely-es with its


previous logged value.
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of fe-sev-es/day with its


previous logged value.
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of fe-unavail-secs with its


previous logged value.
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of fe-unavail-sec/day with


its previous logged value.
This element is only shown in
detail mode.

Released

1191

54 Alarm Log Status Commands

name

Type

fe-es-in-a-day

prev-status

leftrs

prev-status

leftrs-in-a-day

prev-status

fe-leftrs

1192

Description

day, below threshold


Parameter type: <Alarm::FarEndErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds in a day,
exceeded threshold
- below-thres : number of far end errored seconds in a day,
below threshold
Parameter type: <Alarm::FarEndErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds in a day,
exceeded threshold
- below-thres : number of far end errored seconds in a day,
below threshold
Parameter type: <Alarm::LeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
exceeded threshold
- below-thres : number of low error free throughput seconds
below threshold
Parameter type: <Alarm::LeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
exceeded threshold
- below-thres : number of low error free throughput seconds
below threshold
Parameter type: <Alarm::LeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
in a day, exceeded threshold
- below-thres : number of low error free throughput seconds
in a day, below threshold
Parameter type: <Alarm::LeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
in a day, exceeded threshold
- below-thres : number of low error free throughput seconds
in a day, below threshold
Parameter type: <Alarm::FarEndLeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds exceeded threshold
- below-thres : number of far end low error free throughput
seconds below threshold

Released

number of far end errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

status of fe-es-in-a-day with its


previous logged value.
This element is only shown in
detail mode.

number of low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

status of leftrs with its previous


logged value
This element is only shown in
detail mode.

number of low error free


throughput seconds in a day,
exceeded or below threshold
This element is only shown in
detail mode.

status of leftrs-in-a-day with its


previous logged value
This element is only shown in
detail mode.

number of far end low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

prev-status

Parameter type: <Alarm::FarEndLeftrSeconds>


( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds exceeded threshold
- below-thres : number of far end low error free throughput
seconds below threshold
Parameter type: <Alarm::FarEndLeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds in a day, exceeded threshold
- below-thres : number of far end low error free throughput
seconds in a day, below threshold
Parameter type: <Alarm::FarEndLeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds in a day, exceeded threshold
- below-thres : number of far end low error free throughput
seconds in a day, below threshold

status of fe-leftrs with its


previous logged value
This element is only shown in
detail mode.

fe-leftrs-in-a-day

prev-status

3HH-04416-EBAA-TCZZA 01

number of far end low error free


throughput seconds in a day,
exceeded or below threshold
This element is only shown in
detail mode.

status of fe-leftrs-in-a-day with


its previous logged value
This element is only shown in
detail mode.

Released

1193

54 Alarm Log Status Commands

54.16 Vectoring Line Alarm Log Status Command


Command Description
This command displays the vectoring line alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log vect-line [ (index) ]

Command Parameters
Table 54.16-1 "Vectoring Line Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.16-2 "Vectoring Line Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
specifies where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
xtc-variation-vict

1194

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::VectXtcVariation>


( excessive

Released

Description
excessive : abnormal amplitude
variation in xtc coefficients

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

xtc-variation-dist

prev-status

corrupted-errf

prev-status

vect-cpe-cap-mismatch

prev-status

vect-conf-not-feas

3HH-04416-EBAA-TCZZA 01

Type

Description

| normal )
Possible values:
- excessive : abnormal amplitude variation
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectXtcVariation>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectXtcVariationDist>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectXtcVariationDist>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectCorptErrf>
( yes
| no )
Possible values:
- yes : at least 10% corrupted or missing errorf
received
- no : received errorf samples ok
Parameter type: <Alarm::VectCorptErrf>
( yes
| no )
Possible values:
- yes : at least 10% corrupted or missing errorf
received
- no : received errorf samples ok
Parameter type: <Alarm::VectCpeCapMism>
( yes
| no )
Possible values:
- yes : not allowed Vectoring CPE connected
- no : allowed Vectoring CPE connected
Parameter type: <Alarm::VectCpeCapMism>
( yes
| no )
Possible values:
- yes : not allowed Vectoring CPE connected
- no : allowed Vectoring CPE connected
Parameter type: <Alarm::VectConfNotFeas>
( yes
| no )
Possible values:
- yes : vectoring configuration not feasable

This element is only shown in


detail mode.
in xtc
status of xtc-variation-vict with
its previous logged value
This element is only shown in
detail mode.
in xtc
specifies if excessive disturber
crosstalk coefficient variation
occurred or not
This element is only shown in
in xtc detail mode.
status of xtc-variation-dist with
its previous logged value
This element is only shown in
detail mode.
in xtc
specifies if corrupted or at least
10% missing errorf samples
received ccurred or not
This element is only shown in
samples detail mode.
status of corrupted-errf with its
previous logged value
This element is only shown in
detail mode.
samples
specifies if an allowed Vectoring
CPE is connected or not
This element is only shown in
detail mode.
status of vect-cpe-cap-mismatch
with its previous logged value
This element is only shown in
detail mode.
specifies
if
the
vectoring
configuration is feasable
This element is only shown in
detail mode.

Released

1195

54 Alarm Log Status Commands

name

Type
- no : vectoring configuration feasable
Parameter type: <Alarm::VectConfNotFeas>
( yes
| no )
Possible values:
- yes : vectoring configuration not feasable
- no : vectoring configuration feasable

prev-status

1196

Released

Description
status of vect-conf-not-feas with
its previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.17 Vectoring Board Alarm Log Status Command


Command Description
This command displays the vectoring board alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log vect-board [ (index) ]

Command Parameters
Table 54.17-1 "Vectoring Board Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.17-2 "Vectoring Board Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

board-index

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
specifies where the alarm has
occurred.
This element is only shown in
detail mode.

Parameter type: <Equipm::EqptVpSlotIndex>


( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::VectVpLinkIdx2>
this is the vplink id or the
- specifies the soft-link or the vp-link on the vp-board, or soft-link id. This index has value
zero
zero when it is not used
- range: [0,1...8]
This element is only shown in

vp-link-index

3HH-04416-EBAA-TCZZA 01

Released

1197

54 Alarm Log Status Commands

name

Type

Description
detail mode.

Only Show Details: current and previous alarm log status


name
Type

Description

vp-lt-mismatch

Parameter type: <Alarm::VectVpLtMism>


( yes
| no )
Possible values:
- yes : mismatch between expected and actual vp-lt mapping
or incompatible sw version on vp and lt
- no : expected and actual vp-lt in line or vp and lt have
compatible sw versions, OR autodiscovery enabled on vp,
autodiscovery disabled on lt

prev-status

Parameter type: <Alarm::VectVpLtMism>


( yes
| no )
Possible values:
- yes : mismatch between expected and actual vp-lt mapping
or incompatible sw version on vp and lt
- no : expected and actual vp-lt in line or vp and lt have
compatible sw versions, OR autodiscovery enabled on vp,
autodiscovery disabled on lt
Parameter type: <Alarm::VectQsfpInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : QSFP does not have valid Alcatel-Lucent ID
- valid : QSFP has valid Alcatel-Lucent ID OR no QSFP
detected.
Parameter type: <Alarm::VectQsfpInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : QSFP does not have valid Alcatel-Lucent ID
- valid : QSFP has valid Alcatel-Lucent ID OR no QSFP
detected.
Parameter type: <Alarm::VPLTLINKFAIL>
( linkdown
| linkup )
Possible values:
- linkdown : vp-lt link problem
- linkup : vp-lt link ok or no lt-expected OR autodiscovery
enabled on vp, autodiscovery disabled on lt

qsfp-id

prev-status

vp-lt-link

prev-status

1198

Parameter type: <Alarm::VPLTLINKFAIL>


( linkdown
| linkup )
Possible values:
- linkdown : vp-lt link problem
- linkup : vp-lt link ok or no lt-expected OR autodiscovery
enabled on vp, autodiscovery disabled on lt

Released

specifies if a mismatch between


expected and actual vp-lt
mapping OR incompatible sw
version on vp and lt is detected or
not. In case vplt-autodiscovery
disabled on vp, failure reported
on
vp-board.
In
case
vplt-autodiscovery enabled on lt,
failure reported on lt-board.
This element is only shown in
detail mode.
status of vp-lt-mismatch with its
previous logged value
This element is only shown in
detail mode.

specifies if detected QSFP of the


frontcable
has
a
valid
Alcatel-Lucent ID or not
This element is only shown in
detail mode.
status of qsfp-id with its previous
logged value
This element is only shown in
detail mode.

specifies if a VP-LT link failure


is detected or not. In case
vplt-autodiscovery disabled on
vp, failure reported on vp-board
when an lt was expected but no
valid connection between vp-lt.
In
case
vplt-autodiscovery
enabled on lt, failure reported on
lt-board
when
no
valid
connection between vp-lt.
This element is only shown in
detail mode.
status of VP-LT Link Failure
with its previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1199

54 Alarm Log Status Commands

54.18 Electrical-to-Optical Conversion Alarm Log


Status Command
Command Description
This command displays the electrical-to-optical conversion alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log eo-conversion [ (index) ]

Command Parameters
Table 54.18-1 " Electrical-to-Optical Conversion Alarm Log Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.18-2 " Electrical-to-Optical Conversion Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

port

Parameter type: <SignedInteger>


- a signed integer

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identifies where the alarm
occurred
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
loss-of-signal

1200

Description

Parameter type: <Alarm::EoConvLOS>


( yes
| no )
Possible values:
- yes : loss of signal detected in the EO conversion module

Released

specifies whether loss of signal


detected or not in the EO
conversion module
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
prev-status

transmission

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- no : no loss of signal detected in the EO conversion


module
Parameter type: <Alarm::EoConvLOS>
( yes
| no )
Possible values:
- yes : loss of signal detected in the EO conversion module
- no : no loss of signal detected in the EO conversion
module
Parameter type: <Alarm::EoConvTx>
( faulty
| ok )
Possible values:
- faulty : transmission fault in the EO module
- ok : transmission OK
Parameter type: <Alarm::EoConvTx>
( faulty
| ok )
Possible values:
- faulty : transmission fault in the EO module
- ok : transmission OK

status of loss-of-signal with its


previous logged value.
This element is only shown in
detail mode.

specifies whether transmission


fault is occurred or not in the EO
module
This element is only shown in
detail mode.
status of transmission with its
previous logged value.
This element is only shown in
detail mode.

Released

1201

54 Alarm Log Status Commands

54.19 Authentication Alarm Log Status Command


Command Description
This command displays the authentication-related alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log authentication [ (index) ]

Command Parameters
Table 54.19-1 "Authentication Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.19-2 "Authentication Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
vlan-assignment
short name: vlan-assign

prev-status

1202

Released

Description

Parameter type: <Alarm::VLANassignment>


( failed
| successful )
Possible values:
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session
Parameter type: <Alarm::VLANassignment>
( failed
| successful )
Possible values:
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session

specifies whether a VLAN for a


user session is assigned or failed
This element is only shown in
detail mode.
status of vlan-assignment with its
previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1203

54 Alarm Log Status Commands

54.20 xDSL Bonding Alarm Log Status Command


Command Description
This command displays the xDSL bonding-related alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log bonding-group [ (index) ]

Command Parameters
Table 54.20-1 "xDSL Bonding Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.20-2 "xDSL Bonding Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Xdsl::BondingInterfaceIndex>
identifies the bonding group
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface index
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

group

Only Show Details: current and previous alarm log status


name
Type
up-plan-bitrate

1204

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::UpPlannedBitrate>


( failure

Released

Description
specifies whether the actual
group upstream bit rate is above

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

down-plan-bitrate

prev-status

up-min-bitrate

prev-status

down-min-bitrate

3HH-04416-EBAA-TCZZA 01

Type

Description

| ok )
Possible values:
- failure : actual group bitrate is above the minimum
upstream bitrate but below the group upstream planned
bitrate
- ok : actual group bitrate is above the group upstream
planned bitrate
Parameter type: <Alarm::UpPlannedBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum
upstream bitrate but below the group upstream planned
bitrate
- ok : actual group bitrate is above the group upstream
planned bitrate
Parameter type: <Alarm::DownPlanBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum
downstream bitrate but below the group downstream
planned bitrate
- ok : actual group bitrate is above the group downstream
planned bitrate
Parameter type: <Alarm::DownPlanBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum
downstream bitrate but below the group downstream
planned bitrate
- ok : actual group bitrate is above the group downstream
planned bitrate
Parameter type: <Alarm::UpMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group upstream
minimum bitrate
- ok : actual group bitrate is above the group upstream
minimum bitrate
Parameter type: <Alarm::UpMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group upstream
minimum bitrate
- ok : actual group bitrate is above the group upstream
minimum bitrate
Parameter type: <Alarm::DownMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group
downstream minimum bitrate
- ok : actual group bitrate is above the group downstream

the group upstream planned bit


rate or not
This element is only shown in
detail mode.

status of up-plan-bitrate with its


previous logged value.
This element is only shown in
detail mode.

specifies whether the actual


group downstream bit rate is
above the group downstream
planned bit rate or not
This element is only shown in
detail mode.

status of down-plan-bitrate with


its previous logged value.
This element is only shown in
detail mode.

specifies whether the actual


group upstream bit rate is above
the group upstream minimum bit
rate or not
This element is only shown in
detail mode.
status of up-min-bitrate with its
previous logged value.
This element is only shown in
detail mode.

specifies whether the actual


group downstream bit rate is
above the group downstream
minimum bit rate or not
This element is only shown in
detail mode.

Released

1205

54 Alarm Log Status Commands

name

Type

prev-status

up-config

prev-status

down-config

prev-status

bond-cpe-conn

prev-status

multiple-cpes

prev-status

1206

Description

minimum bitrate
Parameter type: <Alarm::DownMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group
downstream minimum bitrate
- ok : actual group bitrate is above the group downstream
minimum bitrate
Parameter type: <Alarm::UpConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : upstream configuration not feasible
- feasible : upstream configuration feasible
Parameter type: <Alarm::UpConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : upstream configuration not feasible
- feasible : upstream configuration feasible
Parameter type: <Alarm::DownConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : downstream configuration not feasible
- feasible : downstream configuration feasible
Parameter type: <Alarm::DownConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : downstream configuration not feasible
- feasible : downstream configuration feasible
Parameter type: <Alarm::BondCPE>
( not-connected
| connected )
Possible values:
- not-connected : bonding cpe modem not connected
- connected : bonding cpe modem connected
Parameter type: <Alarm::BondCPE>
( not-connected
| connected )
Possible values:
- not-connected : bonding cpe modem not connected
- connected : bonding cpe modem connected
Parameter type: <Alarm::BgConnCPE>
( true
| false )
Possible values:
- true : bonding group has multiple cpe modems connected
- false : bonding group has one cpe modem connected
Parameter type: <Alarm::BgConnCPE>
( true
| false )
Possible values:
- true : bonding group has multiple cpe modems connected
- false : bonding group has one cpe modem connected

Released

status of down-min-bitrate with


its previous logged value.
This element is only shown in
detail mode.

specifies whether the upstream


configuration is feasible or not
This element is only shown in
detail mode.
status of up-config with its
previous logged value.
This element is only shown in
detail mode.
specifies whether the downstream
configuration is feasible or not
This element is only shown in
detail mode.
status of down-config with its
previous logged value.
This element is only shown in
detail mode.
specifies whether a bonding CPE
modem is connected or not
This element is only shown in
detail mode.
status of bond-cpe-conn with its
previous logged value.
This element is only shown in
detail mode.
specifies whether the lines of a
bonding group are connected to
multiple CPEs or only one
This element is only shown in
detail mode.
status of bg-conn-cpes with its
previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

register

Parameter type: <Alarm::BgRegFail>


( failure
| ok )
Possible values:
- failure : bonding group discovery or aggregation
failure detected
- ok : bonding group discovery or aggregation
failure not detected
Parameter type: <Alarm::BgRegFail>
( failure
| ok )
Possible values:
- failure : bonding group discovery or aggregation
failure detected
- ok : bonding group discovery or aggregation
failure not detected
Parameter type: <Alarm::BgNotCompl>
( true
| false )
Possible values:
- true : bonding group is incomplete
- false : bonding group is complete
Parameter type: <Alarm::BgNotCompl>
( true
| false )
Possible values:
- true : bonding group is incomplete
- false : bonding group is complete

prev-status

group-incomplete

prev-status

3HH-04416-EBAA-TCZZA 01

Description
specifies whether a discovery or
aggregation
failure
is
encountered or not
This element is only shown in
register detail mode.
register
status of bg-reg-fail with its
previous logged value.
This element is only shown in
detail mode.
register
register
specifies whether all configured
lines of the bonding group are
part of the bonding group
This element is only shown in
detail mode.
status of bg-not-compl with its
previous logged value.
This element is only shown in
detail mode.

Released

1207

54 Alarm Log Status Commands

54.21 Redundancy Alarm Log Status Command


Command Description
This command displays the redundancy alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log redundancy [ (index) ]

Command Parameters
Table 54.21-1 "Redundancy Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.21-2 "Redundancy Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
loss-over-cap

prev-status

ping-check

1208

Description

Parameter type: <Alarm::SwoCap>


( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::SwoCap>
( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::PingCheck>

Released

identify the switchover capability


in a redundant system.
This element is only shown in
detail mode.
status
of
the
switchover
capability with its previous
logged value.
This element is only shown in
detail mode.
identify the ping check in a

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

( failure
| successful )
Possible values:
- failure : system failure of ping check
- successful : system successful of ping check

redundant system.
This element is only shown in
detail mode.

Released

1209

54 Alarm Log Status Commands

54.22 Custom Alarm Log Status Command


Command Description
This command displays the custom alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log custom [ (index) ]

Command Parameters
Table 54.22-1 "Custom Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.22-2 "Custom Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

custom-alarm1

Parameter type: <Alarm::custom1>


( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom1>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom2>
( yes
| no )

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identify the customizableAlarm1
.
This element is only shown in
detail mode.

prev-status

custom-alarm2

1210

Released

status of customizableAlarm1
with its previous logged value.
This element is only shown in
detail mode.
identify the customizableAlarm2
.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

custom-alarm3

prev-status

custom-alarm4

prev-status

custom-alarm5

prev-status

Type

Description

Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm

detail mode.

Only Show Details: host expansion shelves customizable alarms


name
Type
shelf

he-custom-alarm1

3HH-04416-EBAA-TCZZA 01

Parameter type: <Equipm::HolderId>


( <Eqpt::RackId> / <Eqpt::ShelfId>
| not-applicable )
Possible values:
- not-applicable : not applicable
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::he-custom1>

status of customizableAlarm2
with its previous logged value.
This element is only shown in
detail mode.
identify the customizableAlarm3
.
This element is only shown in
detail mode.
status of customizableAlarm3
with its previous logged value.
This element is only shown in
detail mode.
identify the customizableAlarm4
.
This element is only shown in
detail mode.
status of customizableAlarm4
with its previous logged value.
This element is only shown in
detail mode.
identify the customizableAlarm5
.
This element is only shown in
detail mode.
status of customizableAlarm5
with its previous logged value.
This element is only shown in
detail mode.

Description
this is the shelf id (equipment
hoder id) for host expansion
alarms, otherwise it is the rack ID
This element is only shown in
detail mode.

identify the host expansion shelf's

Released

1211

54 Alarm Log Status Commands

name

prev-status

he-custom-alarm2

prev-status

he-custom-alarm3

prev-status

he-custom-alarm4

prev-status

he-custom-alarm5

prev-status

1212

Released

Type

Description

( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom1>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom5>
( yes
| no )
Possible values:

customizableAlarm1 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm1 with
its previous logged value.
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm2 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm2 with
its previous logged value.
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm3 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm3 with
its previous logged value.
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm4 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm4 with
its previous logged value.
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm5 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm5 with
its previous logged value.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
he-custom-alarm6

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : Miscellaneous environment alarm


- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom6>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom6>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm

detail mode.
identify the host expansion shelf's
customizableAlarm6 .
This element is only shown in
detail mode.
status of the host expansion
shelf's customizableAlarm6 with
its previous logged value.
This element is only shown in
detail mode.

Released

1213

54 Alarm Log Status Commands

54.23 SFP Alarm Log Status Command


Command Description
This command displays the SFP alarm log status.
For Expander card SFP alarms, the remote LT slot-identifier that corresponds to the SFP is displayed in the output
parameter "alarm index 1", and not the SFP faceplate cage-number identifier.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sfp [ (index) ]

Command Parameters
Table 54.23-1 "SFP Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.23-2 "SFP Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

alarm index 1

Parameter type: <Alarm::SfpAlarmIdx1Type>


( <Alarm::SfpAlarmIdx1>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
this is the host sfp faceplate
number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.

1214

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
alarm index 2

Type

Only Show Details: host shelf alarms


name
Type
host-sfp-los

host-sfp-tx

host-sfp-pres

host-sfp-id

3HH-04416-EBAA-TCZZA 01

Description

expansion shelf alarm


Parameter type: <Alarm::SfpAlarmIdx2Type>
( <Alarm::SfpAlarmIdx2>
| nt : sfp : <Eqpt::PortIndex>
| nt-a : sfp : <Alarm::SfpAlarmIdx2>
| nt-a : xfp : <Alarm::SfpAlarmIdx2>
| nt-b : sfp : <Alarm::SfpAlarmIdx2>
| nt-b : xfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : xfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : xfp : <Alarm::SfpAlarmIdx2>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- nt : active nt slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Alarm::SfpAlarmIdx2>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
Field type <Eqpt::PortIndex>
- the faceplate port number

Parameter type: <Alarm::hostSFPLOS>


( failing
| ok )
Possible values:
- failing : host downlink SFP loss of signal
- ok : host downlink SFP signal ok
Parameter type: <Alarm::hostSFPTxFail>
( failing
| ok )
Possible values:
- failing : host downlink SFP tx failure
- ok : host downlink SFP tx ok
Parameter type: <Alarm::hostSFPMissing>
( not-present
| present )
Possible values:
- not-present : host downlink SFP not present
- present : host downlink SFP present
Parameter type: <Alarm::hostSFPInvalidAlcatelID>
( invalid
| valid )

this is the lanx port id for host


alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.

Description
current status host downlink SFP
loss of signal
This element is only shown in
detail mode.
status host downlink SFP tx
failure
This element is only shown in
detail mode.
current status host downlink SFP
not present
This element is only shown in
detail mode.
status host downlink SFP does
not have valid Alcatel-Lucent ID
This element is only shown in

Released

1215

54 Alarm Log Status Commands

name

host-sfp-ctrl

host-sfp-rmtlt

host-sfp-mismatch

host-sfp-incompt

Type

Description

Possible values:
- invalid : host downlink SFP does not have valid
Alcatel-Lucent ID
- valid : host downlink SFP has valid Alcatel-Lucent ID
Parameter type: <Alarm::hostSFPControlFail>
( failing
| ok )
Possible values:
- failing : host downlink SFP control failure
- ok : host downlink SFP control ok
Parameter type: <Alarm::hostSFPUnexpectedRemoteLT>
( yes
| no )
Possible values:
- yes : host shelf SFP unexpected remote LT plug-in
- no : host shelf SFP expected remote LT plug-in
Parameter type: <Alarm::hostSFPAssignmentMismatch>
( yes
| no )
Possible values:
- yes : host shelf SFP assignment does not match reported
rack/shelf/slot
- no : host shelf SFP assignment matches reported
rack/shelf/slot
Parameter type: <Alarm::hostSFPIncompatibleShelf>
( yes
| no )
Possible values:
- yes : host shelf SFP incompatible shelf type detected
- no : host shelf SFP compatible shelf type detected

detail mode.

Only Show Details: expansion shelf alarms


name
Type
exp-sfp-los

exp-sfp-pres

exp-sfp-id

1216

Released

host downlink SFP unexpected


remote plug-in
This element is only shown in
detail mode.
host downlink SFP assignment
does
not
match
reported
rack/shelf/slot
This element is only shown in
detail mode.

host downlink SFP incompatible


shelf type detected
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::expansionShelfSFPLos>


( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP loss of signal
- ok : expansion shelf downlink SFP signal ok
Parameter type: <Alarm::expansionShelfSFPTxFail>
( failing
| ok )
Possible values:
- failing : expansion shelf host downlink SFP tx failure
- ok : expansion shelf downlink SFP tx ok
Parameter type: <Alarm::expansionShelfSFPMissing>
( not-present
| present )
Possible values:
- not-present : expansion shelf downlink SFP not present
- present : expansion shelf downlink SFP present
Parameter type: <Alarm::expShelfSFPInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : expansion shelf downlink SFP does not have valid
Alcatel-Lucent ID
- valid : expansion shelf downlink SFP has valid

exp-sfp-tx

status host downlink SFP control


failure
This element is only shown in
detail mode.

current status expansion side


downlink SFP loss of signal
This element is only shown in
detail mode.
status expansion shelf downlink
SFP tx failure
This element is only shown in
detail mode.
current status expansion shelf
downlink SFP not present
This element is only shown in
detail mode.
status expansion shelf downlink
SFP does not have valid
Alcatel-Lucent ID
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
exp-sfp-ctrl

exp-sfp-1-los

exp-sfp-2-los

3HH-04416-EBAA-TCZZA 01

Type

Description

Alcatel-Lucent ID
Parameter type: <Alarm::expansionShelfSFPControlFail>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP control failure
- ok : expansion shelf downlink SFP control ok
Parameter type: <Alarm::expansionShelfSFP1Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP1 loss of signal
- ok : expansion shelf downlink SFP1 signal ok
Parameter type: <Alarm::expansionShelfSFP2Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP2 loss of signal
- ok : expansion shelf downlink SFP2 signal ok

status expansion shelf downlink


SFP control failure
This element is only shown in
detail mode.
current status expansion side
downlink SFP1 loss of signal
This element is only shown in
detail mode.
current status expansion side
downlink SFP2 loss of signal
This element is only shown in
detail mode.

Released

1217

54 Alarm Log Status Commands

54.24 Custom External Alarm Log Status Command


Command Description
This command displays the customizable external alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log custom-ext-alarm [ (index) ]

Command Parameters
Table 54.24-1 "Custom External Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.24-2 "Custom External Alarm Log Status Command" Display parameters
Specific Information
name
board-position

1218

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>

identify where the alarm has


occurred.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

last-updated-on
ext-alarm1

ext-alarm2

ext-alarm3

ext-alarm4

ext-alarm5

3HH-04416-EBAA-TCZZA 01

Type
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::custExtAlarm1>
( yes
| no )
Possible values:
- yes : customizable external alarm 1
- no : no customizable external alarm 1
Parameter type: <Alarm::custExtAlarm2>
( yes
| no )
Possible values:
- yes : customizable external alarm 2
- no : no customizable external alarm 2
Parameter type: <Alarm::custExtAlarm3>
( yes
| no )
Possible values:
- yes : customizable external alarm 3
- no : no customizable external alarm 3
Parameter type: <Alarm::custExtAlarm4>
( yes
| no )
Possible values:
- yes : customizable external alarm 4
- no : no customizable external alarm 4
Parameter type: <Alarm::custExtAlarm5>
( yes
| no )
Possible values:
- yes : customizable external alarm 5
- no : no customizable external alarm 5

Description

network time in seconds when


the alarm was logged.
This element is always shown.
current status specifying external
alarm 1 is present or not
This element is always shown.

current status specifying external


alarm 2 is present or not
This element is always shown.

current status specifying external


alarm 3 is present or not
This element is always shown.

current status specifying external


alarm 4 is present or not
This element is always shown.

current status specifying external


alarm 5 is present or not
This element is always shown.

Released

1219

54 Alarm Log Status Commands

54.25 SFP RSSI for NT Alarm Log Status Command


Command Description
This command displays the SFP RSSI alarm log status.
For NT card SFP alarms, the remote LT slot-identifier that corresponds to the SFP is displayed in the output

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sfprssi [ (index) ]

Command Parameters
Table 54.25-1 "SFP RSSI for NT Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.25-2 "SFP RSSI for NT Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

alarm index 1

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
this is the nt/ntio slot id for host
alarms.
This element is only shown in
detail mode.

1220

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

alarm index 2

Type

Description

| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::RssiPort>
( sfp : <Alarm::RssiPort>
| xfp : <Alarm::RssiPort> )
Possible values:
- sfp : rssi sfp port
- xfp : rssi xfp port
Field type <Alarm::RssiPort>
- value
- range: [0...18]

Only Show Details: sfp rssi diagnostic threshold control alarms


name
Type
tx-power-high-alarm

tx-power-low-alarm

rx-power-high-alarm

rx-power-low-alarm

3HH-04416-EBAA-TCZZA 01

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::NTNTIOTXPWHI>


( yes
| no )
Possible values:
- yes : TX optical power is too high than configured alarm
high threshold
- no : The TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLO>
( yes
| no )
Possible values:
- yes : TX optical power is too low than the configured
alarm low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHI>
( yes
| no )
Possible values:
- yes : RX optical power is too high than the configured
alarm high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLO>

current status optical power is too


high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status RX optical power
is too high than the configured
alarm high threshold
This element is only shown in
detail mode.
current status RX optical power

Released

1221

54 Alarm Log Status Commands

name

tx-biascur-high-alarm

tx-biascur-low-alarm

volt-high-alarm

volt-low-alarm

temp-high-alarm

temp-low-alarm

tx-power-high-warn

tx-power-low-warn

1222

Released

Type

Description

( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
alarm low threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIOTXBIASHI>
( yes
| no )
Possible values:
- yes : TX bias is too high than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLO>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHI>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured alarm high
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOVOLLO>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured alarm low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPHI>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured alarm
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPLO>
( yes
| no )
Possible values:
- yes : temperature is too low than the configured alarm low
threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTXPWHIWARN>
( yes
| no )
Possible values:
- yes : TX optical power is too high than the configured
warning high threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLOWARN>
( yes

is too low than the configured


alarm low threshold
This element is only shown in
detail mode.
current status TX bias is too high
than the configured alarm low
threshold
This element is only shown in
detail mode.
current status TX bias is too low
than the configured alarm low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured alarm high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured alarm low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status TX optical power is
too high than the configured
warning high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

rx-power-high-warn

rx-power-low-warn

tx-biascur-high-warn

tx-biascur-low-warn

volt-high-warn

volt-low-warn

temp-high-warn

temp-low-warn

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : TX optical power is too low than the configured
warning low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHIWARN>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLOWARN>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning low threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIOTXBIASHIWARN>
( yes
| no )
Possible values:
- yes : TX bias is too high than the configured warning high
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLOWARN>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured warning low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHIWARN>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured warning high
threshold
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::NTNTIOVOLLOWARN>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured warning low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPEHIWARN>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured warning
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPELOWARN>
( yes
| no )

warning low threshold


This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
warning high threshold
This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
warning low threshold
This element is only shown in
detail mode.
current status TX bias is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status TX bias is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured warning
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured warning
low threshold

Released

1223

54 Alarm Log Status Commands

name

Type

Description

Possible values:
This element is only shown in
- yes : temperature is too high than the configured warning detail mode.
low threshold
- no : temperature is ok

1224

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.26 PPP Cross-Connect Engine TCA Alarm Log


Status Command
Command Description
This command displays the PPP cross-connect engine TCA alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log pppcc-engine-tca [ (index) ]

Command Parameters
Table 54.26-1 "PPP Cross-Connect Engine TCA Alarm Log Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.26-2 "PPP Cross-Connect Engine TCA Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

engine

Parameter type: <Vlan::StackedVlanSigned>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
this is the ppp-cc engine number
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1225

54 Alarm Log Status Commands

name

Type

Description

Field type <Vlan::CVlanIndex>


- customer vlan identity
- range: [0...4093,4094,4096]

Only Show Details: pppoe cross-connect engine tca alarms


name
Type
pppcce-trans-15min-tca

pppcce-sess-15min-tca

pppcce-trans-1day-tca

pppcce-sess-1day-tca

1226

Released

Description

Parameter type: <Alarm::PPPCCETRANS15MIN>


( yes
| no )
Possible values:
- yes : 15 minutes transaction timeout count exceeds
configured TCA
- no : 15 minutes transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS15MIN>
( yes
| no )
Possible values:
- yes : 15 minutes session timeout count exceeds configured
TCA
- no : 15 minutes session timeout count is OK
Parameter type: <Alarm::PPPCCETRANS1DAY>
( yes
| no )
Possible values:
- yes : 1day transaction timeout count exceeds configured
TCA
- no : 1day transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS1DAY>
( yes
| no )
Possible values:
- yes : 1day session timeout count exceeds configured TCA
- no : 1day session timeout count is OK

current 15 minutes transaction


timeout count exceeds configured
tca
This element is only shown in
detail mode.
15 minutes session timeout count
exceeds configured TCA
This element is only shown in
detail mode.

1day transaction timeout count


exceeds configured TCA
This element is only shown in
detail mode.

1day session timeout count


exceeds configured TCA
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.27 2xE1/DS1 SFP Clock Alarm Log Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Clock Alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sfpe1t1-clock [ (index) ]

Command Parameters
Table 54.27-1 "2xE1/DS1 SFP Clock Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 54.27-2 "2xE1/DS1 SFP Clock Alarm Log Status Command" Display parameters
Specific Information
name
alarm index 1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

Released

1227

54 Alarm Log Status Commands

name

Type

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1Port>
( sfp : <Alarm::E1t1FramerPort>
| xfp : <Alarm::E1t1FramerPort> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]

alarm index 2

Only Show Details: e1t1 sfp clock alarms


name
Type
dsx1-serdes-fail

dsx1-tributary2-fail

dsx1-los-fail

1228

Description

Parameter type: <Alarm::DSX1SERDESFAIL>


( yes
| no )
Possible values:
- yes : SERDES clock failure alarm
- no : SERDES Clock no failure
Parameter type: <Alarm::DSX1TRIB1FAIL>
( yes
| no )
Possible values:
- yes : Tributary 1 clock failure alarm
- no : Tributary 1 clock no failure
Parameter type: <Alarm::DSX1TRIB2FAIL>
( yes
| no )
Possible values:
- yes : Tributary 2 clock failure alarm
- no : Tributary 2 clock no failure
Parameter type: <Alarm::DSX1LOSFAIL>
( yes
| no )
Possible values:
- yes : All selected tributaries in Loss Of Signal
- no : No All selected tributaries in Loss Of Signal

dsx1-tributary1-fail

Released

this is the host sfp faceplate


number
This element is only shown in
detail mode.

SERDES clock failure alarm


This element is only shown in
detail mode.

tributary 1 clock failure alarm


This element is only shown in
detail mode.

tributary 2 clock failure alarm


This element is only shown in
detail mode.

all selected tributaries in loss of


signal
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

dsx1-ais-sync

Parameter type: <Alarm::DSX1AISFAIL>


( yes
| no )
Possible values:
- yes : Alarm Indication Signal on the tributary selected sync
source
- no : No Alarm Indication Signal on the tributary selected
sync source
Parameter type: <Alarm::DSX1LOFSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Frame on the tributary selected sync source
- no : No Loss of Frame on the tributary selected sync
source
Parameter type: <Alarm::DSX1LOSSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Signal on the tributary selected sync source
- no : No Loss of Signal on the tributary selected sync
source
Parameter type: <Alarm::DSX1DEGFAIL>
( yes
| no )
Possible values:
- yes : Signal degrade alarm
- no : Signal degrade alarm

alarm indication signal on the


tributary selected as sync source
This element is only shown in
detail mode.

dsx1-lof-sync

dsx1-los-sync

dsx1-deg-fail

3HH-04416-EBAA-TCZZA 01

loss of frame on the tributary


selected as sync source
This element is only shown in
detail mode.

loss of signal on the tributary


selected as sync source
This element is only shown in
detail mode.

signal degrade alarm


This element is only shown in
detail mode.

Released

1229

54 Alarm Log Status Commands

54.28 2xE1/DS1 SFP Framer Alarm Log Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Framer alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sfpe1t1-framer [ (index) ]

Command Parameters
Table 54.28-1 "2xE1/DS1 SFP Framer Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 54.28-2 "2xE1/DS1 SFP Framer Alarm Log Status Command" Display parameters
Specific Information
name
alarm index 1

1230

Released

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

alarm index 2

Type

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1framerPort>
( sfp : <Alarm::E1t1FramerPort> : <Alarm::tributary>
| xfp : <Alarm::E1t1FramerPort> : <Alarm::tributary> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]
Field type <Alarm::tributary>
- value
- range: [1...2]

Only Show Details: e1t1 framer alarms


name
Type
rei-from-liu

rdi-from-liu

crc6-from-liu

crc4-from-liu

3HH-04416-EBAA-TCZZA 01

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::DSX1REILIU>


( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from LIU
- no : No e1t1 sfp Remote Error Indication Alarm from LIU
Parameter type: <Alarm::DSX1RDILIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from LIU
- no : No e1t1 sfp Remote Defect Alarmn from LIU
Parameter type: <Alarm::DSX1CRC6LIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 6 from LIU
Parameter type: <Alarm::DSX1CRC4LIU>
( yes
| no )

remote error indication alarm


from LIU
This element is only shown in
detail mode.
remote defect indication alarm
from LIU
This element is only shown in
detail mode.
cyclic redundancy check 6 from
LIU
This element is only shown in
detail mode.
cyclic redundancy check 4 from
LIU
This element is only shown in

Released

1231

54 Alarm Log Status Commands

name

crc4-thrshold-from-liu

ais-from-liu

los-from-liu

lof-from-liu

lomf-from-liu

rei-from-iwf

rdi-from-iwf

crc6-from-iwf

crc4-from-iwf

1232

Released

Type

Description

Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 from LIU
Parameter type: <Alarm::DSX1CRC4THLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from LIU
Parameter type: <Alarm::DSX1AISLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from LIU
- no : No e1t1 sfp Alarm Indication Signal alarm from LIU
Parameter type: <Alarm::DSX1LOSLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from LIU
- no : No e1t1 sfp Loss of signal alarm from LIU
Parameter type: <Alarm::DSX1LOFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from LIU
- no : No e1t1 sfp Loss of frame alarm from LIUU
Parameter type: <Alarm::DSX1LOMFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from LIU
- no : No e1t1 sfp Loss of multi frame alarm from LIU
Parameter type: <Alarm::DSX1REIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from IWF
- no : No e1t1 sfp Remote Error Indication Alarm from IWF
Parameter type: <Alarm::DSX1RDIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from IWF
- no : No e1t1 sfp Remote Defect Alarmn from IWF
Parameter type: <Alarm::DSX1CRC6IWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 6 from IWF
Parameter type: <Alarm::DSX1CRC4IWF>
( yes
| no )
Possible values:

detail mode.
cyclic redundancy check 4
threshold alarm from LIU
This element is only shown in
detail mode.

alarm indication signal alarm


from LIU
This element is only shown in
detail mode.
loss of signal alarm from LIU
This element is only shown in
detail mode.

loss of frame alarm from LIU


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.
remote error indication alarm
from IWF
This element is only shown in
detail mode.
remote defect indication alarm
from IWF
This element is only shown in
detail mode.
cyclic redundancy check 6 from
IWF
This element is only shown in
detail mode.
cyclic redundancy check 4 from
IWF
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
crc4-thrshold-from-iwf

ais-from-iwf

los-from-iwf

lof-from-iwf

lomf-from-iwf

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : e1t1 sfp Cyclic Redundancy Check 4 from IWF


- no : No e1t1 sfp Cyclic Redundancy Check 4 from IWF
Parameter type: <Alarm::DSX1CRC4THIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from IWF
Parameter type: <Alarm::DSX1AISIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from IWF
- no : No e1t1 sfp Alarm Indication Signal alarm from IWF
Parameter type: <Alarm::DSX1LOSIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from IWF
- no : No e1t1 sfp Loss of signal alarm from IWF
Parameter type: <Alarm::DSX1LOFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from IWF
- no : No e1t1 sfp Loss of frame alarm from IWF
Parameter type: <Alarm::DSX1LOMFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from IWF
- no : No e1t1 sfp Loss of multi frame alarm from IWF

cyclic redundancy check 4


threshold alarm from IWF
This element is only shown in
detail mode.

alarm indication signal alarm


from IWF
This element is only shown in
detail mode.
loss of signal alarm from IWF
This element is only shown in
detail mode.

loss of frame alarm from IWF


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.

Released

1233

54 Alarm Log Status Commands

54.29 Plug In Unit Extended Alarm Log Status


Command
Command Description
This command displays the plug-in unit extended alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log plug-in-unit-ext [ (index) ]

Command Parameters
Table 54.29-1 "Plug In Unit Extended Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.29-2 "Plug In Unit Extended Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

board-position

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
identify where the alarm has
occurred.
This element is only shown in
detail mode.

1234

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

fan-alarm

dc-a-alarm

dc-b-alarm

dg-alarm

apsf-alarm

ntr-a-loss

ntr-b-loss

3HH-04416-EBAA-TCZZA 01

Type
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::pluginFan>
( yes
| no )
Possible values:
- yes : fan alarm
- no : no fan alarm
Parameter type: <Alarm::plugin-dc-a>
( yes
| no )
Possible values:
- yes : dc a failure alarm
- no : no dc a failure alarm
Parameter type: <Alarm::plugin-dc-b>
( yes
| no )
Possible values:
- yes : dc b failure alarm
- no : no dc b failure alarm
Parameter type: <Alarm::plugin-dg>
( yes
| no )
Possible values:
- yes : dying gasp alarm
- no : no dying gasp alarm
Parameter type: <Alarm::pluginApsf>
( yes
| no )
Possible values:
- yes : apsf failure alarm
- no : no apsf failure alarm
Parameter type: <Alarm::NTRALoss>
( yes
| no )
Possible values:
- yes : ntr-a signal unavailable
- no : ntr-a signal available
Parameter type: <Alarm::NTRBLoss>
( yes
| no )
Possible values:
- yes : ntr-b signal unavailable
- no : ntr-b signal available

Description

current status specifying fan


alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-a
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-b
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dying
gasp alarm is present or not
This element is only shown in
detail mode.
applique power supply failure yes
or no
This element is only shown in
detail mode.
log status specifying NTR-A loss
alarm is present or not
This element is only shown in
detail mode.
log status specifying NTR-B loss
alarm is present or not
This element is only shown in
detail mode.

Released

1235

54 Alarm Log Status Commands

name

Type

Description

xvps-conf-loss

Parameter type: <Alarm::XvpsConfLoss>


( yes
| no )
Possible values:
- yes : implicit xvps configuration loss.
- no : no implicit xvps configuration loss.
Parameter type: <Alarm::MacNofree>
( nofree
| free )
Possible values:
- nofree : no free mac entry in the mac table on the lt board.
- free : file transfer server available.
Parameter type: <Alarm::MacNofree>
( nofree
| free )
Possible values:
- nofree : no free mac entry in the mac table on the lt board.
- free : file transfer server available.
Parameter type: <Alarm::FibreConnMismatch>
( yes
| no )
Possible values:
- yes : REM fibre connection mismatch alarm
- no : no REM fibre connection mismatch alarm
Parameter type: <Alarm::FibreConnMismatch>
( yes
| no )
Possible values:
- yes : REM fibre connection mismatch alarm
- no : no REM fibre connection mismatch alarm
Parameter type: <Alarm::LinkCapMismatch>
( yes
| no )
Possible values:
- yes : actual link speed is not inline with the end-to-end link
capability between NT and LT
- no : actual link speed is inline with the end-to-end link
capability between NT and LT
Parameter type: <Alarm::LinkCapMismatch>
( yes
| no )
Possible values:
- yes : actual link speed is not inline with the end-to-end link
capability between NT and LT
- no : actual link speed is inline with the end-to-end link
capability between NT and LT
Parameter type: <Alarm::EqptCapMismatch>
( yes
| no )
Possible values:
- yes : not all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
- no : all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
Parameter type: <Alarm::EqptCapMismatch>

implicit xvps configuration loss


or not.
This element is only shown in
detail mode.

mac-entry-nofree

prev-status

fibre-conn-mismatch

prev-status

link-cap-mismatch

prev-status

eqpt-cap-mismatch

prev-status

1236

Released

current status specifying no free


mac entry in the mac table on the
lt board.
This element is only shown in
detail mode.
current status specifying no free
mac entry in the mac table on the
lt board.
This element is only shown in
detail mode.
current status specifying fibre
connection mismatch on detected
control card.
This element is only shown in
detail mode.
status of fibre connection
mismatch alarm with its previous
logged value.
This element is only shown in
detail mode.
log-status specifies that the actual
link speed is not in line with the
end-to-end
link
capability
between NT and LT.
This element is only shown in
detail mode.
status of link-cap-mismatch with
its previous logged value.
This element is only shown in
detail mode.

log-status specifies that not all


equipment between NT and LT
can support the speed that NT
and LT can support within the
configured MaxLinkSpeed.
This element is only shown in
detail mode.

status of eqpt-cap-mismatch with

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

ctrl-dnld-failure

prev-status

board-hw-issue

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : not all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
- no : all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
Parameter type: <Alarm::CtrlDownloadFailure>
( yes
| no )
Possible values:
- yes : The downloading of the Software image to the
controller card failed..
- no : The downloading of the Software image to the
controller card passed.
Parameter type: <Alarm::CtrlDownloadFailure>
( yes
| no )
Possible values:
- yes : The downloading of the Software image to the
controller card failed..
- no : The downloading of the Software image to the
controller card passed.
Parameter type: <Alarm::BoardHWIssue>
( yes
| no )
Possible values:
- yes : Board hardware issue
- no : No Board hardware issue.
Parameter type: <Alarm::BoardHWIssue>
( yes
| no )
Possible values:
- yes : Board hardware issue
- no : No Board hardware issue.

its previous logged value.


This element is only shown in
detail mode.

log-status specifies that the


downloading of the Software
image to the controller card
failed.
This element is only shown in
detail mode.
status of ctrl-dnld-failure with its
previous logged value.
This element is only shown in
detail mode.

log-status specifies that board


hardware issue.
This element is only shown in
detail mode.
status of board hardware issue
with its previous logged value.
This element is only shown in
detail mode.

Released

1237

54 Alarm Log Status Commands

54.30 SIP Server Alarm Log Status Commands


Command Description
This command displays the SIP server alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sip-server [ (index) ]

Command Parameters
Table 54.30-1 "SIP Server Alarm Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.30-2 "SIP Server Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name
Type
transport-mismatch

Parameter type: <Alarm::transportMismatch>


( yes
| no )
Possible values:
- yes : mismatch
- no : not mismatch
Parameter type: <Alarm::transportMismatch>
( yes
| no )
Possible values:
- yes : mismatch
- no : not mismatch
Parameter type: <Alarm::dnsLookUpFailure>
( yes
| no )
Possible values:
- yes : fail
- no : not fail
Parameter type: <Alarm::dnsLookUpFailure>

prev-status

dns-lookup-failure

prev-status

1238

Released

Description
specifies isamv and server
transport mismatch or not.
This element is only shown in
detail mode.
status of specifies transport
mismatch with its previous
logged value
This element is only shown in
detail mode.
specifies dns look up fail or not.
This element is only shown in
detail mode.

status of dns look up fail with its

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : fail
- no : not fail

previous logged value


This element is only shown in
detail mode.

Released

1239

54 Alarm Log Status Commands

54.31 SIP VSP Alarm Log Status Commands


Command Description
This command displays the SIP vsp alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sip-vsp [ (index) ]

Command Parameters
Table 54.31-1 "SIP VSP Alarm Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.31-2 "SIP VSP Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name
Type
none-dns-srv

prev-status

no-dns-srv

prev-status

1240

Description

Parameter type: <Alarm::noneDNSSRV>


( yes
| no )
Possible values:
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
Parameter type: <Alarm::noneDNSSRV>
( yes
| no )
Possible values:
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
Parameter type: <Alarm::noDNSSRV>
( yes
| no )
Possible values:
- yes : no dns server configured when sip request
- no : dns server configured when sip request
Parameter type: <Alarm::noDNSSRV>

Released

specifies none of dns server give


reply to to DNS look up or not.
This element is only shown in
detail mode.
status of specifies none of dns
server give reply to DNS look up
with its previous logged value
This element is only shown in
detail mode.
specifies
no
dns
server
configured when sip request or
not.
This element is only shown in
detail mode.
status of specifies no dns server

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

none-srv

prev-status

no-srv

prev-status

reg-srv-unreach

prev-status

prxy-srv-unreach

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : no dns server configured when sip request
- no : dns server configured when sip request
Parameter type: <Alarm::noneSRV>
( yes
| no )
Possible values:
- yes : none sip server give reply when send sip request
- no : sip server give reply when send sip request
Parameter type: <Alarm::noneSRV>
( yes
| no )
Possible values:
- yes : none sip server give reply when send sip request
- no : sip server give reply when send sip request
Parameter type: <Alarm::noSRV>
( yes
| no )
Possible values:
- yes : no sip proxy server configured when send sip request
- no : sip proxy server configured when send sip request
Parameter type: <Alarm::noSRV>
( yes
| no )
Possible values:
- yes : no sip proxy server configured when send sip request
- no : sip proxy server configured when send sip request
Parameter type: <Alarm::noRegSRV>
( yes
| no )
Possible values:
- yes : no sip register server give reply when send sip
register
- no : sip register server give reply when send sip register
Parameter type: <Alarm::noRegSRV>
( yes
| no )
Possible values:
- yes : no sip register server give reply when send sip
register
- no : sip register server give reply when send sip register
Parameter type: <Alarm::noPrxySRV>
( yes
| no )
Possible values:
- yes : no sip proxy server give reply when send sip request
- no : sip proxy server give reply when send sip request
Parameter type: <Alarm::noSRV>
( yes
| no )
Possible values:
- yes : no sip proxy server configured when send sip request
- no : sip proxy server configured when send sip request

configured when sip request with


its previous logged value
This element is only shown in
detail mode.
specifies none sip server give
reply when send sip request or
not.
This element is only shown in
detail mode.
status of specifies none sip server
give reply when send sip request
with its previous logged value
This element is only shown in
detail mode.
specifies no sip proxy server
configured when send sip request
or not.
This element is only shown in
detail mode.
status of specifies no sip proxy
server configured when send sip
request with its previous logged
value
This element is only shown in
detail mode.
specifies no sip register servers
give reply when send sip register
or not.
This element is only shown in
detail mode.
status of specifies no sip register
servers give reply when send sip
register with its previous logged
value
This element is only shown in
detail mode.
specifies no sip proxy servers
give reply when send sip request
or not.
This element is only shown in
detail mode.
status of specifies no sip proxy
servers give reply when send sip
request with its previous logged
value
This element is only shown in
detail mode.

Released

1241

54 Alarm Log Status Commands

54.32 SIP Dial Plan Alarm Log Status Commands


Command Description
This command displays the SIP dial plan alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sip-dial-plan [ (index) ]

Command Parameters
Table 54.32-1 "SIP Dial Plan Alarm Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.32-2 "SIP Dial Plan Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name
Type
bad-digitmap

Parameter type: <Alarm::badDigitMap>


( yes
| no )
Possible values:
- yes : digit map unusable
- no : digit map usable
Parameter type: <Alarm::badDigitMap>
( yes
| no )
Possible values:
- yes : digit map unusable
- no : digit map usable

prev-status

1242

Released

Description
specifies sip digitmap usable or
not.
This element is only shown in
detail mode.
status of specifies sip digitmap
with its previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.33 SIP Slot Alarm Log Status Commands


Command Description
This command displays the SIP slot alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sip-plugin-unit [ (index) ]

Command Parameters
Table 54.33-1 "SIP Slot Alarm Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.33-2 "SIP Slot Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name
Type
dhcp-unreach

prev-status

proxy-srv-unreach

prev-status

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::dhcpServerUnreach>


( yes
| no )
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
Parameter type: <Alarm::dhcpServerUnreach>
( yes
| no )
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
Parameter type: <Alarm::sipProxyServerUnreach>
( yes
| no )
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
Parameter type: <Alarm::sipProxyServerUnreach>

Description
specifies DHCP server status.
This element is only shown in
detail mode.

status of specifies dhcp server


with its previous logged value
This element is only shown in
detail mode.
specifies sip proxy server status.
This element is only shown in
detail mode.

status of specifies sip proxy

Released

1243

54 Alarm Log Status Commands

name

reg-srv-unreach

prev-status

1244

Released

Type

Description

( yes
| no )
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
Parameter type: <Alarm::sipRegistratorServerUnreach>
( yes
| no )
Possible values:
- yes : registrator server unreachable
- no : registrator server reachable
Parameter type: <Alarm::sipRegistratorServerUnreach>
( yes
| no )
Possible values:
- yes : registrator server unreachable
- no : registrator server reachable

server with its previous logged


value
This element is only shown in
detail mode.
specifies sip registrator server
status.
This element is only shown in
detail mode.
status of specifies sip registrator
server with its previous logged
value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.34 SIP Termination Alarm Log Status


Commands
Command Description
This command displays the SIP termination alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sip-termination [ (index) ]

Command Parameters
Table 54.34-1 "SIP Termination Alarm Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.34-2 "SIP Termination Alarm Log Status Commands" Display parameters
Only Show Details: current and previous alarm log status
name
Type
unknown-sub

prev-status

ground-key

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::unknownSubscriber>


( yes
| no )
Possible values:
- yes : wrong subscriber
- no : right subscriber
Parameter type: <Alarm::unknownSubscriber>
( yes
| no )
Possible values:
- yes : wrong subscriber
- no : right subscriber
Parameter type: <Alarm::groundKey>
( yes
| no )
Possible values:

Description
specfies the sip subscriber
unknow or not.
This element is only shown in
detail mode.
status of specifies subscribers
with its previous logged value
This element is only shown in
detail mode.
status of the ground key.
This element is only shown in
detail mode.

Released

1245

54 Alarm Log Status Commands

name

Type

prev-status

port-hightemp

prev-status

port-jbfltca

prev-status

reg-domainname

prev-status

reg-auth

prev-status

reg-timeout

1246

Description

- yes : current to ground


- no : current not to ground
Parameter type: <Alarm::groundKey>
( yes
| no )
Possible values:
- yes : current to ground
- no : current not to ground
Parameter type: <Alarm::highTemperature>
( yes
| no )
Possible values:
- yes : high temperature
- no : not high temperature
Parameter type: <Alarm::highTemperature>
( yes
| no )
Possible values:
- yes : high temperature
- no : not high temperature
Parameter type: <Alarm::jbflTca>
( yes
| no )
Possible values:
- yes : high jb fill level
- no : not high jb fill level
Parameter type: <Alarm::jbflTca>
( yes
| no )
Possible values:
- yes : high jb fill level
- no : not high jb fill level
Parameter type: <Alarm::regdomainname>
( yes
| no )
Possible values:
- yes : register - resolving domain name failed
- no : register - resolving domain name successful
Parameter type: <Alarm::regdomainname>
( yes
| no )
Possible values:
- yes : register - resolving domain name failed
- no : register - resolving domain name successful
Parameter type: <Alarm::regauth>
( yes
| no )
Possible values:
- yes : register - authentication failed
- no : register - authentication successful
Parameter type: <Alarm::regauth>
( yes
| no )
Possible values:
- yes : register - authentication failed
- no : register - authentication successful
Parameter type: <Alarm::regtimeout>

Released

status of specifies ground key


with its previous logged value
This element is only shown in
detail mode.
status of the port temperature.
This element is only shown in
detail mode.

status of specifies temperature


with its previous logged value
This element is only shown in
detail mode.
status of the port jb fill level tca.
This element is only shown in
detail mode.

status of specifies jb fill level tca


with its previous logged value
This element is only shown in
detail mode.
status of resolving domain name
(register).
This element is only shown in
detail mode.
status of resolving domain name
(register) with its previous logged
value
This element is only shown in
detail mode.
status of authentication (register).
This element is only shown in
detail mode.

status of authentication (register)


with its previous logged value
This element is only shown in
detail mode.
status

3HH-04416-EBAA-TCZZA

of

message

01

timeout

54 Alarm Log Status Commands

name

prev-status

reg-srvfailresp

prev-status

inv-domainname

prev-status

inv-auth

prev-status

inv-timeout

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : register - message timeout
- no : register - message not timeout
Parameter type: <Alarm::regtimeout>
( yes
| no )
Possible values:
- yes : register - message timeout
- no : register - message not timeout
Parameter type: <Alarm::regsrvfailresp>
( yes
| no )
Possible values:
- yes : register - failure response from server
- no : register - successful response from server
Parameter type: <Alarm::regsrvfailresp>
( yes
| no )
Possible values:
- yes : register - failure response from server
- no : register - successful response from server
Parameter type: <Alarm::invdomainname>
( yes
| no )
Possible values:
- yes : invite - resolving domain name failed
- no : invite - resolving domain name successful
Parameter type: <Alarm::invdomainname>
( yes
| no )
Possible values:
- yes : invite - resolving domain name failed
- no : invite - resolving domain name successful
Parameter type: <Alarm::invauth>
( yes
| no )
Possible values:
- yes : invite - authentication failed
- no : invite - authentication successful
Parameter type: <Alarm::invauth>
( yes
| no )
Possible values:
- yes : invite - authentication failed
- no : invite - authentication successful
Parameter type: <Alarm::invtimeout>
( yes
| no )
Possible values:
- yes : invite - message timeout
- no : invite - message not timeout
Parameter type: <Alarm::invtimeout>
( yes
| no )
Possible values:

(register).
This element is only shown in
detail mode.
status of message timeout
(register) with its previous logged
value
This element is only shown in
detail mode.
status of failure response from
server (register).
This element is only shown in
detail mode.
status of failure response from
server (register) with its previous
logged value
This element is only shown in
detail mode.
status of resolving domain name
(invite).
This element is only shown in
detail mode.
status of resolving domain name
(invite) with its previous logged
value
This element is only shown in
detail mode.
status of authentication (invite).
This element is only shown in
detail mode.

status of authentication (invite)


with its previous logged value
This element is only shown in
detail mode.
status of message timeout
(invite).
This element is only shown in
detail mode.
status of message timeout (invite)
with its previous logged value
This element is only shown in
detail mode.

Released

1247

54 Alarm Log Status Commands

name

Type

inv-srvfailresp

prev-status

subs-srvfailresp

prev-status

subs-domainname

prev-status

subs-auth

prev-status

subs-refreshfail

prev-status

1248

Description

- yes : invite - message timeout


- no : invite - message not timeout
Parameter type: <Alarm::invsrvfailresp>
( yes
| no )
Possible values:
- yes : invite - failure response from server
- no : invite - successful response from server
Parameter type: <Alarm::invsrvfailresp>
( yes
| no )
Possible values:
- yes : invite - failure response from server
- no : invite - successful response from server
Parameter type: <Alarm::subssrvfailresp>
( yes
| no )
Possible values:
- yes : subscribe - failure response from server
- no : subscribe - successful response from server
Parameter type: <Alarm::subssrvfailresp>
( yes
| no )
Possible values:
- yes : subscribe - failure response from server
- no : subscribe - successful response from server
Parameter type: <Alarm::subsdomainname>
( yes
| no )
Possible values:
- yes : Subscribe - resolving domain name failed
- no : Subscribe - resolving domain name successful
Parameter type: <Alarm::subsdomainname>
( yes
| no )
Possible values:
- yes : Subscribe - resolving domain name failed
- no : Subscribe - resolving domain name successful
Parameter type: <Alarm::subsauth>
( yes
| no )
Possible values:
- yes : Subscribe - authentication failed
- no : Subscribe - authentication successful
Parameter type: <Alarm::subsauth>
( yes
| no )
Possible values:
- yes : Subscribe - authentication failed
- no : Subscribe - authentication successful
Parameter type: <Alarm::subsrefreshfail>
( yes
| no )
Possible values:
- yes : Subscribe - refresh failure
- no : Subscribe - refresh failure
Parameter type: <Alarm::subsrefreshfail>

Released

status of failure response from


server (invite).
This element is only shown in
detail mode.
status of failure response from
server (invite) with its previous
logged value
This element is only shown in
detail mode.
status of failure response from
server (subscribe).
This element is only shown in
detail mode.
status of failure response from
server (subscribe) with its
previous logged value
This element is only shown in
detail mode.
status of resolving domain name
(subscribe).
This element is only shown in
detail mode.
status of resolving domain name
(subscribe) with its previous
logged value
This element is only shown in
detail mode.
status
of
authentication
(subscribe).
This element is only shown in
detail mode.
status
of
authentication
(subscribe) with its previous
logged value
This element is only shown in
detail mode.
status of message timeout or 481
received (refresher subscribe).
This element is only shown in
detail mode.
status of message timeout or 481

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

subs-inittimeout

prev-status

emergency-call

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : Subscribe - refresh failure
- no : Subscribe - refresh failure
Parameter type: <Alarm::subsinittimeout>
( yes
| no )
Possible values:
- yes : Subscribe - initial REQ timeout
- no : Subscribe - initial REQ timeout
Parameter type: <Alarm::subsinittimeout>
( yes
| no )
Possible values:
- yes : Subscribe - initial REQ timeout
- no : Subscribe - initial REQ timeout
Parameter type: <Alarm::emergencycall>
( yes
| no )
Possible values:
- yes : emergency call is ongoing
- no : emergency call is not ongoing
Parameter type: <Alarm::emergencycall>
( yes
| no )
Possible values:
- yes : emergency call is ongoing
- no : emergency call is not ongoing

received (refresher subscribe)


with its previous logged value
This element is only shown in
detail mode.
status of message timeout (initial
subscribe).
This element is only shown in
detail mode.
status of message timeout (initial
subscribe) with its previous
logged value
This element is only shown in
detail mode.
status of emergency call.
This element is only shown in
detail mode.

status of emergency call with its


previous logged value
This element is only shown in
detail mode.

Released

1249

54 Alarm Log Status Commands

54.35 Megaco Media Gateway Alarm Log Status


Command
Command Description
This command displays the Megaco media gateway alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log megaco-media-gw [ (index) ]

Command Parameters
Table 54.35-1 "Megaco Media Gateway Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.35-2 "Megaco Media Gateway Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name
Type
mgc-unreachable

prev-status

failover-to-esamgc

1250

Description

Parameter type: <Alarm::mgcUnreachable>


( yes
| no )
Possible values:
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
Parameter type: <Alarm::mgcUnreachable>
( yes
| no )
Possible values:
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
Parameter type: <Alarm::failovertoESAMGC>
( yes
| no )
Possible values:

Released

specifies the media gateway


controller status
This element is only shown in
detail mode.
status of specifies media gateway
with its previous logged value
This element is only shown in
detail mode.
specifies the esa mgc status
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
prev-status

3HH-04416-EBAA-TCZZA 01

Type
- yes : failover to esa mgc
- no : normal mgc is in service
Parameter type: <Alarm::failovertoESAMGC>
( yes
| no )
Possible values:
- yes : failover to esa mgc
- no : normal mgc is in service

Description
status of esa mgc
This element is only shown in
detail mode.

Released

1251

54 Alarm Log Status Commands

54.36 Megaco Signaling Gateway Alarm Log Status


Command
Command Description
This command displays the Megaco signaling gateway alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log megaco-sig-gw [ (index) ]

Command Parameters
Table 54.36-1 "Megaco Signaling Gateway Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.36-2 "Megaco Signaling Gateway Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name
Type
sgc-unreachable

prev-status

1252

Description

Parameter type: <Alarm::sgcUnreachable>


( yes
| no )
Possible values:
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable
Parameter type: <Alarm::sgcUnreachable>
( yes
| no )
Possible values:
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable

Released

specifies the signaling gateway


controller status
This element is only shown in
detail mode.
status of specifies signaling
gateway with its previous logged
value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.37 Megaco Plug Unit Alarm Log Status


Command
Command Description
This command displays the Megaco plug unit alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log megaco-plug-unit [ (index) ]

Command Parameters
Table 54.37-1 "Megaco Plug Unit Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.37-2 "Megaco Plug Unit Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name
Type
lcard-unreach-srvcard

prev-status

lcard-type-mismatch

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::lineCardUnreachSrvCard>


( yes
| no )
Possible values:
- yes : line card is unreachable with server card
- no : line card is reachable with server card
Parameter type: <Alarm::lineCardUnreachSrvCard>
( yes
| no )
Possible values:
- yes : line card is unreachable with server card
- no : line card is reachable with server card
Parameter type: <Alarm::lineCardTypeMismathch>
( yes
| no )
Possible values:

Description
specifies the line card with server
card status
This element is only shown in
detail mode.
status of line card and server card
with its previous logged value
This element is only shown in
detail mode.
specifies the line card type status
This element is only shown in
detail mode.

Released

1253

54 Alarm Log Status Commands

name
prev-status

1254

Released

Type

Description

- yes : line card type is mismatch


- no : line card type is match
Parameter type: <Alarm::lineCardTypeMismathch>
( yes
| no )
Possible values:
- yes : line card type is mismatch
- no : line card type is match

status of line card type with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.38 Megaco Termination Alarm Log Status


Command
Command Description
This command displays the Megaco termination alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log megaco-term [ (index) ]

Command Parameters
Table 54.38-1 "Megaco Termination Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.38-2 "Megaco Termination Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name
Type
meg-unknown-sub

prev-status

meg-ground-key

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::megacoUnknownSubscriber>


( yes
| no )
Possible values:
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
Parameter type: <Alarm::megacoUnknownSubscriber>
( yes
| no )
Possible values:
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
Parameter type: <Alarm::voicePortGroundKey>
( yes
| no )
Possible values:

Description
specifies the megaco subscriber
status
This element is only shown in
detail mode.
status of the megaco subscriber
with its previous logged value
This element is only shown in
detail mode.
specifies the voice port ground
key status
This element is only shown in
detail mode.

Released

1255

54 Alarm Log Status Commands

name

Type

prev-status

meg-high-temp

prev-status

l1-act-fail

prev-status

over-current

prev-status

line-showering

prev-status

low-qos-packetloss

1256

Description

- yes : voice port ground key


- no : voice port not ground key
Parameter type: <Alarm::voicePortGroundKey>
( yes
| no )
Possible values:
- yes : voice port ground key
- no : voice port not ground key
Parameter type: <Alarm::voicePortHighTemp>
( yes
| no )
Possible values:
- yes : voice port high temperature
- no : voice port not high temperature
Parameter type: <Alarm::voicePortHighTemp>
( yes
| no )
Possible values:
- yes : voice port high temperature
- no : voice port not high temperature
Parameter type: <Alarm::voicePortL1ActFail>
( yes
| no )
Possible values:
- yes : voice port l1 act failure
- no : voice port l1 act not failure
Parameter type: <Alarm::voicePortL1ActFail>
( yes
| no )
Possible values:
- yes : voice port l1 act failure
- no : voice port l1 act not failure
Parameter type: <Alarm::voicePortOverCurrent>
( yes
| no )
Possible values:
- yes : voice port over current
- no : voice port not over current
Parameter type: <Alarm::voicePortOverCurrent>
( yes
| no )
Possible values:
- yes : voice port over current
- no : voice port not over current
Parameter type: <Alarm::lineshowering>
( yes
| no )
Possible values:
- yes : line showering
- no : no line showering
Parameter type: <Alarm::lineshowering>
( yes
| no )
Possible values:
- yes : line showering
- no : no line showering
Parameter type: <Alarm::lowQosPacketLoss>

Released

status of the voice port ground


key with its previous logged
value
This element is only shown in
detail mode.
specifies
the
voice
port
temperature status
This element is only shown in
detail mode.
status of the voice port
temperature with its previous
logged value
This element is only shown in
detail mode.
specifies the voice port l1 act
status
This element is only shown in
detail mode.
status of the voice port l1 act with
its previous logged value
This element is only shown in
detail mode.
specifies the voice port over
current status
This element is only shown in
detail mode.
status of the voice port over
current with its previous logged
value
This element is only shown in
detail mode.
specifies the line showering
status
This element is only shown in
detail mode.
status of the line showering with
its previous logged value
This element is only shown in
detail mode.
specifies the megaco total packet

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

low-qos-jitter

prev-status

low-qos-delay

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : the total packet loss has exceeded the configured
threshold
- no : the total packet loss has not exceeded the configured
threshold
Parameter type: <Alarm::lowQosPacketLoss>
( yes
| no )
Possible values:
- yes : the total packet loss has exceeded the configured
threshold
- no : the total packet loss has not exceeded the configured
threshold
Parameter type: <Alarm::lowQosJitter>
( yes
| no )
Possible values:
- yes : the rtp jitter has exceeded the configured threshold
- no : the rtp jitter has not exceeded the configured threshold
Parameter type: <Alarm::lowQosJitter>
( yes
| no )
Possible values:
- yes : the rtp jitter has exceeded the configured threshold
- no : the rtp jitter has not exceeded the configured threshold
Parameter type: <Alarm::lowQosDelay>
( yes
| no )
Possible values:
- yes : the rtp delay has exceeded the configured threshold
- no : the rtp delay has not exceeded the configured
threshold
Parameter type: <Alarm::lowQosDelay>
( yes
| no )
Possible values:
- yes : the rtp delay has exceeded the configured threshold
- no : the rtp delay has not exceeded the configured
threshold

loss status
This element is only shown in
detail mode.

status of the megaco total packet


loss value
This element is only shown in
detail mode.

specifies the megaco rtp jitter


status
This element is only shown in
detail mode.
status of the megaco rtp jitter
value
This element is only shown in
detail mode.
specifies the megaco rtp delay
status
This element is only shown in
detail mode.

status of the megaco rtp delay


value
This element is only shown in
detail mode.

Released

1257

54 Alarm Log Status Commands

54.39 Megaco Signaling Lt Alarm Log Status


Command
Command Description
This command displays the Megaco signaling lt alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log megaco-sig-lt [ (index) ]

Command Parameters
Table 54.39-1 "Megaco Signaling Lt Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.39-2 "Megaco Signaling Lt Alarm Log Status Command" Display parameters
Only Show Details: current and previous alarm log status
name
Type
sig-brd-persist-loss

prev-status

sig-brd-disk-full

1258

Description

Parameter type: <Alarm::megacoSigBoardPersDataLoss>


( yes
| no )
Possible values:
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
Parameter type: <Alarm::megacoSigBoardPersDataLoss>
( yes
| no )
Possible values:
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
Parameter type: <Alarm::voiceSigBoard90PercentFull>
( yes
| no )
Possible values:

Released

specifies the voice signaling


board persistenet data status
This element is only shown in
detail mode.
status of voice signaling board
persistenet data with its previous
logged value
This element is only shown in
detail mode.
specifies the voice signaling
board disk status
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
prev-status

sig-brd-db-roolback

prev-status

mg-overload

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : specifies the voice signaling board disk 90% full


- no : specifies the voice signaling board disk no 90% full
Parameter type: <Alarm::voiceSigBoard90PercentFull>
( yes
| no )
Possible values:
- yes : specifies the voice signaling board disk 90% full
- no : specifies the voice signaling board disk no 90% full
Parameter type: <Alarm::sigBoardDBRollback>
( yes
| no )
Possible values:
- yes : specifies the voice signaling board implicit
rollback
- no : specifies the voice signaling board implicit db
rollback
Parameter type: <Alarm::sigBoardDBRollback>
( yes
| no )
Possible values:
- yes : specifies the voice signaling board implicit
rollback
- no : specifies the voice signaling board implicit db
rollback
Parameter type: <Alarm::megMGOverLoad>
( yes
| no )
Possible values:
- yes : specifies the mg overload
- no : specifies the mg no overload
Parameter type: <Alarm::megMGOverLoad>
( yes
| no )
Possible values:
- yes : specifies the mg overload
- no : specifies the mg no overload

status of voice signaling board


disk with its previous logged
value
This element is only shown in
detail mode.
specifies the voice signaling
board implicit db status
This element is only shown in
detail mode.
db
no
status of voice signaling board
implicit db with its previous
logged value
This element is only shown in
db detail mode.
no
specifies the mg overload status
This element is only shown in
detail mode.

status of the mg overload with its


previous logged value
This element is only shown in
detail mode.

Released

1259

54 Alarm Log Status Commands

54.40 Shdsl Alarm Log Status Command


Command Description
This command displays the Shdsl alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log shdsl [ (index) ]

Command Parameters
Table 54.40-1 "Shdsl Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.40-2 "Shdsl Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::ShdslLine>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValuesHigh>
identify where the alarm has
- identify where the alarm occurred
occurred
This element is only shown in
detail mode.

port

wire-pair

1260

Type

Released

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

unit

Parameter type: <Alarm::LinkDeviceValuesLow>


- identify where the alarm occurred

identify where the alarm has


occurred
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
loop-act-net

prev-status

loop-act-cus

prev-status

config-error

prev-status

loss-atm

prev-status

loss-pr

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::LoopbackActiveNetwork>


( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::LoopbackActiveNetwork>
( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::LoopbackActiveCustom>
( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::LoopbackActiveCustom>
( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::ConfigError>
( yes
| no )
Possible values:
- yes : config error
- no : no config error
Parameter type: <Alarm::ConfigError>
( yes
| no )
Possible values:
- yes : config error
- no : no config error
Parameter type: <Alarm::LossATMCellDel>
( yes
| no )
Possible values:
- yes : loss atm cell delineation
- no : no loss atm cell delineation
Parameter type: <Alarm::LossATMCellDel>
( yes
| no )
Possible values:
- yes : loss atm cell delineation
- no : no loss atm cell delineation
Parameter type: <Alarm::LossPowerSTUR>
( yes
| no )

Description
loopback active at the network
side
This element is only shown in
detail mode.
status of loop-act-net with its
previous logged value
This element is only shown in
detail mode.
loopback active at the custom
side
This element is only shown in
detail mode.
status of loop-act-cus with its
previous logged value
This element is only shown in
detail mode.
configuration error
This element is only shown in
detail mode.

status of config-error with its


previous logged value
This element is only shown in
detail mode.
loss of atm cell delineation
This element is only shown in
detail mode.

status of loss-atm with its


previous logged value
This element is only shown in
detail mode.
loss of power at stu-r
This element is only shown in
detail mode.

Released

1261

54 Alarm Log Status Commands

name

Type

prev-status

secu-error

prev-status

dev-fault

prev-status

atm-ncd

prev-status

1262

Description

Possible values:
- yes : loss power at stu-r
- no : no loss power at stu-r
Parameter type: <Alarm::LossPowerSTUR>
( yes
| no )
Possible values:
- yes : loss power at stu-r
- no : no loss power at stu-r
Parameter type: <Alarm::UnableDisableSTUR>
( yes
| no )
Possible values:
- yes : loss ability at stu-r
- no : no loss ability at stu-r
Parameter type: <Alarm::UnableDisableSTUR>
( yes
| no )
Possible values:
- yes : loss ability at stu-r
- no : no loss ability at stu-r
Parameter type: <Alarm::DeviceFault>
( yes
| no )
Possible values:
- yes : device fault
- no : no device fault
Parameter type: <Alarm::DeviceFault>
( yes
| no )
Possible values:
- yes : device fault
- no : no device fault
Parameter type: <Alarm::ATMCellDel>
( yes
| no )
Possible values:
- yes : no atm cell delineation
- no : atm cell delineation
Parameter type: <Alarm::ATMCellDel>
( yes
| no )
Possible values:
- yes : no atm cell delineation
- no : atm cell delineation

Released

status of loss-pr with its previous


logged value
This element is only shown in
detail mode.
loss of ability to disable stu-r
access
This element is only shown in
detail mode.
status of secu-error with its
previous logged value
This element is only shown in
detail mode.
fault of device
This element is only shown in
detail mode.

status of dev-fault with its


previous logged value
This element is only shown in
detail mode.
none of atm cell delineation
This element is only shown in
detail mode.

status of atm-ncd with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.41 Shdsl Alarm Log Status Command


Command Description
This command displays the Shdsl alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log shdsl-isam [ (index) ]

Command Parameters
Table 54.41-1 "Shdsl Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.41-2 "Shdsl Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

port

unit

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::ShdslLine>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValues>
identify where the alarm has
- a signed integer
occurred
This element is only shown in
detail mode.

Released

1263

54 Alarm Log Status Commands

Only Show Details: current and previous alarm log status


name
Type
loss-syn-net

prev-status

loss-syn-cus

prev-status

loop-att-net

prev-status

loop-att-cus

prev-status

snr-net

prev-status

1264

Description

Parameter type: <Alarm::LossSyncWordNetwork>


( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LossSyncWordNetwork>
( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LossSyncWordCustom>
( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LossSyncWordCustom>
( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LoopAttenuationNetwork>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::LoopAttenuationNetwork>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::LoopAttenuationCustom>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::LoopAttenuationCustom>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::SNRNetwork>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::SNRNetwork>
( yes

Released

loss of sync word at the network


side on each pair
This element is only shown in
detail mode.
status of loss-syn-net with its
previous logged value
This element is only shown in
detail mode.
loss of sync word at the custom
side on each pair
This element is only shown in
detail mode.
status of loss-syn-cus with its
previous logged value
This element is only shown in
detail mode.
loop attenuation alarm at the
network side on each pair
This element is only shown in
detail mode.
status of loop-att-net with its
previous logged value
This element is only shown in
detail mode.
loop attenuation alarm at the
custom side on each pair
This element is only shown in
detail mode.
status of loop-att-cus with its
previous logged value
This element is only shown in
detail mode.
snr margin alarm at the network
side each pair
This element is only shown in
detail mode.
status of snr-net with its previous
logged value

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

snr-cus

prev-status

dc-net

prev-status

dc-cus

prev-status

act-fail-cus

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::SNRCustom>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::SNRCustom>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::DCContinuityFaultNetwork>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::DCContinuityFaultNetwork>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::DCContinuityFaultCustom>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::DCContinuityFaultCustom>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::ActivationFailureCustom>
( yes
| no )
Possible values:
- yes : activation failure
- no : no activation failure
Parameter type: <Alarm::ActivationFailureCustom>
( yes
| no )
Possible values:
- yes : activation failure
- no : no activation failure

This element is only shown in


detail mode.
snr margin alarm at the custom
side each pair
This element is only shown in
detail mode.
status of snr-cus with its previous
logged value
This element is only shown in
detail mode.
dc continuity fault at the network
side on each pair
This element is only shown in
detail mode.
status of dc-net with its previous
logged value
This element is only shown in
detail mode.
dc continuity fault at the custom
side on each pair
This element is only shown in
detail mode.
status of dc-cus with its previous
logged value
This element is only shown in
detail mode.
activation failure at the custom
side on each pair
This element is only shown in
detail mode.
status of act-fail-cus with its
previous logged value
This element is only shown in
detail mode.

Released

1265

54 Alarm Log Status Commands

54.42 Ima-Group Alarm Log Status Command


Command Description
This command displays the Ima-Group alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ima-group [ (index) ]

Command Parameters
Table 54.42-1 "Ima-Group Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.42-2 "Ima-Group Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Equipm::AtmImaIndex>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
far-end-start

1266

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::FarEndStartup>


( yes

Released

Description
far-end starting up
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

far-end-fconf

prev-status

near-end-fconf

prev-status

far-end-ins-lnk

prev-status

near-end-ins-lnk

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : far-end startup
- no : no far-end startup
Parameter type: <Alarm::FarEndStartup>
( yes
| no )
Possible values:
- yes : far-end startup
- no : no far-end startup
Parameter type: <Alarm::FarEndFailedConfig>
( yes
| no )
Possible values:
- yes : far-end failed config
- no : no far-end failed config
Parameter type: <Alarm::FarEndFailedConfig>
( yes
| no )
Possible values:
- yes : far-end failed config
- no : no far-end failed config
Parameter type: <Alarm::NearEndFailedConfig>
( yes
| no )
Possible values:
- yes : near-end failed config
- no : no near-end failed config
Parameter type: <Alarm::NearEndFailedConfig>
( yes
| no )
Possible values:
- yes : near-end failed config
- no : no near-end failed config
Parameter type: <Alarm::FarEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at far-end
- no : no insufficient number of links at far-end
Parameter type: <Alarm::FarEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at far-end
- no : no insufficient number of links at far-end
Parameter type: <Alarm::NearEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at near-end
- no : no insufficient number of links at near-end
Parameter type: <Alarm::NearEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at near-end

detail mode.

status of far-end-start with its


previous logged value
This element is only shown in
detail mode.
failed configuration of far-end
This element is only shown in
detail mode.

status of far-end-fconf with its


previous logged value
This element is only shown in
detail mode.
failed configuration of near-end
This element is only shown in
detail mode.

status of near-end-fconf with its


previous logged value
This element is only shown in
detail mode.
insufficient number of links at
far-end
This element is only shown in
detail mode.
status of far-end-ins-lnk with its
previous logged value
This element is only shown in
detail mode.
insufficient number of links at
near-end
This element is only shown in
detail mode.
status of near-end-ins-lnk with its
previous logged value
This element is only shown in
detail mode.

Released

1267

54 Alarm Log Status Commands

name

Type

far-end-blk

prev-status

1268

Description

- no : no insufficient number of links at near-end


Parameter type: <Alarm::FarEndBlocked>
( yes
| no )
Possible values:
- yes : far-end blocked
- no : no far-end blocked
Parameter type: <Alarm::FarEndBlocked>
( yes
| no )
Possible values:
- yes : far-end blocked
- no : no far-end blocked

Released

status that far-end is blocked


This element is only shown in
detail mode.

status of far-end-blk with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.43 Ima-Link Alarm Log Status Command


Command Description
This command displays the Ima-Link alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ima-link [ (index) ]

Command Parameters
Table 54.43-1 "Ima-Link Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.43-2 "Ima-Link Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

port

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::ShdslLine>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Only Show Details: current and previous alarm log status


name
Type
loss-ima-frm

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::LossImaFrame>


( yes

Description
loss of ima frame
This element is only shown in

Released

1269

54 Alarm Log Status Commands

name

prev-status

lods

prev-status

link-misc

prev-status

link-rfi

prev-status

link-fault

prev-status

1270

Released

Type

Description

| no )
Possible values:
- yes : loss ima frame
- no : no loss ima frame
Parameter type: <Alarm::LossImaFrame>
( yes
| no )
Possible values:
- yes : loss ima frame
- no : no loss ima frame
Parameter type: <Alarm::LinkOutofDelaySynch>
( yes
| no )
Possible values:
- yes : link out of delay
- no : no link out of delay
Parameter type: <Alarm::LinkOutofDelaySynch>
( yes
| no )
Possible values:
- yes : link out of delay
- no : no link out of delay
Parameter type: <Alarm::LinkMisconnect>
( yes
| no )
Possible values:
- yes : link misconnect
- no : no link misconnect
Parameter type: <Alarm::LinkMisconnect>
( yes
| no )
Possible values:
- yes : link misconnect
- no : no link misconnect
Parameter type: <Alarm::LinkRemoteFailureIndication>
( yes
| no )
Possible values:
- yes : link remote failure indication
- no : no link remote failure indication
Parameter type: <Alarm::LinkRemoteFailureIndication>
( yes
| no )
Possible values:
- yes : link remote failure indication
- no : no link remote failure indication
Parameter type: <Alarm::LinkFault>
( yes
| no )
Possible values:
- yes : fault in link facility
- no : no fault in link facility
Parameter type: <Alarm::LinkFault>
( yes
| no )
Possible values:
- yes : fault in link facility

detail mode.

status of loss-ima-frm with its


previous logged value
This element is only shown in
detail mode.
link out of delay synchronization
This element is only shown in
detail mode.

status of lods with its previous


logged value
This element is only shown in
detail mode.
link of misconnecting
This element is only shown in
detail mode.

status of link-misc with its


previous logged value
This element is only shown in
detail mode.
link of remote failure indication
This element is only shown in
detail mode.

status of link-rfi with its previous


logged value
This element is only shown in
detail mode.
fault of link
This element is only shown in
detail mode.

status of link-fault with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
fe-tx-blk

prev-status

fe-rec-blk

prev-status

3HH-04416-EBAA-TCZZA 01

Type
- no : no fault in link facility
Parameter type: <Alarm::FarEndTXBlocked>
( yes
| no )
Possible values:
- yes : transmit blocked due to far-end
- no : no transmit blocked due to far-end
Parameter type: <Alarm::FarEndTXBlocked>
( yes
| no )
Possible values:
- yes : transmit blocked due to far-end
- no : no transmit blocked due to far-end
Parameter type: <Alarm::FarEndRXBlocked>
( yes
| no )
Possible values:
- yes : receive blocked due to far-end
- no : no receive blocked due to far-end
Parameter type: <Alarm::FarEndRXBlocked>
( yes
| no )
Possible values:
- yes : receive blocked due to far-end
- no : no receive blocked due to far-end

Description
transmit blocked due to far-end
This element is only shown in
detail mode.

status of fe-tx-blk with its


previous logged value
This element is only shown in
detail mode.
receive blocked due to far-end
This element is only shown in
detail mode.

status of fe-rec-blk with its


previous logged value
This element is only shown in
detail mode.

Released

1271

54 Alarm Log Status Commands

54.44 Ether-Tca Alarm Log Status Command


Command Description
This command displays the Ether-Tca alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ether-tca [ (index) ]

Command Parameters
Table 54.44-1 "Ether-Tca Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.44-2 "Ether-Tca Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::EthernetPortIndex>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
etca-los

1272

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::EthTcaLos>


( yes

Released

Description
ethernet loss of signal
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

etca-fcs

prev-status

etca-rx-octets

prev-status

etca-tx-octets

prev-status

etca-day-los

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
Parameter type: <Alarm::EthTcaLos>
( yes
| no )
Possible values:
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
Parameter type: <Alarm::EthTcaFcs>
( yes
| no )
Possible values:
- yes : ethernet frame check sequence errors exceeds
- no : ethernet frame check sequence errors normal
Parameter type: <Alarm::EthTcaFcs>
( yes
| no )
Possible values:
- yes : ethernet frame check sequence errors exceeds
- no : ethernet frame check sequence errors normal
Parameter type: <Alarm::EthTcaRxb>
( yes
| no )
Possible values:
- yes : received octets exceeds
- no : received octets normal
Parameter type: <Alarm::EthTcaRxb>
( yes
| no )
Possible values:
- yes : received octets exceeds
- no : received octets normal
Parameter type: <Alarm::EthTcaTxb>
( yes
| no )
Possible values:
- yes : transmitted octets exceeds
- no : transmitted octets normal
Parameter type: <Alarm::EthTcaTxb>
( yes
| no )
Possible values:
- yes : transmitted octets exceeds
- no : transmitted octets normal
Parameter type: <Alarm::EthDayLos>
( yes
| no )
Possible values:
- yes : ethernet day los errors exceeds
- no : ethernet day los errors normal
Parameter type: <Alarm::EthDayLos>
( yes
| no )
Possible values:
- yes : ethernet day los errors exceeds

detail mode.

status of etca-los with its


previous logged value
This element is only shown in
detail mode.
ethernet frame check sequence
This element is only shown in
detail mode.

status of etca-fcs with its


previous logged value
This element is only shown in
detail mode.
received octets
This element is only shown in
detail mode.

status of etca-rx-octets with its


previous logged value
This element is only shown in
detail mode.
transmitted octets
This element is only shown in
detail mode.

status of etca-tx-octets with its


previous logged value
This element is only shown in
detail mode.
ethernet day los
This element is only shown in
detail mode.

status of etca-day-los with its


previous logged value
This element is only shown in
detail mode.

Released

1273

54 Alarm Log Status Commands

name

Type
- no : ethernet day los errors normal
Parameter type: <Alarm::EthDayFcs>
( yes
| no )
Possible values:
- yes : ethernet day fcs errors exceeds
- no : ethernet day fcs errors normal
Parameter type: <Alarm::EthDayFcs>
( yes
| no )
Possible values:
- yes : ethernet day fcs errors exceeds
- no : ethernet day fcs errors normal
Parameter type: <Alarm::EthDayRxb>
( yes
| no )
Possible values:
- yes : received octets day exceeds
- no : received octets day normal
Parameter type: <Alarm::EthDayRxb>
( yes
| no )
Possible values:
- yes : received octets day exceeds
- no : received octets day normal
Parameter type: <Alarm::EthDayTxb>
( yes
| no )
Possible values:
- yes : transmitted octets day exceeds
- no : transmitted octets day normal
Parameter type: <Alarm::EthDayTxb>
( yes
| no )
Possible values:
- yes : transmitted octets day exceeds
- no : transmitted octets day normal

etca-day-fcs

prev-status

etca-day-rx-octets

prev-status

etca-day-tx-octets

prev-status

1274

Released

Description
ethernet day fcs
This element is only shown in
detail mode.

status of etca-day-fcs with its


previous logged value
This element is only shown in
detail mode.
received octets
This element is only shown in
detail mode.

status of etca-day-rx-octets with


its previous logged value
This element is only shown in
detail mode.
transmitted octets
This element is only shown in
detail mode.

status of etca-day-tx-octets with


its previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.45 Ether-Sfp Alarm Log Status Command


Command Description
This command displays the Ether-Sfp alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ether-sfp [ (index) ]

Command Parameters
Table 54.45-1 "Ether-Sfp Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.45-2 "Ether-Sfp Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

port

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::EthernetPortIndex>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Only Show Details: current and previous alarm log status


name
Type
sfp-los

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::EthSfpLos>


( yes

Description
ethernet sfp loss of signal
This element is only shown in

Released

1275

54 Alarm Log Status Commands

name

prev-status

sfp-tx-fail

prev-status

sfp-not-prst

prev-status

sfp-inv-id

prev-status

user-sfp-t-exceed

prev-status

1276

Released

Type

Description

| no )
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
Parameter type: <Alarm::EthSfpLos>
( yes
| no )
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
Parameter type: <Alarm::EthSfpTxFail>
( yes
| no )
Possible values:
- yes : ethernet sfp Tx Failure
- no : ethernet sfp Tx normal
Parameter type: <Alarm::EthSfpTxFail>
( yes
| no )
Possible values:
- yes : ethernet sfp Tx Failure
- no : ethernet sfp Tx normal
Parameter type: <Alarm::EthSfpNotPrst>
( yes
| no )
Possible values:
- yes : ethernet sfp not detected
- no : ethernet sfp detected
Parameter type: <Alarm::EthSfpNotPrst>
( yes
| no )
Possible values:
- yes : ethernet sfp not detected
- no : ethernet sfp detected
Parameter type: <Alarm::EthSfpInvalid>
( yes
| no )
Possible values:
- yes : ethernet sfp id invalid
- no : ethernet sfp id normal
Parameter type: <Alarm::EthSfpInvalid>
( yes
| no )
Possible values:
- yes : ethernet sfp id invalid
- no : ethernet sfp id normal
Parameter type: <Alarm::EthSfpTempExceed>
( yes
| no )
Possible values:
- yes : ethernet sfp temperature exceed
- no : ethernet sfp temperature normal
Parameter type: <Alarm::EthSfpTempExceed>
( yes
| no )
Possible values:
- yes : ethernet sfp temperature exceed

detail mode.

status of sfp-los with its previous


logged value
This element is only shown in
detail mode.
ethernet sfp tx
This element is only shown in
detail mode.

status of sfp-tx-fail with its


previous logged value
This element is only shown in
detail mode.
ethernet sfp presence
This element is only shown in
detail mode.

status of sfp-not-prst with its


previous logged value
This element is only shown in
detail mode.
ethernet sfp id validity
This element is only shown in
detail mode.

status of sfp-inv-id with its


previous logged value
This element is only shown in
detail mode.
ethernet sfp temperature
This element is only shown in
detail mode.

status of user-sfp-t-exceed with


its previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name
user-sfp-mismatch

prev-status

3HH-04416-EBAA-TCZZA 01

Type
- no : ethernet sfp temperature normal
Parameter type: <Alarm::EthSfpMismatch>
( yes
| no )
Possible values:
- yes : ethernet sfp mismatch the configured type
- no : ethernet sfp match the configured type
Parameter type: <Alarm::EthSfpMismatch>
( yes
| no )
Possible values:
- yes : ethernet sfp mismatch the configured type
- no : ethernet sfp match the configured type

Description
ethernet sfp type
This element is only shown in
detail mode.

status of user-sfp-mismatch with


its previous logged value
This element is only shown in
detail mode.

Released

1277

54 Alarm Log Status Commands

54.46 Alarm Qos Slot Log Status Commands


Command Description
This command displays the Qos Slot alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log qos-slot [ (index) ]

Command Parameters
Table 54.46-1 "Alarm Qos Slot Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.46-2 "Alarm Qos Slot Log Status Commands" Display parameters
Specific Information
name
last-updated-on
board-position

1278

Released

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Equipm::EqptSlotIndex>
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

network time in seconds when


the alarm was logged.
This element is always shown.
identify where the alarm has
occurred.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

- ext-b : nt-b slot in an extension shelf


- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

Only Show Details: current and previous alarm log status


name
Type
up-overflow

prev-status

dw-overflow

prev-status

upobc-overflow

prev-status

dwobc-overflow

prev-status

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::up-overflow>


( yes
| no )
Possible values:
- yes : up overflow alarm
- no : no up overflow alarm
Parameter type: <Alarm::up-overflow>
( yes
| no )
Possible values:
- yes : up overflow alarm
- no : no up overflow alarm
Parameter type: <Alarm::dw-overflow>
( yes
| no )
Possible values:
- yes : down overflow alarm
- no : no down overflow alarm
Parameter type: <Alarm::dw-overflow>
( yes
| no )
Possible values:
- yes : down overflow alarm
- no : no down overflow alarm
Parameter type: <Alarm::upobc-overflow>
( yes
| no )
Possible values:
- yes : up to obc overflow alarm
- no : no up to obc overflow alarm
Parameter type: <Alarm::upobc-overflow>
( yes
| no )
Possible values:
- yes : up to obc overflow alarm
- no : no up to obc overflow alarm
Parameter type: <Alarm::dwobc-overflow>
( yes
| no )
Possible values:
- yes : down to obc overflow alarm
- no : no down to obc overflow alarm
Parameter type: <Alarm::dwobc-overflow>
( yes

Description
check LT load in upstream.
This element is only shown in
detail mode.

status of specifies up overflow


with its previous logged value
This element is only shown in
detail mode.
check LT load in downstream.
This element is only shown in
detail mode.

status of specifies down overflow


with its previous logged value
This element is only shown in
detail mode.
check LT load to OBC in
upstream.
This element is only shown in
detail mode.
status of specifies up to obc
overflow with its previous logged
value
This element is only shown in
detail mode.
check LT load to OBC in
downstream.
This element is only shown in
detail mode.
status of specifies down to obc
overflow with its previous logged

Released

1279

54 Alarm Log Status Commands

name

lwpriority-overflow

prev-status

fanout

prev-status

1280

Released

Type

Description

| no )
Possible values:
- yes : down to obc overflow alarm
- no : no down to obc overflow alarm
Parameter type: <Alarm::lwpriority-overflow>
( yes
| no )
Possible values:
- yes : alarm
- no : no dying gasp alarm
Parameter type: <Alarm::lwpriority-overflow>
( yes
| no )
Possible values:
- yes : alarm
- no : no dying gasp alarm
Parameter type: <Alarm::fanout>
( yes
| no )
Possible values:
- yes : fan out alarm
- no : no fan out alarm
Parameter type: <Alarm::fanout>
( yes
| no )
Possible values:
- yes : fan out alarm
- no : no fan out alarm

value
This element is only shown in
detail mode.
check Voice and Video load.
This element is only shown in
detail mode.

status of specifies voice and


video load with its previous
logged value
This element is only shown in
detail mode.
check LT Load.
This element is only shown in
detail mode.

status of fan out with its previous


logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.47 Alarm Qos Queue Log Status Commands


Command Description
This command displays the Qos Queue alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log qos-queue [ (index) ]

Command Parameters
Table 54.47-1 "Alarm Qos Queue Log Status Commands" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.47-2 "Alarm Qos Queue Log Status Commands" Display parameters
Specific Information
name
last-updated-on
port

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Itf::PhyLine>
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number

network time in seconds when


the alarm was logged.
This element is always shown.
identifies the physical position of
/ the port
This element is always shown.
/
/
/
/
/

Released

1281

54 Alarm Log Status Commands

name

queue

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Qos::AlarmQueues>
- identify where the alarm has occurred
- range: [0...7]

identify where the alarm has


occurred.
This element is always shown.

Only Show Details: current and previous alarm log status


name
Type
queue-discard-overflow

prev-status

queue-load

prev-status

1282

Released

Description

Parameter type: <Alarm::queue-discard-overflow>


( yes
| no )
Possible values:
- yes : queue discard alarm
- no : no queue discard alarm
Parameter type: <Alarm::queue-discard-overflow>
( yes
| no )
Possible values:
- yes : queue discard alarm
- no : no queue discard alarm
Parameter type: <Alarm::queue-load>
( yes
| no )
Possible values:
- yes : queue load alarm
- no : no queue load alarm
Parameter type: <Alarm::queue-load>
( yes
| no )
Possible values:
- yes : queue load alarm
- no : no queue load alarm

check the corresponding queue


Load.
This element is only shown in
detail mode.
status of specifies queue discard
overflow with its previous logged
value
This element is only shown in
detail mode.
check the corresponding queue
Load.
This element is only shown in
detail mode.
status of queue load with its
previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.48 Log File Transfer Server Alarm Log Status


Command
Command Description
This command displays the log status of the file transfer server alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log filetransfer [ (index) ]

Command Parameters
Table 54.48-1 "Log File Transfer Server Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.48-2 "Log File Transfer Server Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

server-id

fileserv-unavail

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Alarm::FileTransfer>
this is the server id for file server
- next hop IP address
alarms
This element is only shown in
detail mode.
Parameter type: <Alarm::FileTransferUnavial>
current status specifing that
( unavailable
whether file transfer server
| available )
available
Possible values:
This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available
Parameter type: <Alarm::relayNotSet>
status of relay with its previous

Released

1283

54 Alarm Log Status Commands

name

1284

Released

Type

Description

( yes
| no )
Possible values:
- yes : wrong appliq
- no : right appliq

logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.49 Log Lsm Redundancy Alarm Log Status


Command
Command Description
This command displays the log status of the Lsm Redundancy alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log lsmredundancy [ (index) ]

Command Parameters
Table 54.49-1 "Log Lsm Redundancy Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.49-2 "Log Lsm Redundancy Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

board-station

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::SwoCap>
( loss
| not-loss )

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
this is the physical number of the
slot for lsm redundancy alarms
This element is only shown in
detail mode.

loss-lsmswp-cap

3HH-04416-EBAA-TCZZA 01

current status specifing the


switchover capability in a
redundant system

Released

1285

54 Alarm Log Status Commands

name

prev-status

inv-xvps-pair-data

prev-status

1286

Released

Type

Description

Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::SwoCap>
( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::DataXvps>
( invalid
| valid )
Possible values:
- invalid : data of xvps pair is not the same
- valid : data of xvps pair is same
Parameter type: <Alarm::DataXvps>
( invalid
| valid )
Possible values:
- invalid : data of xvps pair is not the same
- valid : data of xvps pair is same

This element is only shown in


detail mode.
prev
status
specifing
the
switchover capability in a
redundant system
This element is only shown in
detail mode.
log status of the data of xvps pair
This element is only shown in
detail mode.

prev status of the data of xvps


pair
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.50 Log L2 Forward Alarm Log Status Command


Command Description
This command displays the log status of the l2 forward alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log l2forward [ (index) ]

Command Parameters
Table 54.50-1 "Log L2 Forward Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.50-2 "Log L2 Forward Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

bridgeport

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Vlan::BridgePort>
identify the bridge port where the
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
This element is only shown in
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / detail mode.
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>

Released

1287

54 Alarm Log Status Commands

name

Type

vlan-id

mac-conflict

prev-status

vmac-full

1288

Description

- the rack number


Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlanSigned>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Alarm::MACconflict>
( yes
| no )
Possible values:
- yes : duplicate mac address from this bridge port
- no : no duplicate mac address from this bridge port
Parameter type: <Alarm::MACconflict>
( yes
| no )
Possible values:
- yes : duplicate mac address from this bridge port
- no : no duplicate mac address from this bridge port
Parameter type: <Alarm::VMACFull>
( yes
| no )
Possible values:
- yes : virtual mac entry full on this bridge port
- no : no virtual mac entry full on this bridge port

Released

identify the vlan id where the


alarm has occurred.
This element is only shown in
detail mode.

specifies whether duplicate mac


address from the Bridge port.
This element is only shown in
detail mode.
status of mac-conflict with its
previous logged value.
This element is only shown in
detail mode.
specifies whether virtual mac is
full on the bridge port.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

Type

Description

prev-status

Parameter type: <Alarm::VMACFull>


( yes
| no )
Possible values:
- yes : virtual mac entry full on this bridge port
- no : no virtual mac entry full on this bridge port

status of vmac-full with its


previous logged value.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1289

54 Alarm Log Status Commands

54.51 External Device Alarm Log Status Command


Command Description
This command displays the external-device alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log external-device [ (index) ]

Command Parameters
Table 54.51-1 "External Device Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.51-2 "External Device Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

loss-env-mon

Parameter type: <Alarm::LossEnvMon>


( lost
| not-lost )
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists
Parameter type: <Alarm::LossEnvMon>
( lost
| not-lost )
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
status of env-monitor box
This element is only shown in
detail mode.

prev-status

1290

Released

status of loss-env-mon with its


previous logged value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.52 LT CFM Alarm Log Status Command


Command Description
This command displays lt cfm alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log cfm [ (index) ]

Command Parameters
Table 54.52-1 "LT CFM Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.52-2 "LT CFM Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

last-updated-on

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

cfm-mep-id

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

cfm-unique-id

Parameter type: <Alarm::IdentificationIdxOrZero>


- a signed integer

additional-info

Parameter type: <PrintableString>


- printable string

network time in seconds when


the alarm was logged
This element is only shown in
detail mode.
dot1agCfmMepIdentifier index
where the alarm has occurred.
This element is only shown in
detail mode.
unique identification for the
alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
Additional information regarding
the cfm alarm
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status

3HH-04416-EBAA-TCZZA 01

Released

1291

54 Alarm Log Status Commands

name

Type

Description

cfm-defrdiccm

Parameter type: <Alarm::IacmCfmRdiCcm>


( yes
| no )
Possible values:
- yes : rdi bit in ccm received
- no : no rdi bit in ccm received
Parameter type: <Alarm::IacmCfmMacError>
( yes
| no )
Possible values:
- yes : mac error status
- no : no mac error status
Parameter type: <Alarm::IacmCfmMepCcm>
( yes
| no )
Possible values:
- yes : missing ccm from mep
- no : no missing ccm from mep
Parameter type: <Alarm::IacmCfmInvalidCcm>
( yes
| no )
Possible values:
- yes : invalid ccm received
- no : no invalid ccm received
Parameter type: <Alarm::IacmCfmUnexpectedCcm>
( yes
| no )
Possible values:
- yes : unexpected ccm received
- no : no unexpected ccm received

specifies rdi bit in ccm received


This element is only shown in
detail mode.

cfm-defmacstatus

cfm-defremoteccm

cfm-deferrorccm

cfm-defxconccm

1292

Released

ccm mac error status


This element is only shown in
detail mode.

specifies missing ccm from mep


This element is only shown in
detail mode.

specifies invalid ccm received


This element is only shown in
detail mode.

specifies
unexpected
ccm
received
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

54.53 Sync Clock Alarm Log Status Command


Command Description
This command displays the synce and bits alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sync [ (index) ]

Command Parameters
Table 54.53-1 "Sync Clock Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.53-2 "Sync Clock Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged
This element is only shown in
detail mode.

Only Show Details: slot information


name
Type
slot

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Alarm::SynceSlot>


( ntio-1
| ntio-2
| nt-a
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot

identifies the synce port where


the alarm has occurred.
This element is only shown in
detail mode.

Released

1293

54 Alarm Log Status Commands

name

Type

Description

- nt : nt slot for bits


- nt : active nt slot
- not-used : no interface
Parameter type: <Alarm::SyncePort>
( sfp : <Alarm::SynceClk>
| xfp : <Alarm::SynceClk>
| bits-a
| bits-b
| ieee1588-a
| not-used
| ieee1588-b )
Possible values:
- sfp : synce reference on sfp port
- xfp : synce reference on xfp port
- bits-a : bits clock source on nt-a
- bits-b : bits clock source on nt-b
- ieee1588-a : ieee1588 clock source on nt-a
- ieee1588-b : ieee1588 clock source on nt-b
- not-used : not-used
Field type <Alarm::SynceClk>
- value
- range: [0...16]

port

identifies the synce port where


the alarm has occurred.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
bits-fail

prev-status

synce-fail

prev-status

bits-output-shutoff

prev-status

1294

Description

Parameter type: <Alarm::BitsFail>


( yes
| no )
Possible values:
- yes : bits source failed
- no : no bits source failed
Parameter type: <Alarm::BitsFail>
( yes
| no )
Possible values:
- yes : bits source failed
- no : no bits source failed
Parameter type: <Alarm::SynceFail>
( yes
| no )
Possible values:
- yes : synce source failed
- no : no synce source failed
Parameter type: <Alarm::SynceFail>
( yes
| no )
Possible values:
- yes : synce source failed
- no : no synce source failed
Parameter type: <Alarm::BitsOutputShutoffFail>
( yes
| no )
Possible values:
- yes : bits output shutoff
- no : no bits output shutoff
Parameter type: <Alarm::BitsOutputShutoffFail>
( yes
| no )

Released

specifies whether bits clock


source has failed or not
This element is only shown in
detail mode.
status of bits failure alarm with
its previous logged value.
This element is only shown in
detail mode.
specifies whether synce clock
source has failed or not
This element is only shown in
detail mode.
status of synce failure with its
previous logged value.
This element is only shown in
detail mode.
specifies whether bits output
failed or not
This element is only shown in
detail mode.
status of bits output shutoff alarm
with its previous logged value.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- yes : bits output shutoff
- no : no bits output shutoff

detail mode.

Released

1295

54 Alarm Log Status Commands

54.54 EFM-OAM Alarm Log Status Command


Command Description
This command displays the EFM-OAM alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log efm-oam [ (index) ]

Command Parameters
Table 54.54-1 "EFM-OAM Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.54-2 "EFM-OAM Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::EfmEthernetIndex>
identifies the physical xdsl line
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId>
detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

line

Only Show Details: current and previous alarm log status


name
Type
link-fault

1296

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::linkFaultType>


( yes

Released

Description
specifies whether link fault is
present or not.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-link-fault

dying-gasp

prev-dying-gasp

critical-event

prev-critical-event

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : link fault at cpe/onu
- no : link fault is not exist
Parameter type: <Alarm::linkFaultType>
( yes
| no )
Possible values:
- yes : link fault at cpe/onu
- no : link fault is not exist
Parameter type: <Alarm::dyingGaspType>
( yes
| no )
Possible values:
- yes : dying gasp is exist
- no : dying gasp is not exist
Parameter type: <Alarm::dyingGaspType>
( yes
| no )
Possible values:
- yes : dying gasp is exist
- no : dying gasp is not exist
Parameter type: <Alarm::criticalEventType>
( yes
| no )
Possible values:
- yes : critical event is exist
- no : critical event is not exist
Parameter type: <Alarm::criticalEventType>
( yes
| no )
Possible values:
- yes : critical event is exist
- no : critical event is not exist

This element is only shown in


detail mode.
status of link-fault with its
previous logged value.
This element is only shown in
detail mode.
specifies whether dying gasp
indication is received from cpe or
not.
This element is only shown in
detail mode.
status of dying-gasp with its
previous logged value.
This element is only shown in
detail mode.
specifies whether critical event is
received from cpe or not.
This element is only shown in
detail mode.
status of critical-event with its
previous logged value.
This element is only shown in
detail mode.

Released

1297

54 Alarm Log Status Commands

54.55 Alarm Table Alarm Log Status Command


Command Description
This command displays the alarm-table alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log alarm-table [ (index) ]

Command Parameters
Table 54.55-1 "Alarm Table Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.55-2 "Alarm Table Alarm Log Status Command" Display parameters
Specific Information
name
last-updated-on

Type

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.

Only Show Details: current and previous alarm log status


name
Type
alrm-tbl-overflow

Parameter type: <Alarm::AlrmTblOflow>


( overflow
| no-overflow )
Possible values:
- overflow : alarm table overflow
- no-overflow : no alarm table overflow
Parameter type: <Alarm::AlrmTblOflow>
( overflow
| no-overflow )
Possible values:
- overflow : alarm table overflow
- no-overflow : no alarm table overflow

prev-status

1298

Released

Description
identify if the alarm table has
overflowed
This element is only shown in
detail mode.
previously logged value of the
alarm table overflow alarm
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1299

54 Alarm Log Status Commands

54.56 Auto-Switch Alarm Log Status command


Command Description
This command displays log table of autoswitch alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log auto-switch [ (index) ]

Command Parameters
Table 54.56-1 "Auto-Switch Alarm Log Status command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 54.56-2 "Auto-Switch Alarm Log Status command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::XdslLine>
identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Only Show Details: current and previous alarm log status


name
Type
auto-switch-status

1300

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::autoSwitchStatus>


( yes

Released

Description
show auto-switch alarm status.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

54 Alarm Log Status Commands

name

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : auto-switch alarm status
- no : auto-switch alarm status clear
Parameter type: <Alarm::autoSwitchStatus>
( yes
| no )
Possible values:
- yes : auto-switch alarm status
- no : auto-switch alarm status clear

detail mode.

status of auto-switch with its


previous logged value.
This element is only shown in
detail mode.

Released

1301

55- Current Alarm Status Commands

55.1 Current Alarm Status Command Tree


55.2 Alarm Current Status Command
55.3 Equipment Current Alarm Status Command
55.4 Equipment Holder Current Alarm Status Command
55.5 Equipment Holder Extended Current Alarm Status
Command
55.6 Plug-in Unit Current Alarm Status Command
55.7 ATM Current Alarm Status Command
55.8 Ethernet Interface Current Alarm Status Command
55.9 Software Management Current Alarm Status
Command
55.10 Temporal Filter Current Alarm Status Command
55.11 Spatial Filter Current Alarm Status Command
55.12 xDSL Current Alarm Status Command
55.13 TCA xDSL Current Alarm Status Command
55.14 Vectoring Line Current Alarm Status Command
55.15 Vectoring Board Current Alarm Status Command
55.16 Electrical-to-Optical Conversion Current Alarm
Status Command
55.17 Authentication Current Alarm Status Command
55.18 xDSL Bonding Current Alarm Status Command
55.19 Redundancy Current Alarm Status Command
55.20 Custom Current Alarm Status Command
55.21 SFP Current Alarm Status Command
55.22 Custom External Current Alarm Status Command
55.23 SFP RSSI Current Alarm Status Command
55.24 PPP Cross-Connect Engine TCA Current Alarm
Status Command
55.25 2xE1/DS1 SFP Clock Current Alarm Status
Command
55.26 2xE1/DS1 SFP Framer Alarm Status Command
55.27 Plug In Unit Extended Current Alarm Status
Command
55.28 SIP Server Current Alarm Status Command
55.29 SIP VSP Current Alarm Status Command
55.30 SIP Dial Plan Current Alarm Status Command
55.31 SIP Slot Current Alarm Status Command
55.32 SIP Termination Current Alarm Status Command
55.33 Megaco Media Gateway Current Alarm Status
Command
55.34 Megaco Signaling Gateway Current Alarm Status
Command
55.35 Megaco Plugin Unit Current Alarm Status Command
55.36 Megaco Termination Current Alarm Status
Command
55.37 Megaco Signaling Lt Current Alarm Status
Command
55.38 Shdsl Current Alarm Status Command
55.39 Shdsl Current Alarm Status Command
55.40 Ima-Group Current Alarm Status Command

1302

Released

55-1304
55-1307
55-1311
55-1313
55-1315
55-1318
55-1321
55-1323
55-1324
55-1326
55-1330
55-1334
55-1338
55-1342
55-1344
55-1346
55-1348
55-1349
55-1352
55-1353
55-1356
55-1360
55-1362
55-1366
55-1368
55-1371
55-1375
55-1378
55-1379
55-1381
55-1382
55-1384
55-1387
55-1389
55-1390
55-1392
55-1394
55-1396
55-1398
55-1400

3HH-04416-EBAA-TCZZA

01

55.41 Ima-Link Current Alarm Status Command


55.42 Alarm Current Ether-Tca Status Command
55.43 Alarm Current Ether-Sfp Status Command
55.44 Alarm Current Qos Slot Status Command
55.45 Alarm Current Qos Queue Status Command
55.46 Alarm File Transfer Server Status Command
55.47 Alarm LSM Redundancy Status Command
55.48 Alarm L2 Forward Status Command
55.49 Alarm Current External Device Status Command
55.50 Sync Clock Current Alarm Status Command
55.51 LT Cfm Current Alarm Status Command
55.52 EFM-OAM Current Alarm Status Command
55.53 Alarm Table Current Alarm Status Command
55.54 Auto-Switch Current Alarm Status Command

3HH-04416-EBAA-TCZZA 01

55-1402
55-1404
55-1406
55-1408
55-1410
55-1412
55-1413
55-1415
55-1417
55-1418
55-1420
55-1422
55-1424
55-1425

Released

1303

55 Current Alarm Status Commands

55.1 Current Alarm Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Current Alarm Status Commands".

Command Tree
----show
----alarm
----current
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi

1304

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----sync
- (index)
----cfm
- (index)
----efm-oam
- (index)

3HH-04416-EBAA-TCZZA 01

Released

1305

55 Current Alarm Status Commands

----alarm-table
- (index)
----auto-switch
- (index)

1306

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.2 Alarm Current Status Command


Command Description
This command displays all current alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current table [ (index) ]

Command Parameters
Table 55.2-1 "Alarm Current Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.2-2 "Alarm Current Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmType>


( equipment
| eqpt-holder
| plug-in-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| qos-queue
| temporal
| spatial
| ( software-mngt | sw-mgmt )
| xdsl
| xdsl-tca
| eo-conv
| authentication

type of the alarms that are active.


This element is always shown.

Released

1307

55 Current Alarm Status Commands

name

Type

Description

| bonding
| sfp
| shdsl-isam
| custom-ext-alarm
| plug-in-unit-ext
| sip-user-agent
| sip-plugin-unit
| sip-termination
| filetransfer
| external-device
| l2forward
| ether-tca
| ether-sfp
| megaco-media-gw
| megaco-sig-gw
| megaco-plug-unit
| megaco-term
| megaco-sig-lt
| eqpt-holder-ext
| lsmredundancy
| sync
| vect-line
| vect-board
| sip-dial-plan
| sip-vsp
| sip-server
| sfprssi
| sfpe1t1-framer
| sfpe1t1-clock
| pppcc-engine-tca
| cfm
| efm-oam
| alarm-table
| auto-switch )
Possible values:
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plug-in-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ima-group : ima-group alarms
- ima-link : ima-link alarms
- redundancy : redundancy alarms
- shdsl : shdsl alarms
- ether-itf : ethernet interface alarms
- traffic-overflow : Traffic overflow alarms
- qos-queue : qos queue alarms
- temporal : temporal alarms
- spatial : spatial alarms
- software-mngt : software management alarms
- sw-mgmt : software management alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related alarms
- bonding : bonding-group related alarms
- sfp : SFP related alarms

1308

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

last-updated-on

Type

Description

- shdsl-isam : shdsl isam alarms


- custom-ext-alarm : customizable external alarms
- plug-in-unit-ext : other plugin unit alarms
- sip-user-agent : sip user agent related alarms
- sip-plugin-unit : sip plug in unit related alarms
- sip-termination : sip termination related alarms
- filetransfer : file transfer server alarms
- external-device : external device related alarms
- l2forward : l2forward related alarms
- ether-tca : ethernet threshold cross alarms
- ether-sfp : ethernet SFP related alarms
- megaco-media-gw : megaco media gateway related alarms
- megaco-sig-gw : megaco signaling gateway related alarms
- megaco-plug-unit : megaco plug unit related alarms
- megaco-term : megaco termination related alarms
- megaco-sig-lt : megaco signaling lt related alarms
- eqpt-holder-ext : other equipment holder alarms
- lsmredundancy : lsm redundancy alarms
- sync : synce and bits alarms
- vect-line : xDSL vectoring line alarms
- vect-board : xDSL vectoring board alarms
- sip-dial-plan : sip dial plan related alarms
- sip-vsp : sip vsp related alarms
- sip-server : sip server related alarms
- sfprssi : SFP RSSI related alarms
- sfpe1t1-framer : SFP 2e1t1 framer alarms
- sfpe1t1-clock : SFP 2e1t1 clock alarms
- pppcc-engine-tca : PPPOE Cross Connect Engine TCA
related alarm
- cfm : Cfm related alarms
- efm-oam : EFM-OAM related alarms
- alarm-table : alarm table related alarms
- auto-switch : auto-switch related alarms
Parameter type: <Sys::timeInSecs>
time in seconds when the entry
- the time (yyyy-mm-dd:hour:minutes:secs)
was updated.
- unit: UTC
This element is always shown.

Only Show Details: number of changes since start up and number of entries in the table
name
Type
Description
changes

Parameter type: <Counter>


- 32 bit counter

entries

Parameter type: <Gauge>


- gauge

tot-delta-log

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

Only Show Details: active severities in the table


name
Type
indeterminate

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::IndetSevState>


( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity

number of changes that have


occurred since startup.
This element is only shown in
detail mode.
number of entries
This element is only shown in
detail mode.
total number of delta log entries
This element is only shown in
detail mode.

Description
status of the severity type
indeterminate
This element is only shown in
detail mode.

Released

1309

55 Current Alarm Status Commands

name

Type

Description

warning

Parameter type: <Alarm::WarnSevState>


( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::MinorSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::MajorSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::CriticalSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity

status of the severity type


warning
This element is only shown in
detail mode.

minor

major

critical

1310

Released

status of the severity type minor


This element is only shown in
detail mode.

status of the severity type major


This element is only shown in
detail mode.

status of the severity type critical


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.3 Equipment Current Alarm Status Command


Command Description
This command displays the equipment current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current equipment [ (index) ]

Command Parameters
Table 55.3-1 "Equipment Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.3-2 "Equipment Current Alarm Status Command" Display parameters
Specific Information
name
persist-data

sntp-comm

nt-disk

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::persistDataLoss>


( lost
| not-lost )
Possible values:
- lost : persistant data is lost
- not-lost : persistant data is not lost
Parameter type: <Alarm::sntpCommLoss>
( lost
| not-lost )
Possible values:
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
Parameter type: <Alarm::ntDiskSpace>
( ( nintyfive-perc | 95%-full )
| ( less-nintyfive-perc | less-than-95% ) )
Possible values:
- nintyfive-perc : NT disk space is 95% full
- 95%-full : NT disk space is 95% full
- less-nintyfive-perc : NT disk space usage less that 95%

current status specifing persistant


data is lost or not
This element is only shown in
detail mode.
current
status
of
sntp
communication is lost or not
This element is only shown in
detail mode.
current status of nt disk space is
95% full or less than that
This element is only shown in
detail mode.

Released

1311

55 Current Alarm Status Commands

name

Type

preferred-mode
short name: pref-mode

timing-reference
short name: time-ref

connection-lost
short name: conn-lost

back-pnl-inv
short name: bpnl-inv

shub-conf-lost
short name: conf-lost

1312

Released

Description

- less-than-95% : NT disk space usage less that 95%


Parameter type: <Alarm::clkPrefMode>
( not-available
| available )
Possible values:
- not-available : Preferred timing mode is not available
- available : Preferred Timing mode available
Parameter type: <Alarm::clkFreeMode>
( failed
| available )
Possible values:
- failed : System is in holdover or free-run mode
- available : System is not in holdover or free-run mode
Parameter type: <Alarm::ShubLoc>
( lost
| not-lost )
Possible values:
- lost : NT shub communication lost
- not-lost : NT shub communication intact
Parameter type: <Alarm::BackPnlInv>
( invalid
| valid )
Possible values:
- invalid : BackPanel-type Invalid
- valid : BackPanel-type Valid
Parameter type: <Alarm::SHubCfgLost>
( lost
| not-lost )
Possible values:
- lost : SHub configuration loss - recent changes lost
- not-lost : SHub configuration up to date

current status of preferred timing


mode
This element is only shown in
detail mode.
current status of timing reference
This element is only shown in
detail mode.

current status of nt shub


communication is lost or intact
This element is only shown in
detail mode.
current status of BackPanel-type
Invalid alarm.
This element is only shown in
detail mode.
actual shub configuration may
differ from lanx database on nt
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.4 Equipment Holder Current Alarm Status


Command
Command Description
This command displays the equipment holder current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current eqpt-holder [ (index) ]

Command Parameters
Table 55.4-1 "Equipment Holder Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.4-2 "Equipment Holder Current Alarm Status Command" Display parameters
Specific Information
name
shelf

rack-power

fan-unit1
short name: fan1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::rackPower>
( failing
| ok )
Possible values:
- failing : the fuse is broken
- ok : the fuse is intact
Parameter type: <Alarm::fanUnit1>
( ( failing | fail )
| ok )
Possible values:

specify which shelf the alarm


occurred on.
This element is only shown in
detail mode.
current status of rack power
alarm, indicating fuse is broken
or intact
This element is only shown in
detail mode.
current status of fan-unit1
This element is only shown in
detail mode.

Released

1313

55 Current Alarm Status Commands

name

Type

fan-unit2
short name: fan2

shelf-type-mismatch
short name: shelf-type

shelf-missing

shelf-install-missing

door

ac-power-fail
short name: ac-pwr

1314

Released

Description

- failing : fan unit 1 is failing


- fail : fan unit 1 is failing
- ok : fan unit 1 is ok
Parameter type: <Alarm::fanUnit2>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 2 is failing
- fail : fan unit 2 is failing
- ok : fan unit 2 is ok
Parameter type: <Alarm::shelfTypeMismatch>
( mismatch
| no-mismatch )
Possible values:
- mismatch : installed and planned shelf types are different
- no-mismatch : installed and planned shelf types are the
same
Parameter type: <Alarm::shelfMissing>
( missing
| not-missing )
Possible values:
- missing : detected shelf now missing
- not-missing : detected shelf was missing, now reinserted
Parameter type: <Alarm::shelfInstall>
( yes
| no )
Possible values:
- yes : shelf now installed
- no : shelf now not installed
Parameter type: <Alarm::door>
( ( failing | fail )
| ok )
Possible values:
- failing : the cabinet door is opened
- fail : the cabinet door is opened
- ok : the cabinet door is closed
Parameter type: <Alarm::acPowerFail>
( ( failing | fail )
| ok )
Possible values:
- failing : system AC power fails
- fail : system AC power fails
- ok : the system AC power works properly

current status of fan-unit2


This element is only shown in
detail mode.

current status specifies installed


and planned shelf types are
different
This element is only shown in
detail mode.
current status specifies once
inserted shelf has gone missing
This element is only shown in
detail mode.
current status specifies shelf is
planned but not installed
This element is only shown in
detail mode.
current status of door alarm,
indicating the cabinet door is
opened
This element is only shown in
detail mode.
current status of AC power
failure alarm, indicating the AC
Power is broken
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.5 Equipment Holder Extended Current Alarm


Status Command
Command Description
This command displays the equipment holder extended current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current eqpt-holder-ext [ (index) ]

Command Parameters
Table 55.5-1 "Equipment Holder Extended Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.5-2 "Equipment Holder Extended Current Alarm Status Command" Display parameters
Specific Information
name
shelf

ctl-com-fail

network-power-loss

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::ctlComFail>
( ( failing | fail )
| ok )
Possible values:
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
Parameter type: <Alarm::netPwrFail>
( ( failing | fail )
| ok )

specify which shelf the alarm


occurred on.
This element is only shown in
detail mode.
current status of shelf controller
communication failure.
This element is only shown in
detail mode.

current status of network power


failure.
This element is only shown in

Released

1315

55 Current Alarm Status Commands

name

hw-fault

bat-a-fail

bat-b-fail

network-power-loss-b

sem-ac-power-fail

sem-ups-fail

dc-a-fail

plan-power-mismatch

1316

Released

Type

Description

Possible values:
- failing : network power is failing
- fail : network power is failing
- ok : network power is ok
Parameter type: <Alarm::hwFail>
( ( failing | fail )
| ok )
Possible values:
- failing : hardware is failing
- fail : hardware is failing
- ok : hardware is ok
Parameter type: <Alarm::batAFail>
( yes
| no )
Possible values:
- yes : Power Source Battery A Failure
- no : Power Source Battery A is OK
Parameter type: <Alarm::batBFail>
( yes
| no )
Possible values:
- yes : Power Source Battery B Failure
- no : bfd stale entry not present
Parameter type: <Alarm::netPwrFailB>
( ( failing | fail )
| no )
Possible values:
- failing : network power B is failing
- fail : network power B is failing
- no : network power B is ok
Parameter type: <Alarm::semAcPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : AC power input is failing
- fail : AC power input is failing
- no : AC power input is ok
Parameter type: <Alarm::semUpsFail>
( low
| no )
Possible values:
- low : voltage level low
- no : voltage level is ok
Parameter type: <Alarm::dcAPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : Local DC A power input is failing
- fail : Local DC A power input is failing
- no : Local DC A power input is ok
Parameter type: <Alarm::planPwrMismatch>
( mismatch
| no )
Possible values:
- mismatch : detected and planned power mode are in
mismatch
- no : planned and detected power mode are identic

detail mode.

current status of hardware failure.


This element is only shown in
detail mode.

current status of shelf power


source A failure.
This element is only shown in
detail mode.
current status of shelf power
source b failure.
This element is only shown in
detail mode.
network power b failure.
This element is only shown in
detail mode.

external ac power supply failure.


This element is only shown in
detail mode.

external power supply failure.


This element is only shown in
detail mode.

local DC A power failure.


This element is only shown in
detail mode.

detected power mode is different


from planned power mode.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1317

55 Current Alarm Status Commands

55.6 Plug-in Unit Current Alarm Status Command


Command Description
This command displays the plug-in unit current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current plug-in-unit [ (index) ]

Command Parameters
Table 55.6-1 "Plug-in Unit Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.6-2 "Plug-in Unit Current Alarm Status Command" Display parameters
Specific Information
name
board-position

1318

Released

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot

identify where the alarm has


occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

board-mismatch

sw-download

temperature

sem-power-fail

sem-ups-fail

temp-shutoff

board-present

3HH-04416-EBAA-TCZZA 01

Type

Description

- ext-a : nt-a slot in an extension shelf


- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::boardMismatch>
( yes
| no )
Possible values:
- yes : planned and plugged-in types are different
- no : planned and plugged-in types are same
Parameter type: <Alarm::swStatus>
( waiting
| completed )
Possible values:
- waiting : not able to download all the applicable SW files
- completed : download completed
Parameter type: <Alarm::tempStatus>
( above-thres
| below-thres )
Possible values:
- above-thres : temperature threshold on board exceeded
- below-thres : board temperature within threshold
Parameter type: <Alarm::extPowerStatus>
( sem-power-fail
| sem-power-ok )
Possible values:
- sem-power-fail : SEM external power failure
- sem-power-ok : SEM external power ok
Parameter type: <Alarm::powerSupplyStatus>
( sem-ups-fail
| sem-ups-ok )
Possible values:
- sem-ups-fail : SEM external power supply failure
- sem-ups-ok : SEM external power supply ok
Parameter type: <Alarm::tempShutoffStatus>
( board-switched-off
| board-switched-on )
Possible values:
- board-switched-off : board switched off - excess
temperature
- board-switched-on : board switched on
Parameter type: <Alarm::boardPresence>
( missing

alarm specifing the planned and


plugged-in types are different
This element is only shown in
detail mode.
alarm specifing download of the
software is completed or not.
This element is only shown in
detail mode.
alarm
specifing
board
temperature is crossed the
threshold or not.
This element is only shown in
detail mode.
alarm specifing SEM external
power failure.
This element is only shown in
detail mode.
alarm specifing SEM external
power supply failure.
This element is only shown in
detail mode.
alarm specifing board is swiched
off
because
of
excess
temperature.
This element is only shown in
detail mode.
indicates the presence of the
board.

Released

1319

55 Current Alarm Status Commands

name

board-inserted

board-init

board-reset-cf

shub-uplink

1320

Released

Type

Description

| yes )
Possible values:
- missing : board was present, but now missing
- yes : board present
Parameter type: <Alarm::boardInsertion>
( never-inserted
| inserted )
Possible values:
- never-inserted : board was never inserted
- inserted : board was inserted
Parameter type: <Alarm::boardInit>
( failed
| completed )
Possible values:
- failed : board initialization failed
- completed : board initialization completed
Parameter type: <Alarm::boardResetCommFail>
( yes
| ok )
Possible values:
- yes : board reset/communication failure occurred
- ok : no board reset/communication failure
Parameter type: <Alarm::lanxuplinkbrkdwn>
( failure
| ok )
Possible values:
- failure : lanx uplink breakdown or removal
- ok : no breakdown or removal of lanx uplink

This element is only shown in


detail mode.
indicates the status of board was
inserted or not.
This element is only shown in
detail mode.
specifies board initializaion is
sucessful or failed.
This element is only shown in
detail mode.
indicates there has been a reset
and/or communication failure of
the board.
This element is only shown in
detail mode.
indicates that lanx uplink
breakdown or removal
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.7 ATM Current Alarm Status Command


Command Description
This command displays the ATM current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current atm [ (index) ]

Command Parameters
Table 55.7-1 "ATM Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.7-2 "ATM Current Alarm Status Command" Display parameters
Specific Information
name
port

vpi-vci

cell-discard-up

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::AtmIndex>


identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::VpiVciValues>
identify where the alarm has
- the vpi and vci value (vpi/vci)
occurred.
This element is only shown in
detail mode.
Parameter type: <Alarm::CellDiscardUpstream>
specifies ATM cell is discarded
( discarded
or not in upstream direction.
| no-discard )
This element is only shown in
Possible values:
detail mode.

Released

1321

55 Current Alarm Status Commands

name

Type

cell-discard-down

1322

Description

- discarded : ATM cell discarded in upstream direction


- no-discard : no ATM cell discarded in upstream direction
Parameter type: <Alarm::CellDiscardDownstream>
( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in downstream direction
- no-discard : no ATM cell discarded in downstream
direction

Released

specifies ATM cell is discarded


or not in downstream direction.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.8 Ethernet Interface Current Alarm Status


Command
Command Description
This command displays the Ethernet Interface current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ether-itf [ (index) ]

Command Parameters
Table 55.8-1 "Ethernet Interface Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.8-2 "Ethernet Interface Current Alarm Status Command" Display parameters
Specific Information
name
ether-ifindex

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ether::InterfaceIndex>


- index of the collision interface
- range: [0...2147483647]

identify where the alarm has


occurred.
This element is only shown in
detail mode.

Released

1323

55 Current Alarm Status Commands

55.9 Software Management Current Alarm Status


Command
Command Description
This command displays the software management current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sw-mgmt [ (index) ]

Command Parameters
Table 55.9-1 "Software Management Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.9-2 "Software Management Current Alarm Status Command" Display parameters
Specific Information
name
board-position

1324

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identifies the physical position of


the slot
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

sw-rollback

db-rollback

xvps-inv-dbase

inv-cde-file

miss-cde-file

cde-hash-error

3HH-04416-EBAA-TCZZA 01

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::SwRollback>
( yes
| no )
Possible values:
- yes : implicit software rollback performed
- no : no implicit software rollback
Parameter type: <Alarm::DbRollback>
( yes
| no )
Possible values:
- yes : implicit database rollback performed
- no : no implicit database rollback
Parameter type: <Alarm::XvpsInvalidDataBase>
( invalid
| valid )
Possible values:
- invalid : invalid xvps dbbase is detected
- valid : xvps dbase is valid
Parameter type: <Alarm::XvpsInvalidCDEFile>
( invalid
| valid )
Possible values:
- invalid : invalid xvps cde file is detected
- valid : xvps cde file is valid
Parameter type: <Alarm::MissingCDEProfile>
( yes
| no )
Possible values:
- yes : cde profile is missed
- no : cde profile is exist
Parameter type: <Alarm::CDEProfileHashErr>
( yes
| no )
Possible values:
- yes : cde profile hash error
- no : cde profile hash correct

Description

specifies
implicit
software
rollback is performed or not.
This element is only shown in
detail mode.
specifies
implicit
database
rollback is performed or not.
This element is only shown in
detail mode.
specifies implicit xvps dbase is
valid or not.
This element is only shown in
detail mode.
specifies implicit xvps cdefile is
valid or not.
This element is only shown in
detail mode.
specifies cde profile is missed or
not.
This element is only shown in
detail mode.
specifies cde profile no key.
This element is only shown in
detail mode.

Released

1325

55 Current Alarm Status Commands

55.10 Temporal Filter Current Alarm Status


Command
Command Description
This command displays temporal filter current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current temporal [ (index) ]

Command Parameters
Table 55.10-1 "Temporal Filter Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.10-2 "Temporal Filter Current Alarm Status Command" Display parameters
Specific Information
name
tmp-filter1

tmp-filter2

tmp-filter3

1326

Released

Type

Description

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:

current status for temporal filter1


This element is only shown in
detail mode.

current status for temporal filter2


This element is only shown in
detail mode.

current status for temporal filter3


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
tmp-filter4

tmp-filter5

tmp-filter6

tmp-filter7

tmp-filter8

tmp-filter9

tmp-filter10

tmp-filter11

tmp-filter12

tmp-filter13

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>

Description
current status for temporal filter4
This element is only shown in
detail mode.

current status for temporal filter5


This element is only shown in
detail mode.

current status for temporal filter6


This element is only shown in
detail mode.

current status for temporal filter7


This element is only shown in
detail mode.

current status for temporal filter8


This element is only shown in
detail mode.

current status for temporal filter9


This element is only shown in
detail mode.

current status for temporal


filter10
This element is only shown in
detail mode.
current status for temporal
filter11
This element is only shown in
detail mode.
current status for temporal
filter12
This element is only shown in
detail mode.
current

Released

status

for

1327

temporal

55 Current Alarm Status Commands

name

tmp-filter14

tmp-filter15

tmp-filter16

tmp-filter17

tmp-filter18

tmp-filter19

tmp-filter20

tmp-filter21

tmp-filter22

1328

Released

Type

Description

( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:

filter13
This element is only shown in
detail mode.
current status for temporal
filter14
This element is only shown in
detail mode.
current status for temporal
filter15
This element is only shown in
detail mode.
current status for temporal
filter16
This element is only shown in
detail mode.
current status for temporal
filter17
This element is only shown in
detail mode.
current status for temporal
filter18
This element is only shown in
detail mode.
current status for temporal
filter19
This element is only shown in
detail mode.
current status for temporal
filter20
This element is only shown in
detail mode.
current status for temporal
filter21
This element is only shown in
detail mode.
current status for temporal
filter22
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
tmp-filter23

tmp-filter24

tmp-filter25

tmp-filter26

tmp-filter27

tmp-filter28

tmp-filter29

tmp-filter30

tmp-filter31

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

Description
current status for temporal
filter23
This element is only shown in
detail mode.
current status for temporal
filter24
This element is only shown in
detail mode.
current status for temporal
filter25
This element is only shown in
detail mode.
current status for temporal
filter26
This element is only shown in
detail mode.
current status for temporal
filter27
This element is only shown in
detail mode.
current status for temporal
filter28
This element is only shown in
detail mode.
current status for temporal
filter29
This element is only shown in
detail mode.
current status for temporal
filter30
This element is only shown in
detail mode.
current status for temporal
filter31
This element is only shown in
detail mode.

Released

1329

55 Current Alarm Status Commands

55.11 Spatial Filter Current Alarm Status Command


Command Description
This command displays spatial filter current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current spatial [ (index) ]

Command Parameters
Table 55.11-1 "Spatial Filter Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.11-2 "Spatial Filter Current Alarm Status Command" Display parameters
Specific Information
name
spa-filter1

spa-filter2

spa-filter3

spa-filter4

1330

Released

Type

Description

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>

current status for spatial filter1


This element is only shown in
detail mode.

current status for spatial filter2


This element is only shown in
detail mode.

current status for spatial filter3


This element is only shown in
detail mode.

current status for spatial filter4

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

spa-filter5

spa-filter6

spa-filter7

spa-filter8

spa-filter9

spa-filter10

spa-filter11

spa-filter12

spa-filter13

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>
( yes
| no )
Possible values:

This element is only shown in


detail mode.

current status for spatial filter5


This element is only shown in
detail mode.

current status for spatial filter6


This element is only shown in
detail mode.

current status for spatial filter7


This element is only shown in
detail mode.

current status for spatial filter8


This element is only shown in
detail mode.

current status for spatial filter9


This element is only shown in
detail mode.

current status for spatial filter10


This element is only shown in
detail mode.

current status for spatial filter11


This element is only shown in
detail mode.

current status for spatial filter12


This element is only shown in
detail mode.

current status for spatial filter13


This element is only shown in
detail mode.

Released

1331

55 Current Alarm Status Commands

name

Type
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>

spa-filter14

spa-filter15

spa-filter16

spa-filter17

spa-filter18

spa-filter19

spa-filter20

spa-filter21

spa-filter22

spa-filter23

1332

Released

Description
current status for spatial filter14
This element is only shown in
detail mode.

current status for spatial filter15


This element is only shown in
detail mode.

current status for spatial filter16


This element is only shown in
detail mode.

current status for spatial filter17


This element is only shown in
detail mode.

current status for spatial filter18


This element is only shown in
detail mode.

current status for spatial filter19


This element is only shown in
detail mode.

current status for spatial filter20


This element is only shown in
detail mode.

current status for spatial filter21


This element is only shown in
detail mode.

current status for spatial filter22


This element is only shown in
detail mode.

current status for spatial filter23

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

spa-filter24

spa-filter25

spa-filter26

spa-filter27

spa-filter28

spa-filter29

spa-filter30

spa-filter31

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

This element is only shown in


detail mode.

current status for spatial filter24


This element is only shown in
detail mode.

current status for spatial filter25


This element is only shown in
detail mode.

current status for spatial filter26


This element is only shown in
detail mode.

current status for spatial filter27


This element is only shown in
detail mode.

current status for spatial filter28


This element is only shown in
detail mode.

current status for spatial filter29


This element is only shown in
detail mode.

current status for spatial filter30


This element is only shown in
detail mode.

current status for spatial filter31


This element is only shown in
detail mode.

Released

1333

55 Current Alarm Status Commands

55.12 xDSL Current Alarm Status Command


Command Description
This command displays the xDSL current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current xdsl [ (index) ]

Command Parameters
Table 55.12-1 "xDSL Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.12-2 "xDSL Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::XdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::NearEndLOS>
specifies near end loss of signal
( yes
occured or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
Parameter type: <Alarm::NearEndLOF>
specifies near end loss of frame
( yes
occured or not.

near-end-los

near-end-lof

1334

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

near-end-lom

near-end-ese

line-config

line-capacity

near-end-bitrate

near-end-ncd

near-end-lcd

far-end-los

far-end-lof

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : near end loss of frame occurred
- no : no near end loss of frame
Parameter type: <Alarm::NearEndLOM>
( yes
| no )
Possible values:
- yes : near end loss of margin occurred
- no : no near end loss of margin
Parameter type: <Alarm::NearEndESE>
( yes
| no )
Possible values:
- yes : near end excessive severe errors occurred
- no : no near end excessive severe errors occurred
Parameter type: <Alarm::LineConfig>
( config-error
| config-ok )
Possible values:
- config-error : line configuration data cannot be used
- config-ok : Line configuration data OK
Parameter type: <Alarm::LineCapacity>
( below-requirement
| meets-requirement )
Possible values:
- below-requirement : line capacity not enough to set up
requested profile
- meets-requirement : line capacity enough to set up
requested profile
Parameter type: <Alarm::NearEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : upstream planned bitrate not reached after
initialization
- meets-plan : upstream planned bitrate reached
Parameter type: <Alarm::NearEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no near end cell delineation
- cell-deline-occurred : near end cell delineation occurred
Parameter type: <Alarm::NearEndLCD>
( yes
| no )
Possible values:
- yes : loss of near end cell deliniation
- no : no loss of near end cell deliniation
Parameter type: <Alarm::FarEndLOS>
( yes
| no )
Possible values:
- yes : far end loss of signal occurred
- no : no far end loss of signal
Parameter type: <Alarm::FarEndLOF>
( yes

This element is only shown in


detail mode.
specifies near end loss of margin
occured or not.
This element is only shown in
detail mode.
specifies near end excessive
severe errors occured or not.
This element is only shown in
detail mode.
specifies
whether
line
configuration data is used or not.
This element is only shown in
detail mode.
specifies whether line capacity is
set up or not.
This element is only shown in
detail mode.

specifies
whether
upstream
planned bitrate reached or not
after initialization.
This element is only shown in
detail mode.
specifies whether near end cell
delineation is occured or not.
This element is only shown in
detail mode.
specifies whether loss of near end
cell deliniation is occured or not.
This element is only shown in
detail mode.
specifies whether far end loss of
signal occured or not.
This element is only shown in
detail mode.
specifies whether far end loss of
frame occured or not.

Released

1335

55 Current Alarm Status Commands

name

far-end-lpr

far-end-lol

far-end-lom

far-end-ese

xdsl-init

peer-modem

far-end-bitrate

far-end-ncd

far-end-lcd

1336

Released

Type

Description

| no )
Possible values:
- yes : far end loss of frame occurred
- no : no far end loss of frame
Parameter type: <Alarm::FarEndLPR>
( yes
| no )
Possible values:
- yes : far end loss of power detected
- no : no far end loss of power
Parameter type: <Alarm::FarEndLOL>
( yes
| no )
Possible values:
- yes : far end loss of link detected
- no : no far end loss of link
Parameter type: <Alarm::FarEndLOM>
( yes
| no )
Possible values:
- yes : far end loss of margin occurred
- no : no far end loss of margin
Parameter type: <Alarm::FarEndESE>
( yes
| no )
Possible values:
- yes : far end excessive severe errors occurred
- no : no far end excessive severe errors occurred
Parameter type: <Alarm::Initialization>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to comminication
problem
- successful : initialization successful
Parameter type: <Alarm::PeerModem>
( no
| yes )
Possible values:
- no : no peer modem detected
- yes : peer modem detected
Parameter type: <Alarm::FarEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : downstream planned bitrate not reached after
initialization
- meets-plan : downstream planned bitrate reached
Parameter type: <Alarm::FarEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no far end cell delineation
- cell-deline-occurred : far end cell delineation occurred
Parameter type: <Alarm::FarEndLCD>
( yes
| no )

This element is only shown in


detail mode.
specifies whether far end loss of
power detected or not.
This element is only shown in
detail mode.
specifies whether far end loss of
link detected or not.
This element is only shown in
detail mode.
specifies whether far end loss of
margin occured or not.
This element is only shown in
detail mode.
specifies whether far end
excessive severe errors occured
or not.
This element is only shown in
detail mode.
specifies xdsl line initialization is
successful or not.
This element is only shown in
detail mode.

specifies whether peer modem


detected or not.
This element is only shown in
detail mode.
specifies whether downstream
planned bitrate reached or not.
This element is only shown in
detail mode.

specifies whether far end cell


delineation occured or not.
This element is only shown in
detail mode.
specifies there is loss of far end
cell deliniation or not.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

far-end-upbo-vio

far-end-cpe-pol

forced-rtx-init

tpstc-mis

vect-dle

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- yes : loss of far end cell deliniation
- no : no loss of far end cell deliniation
Parameter type: <Alarm::FarEndUPBO>
( yes
| no )
Possible values:
- yes : UPBO violation
- no : no UPBO violation
Parameter type: <Alarm::FarEndActFail>
( yes
| no )
Possible values:
- yes : activation failure due to CPE policing
- no : no activation failure due to CPE policing
Parameter type: <Alarm::ForcedRtxInit>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to forced
retransmission
- successful : initialization successful
Parameter type: <Alarm::TpstcMis>
( yes
| no )
Possible values:
- yes : mismatch between the configured tps-tc mode and the
mode supported by the connected cpe
- no : no mismatch between the configured and the tpstc
mode supported by connected cpe
Parameter type: <Alarm::NearEndVectDle>
( yes
| no )
Possible values:
- yes : loss of us signal due to disorderly leaving event
- no : no disorderly leaving detected

detail mode.
UPBO violation
This element is only shown in
detail mode.

activation failure due to CPE


policing
This element is only shown in
detail mode.
specifies forced rtx initialization
is successful or not
This element is only shown in
detail mode.

mismatch between the configured


tps-tc mode and the mode
supported by the connected cpe
This element is only shown in
detail mode.

specifies whether a disorderly


leaving event occured or not.
This element is only shown in
detail mode.

Released

1337

55 Current Alarm Status Commands

55.13 TCA xDSL Current Alarm Status Command


Command Description
This command displays the xDSL threshold cross current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current xdsl-tca [ (index) ]

Command Parameters
Table 55.13-1 "TCA xDSL Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.13-2 "TCA xDSL Current Alarm Status Command" Display parameters
Specific Information
name
port

errored-secs

es-in-a-day

1338

Released

Type

Description

Parameter type: <Itf::XdslLine>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::ErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
Parameter type: <Alarm::ErroredSecondsInAday>

identifies where the alarm


occurred
This element is only shown in
detail mode.

number of errored seconds


exceeded or below threshold
This element is only shown in
detail mode.

errored

3HH-04416-EBAA-TCZZA

seconds

in

01

day

55 Current Alarm Status Commands

name

severely-es

severely-es-in-a-day

unavailable-secs

unavail-secs-in-a-day

far-end-es

fe-severely-es

fe-severely-es/day

3HH-04416-EBAA-TCZZA 01

Type

Description

( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds in a day, exceeded
threshold
- below-thres : number of errored seconds in a day, below
threshold
Parameter type: <Alarm::SeverelyErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds exceeded
threshold
- below-thres : number of severely errored seconds below
threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::UnavailableSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds exceeded
threshold
- below-thres : number of unavailable seconds below
threshold
Parameter type: <Alarm::UnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds in a day,
exceeded threshold
- below-thres : number of unavailable seconds in a day,
below threshold
Parameter type: <Alarm::FarEndErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds exceeded
threshold
- below-thres : number of far end errored seconds below
threshold
Parameter type: <Alarm::FarEndSevErroredSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end severely errored seconds
exceeded threshold
- below-thres : number of far end severely errored seconds
below threshold
Parameter type: <Alarm::FarEndSevErroredSecsInAday>
( above-thres

exceeded or below threshold


This element is only shown in
detail mode.

number of severely errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of unavailable seconds


exceeded or below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

number of far end severely


errored seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or

Released

1339

55 Current Alarm Status Commands

name

fe-unavail-secs

fe-unavail-sec/day

fe-es-in-a-day

leftrs

leftrs-in-a-day

fe-leftrs

fe-leftrs-in-a-day

1340

Released

Type

Description

| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::FarEndUnavailSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds
exceeded threshold
- below-thres : number of far end unavailable seconds below
threshold
Parameter type: <Alarm::FarEndUnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds in a
day, exceeded threshold
- below-thres : number of far end unavailable seconds in a
day, below threshold
Parameter type: <Alarm::FarEndErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds in a day,
exceeded threshold
- below-thres : number of far end errored seconds in a day,
below threshold
Parameter type: <Alarm::LeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
exceeded threshold
- below-thres : number of low error free throughput seconds
below threshold
Parameter type: <Alarm::LeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
in a day, exceeded threshold
- below-thres : number of low error free throughput seconds
in a day, below threshold
Parameter type: <Alarm::FarEndLeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds exceeded threshold
- below-thres : number of far end low error free throughput
seconds below threshold
Parameter type: <Alarm::FarEndLeftrSecondsInAday>
( above-thres
| below-thres )

below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of low error free


throughput seconds in a day,
exceeded or below threshold
This element is only shown in
detail mode.

number of far end low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of far end low error free


throughput seconds in a day,
exceeded or below threshold

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

Possible values:
This element is only shown in
- above-thres : number of far end low error free throughput detail mode.
seconds in a day, exceeded threshold
- below-thres : number of far end low error free throughput
seconds in a day, below threshold

3HH-04416-EBAA-TCZZA 01

Released

1341

55 Current Alarm Status Commands

55.14 Vectoring Line Current Alarm Status


Command
Command Description
This command displays the vectoring line current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current vect-line [ (index) ]

Command Parameters
Table 55.14-1 "Vectoring Line Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm table index

Command Output
Table 55.14-2 "Vectoring Line Current Alarm Status Command" Display parameters
Specific Information
name
port

xtc-variation-vict

1342

Released

Type

Description

Parameter type: <Itf::XdslLine>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::VectXtcVariation>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation in xtc

identifies the physical position of


the port where the alarm has
occurred.
This element is only shown in
detail mode.

excessive : abnormal amplitude


variation in xtc coefficients
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
xtc-variation-dist

corrupted-errf

vect-cpe-cap-mismatch

vect-conf-not-feas

3HH-04416-EBAA-TCZZA 01

Type

Description

coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectXtcVariationDist>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation in xtc
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectCorptErrf>
( yes
| no )
Possible values:
- yes : at least 10% corrupted or missing errorf samples
received
- no : received errorf samples ok
Parameter type: <Alarm::VectCpeCapMism>
( yes
| no )
Possible values:
- yes : not allowed Vectoring CPE connected
- no : allowed Vectoring CPE connected
Parameter type: <Alarm::VectConfNotFeas>
( yes
| no )
Possible values:
- yes : vectoring configuration not feasable
- no : vectoring configuration feasable

specifies if excessive outgoing


crosstalk coefficient variation
occurred or not
This element is only shown in
detail mode.
specifies if corrupted or at least
10% missing errorf samples
received occurred or not
This element is only shown in
detail mode.
specifies if an allowed Vectoring
CPE is connected or not
This element is only shown in
detail mode.
specifies
if
the
vectoring
configuration is feasable
This element is only shown in
detail mode.

Released

1343

55 Current Alarm Status Commands

55.15 Vectoring Board Current Alarm Status


Command
Command Description
This command displays the vectoring board current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current vect-board [ (index) ]

Command Parameters
Table 55.15-1 "Vectoring Board Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm table index

Command Output
Table 55.15-2 "Vectoring Board Current Alarm Status Command" Display parameters
Specific Information
name
board-index

Description

Parameter type: <Equipm::EqptVpSlotIndex>


specifies where the alarm has
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
This element is only shown in
Possible values:
detail mode.
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::VectVpLinkIdx2>
this is the vplink id or the
- specifies the soft-link or the vp-link on the vp-board, or soft-link id. This index has value
zero
zero when it is not used
- range: [0,1...8]
This element is only shown in
detail mode.

vp-link-index

1344

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

vp-lt-mismatch

Parameter type: <Alarm::VectVpLtMism>


( yes
| no )
Possible values:
- yes : mismatch between expected and actual vp-lt mapping
or incompatible sw version on vp and lt
- no : expected and actual vp-lt in line or vp and lt have
compatible sw versions, OR autodiscovery enabled on vp,
autodiscovery disabled on lt

qsfp-id

Parameter type: <Alarm::VectQsfpInvalidAlcatelID>


( invalid
| valid )
Possible values:
- invalid : QSFP does not have valid Alcatel-Lucent ID
- valid : QSFP has valid Alcatel-Lucent ID OR no QSFP
detected.
Parameter type: <Alarm::VPLTLINKFAIL>
( linkdown
| linkup )
Possible values:
- linkdown : vp-lt link problem
- linkup : vp-lt link ok or no lt-expected OR autodiscovery
enabled on vp, autodiscovery disabled on lt

specifies if a mismatch between


expected and actual vp-lt
mapping OR incompatible sw
version on vp and lt is detected or
not. In case vplt-autodiscovery
disabled on vp, failure reported
on
vp-board.
In
case
vplt-autodiscovery enabled on lt,
failure reported on lt-board.
This element is only shown in
detail mode.
specifies if detected QSFP of the
frontcable
has
a
valid
Alcatel-Lucent ID or not
This element is only shown in
detail mode.

vp-lt-link

additional-info

3HH-04416-EBAA-TCZZA 01

specifies if a VP-LT link failure


is detected or not. In case
vplt-autodiscovery disabled on
vp, failure reported on vp-board
when an lt was expected but no
valid connection between vp-lt.
In
case
vplt-autodiscovery
enabled on lt, failure reported on
lt-board
when
no
valid
connection between vp-lt.
This element is only shown in
detail mode.
Parameter type: <Alarm::VpLtLinkFailAdditionalInfo>
AdditionalInfo in case a vp-lt link
- string contains slot identifier (type-bases slot-numbering), failure is reported, or empty
isam ipaddress, isam-id , qsfp-state of the peer slv-vp board string
- length: x<=512
This element is only shown in
detail mode.

Released

1345

55 Current Alarm Status Commands

55.16 Electrical-to-Optical Conversion Current


Alarm Status Command
Command Description
This command displays the Electrical-to-Optical conversion current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current eo-conversion [ (index) ]

Command Parameters
Table 55.16-1 "Electrical-to-Optical Conversion Current Alarm Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.16-2 "Electrical-to-Optical Conversion Current Alarm Status Command" Display
parameters
Specific Information
name

Type

Description

port

Parameter type: <SignedInteger>


- a signed integer

loss-of-signal

identifies where the alarm


occurred.
This element is only shown in
detail mode.
specifies whether loss of signal
detected or not in the EO
conversion module
This element is only shown in
detail mode.

Parameter type: <Alarm::EoConvLOS>


( yes
| no )
Possible values:
- yes : loss of signal detected in the EO conversion module
- no : no loss of signal detected in the EO conversion
module
Parameter type: <Alarm::EoConvTx>
specifies whether transmission
( faulty
fault is occurred or not in the EO
| ok )
module

transmission

1346

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- faulty : transmission fault in the EO module
- ok : transmission OK

This element is only shown in


detail mode.

Released

1347

55 Current Alarm Status Commands

55.17 Authentication Current Alarm Status


Command
Command Description
This command displays the authentication current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current authentication [ (index) ]

Command Parameters
Table 55.17-1 "Authentication Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.17-2 "Authentication Current Alarm Status Command" Display parameters
Specific Information
name
vlan-assign

1348

Released

Type

Description

Parameter type: <Alarm::VLANassignment>


( failed
| successful )
Possible values:
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session

specifies whether a VLAN for a


user session is assigned or failed
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.18 xDSL Bonding Current Alarm Status


Command
Command Description
This command displays the xDSL Bonding current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current bonding-group [ (index) ]

Command Parameters
Table 55.18-1 "xDSL Bonding Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.18-2 "xDSL Bonding Current Alarm Status Command" Display parameters
Specific Information
name
group

up-plan-bitrate

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::BondingInterfaceIndex>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::UpPlannedBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum

identifies the bonding group


interface index
This element is only shown in
detail mode.

specifies whether the actual


group upstream bit rate is above
the group upstream planned bit
rate or not
This element is only shown in

Released

1349

55 Current Alarm Status Commands

name

down-plan-bitrate

up-min-bitrate

down-min-bitrate

up-config

down-config

bond-cpe-conn

multiple-cpes

register

1350

Released

Type

Description

upstream bitrate but below the group upstream planned


bitrate
- ok : actual group bitrate is above the group upstream
planned bitrate
Parameter type: <Alarm::DownPlanBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum
downstream bitrate but below the group downstream
planned bitrate
- ok : actual group bitrate is above the group downstream
planned bitrate
Parameter type: <Alarm::UpMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group upstream
minimum bitrate
- ok : actual group bitrate is above the group upstream
minimum bitrate
Parameter type: <Alarm::DownMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group
downstream minimum bitrate
- ok : actual group bitrate is above the group downstream
minimum bitrate
Parameter type: <Alarm::UpConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : upstream configuration not feasible
- feasible : upstream configuration feasible
Parameter type: <Alarm::DownConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : downstream configuration not feasible
- feasible : downstream configuration feasible
Parameter type: <Alarm::BondCPE>
( not-connected
| connected )
Possible values:
- not-connected : bonding cpe modem not connected
- connected : bonding cpe modem connected
Parameter type: <Alarm::BgConnCPE>
( true
| false )
Possible values:
- true : bonding group has multiple cpe modems connected
- false : bonding group has one cpe modem connected
Parameter type: <Alarm::BgRegFail>
( failure
| ok )
Possible values:

detail mode.

specifies whether the actual


group downstream bit rate is
above the group downstream
planned bit rate or not
This element is only shown in
detail mode.

specifies whether the actual


group upstream bit rate is above
the group upstream minimum bit
rate or not
This element is only shown in
detail mode.
specifies whether the actual
group downstream bit rate is
above the group downstream
minimum bit rate or not
This element is only shown in
detail mode.
specifies whether the upstream
configuration is feasible or not
This element is only shown in
detail mode.
specifies whether the downstream
configuration is feasible or not
This element is only shown in
detail mode.
specifies whether a bonding CPE
modem is connected or not
This element is only shown in
detail mode.
specifies whether the lines of a
bonding group are connected to
multiple CPEs or only one
This element is only shown in
detail mode.
specifies whether a discovery or
aggregation
failure
is
encountered or not
This element is only shown in

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

group-incomplete

3HH-04416-EBAA-TCZZA 01

Type

Description

- failure : bonding group discovery or aggregation register detail mode.


failure detected
- ok : bonding group discovery or aggregation register
failure not detected
Parameter type: <Alarm::BgNotCompl>
specifies whether all configured
( true
lines of the bonding group are
| false )
part of the bonding group
Possible values:
This element is only shown in
- true : bonding group is incomplete
detail mode.
- false : bonding group is complete

Released

1351

55 Current Alarm Status Commands

55.19 Redundancy Current Alarm Status Command


Command Description
This command displays the redundancy current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current redundancy [ (index) ]

Command Parameters
Table 55.19-1 "Redundancy Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.19-2 "Redundancy Current Alarm Status Command" Display parameters
Specific Information
name
loss-over-cap

ping-check-fail

1352

Released

Type

Description

Parameter type: <Alarm::SwoCap>


( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::PingCheck>
( failure
| successful )
Possible values:
- failure : system failure of ping check
- successful : system successful of ping check

identify the switchover capability


in a redundant system.
This element is only shown in
detail mode.
identify the ping check in a
redundant system.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.20 Custom Current Alarm Status Command


Command Description
This command displays the custom current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current custom [ (index) ]

Command Parameters
Table 55.20-1 "Custom Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.20-2 "Custom Current Alarm Status Command" Display parameters
Specific Information
name
custom-alarm1

custom-alarm2

custom-alarm3

custom-alarm4

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::custom1>


( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom4>

identify the customizableAlarm1


.
This element is only shown in
detail mode.
identify the customizableAlarm2
.
This element is only shown in
detail mode.
identify the customizableAlarm3
.
This element is only shown in
detail mode.
identify the customizableAlarm4

Released

1353

55 Current Alarm Status Commands

name

Type

Description
.
This element is only shown in
detail mode.

custom-alarm5

( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm

Only Show Details: host expansion shelves customizable alarms


name
Type
shelf

Parameter type: <Equipm::HolderId>


( <Eqpt::RackId> / <Eqpt::ShelfId>
| not-applicable )
Possible values:
- not-applicable : not applicable
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::he-custom1>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom6>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm

he-custom-alarm1

he-custom-alarm2

he-custom-alarm3

he-custom-alarm4

he-custom-alarm5

he-custom-alarm6

1354

Released

identify the customizableAlarm5


.
This element is only shown in
detail mode.

Description
this is the shelf id (equipment
hoder id) for host expansion
alarms, otherwise it is the rack ID
This element is only shown in
detail mode.

identify the host expansion shelf's


customizableAlarm1 .
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm2 .
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm3 .
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm4 .
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm5 .
This element is only shown in
detail mode.
identify the host expansion shelf's
customizableAlarm6 .
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

- no : no Miscellaneous environment alarm

3HH-04416-EBAA-TCZZA 01

Released

1355

55 Current Alarm Status Commands

55.21 SFP Current Alarm Status Command


Command Description
This command displays the SFP current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sfp [ (index) ]

Command Parameters
Table 55.21-1 "SFP Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.21-2 "SFP Current Alarm Status Command" Display parameters
Specific Information
name
alarm index 1

alarm index 2

1356

Released

Type

Description

Parameter type: <Alarm::SfpAlarmIdx1Type>


( <Alarm::SfpAlarmIdx1>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
Parameter type: <Alarm::SfpAlarmIdx2Type>
( <Alarm::SfpAlarmIdx2>
| nt : sfp : <Eqpt::PortIndex>
| nt-a : sfp : <Alarm::SfpAlarmIdx2>
| nt-a : xfp : <Alarm::SfpAlarmIdx2>

this is the host sfp faceplate


number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.

this is the lanx port id for host


alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

| nt-b : sfp : <Alarm::SfpAlarmIdx2>


| nt-b : xfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : xfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : xfp : <Alarm::SfpAlarmIdx2>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- nt : active nt slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Alarm::SfpAlarmIdx2>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
Field type <Eqpt::PortIndex>
- the faceplate port number

Only Show Details: host shelf alarms


name
Type
host-sfp-los

host-sfp-tx

host-sfp-pres

host-sfp-id

host-sfp-ctrl

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Alarm::hostSFPLOS>


( failing
| ok )
Possible values:
- failing : host downlink SFP loss of signal
- ok : host downlink SFP signal ok
Parameter type: <Alarm::hostSFPTxFail>
( failing
| ok )
Possible values:
- failing : host downlink SFP tx failure
- ok : host downlink SFP tx ok
Parameter type: <Alarm::hostSFPMissing>
( not-present
| present )
Possible values:
- not-present : host downlink SFP not present
- present : host downlink SFP present
Parameter type: <Alarm::hostSFPInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : host downlink SFP does not have valid
Alcatel-Lucent ID
- valid : host downlink SFP has valid Alcatel-Lucent ID
Parameter type: <Alarm::hostSFPControlFail>
( failing

current status of SFP alarm, Host


downlink SFP loss of signal
This element is only shown in
detail mode.
current status of SFP alarm, host
downlink SFP Tx failure
This element is only shown in
detail mode.
current status of SFP alarm, Host
downlink SFP not present
This element is only shown in
detail mode.
current status of SFP alarm, host
downlink SFP does not have
valid Alcatel-Lucent ID
This element is only shown in
detail mode.
current status of SFP alarm, host
downlink SFP control failure

Released

1357

55 Current Alarm Status Commands

name

host-sfp-rmtlt

host-sfp-mismatch

host-sfp-incompt

Type

Description

| ok )
Possible values:
- failing : host downlink SFP control failure
- ok : host downlink SFP control ok
Parameter type: <Alarm::hostSFPUnexpectedRemoteLT>
( yes
| no )
Possible values:
- yes : host shelf SFP unexpected remote LT plug-in
- no : host shelf SFP expected remote LT plug-in
Parameter type: <Alarm::hostSFPAssignmentMismatch>
( yes
| no )
Possible values:
- yes : host shelf SFP assignment does not match reported
rack/shelf/slot
- no : host shelf SFP assignment matches reported
rack/shelf/slot
Parameter type: <Alarm::hostSFPIncompatibleShelf>
( yes
| no )
Possible values:
- yes : host shelf SFP incompatible shelf type detected
- no : host shelf SFP compatible shelf type detected

This element is only shown in


detail mode.

Only Show Details: expansion shelf alarms


name
Type
exp-sfp-los

exp-sfp-pres

exp-sfp-id

exp-sfp-ctrl

1358

Released

current status of SFP alarm, host


downlink SFP assignment does
not match reported rack/shelf/slot
This element is only shown in
detail mode.

current status of SFP alarm, host


downlink
SFP
detected
incompatible shelf type
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::expansionShelfSFPLos>


( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP loss of signal
- ok : expansion shelf downlink SFP signal ok
Parameter type: <Alarm::expansionShelfSFPTxFail>
( failing
| ok )
Possible values:
- failing : expansion shelf host downlink SFP tx failure
- ok : expansion shelf downlink SFP tx ok
Parameter type: <Alarm::expansionShelfSFPMissing>
( not-present
| present )
Possible values:
- not-present : expansion shelf downlink SFP not present
- present : expansion shelf downlink SFP present
Parameter type: <Alarm::expShelfSFPInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : expansion shelf downlink SFP does not have valid
Alcatel-Lucent ID
- valid : expansion shelf downlink SFP has valid
Alcatel-Lucent ID
Parameter type: <Alarm::expansionShelfSFPControlFail>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP control failure

exp-sfp-tx

current status of SFP alarm, host


downlink SFP unexpected remote
plug-in
This element is only shown in
detail mode.

current status of SFP alarm,


Expansion side SFP loss of signal
This element is only shown in
detail mode.
current status of SFP alarm,
Expansion shelf SFP Tx failure
This element is only shown in
detail mode.
current status of SFP alarm,
expansion shelf SFP not present
This element is only shown in
detail mode.
current status of SFP alarm,
expansion shelf SFP does not
have valid Alcatel-Lucent ID
This element is only shown in
detail mode.

current status of SFP alarm,


expansion shelf downlink SFP
control failure
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
exp-sfp-1-los

exp-sfp-2-los

3HH-04416-EBAA-TCZZA 01

Type
- ok : expansion shelf downlink SFP control ok
Parameter type: <Alarm::expansionShelfSFP1Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP1 loss of signal
- ok : expansion shelf downlink SFP1 signal ok
Parameter type: <Alarm::expansionShelfSFP2Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP2 loss of signal
- ok : expansion shelf downlink SFP2 signal ok

Description
current status of SFP1 alarm,
Expansion side SFP1 loss of
signal
This element is only shown in
detail mode.
current status of SFP2 alarm,
Expansion side SFP2 loss of
signal
This element is only shown in
detail mode.

Released

1359

55 Current Alarm Status Commands

55.22 Custom External Current Alarm Status


Command
Command Description
This command displays the custom external current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current custom-ext-alarm [ (index) ]

Command Parameters
Table 55.22-1 "Custom External Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 55.22-2 "Custom External Current Alarm Status Command" Display parameters
Specific Information
name
board-position

1360

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identify where the alarm has


occurred.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

ext-alarm1

ext-alarm2

ext-alarm3

ext-alarm4

ext-alarm5

3HH-04416-EBAA-TCZZA 01

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::custExtAlarm1>
( yes
| no )
Possible values:
- yes : customizable external alarm 1
- no : no customizable external alarm 1
Parameter type: <Alarm::custExtAlarm2>
( yes
| no )
Possible values:
- yes : customizable external alarm 2
- no : no customizable external alarm 2
Parameter type: <Alarm::custExtAlarm3>
( yes
| no )
Possible values:
- yes : customizable external alarm 3
- no : no customizable external alarm 3
Parameter type: <Alarm::custExtAlarm4>
( yes
| no )
Possible values:
- yes : customizable external alarm 4
- no : no customizable external alarm 4
Parameter type: <Alarm::custExtAlarm5>
( yes
| no )
Possible values:
- yes : customizable external alarm 5
- no : no customizable external alarm 5

Description

current status specifying external


alarm 1 is present or not
This element is always shown.

current status specifying external


alarm 2 is present or not
This element is always shown.

current status specifying external


alarm 3 is present or not
This element is always shown.

current status specifying external


alarm 4 is present or not
This element is always shown.

current status specifying external


alarm 5 is present or not
This element is always shown.

Released

1361

55 Current Alarm Status Commands

55.23 SFP RSSI Current Alarm Status Command


Command Description
This command displays the SFP RSSI current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sfprssi [ (index) ]

Command Parameters
Table 55.23-1 "SFP RSSI Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.23-2 "SFP RSSI Current Alarm Status Command" Display parameters
Specific Information
name
alarm index 1

1362

Released

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

alarm index 2

Type

Description

- ext-a : nt-a slot in an extension shelf


- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::RssiPort>
( sfp : <Alarm::RssiPort>
| xfp : <Alarm::RssiPort> )
Possible values:
- sfp : rssi sfp port
- xfp : rssi xfp port
Field type <Alarm::RssiPort>
- value
- range: [0...18]

Only Show Details: sfp rssi diagnostic threshold control alarms


name
Type
tx-power-high-alarm

tx-power-low-alarm

rx-power-high-alarm

rx-power-low-alarm

3HH-04416-EBAA-TCZZA 01

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::NTNTIOTXPWHI>


( yes
| no )
Possible values:
- yes : TX optical power is too high than configured alarm
high threshold
- no : The TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLO>
( yes
| no )
Possible values:
- yes : TX optical power is too low than the configured
alarm low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHI>
( yes
| no )
Possible values:
- yes : RX optical power is too high than the configured
alarm high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLO>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
alarm low threshold
- no : RX optical power is ok

current status optical power is too


high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status RX optical power
is too high than the configured
alarm high threshold
This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
alarm low threshold
This element is only shown in
detail mode.

Released

1363

55 Current Alarm Status Commands

name

Type

Description

tx-biascur-high-alarm

Parameter type: <Alarm::NTNTIOTXBIASHI>


( yes
| no )
Possible values:
- yes : TX bias is too high than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLO>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHI>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured alarm high
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOVOLLO>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured alarm low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPHI>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured alarm
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPLO>
( yes
| no )
Possible values:
- yes : temperature is too low than the configured alarm low
threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTXPWHIWARN>
( yes
| no )
Possible values:
- yes : TX optical power is too high than the configured
warning high threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLOWARN>
( yes
| no )
Possible values:
- yes : TX optical power is too low than the configured
warning low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHIWARN>

current status TX bias is too high


than the configured alarm low
threshold
This element is only shown in
detail mode.

tx-biascur-low-alarm

volt-high-alarm

volt-low-alarm

temp-high-alarm

temp-low-alarm

tx-power-high-warn

tx-power-low-warn

rx-power-high-warn

1364

Released

current status TX bias is too low


than the configured alarm low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured alarm high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured alarm low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status TX optical power is
too high than the configured
warning high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured
warning low threshold
This element is only shown in
detail mode.
current status RX optical power

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

rx-power-low-warn

tx-biascur-high-warn

tx-biascur-low-warn

volt-high-warn

volt-low-warn

temp-high-warn

temp-low-warn

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLOWARN>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning low threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIOTXBIASHIWARN>
( yes
| no )
Possible values:
- yes : TX bias is too high than the configured warning high
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLOWARN>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured warning low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHIWARN>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured warning high
threshold
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::NTNTIOVOLLOWARN>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured warning low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPEHIWARN>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured warning
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPELOWARN>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured warning
low threshold
- no : temperature is ok

is too low than the configured


warning high threshold
This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
warning low threshold
This element is only shown in
detail mode.
current status TX bias is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status TX bias is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured warning
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured warning
low threshold
This element is only shown in
detail mode.

Released

1365

55 Current Alarm Status Commands

55.24 PPP Cross-Connect Engine TCA Current


Alarm Status Command
Command Description
This command displays the pppcc engine tca current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current pppcc-engine-tca [ (index) ]

Command Parameters
Table 55.24-1 "PPP Cross-Connect Engine TCA Current Alarm Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.24-2 "PPP Cross-Connect Engine TCA Current Alarm Status Command" Display
parameters
Specific Information
name
engine

1366

Released

Type

Description

Parameter type: <Vlan::StackedVlanSigned>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

this is the ppp-cc engine number


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

Only Show Details: pppoe cross-connect engine tca alarms


name
Type
pppcce-trans-15min-tca

pppcce-sess-15min-tca

pppcce-trans-1day-tca

pppcce-sess-1day-tca

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Alarm::PPPCCETRANS15MIN>


( yes
| no )
Possible values:
- yes : 15 minutes transaction timeout count exceeds
configured TCA
- no : 15 minutes transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS15MIN>
( yes
| no )
Possible values:
- yes : 15 minutes session timeout count exceeds configured
TCA
- no : 15 minutes session timeout count is OK
Parameter type: <Alarm::PPPCCETRANS1DAY>
( yes
| no )
Possible values:
- yes : 1day transaction timeout count exceeds configured
TCA
- no : 1day transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS1DAY>
( yes
| no )
Possible values:
- yes : 1day session timeout count exceeds configured TCA
- no : 1day session timeout count is OK

current 15 minutes transaction


timeout count exceeds configured
tca
This element is only shown in
detail mode.
15 minutes session timeout count
exceeds configured TCA
This element is only shown in
detail mode.

1day transaction timeout count


exceeds configured TCA
This element is only shown in
detail mode.

1day session timeout count


exceeds configured TCA
This element is only shown in
detail mode.

Released

1367

55 Current Alarm Status Commands

55.25 2xE1/DS1 SFP Clock Current Alarm Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Clock current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sfpe1t1-clock [ (index) ]

Command Parameters
Table 55.25-1 "2xE1/DS1 SFP Clock Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.25-2 "2xE1/DS1 SFP Clock Current Alarm Status Command" Display parameters
Specific Information
name
alarm index 1

1368

Released

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

alarm index 2

Type

Only Show Details: e1t1 sfp clock alarms


name
Type
dsx1-serdes-fail

dsx1-tributary1-fail

dsx1-tributary2-fail

dsx1-los-fail

3HH-04416-EBAA-TCZZA 01

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1Port>
( sfp : <Alarm::E1t1FramerPort>
| xfp : <Alarm::E1t1FramerPort> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]

Parameter type: <Alarm::DSX1SERDESFAIL>


( yes
| no )
Possible values:
- yes : SERDES clock failure alarm
- no : SERDES Clock no failure
Parameter type: <Alarm::DSX1TRIB1FAIL>
( yes
| no )
Possible values:
- yes : Tributary 1 clock failure alarm
- no : Tributary 1 clock no failure
Parameter type: <Alarm::DSX1TRIB2FAIL>
( yes
| no )
Possible values:
- yes : Tributary 2 clock failure alarm
- no : Tributary 2 clock no failure
Parameter type: <Alarm::DSX1LOSFAIL>
( yes
| no )
Possible values:
- yes : All selected tributaries in Loss Of Signal
- no : No All selected tributaries in Loss Of Signal

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description
SERDES clock failure alarm
This element is only shown in
detail mode.

tributary 1 clock failure alarm


This element is only shown in
detail mode.

tributary 2 clock failure alarm


This element is only shown in
detail mode.

all selected tributaries in loss of


signal
This element is only shown in
detail mode.

Released

1369

55 Current Alarm Status Commands

name

Type

Description

dsx1-ais-sync

Parameter type: <Alarm::DSX1AISFAIL>


( yes
| no )
Possible values:
- yes : Alarm Indication Signal on the tributary selected sync
source
- no : No Alarm Indication Signal on the tributary selected
sync source
Parameter type: <Alarm::DSX1LOFSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Frame on the tributary selected sync source
- no : No Loss of Frame on the tributary selected sync
source
Parameter type: <Alarm::DSX1LOSSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Signal on the tributary selected sync source
- no : No Loss of Signal on the tributary selected sync
source
Parameter type: <Alarm::DSX1DEGFAIL>
( yes
| no )
Possible values:
- yes : Signal degrade alarm
- no : Signal degrade alarm

alarm indication signal on the


tributary selected as sync source
This element is only shown in
detail mode.

dsx1-lof-sync

dsx1-los-sync

dsx1-deg-fail

1370

Released

loss of frame on the tributary


selected as sync source
This element is only shown in
detail mode.

loss of signal on the tributary


selected as sync source
This element is only shown in
detail mode.

signal degrade alarm


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.26 2xE1/DS1 SFP Framer Alarm Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Framer current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sfpe1t1-framer [ (index) ]

Command Parameters
Table 55.26-1 "2xE1/DS1 SFP Framer Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.26-2 "2xE1/DS1 SFP Framer Alarm Status Command" Display parameters
Specific Information
name
alarm index 1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

Released

1371

55 Current Alarm Status Commands

name

Type

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1framerPort>
( sfp : <Alarm::E1t1FramerPort> : <Alarm::tributary>
| xfp : <Alarm::E1t1FramerPort> : <Alarm::tributary> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]
Field type <Alarm::tributary>
- value
- range: [1...2]

alarm index 2

Only Show Details: e1t1 framer alarms


name
Type
rei-from-liu

crc6-from-liu

crc4-from-liu

1372

Description

Parameter type: <Alarm::DSX1REILIU>


( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from LIU
- no : No e1t1 sfp Remote Error Indication Alarm from LIU
Parameter type: <Alarm::DSX1RDILIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from LIU
- no : No e1t1 sfp Remote Defect Alarmn from LIU
Parameter type: <Alarm::DSX1CRC6LIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 6 from LIU
Parameter type: <Alarm::DSX1CRC4LIU>
( yes
| no )

rdi-from-liu

Released

this is the host sfp faceplate


number
This element is only shown in
detail mode.

remote error indication alarm


from LIU
This element is only shown in
detail mode.
remote defect indication alarm
from LIU
This element is only shown in
detail mode.
cyclic redundancy check 6 from
LIU
This element is only shown in
detail mode.
cyclic redundancy check 4 from
LIU
This element is only shown in

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

crc4-thrshold-from-liu

ais-from-liu

los-from-liu

lof-from-liu

lomf-from-liu

rei-from-iwf

rdi-from-iwf

crc6-from-iwf

crc4-from-iwf

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 from LIU
Parameter type: <Alarm::DSX1CRC4THLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from LIU
Parameter type: <Alarm::DSX1AISLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from LIU
- no : No e1t1 sfp Alarm Indication Signal alarm from LIU
Parameter type: <Alarm::DSX1LOSLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from LIU
- no : No e1t1 sfp Loss of signal alarm from LIU
Parameter type: <Alarm::DSX1LOFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from LIU
- no : No e1t1 sfp Loss of frame alarm from LIUU
Parameter type: <Alarm::DSX1LOMFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from LIU
- no : No e1t1 sfp Loss of multi frame alarm from LIU
Parameter type: <Alarm::DSX1REIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from IWF
- no : No e1t1 sfp Remote Error Indication Alarm from IWF
Parameter type: <Alarm::DSX1RDIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from IWF
- no : No e1t1 sfp Remote Defect Alarmn from IWF
Parameter type: <Alarm::DSX1CRC6IWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 6 from IWF
Parameter type: <Alarm::DSX1CRC4IWF>
( yes
| no )
Possible values:

detail mode.
cyclic redundancy check 4
threshold alarm from LIU
This element is only shown in
detail mode.

alarm indication signal alarm


from LIU
This element is only shown in
detail mode.
loss of signal alarm from LIU
This element is only shown in
detail mode.

loss of frame alarm from LIU


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.
remote error indication alarm
from IWF
This element is only shown in
detail mode.
remote defect indication alarm
from IWF
This element is only shown in
detail mode.
cyclic redundancy check 6 from
IWF
This element is only shown in
detail mode.
cyclic redundancy check 4 from
IWF
This element is only shown in
detail mode.

Released

1373

55 Current Alarm Status Commands

name

Type

crc4-thrshold-from-iwf

ais-from-iwf

los-from-iwf

lof-from-iwf

lomf-from-iwf

1374

Released

Description

- yes : e1t1 sfp Cyclic Redundancy Check 4 from IWF


- no : No e1t1 sfp Cyclic Redundancy Check 4 from IWF
Parameter type: <Alarm::DSX1CRC4THIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from IWF
Parameter type: <Alarm::DSX1AISIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from IWF
- no : No e1t1 sfp Alarm Indication Signal alarm from IWF
Parameter type: <Alarm::DSX1LOSIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from IWF
- no : No e1t1 sfp Loss of signal alarm from IWF
Parameter type: <Alarm::DSX1LOFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from IWF
- no : No e1t1 sfp Loss of frame alarm from IWF
Parameter type: <Alarm::DSX1LOMFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from IWF
- no : No e1t1 sfp Loss of multi frame alarm from IWF

cyclic redundancy check 4


threshold alarm from IWF
This element is only shown in
detail mode.

alarm indication signal alarm


from IWF
This element is only shown in
detail mode.
loss of signal alarm from IWF
This element is only shown in
detail mode.

loss of frame alarm from IWF


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.27 Plug In Unit Extended Current Alarm Status


Command
Command Description
This command shows the plug-in unit extended current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current plug-in-unit-ext [ (index) ]

Command Parameters
Table 55.27-1 "Plug In Unit Extended Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 55.27-2 "Plug In Unit Extended Current Alarm Status Command" Display parameters
Specific Information
name
board-position

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identify where the alarm has


occurred.
This element is only shown in
detail mode.

Released

1375

55 Current Alarm Status Commands

name

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::pluginFan>
( yes
| no )
Possible values:
- yes : fan alarm
- no : no fan alarm
Parameter type: <Alarm::plugin-dc-a>
( yes
| no )
Possible values:
- yes : dc a failure alarm
- no : no dc a failure alarm
Parameter type: <Alarm::plugin-dc-b>
( yes
| no )
Possible values:
- yes : dc b failure alarm
- no : no dc b failure alarm
Parameter type: <Alarm::plugin-dg>
( yes
| no )
Possible values:
- yes : dying gasp alarm
- no : no dying gasp alarm
Parameter type: <Alarm::pluginApsf>
( yes
| no )
Possible values:
- yes : apsf failure alarm
- no : no apsf failure alarm
Parameter type: <Alarm::NTRALoss>
( yes
| no )
Possible values:
- yes : ntr-a signal unavailable
- no : ntr-a signal available
Parameter type: <Alarm::NTRBLoss>
( yes
| no )
Possible values:
- yes : ntr-b signal unavailable
- no : ntr-b signal available
Parameter type: <Alarm::XvpsConfLoss>
( yes
| no )
Possible values:

fan-alarm

dc-a-alarm

dc-b-alarm

dg-alarm

apsf-alarm

ntr-a-loss

ntr-b-loss

xvps-conf-loss

1376

Released

Description

current status specifying fan


alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-a
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-b
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dying
gasp alarm is present or not
This element is only shown in
detail mode.
power for the applique is
available or not
This element is only shown in
detail mode.
current status specifying NTR-A
loss alarm is present or not
This element is only shown in
detail mode.
current status specifying NTR-B
loss alarm is present or not
This element is only shown in
detail mode.
implicit xvps configuration loss
or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
mac-entry-nofree

fibre-conn-mismatch

link-cap-mismatch

eqpt-cap-mismatch

ctrl-dnld-failed

board-hw-issue

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : implicit xvps configuration loss.


- no : no implicit xvps configuration loss.
Parameter type: <Alarm::MacNofree>
( nofree
| free )
Possible values:
- nofree : no free mac entry in the mac table on the lt board.
- free : file transfer server available.
Parameter type: <Alarm::FibreConnMismatch>
( yes
| no )
Possible values:
- yes : REM fibre connection mismatch alarm
- no : no REM fibre connection mismatch alarm
Parameter type: <Alarm::LinkCapMismatch>
( yes
| no )
Possible values:
- yes : actual link speed is not inline with the end-to-end link
capability between NT and LT
- no : actual link speed is inline with the end-to-end link
capability between NT and LT
Parameter type: <Alarm::EqptCapMismatch>
( yes
| no )
Possible values:
- yes : not all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
- no : all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
Parameter type: <Alarm::CtrlDownloadFailure>
( yes
| no )
Possible values:
- yes : The downloading of the Software image to the
controller card failed..
- no : The downloading of the Software image to the
controller card passed.
Parameter type: <Alarm::BoardHWIssue>
( yes
| no )
Possible values:
- yes : Board hardware issue
- no : No Board hardware issue.

current status specifying no free


mac entry in the mac table on the
lt board
This element is only shown in
detail mode.
current status specifying fibre
connection mismatch on detected
control card.
This element is only shown in
detail mode.
current status actual link speed is
not in line with the end-to-end
link capability between NT and
LT.
This element is only shown in
detail mode.
current status not all equipment
between NT and LT can support
the speed that NT and LT can
support within the configured
MaxLinkSpeed.
This element is only shown in
detail mode.

current status The downloading


of the Software image to the
controller card failed.
This element is only shown in
detail mode.

current status Board hardware


issue.
This element is only shown in
detail mode.

Released

1377

55 Current Alarm Status Commands

55.28 SIP Server Current Alarm Status Command


Command Description
This command displays the SIP Server current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sip-server [ (index) ]

Command Parameters
Table 55.28-1 "SIP Server Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.28-2 "SIP Server Current Alarm Status Command" Display parameters
Specific Information
name
server-index
transport-mismatch

dns-lookup-failure

1378

Released

Type

Description

Parameter type: <Sip::ServerId>


- the SIP server table index
- range: [1...32]
Parameter type: <Alarm::transportMismatch>
( yes
| no )
Possible values:
- yes : mismatch
- no : not mismatch
Parameter type: <Alarm::dnsLookUpFailure>
( yes
| no )
Possible values:
- yes : fail
- no : not fail

identifies sip server


This element is only shown in
detail mode.
specifies isamv and server
transport mismatch or not.
This element is only shown in
detail mode.
specifies dns look up fail or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.29 SIP VSP Current Alarm Status Command


Command Description
This command displays the SIP VSP current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sip-vsp [ (index) ]

Command Parameters
Table 55.29-1 "SIP VSP Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.29-2 "SIP VSP Current Alarm Status Command" Display parameters
Specific Information
name
vsp-index
none-dns-srv

no-dns-srv

none-srv

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sip::DialPlanId>


- the dial plan table index
- range: [1...255]
Parameter type: <Alarm::noneDNSSRV>
( yes
| no )
Possible values:
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
Parameter type: <Alarm::noDNSSRV>
( yes
| no )
Possible values:
- yes : no dns server configured when sip request
- no : dns server configured when sip request
Parameter type: <Alarm::noneSRV>
( yes
| no )
Possible values:

identifies sip vsp


This element is only shown in
detail mode.
specifies none of dns server give
reply to to DNS look up or not.
This element is only shown in
detail mode.
specifies
no
dns
server
configured when sip request or
not.
This element is only shown in
detail mode.
specifies none sip server give
reply when send sip request or
not.
This element is only shown in

Released

1379

55 Current Alarm Status Commands

name
no-srv

reg-srv-unreach

prxy-srv-unreach

1380

Released

Type

Description

- yes : none sip server give reply when send sip request
- no : sip server give reply when send sip request
Parameter type: <Alarm::noSRV>
( yes
| no )
Possible values:
- yes : no sip proxy server configured when send sip request
- no : sip proxy server configured when send sip request
Parameter type: <Alarm::noRegSRV>
( yes
| no )
Possible values:
- yes : no sip register server give reply when send sip
register
- no : sip register server give reply when send sip register
Parameter type: <Alarm::noPrxySRV>
( yes
| no )
Possible values:
- yes : no sip proxy server give reply when send sip request
- no : sip proxy server give reply when send sip request

detail mode.
specifies no sip proxy server
configured when send sip request
or not.
This element is only shown in
detail mode.
specifies no sip register servers
give reply when send sip register
or not.
This element is only shown in
detail mode.
specifies no sip proxy servers
give reply when send sip request
or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.30 SIP Dial Plan Current Alarm Status Command


Command Description
This command displays the SIP dial plan current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sip-dial-plan [ (index) ]

Command Parameters
Table 55.30-1 "SIP Dial Plan Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.30-2 "SIP Dial Plan Current Alarm Status Command" Display parameters
Specific Information
name
dialplan-index
bad-digitmap

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sip::DialPlanId>


- the dial plan table index
- range: [1...255]
Parameter type: <Alarm::badDigitMap>
( yes
| no )
Possible values:
- yes : digit map unusable
- no : digit map usable

identifies the dial plan


This element is only shown in
detail mode.
specifies sip digitmap status.
This element is only shown in
detail mode.

Released

1381

55 Current Alarm Status Commands

55.31 SIP Slot Current Alarm Status Command


Command Description
This command displays the SIP slot current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sip-plugin-unit [ (index) ]

Command Parameters
Table 55.31-1 "SIP Slot Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.31-2 "SIP Slot Current Alarm Status Command" Display parameters
Specific Information
name
slot-index

1382

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>

identifies the board


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

dhcp-unreach

proxy-srv-unreach

reg-srv-unreach

3HH-04416-EBAA-TCZZA 01

Type

Description

- the rack number


Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::dhcpServerUnreach>
( yes
| no )
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
Parameter type: <Alarm::sipProxyServerUnreach>
( yes
| no )
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
Parameter type: <Alarm::sipRegistratorServerUnreach>
( yes
| no )
Possible values:
- yes : registrator server unreachable
- no : registrator server reachable

specifies DHCP server status.


This element is only shown in
detail mode.

specifies sip proxy server status.


This element is only shown in
detail mode.

specifies sip registrator server


status.
This element is only shown in
detail mode.

Released

1383

55 Current Alarm Status Commands

55.32 SIP Termination Current Alarm Status


Command
Command Description
This command displays the SIP termination current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sip-termination [ (index) ]

Command Parameters
Table 55.32-1 "SIP Termination Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.32-2 "SIP Termination Current Alarm Status Command" Display parameters
Specific Information
name
term-index

Description

Parameter type: <Itf::PotsLine>


identifies the termination
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId>
detail mode.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::unknownSubscriber>
specfies the sip subscriber
( yes
unknow or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : wrong subscriber

unknown-sub

1384

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
ground-key

port-hightemp

port-jbfltca

reg-domainname

reg-auth

reg-timeout

reg-srvfailresp

inv-domainname

inv-auth

inv-timeout

3HH-04416-EBAA-TCZZA 01

Type
- no : right subscriber
Parameter type: <Alarm::groundKey>
( yes
| no )
Possible values:
- yes : current to ground
- no : current not to ground
Parameter type: <Alarm::highTemperature>
( yes
| no )
Possible values:
- yes : high temperature
- no : not high temperature
Parameter type: <Alarm::jbflTca>
( yes
| no )
Possible values:
- yes : high jb fill level
- no : not high jb fill level
Parameter type: <Alarm::regdomainname>
( yes
| no )
Possible values:
- yes : register - resolving domain name failed
- no : register - resolving domain name successful
Parameter type: <Alarm::regauth>
( yes
| no )
Possible values:
- yes : register - authentication failed
- no : register - authentication successful
Parameter type: <Alarm::regtimeout>
( yes
| no )
Possible values:
- yes : register - message timeout
- no : register - message not timeout
Parameter type: <Alarm::regsrvfailresp>
( yes
| no )
Possible values:
- yes : register - failure response from server
- no : register - successful response from server
Parameter type: <Alarm::invdomainname>
( yes
| no )
Possible values:
- yes : invite - resolving domain name failed
- no : invite - resolving domain name successful
Parameter type: <Alarm::invauth>
( yes
| no )
Possible values:
- yes : invite - authentication failed
- no : invite - authentication successful
Parameter type: <Alarm::invtimeout>
( yes

Description
status of the ground key.
This element is only shown in
detail mode.

status of the port temperature.


This element is only shown in
detail mode.

status of the port jb fill level tca.


This element is only shown in
detail mode.

status of resolving domain name


(register).
This element is only shown in
detail mode.
status of authentication (register).
This element is only shown in
detail mode.

status of message timeout


(register).
This element is only shown in
detail mode.
status of failure response from
server (register).
This element is only shown in
detail mode.
status of resolving domain name
(invite).
This element is only shown in
detail mode.
status of authentication (invite).
This element is only shown in
detail mode.

status of
(invite).

Released

message

1385

timeout

55 Current Alarm Status Commands

name

inv-srvfailresp

subs-srvfailresp

subs-domainname

subs-auth

subs-refreshfail

subs-inittimeout

emergency-call

additional-info

1386

Released

Type

Description

| no )
Possible values:
- yes : invite - message timeout
- no : invite - message not timeout
Parameter type: <Alarm::invsrvfailresp>
( yes
| no )
Possible values:
- yes : invite - failure response from server
- no : invite - successful response from server
Parameter type: <Alarm::subssrvfailresp>
( yes
| no )
Possible values:
- yes : subscribe - failure response from server
- no : subscribe - successful response from server
Parameter type: <Alarm::subsdomainname>
( yes
| no )
Possible values:
- yes : Subscribe - resolving domain name failed
- no : Subscribe - resolving domain name successful
Parameter type: <Alarm::subsauth>
( yes
| no )
Possible values:
- yes : Subscribe - authentication failed
- no : Subscribe - authentication successful
Parameter type: <Alarm::subsrefreshfail>
( yes
| no )
Possible values:
- yes : Subscribe - refresh failure
- no : Subscribe - refresh failure
Parameter type: <Alarm::subsinittimeout>
( yes
| no )
Possible values:
- yes : Subscribe - initial REQ timeout
- no : Subscribe - initial REQ timeout
Parameter type: <Alarm::emergencycall>
( yes
| no )
Possible values:
- yes : emergency call is ongoing
- no : emergency call is not ongoing
Parameter type: <Alarm::AddInfoString>
- additional alarm information

This element is only shown in


detail mode.
status of failure response from
server (invite).
This element is only shown in
detail mode.
status of failure response from
server (subscribe).
This element is only shown in
detail mode.
status of resolving domain name
(subscribe).
This element is only shown in
detail mode.
status
of
authentication(subscribe).
This element is only shown in
detail mode.
status of message timeout or 481
received (refresh subsrcibe).
This element is only shown in
detail mode.
status of message timeout (initial
subscribe).
This element is only shown in
detail mode.
status of emergency call.
This element is only shown in
detail mode.

Additional information regarding


the reg-srvfailresp alarm.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.33 Megaco Media Gateway Current Alarm Status


Command
Command Description
This command displays the Megaco media gateway current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current megaco-media-gw [ (index) ]

Command Parameters
Table 55.33-1 "Megaco Media Gateway Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.33-2 "Megaco Media Gateway Current Alarm Status Command" Display parameters
Specific Information
name
board-position

mgc-unreachable

failover-to-esamgc

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::mgcUnreachable>
( yes
| no )
Possible values:
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
Parameter type: <Alarm::failovertoESAMGC>

identify the board where the


alarm has occurred.
This element is only shown in
detail mode.

specifies the media gateway


controller is unreachable or not.
This element is only shown in
detail mode.
specifies

Released

the

media

1387

gateway

55 Current Alarm Status Commands

name

1388

Released

Type

Description

( yes
| no )
Possible values:
- yes : failover to esa mgc
- no : normal mgc is in service

failover to esa mgc or not.


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.34 Megaco Signaling Gateway Current Alarm


Status Command
Command Description
This command displays the Megaco signaling gateway current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current megaco-sig-gw [ (index) ]

Command Parameters
Table 55.34-1 "Megaco Signaling Gateway Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.34-2 "Megaco Signaling Gateway Current Alarm Status Command" Display parameters
Specific Information
name
board-position

sgc-unreachable

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::sgcUnreachable>
( yes
| no )
Possible values:
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable

identify the board where the


alarm has occurred.
This element is only shown in
detail mode.

specifies the signaling gateway


controller is unreachable or not.
This element is only shown in
detail mode.

Released

1389

55 Current Alarm Status Commands

55.35 Megaco Plugin Unit Current Alarm Status


Command
Command Description
This command displays the Megaco plugin unit current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current megaco-plug-unit [ (index) ]

Command Parameters
Table 55.35-1 "Megaco Plugin Unit Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.35-2 "Megaco Plugin Unit Current Alarm Status Command" Display parameters
Specific Information
name
board-position

lcard-unreach-srvcard

lcard-type-mismatch

1390

Released

Type

Description

Parameter type: <Equipm::PortSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Parameter type: <Alarm::lineCardUnreachSrvCard>
( yes
| no )
Possible values:
- yes : line card is unreachable with server card
- no : line card is reachable with server card
Parameter type: <Alarm::lineCardTypeMismathch>

identify the board where the


alarm has occurred.
This element is only shown in
detail mode.

specifies the line card is


unreachable with server card or
not.
This element is only shown in
detail mode.
specifies the line card type is

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : line card type is mismatch
- no : line card type is match

mismatch or not.
This element is only shown in
detail mode.

Released

1391

55 Current Alarm Status Commands

55.36 Megaco Termination Current Alarm Status


Command
Command Description
This command displays the Megaco termination current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current megaco-term [ (index) ]

Command Parameters
Table 55.36-1 "Megaco Termination Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.36-2 "Megaco Termination Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::MegacoPotsLine>


identify the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> / the port.
<Eqpt::MegacoPortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco
Parameter type: <Alarm::megacoUnknownSubscriber>
specifies the megaco subscriber is
( yes
unknown or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : unknown wrong megaco subscriber

meg-unknown-sub

1392

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
meg-ground-key

meg-high-temp

l1-act-fail

over-current

line-showering

low-qos-packetloss

low-qos-jitter

low-qos-delay

3HH-04416-EBAA-TCZZA 01

Type

Description

- no : no wrong megaco subscriber


Parameter type: <Alarm::voicePortGroundKey>
( yes
| no )
Possible values:
- yes : voice port ground key
- no : voice port not ground key
Parameter type: <Alarm::voicePortHighTemp>
( yes
| no )
Possible values:
- yes : voice port high temperature
- no : voice port not high temperature
Parameter type: <Alarm::voicePortL1ActFail>
( yes
| no )
Possible values:
- yes : voice port l1 act failure
- no : voice port l1 act not failure
Parameter type: <Alarm::voicePortOverCurrent>
( yes
| no )
Possible values:
- yes : voice port over current
- no : voice port not over current
Parameter type: <Alarm::lineshowering>
( yes
| no )
Possible values:
- yes : line showering
- no : no line showering
Parameter type: <Alarm::lowQosPacketLoss>
( yes
| no )
Possible values:
- yes : the total packet loss has exceeded the configured
threshold
- no : the total packet loss has not exceeded the configured
threshold
Parameter type: <Alarm::lowQosJitter>
( yes
| no )
Possible values:
- yes : the rtp jitter has exceeded the configured threshold
- no : the rtp jitter has not exceeded the configured threshold
Parameter type: <Alarm::lowQosDelay>
( yes
| no )
Possible values:
- yes : the rtp delay has exceeded the configured threshold
- no : the rtp delay has not exceeded the configured
threshold

specifies the voice port ground


key or not.
This element is only shown in
detail mode.
specifies the voice port high
temperature or not.
This element is only shown in
detail mode.
specifies the voice port l1 act
failure or not.
This element is only shown in
detail mode.
specifies the voice port over
current or not.
This element is only shown in
detail mode.
specifies the line showering or
not.
This element is only shown in
detail mode.
specifies the megaco total packet
loss has exceeded the configured
threshold or not.
This element is only shown in
detail mode.

specifies the megaco rtp jitter has


exceeded
the
configured
threshold or not.
This element is only shown in
detail mode.
specifies the megaco rtp delay
has exceeded the configured
threshold or not.
This element is only shown in
detail mode.

Released

1393

55 Current Alarm Status Commands

55.37 Megaco Signaling Lt Current Alarm Status


Command
Command Description
This command displays the Megaco signaling lt current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current megaco-sig-lt [ (index) ]

Command Parameters
Table 55.37-1 "Megaco Signaling Lt Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.37-2 "Megaco Signaling Lt Current Alarm Status Command" Display parameters
Specific Information
name
board-position

sig-brd-persist-loss

sig-brd-disk-full

1394

Released

Type

Description

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::megacoSigBoardPersDataLoss>
( yes
| no )
Possible values:
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
Parameter type: <Alarm::voiceSigBoard90PercentFull>

identify the board where the


alarm has occurred.
This element is only shown in
detail mode.

specifies the voice signaling


board persistenet data loss or not.
This element is only shown in
detail mode.
specifies

3HH-04416-EBAA-TCZZA

the

voice

01

signaling

55 Current Alarm Status Commands

name

sig-brd-db-rollback

mg-overload

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
board disk 90% full or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : specifies the voice signaling board disk 90% full
- no : specifies the voice signaling board disk no 90% full
Parameter type: <Alarm::sigBoardDBRollback>
specifies the voice signaling
( yes
board implicit db rollback or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : specifies the voice signaling board implicit db
rollback
- no : specifies the voice signaling board implicit db no
rollback
Parameter type: <Alarm::megMGOverLoad>
specifies the mg overload or not.
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : specifies the mg overload
- no : specifies the mg no overload

Released

1395

55 Current Alarm Status Commands

55.38 Shdsl Current Alarm Status Command


Command Description
This command displays the Shdsl current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current shdsl [ (index) ]

Command Parameters
Table 55.38-1 "Shdsl Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.38-2 "Shdsl Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValues>
identify where the alarm has
- a signed integer
occurred
This element is only shown in
detail mode.
Parameter type: <Alarm::LoopbackActiveNetwork>
current status of loopback active
( yes
at the network side
| no )
This element is only shown in
Possible values:
detail mode.

unit

loop-act-net

1396

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name
loop-act-cus

config-error

loss-atm

loss-pr

secu-error

dev-fault

atm-ncd

3HH-04416-EBAA-TCZZA 01

Type
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::LoopbackActiveCustom>
( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::ConfigError>
( yes
| no )
Possible values:
- yes : config error
- no : no config error
Parameter type: <Alarm::LossATMCellDel>
( yes
| no )
Possible values:
- yes : loss atm cell delineation
- no : no loss atm cell delineation
Parameter type: <Alarm::LossPowerSTUR>
( yes
| no )
Possible values:
- yes : loss power at stu-r
- no : no loss power at stu-r
Parameter type: <Alarm::UnableDisableSTUR>
( yes
| no )
Possible values:
- yes : loss ability at stu-r
- no : no loss ability at stu-r
Parameter type: <Alarm::DeviceFault>
( yes
| no )
Possible values:
- yes : device fault
- no : no device fault
Parameter type: <Alarm::ATMCellDel>
( yes
| no )
Possible values:
- yes : no atm cell delineation
- no : atm cell delineation

Description
current status of loopback active
at the custom side
This element is only shown in
detail mode.
current status of configuration
error
This element is only shown in
detail mode.
current status of loss of atm cell
delineation
This element is only shown in
detail mode.
current status of loss of power at
stu-r
This element is only shown in
detail mode.
current status of loss of ability to
disable stu-r access
This element is only shown in
detail mode.
current status of fault of device
This element is only shown in
detail mode.

current status of none of atm cell


delineation
This element is only shown in
detail mode.

Released

1397

55 Current Alarm Status Commands

55.39 Shdsl Current Alarm Status Command


Command Description
This command displays the Shdsl current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current shdsl-isam [ (index) ]

Command Parameters
Table 55.39-1 "Shdsl Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.39-2 "Shdsl Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValuesHigh>
identify where the alarm has
- identify where the alarm occurred
occurred
This element is only shown in
detail mode.
Parameter type: <Alarm::LinkDeviceValuesLow>
identify where the alarm has
- identify where the alarm occurred
occurred
This element is only shown in
detail mode.

wire-pair

unit

1398

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

loss-syn-net

Parameter type: <Alarm::LossSyncWordNetwork>


( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LossSyncWordCustom>
( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LoopAttenuationNetwork>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::LoopAttenuationCustom>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::SNRNetwork>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::SNRCustom>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::DCContinuityFaultNetwork>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::DCContinuityFaultCustom>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::ActivationFailureCustom>
( yes
| no )
Possible values:
- yes : activation failure
- no : no activation failure

current status of loss of sync


word at the network side on each
pair
This element is only shown in
detail mode.

loss-syn-cus

loop-att-net

loop-att-cus

snr-net

snr-cus

dc-net

dc-cus

act-fail-cus

3HH-04416-EBAA-TCZZA 01

current status of loss of sync


word at the custom side on each
pair
This element is only shown in
detail mode.
current status of loop attenuation
alarm at the network side on each
pair
This element is only shown in
detail mode.
current status of loop attenuation
alarm at the custom side on each
pair
This element is only shown in
detail mode.
current status of snr margin alarm
at the network side each pair
This element is only shown in
detail mode.
current status of snr margin alarm
at the custom side each pair
This element is only shown in
detail mode.
current status of dc continuity
fault at the network side on each
pair
This element is only shown in
detail mode.
current status of dc continuity
fault at the custom side on each
pair
This element is only shown in
detail mode.
current status of activation failure
at the custom side on each pair
This element is only shown in
detail mode.

Released

1399

55 Current Alarm Status Commands

55.40 Ima-Group Current Alarm Status Command


Command Description
This command displays the Ima-Group current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ima-group [ (index) ]

Command Parameters
Table 55.40-1 "Ima-Group Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.40-2 "Ima-Group Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Equipm::AtmImaIndex>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::FarEndStartup>
current status of far-end starting
( yes
up
| no )
This element is only shown in
Possible values:
detail mode.
- yes : far-end startup
- no : no far-end startup
Parameter type: <Alarm::FarEndFailedConfig>
current
status
of
failed
( yes
configuration of far-end

far-end-start

far-end-fconf

1400

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

near-end-fconf

far-end-ins-lnk

near-end-ins-lnk

far-end-blk

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : far-end failed config
- no : no far-end failed config
Parameter type: <Alarm::NearEndFailedConfig>
( yes
| no )
Possible values:
- yes : near-end failed config
- no : no near-end failed config
Parameter type: <Alarm::FarEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at far-end
- no : no insufficient number of links at far-end
Parameter type: <Alarm::NearEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at near-end
- no : no insufficient number of links at near-end
Parameter type: <Alarm::FarEndBlocked>
( yes
| no )
Possible values:
- yes : far-end blocked
- no : no far-end blocked

This element is only shown in


detail mode.
current
status
of
failed
configuration of near-end
This element is only shown in
detail mode.
current status of insufficient
number of links at far-end
This element is only shown in
detail mode.
current status of insufficient
number of links at near-end
This element is only shown in
detail mode.
current status of status that
far-end is blocked
This element is only shown in
detail mode.

Released

1401

55 Current Alarm Status Commands

55.41 Ima-Link Current Alarm Status Command


Command Description
This command displays the Ima-Link current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ima-link [ (index) ]

Command Parameters
Table 55.41-1 "Ima-Link Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.41-2 "Ima-Link Current Alarm Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LossImaFrame>
current status of loss of ima
( yes
frame
| no )
This element is only shown in
Possible values:
detail mode.
- yes : loss ima frame
- no : no loss ima frame
Parameter type: <Alarm::LinkOutofDelaySynch>
current status of link out of delay
( yes
synchronization

loss-ima-frm

lods

1402

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

link-misc

link-rfi

link-fault

fe-tx-blk

fe-rec-blk

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : link out of delay
- no : no link out of delay
Parameter type: <Alarm::LinkMisconnect>
( yes
| no )
Possible values:
- yes : link misconnect
- no : no link misconnect
Parameter type: <Alarm::LinkRemoteFailureIndication>
( yes
| no )
Possible values:
- yes : link remote failure indication
- no : no link remote failure indication
Parameter type: <Alarm::LinkFault>
( yes
| no )
Possible values:
- yes : fault in link facility
- no : no fault in link facility
Parameter type: <Alarm::FarEndTXBlocked>
( yes
| no )
Possible values:
- yes : transmit blocked due to far-end
- no : no transmit blocked due to far-end
Parameter type: <Alarm::FarEndRXBlocked>
( yes
| no )
Possible values:
- yes : receive blocked due to far-end
- no : no receive blocked due to far-end

This element is only shown in


detail mode.
current status of link of
misconnecting
This element is only shown in
detail mode.
current status of link of remote
failure indication
This element is only shown in
detail mode.
current status of fault of link
This element is only shown in
detail mode.

current status of transmit blocked


due to far-end
This element is only shown in
detail mode.
current status of receive blocked
due to far-end
This element is only shown in
detail mode.

Released

1403

55 Current Alarm Status Commands

55.42 Alarm Current Ether-Tca Status Command


Command Description
This command displays the Ether-Tca related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ether-tca [ (index) ]

Command Parameters
Table 55.42-1 "Alarm Current Ether-Tca Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.42-2 "Alarm Current Ether-Tca Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::EthernetPortIndex>


identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::EthTcaLos>
current status of ethernet los in 15
( yes
min
| no )
This element is only shown in
Possible values:
detail mode.
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
Parameter type: <Alarm::EthTcaFcs>
current status of ethernet fcs in 15
( yes
min

etca-los

etca-fcs

1404

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

etca-rx-octets

etca-tx-octets

etca-day-los

etca-day-fcs

etca-day-rx-octets

etca-day-tx-octets

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : ethernet frame check sequence errors exceeds
- no : ethernet frame check sequence errors normal
Parameter type: <Alarm::EthTcaRxb>
( yes
| no )
Possible values:
- yes : received octets exceeds
- no : received octets normal
Parameter type: <Alarm::EthTcaTxb>
( yes
| no )
Possible values:
- yes : transmitted octets exceeds
- no : transmitted octets normal
Parameter type: <Alarm::EthDayLos>
( yes
| no )
Possible values:
- yes : ethernet day los errors exceeds
- no : ethernet day los errors normal
Parameter type: <Alarm::EthDayFcs>
( yes
| no )
Possible values:
- yes : ethernet day fcs errors exceeds
- no : ethernet day fcs errors normal
Parameter type: <Alarm::EthDayRxb>
( yes
| no )
Possible values:
- yes : received octets day exceeds
- no : received octets day normal
Parameter type: <Alarm::EthDayTxb>
( yes
| no )
Possible values:
- yes : transmitted octets day exceeds
- no : transmitted octets day normal

This element is only shown in


detail mode.
current status of received octets
in 15 min
This element is only shown in
detail mode.
current status of transmitted
octets in 15 min
This element is only shown in
detail mode.
current status of ethernet day los
This element is only shown in
detail mode.

current status of ethernet day fcs


This element is only shown in
detail mode.

current status of received octets


in 1 day
This element is only shown in
detail mode.
current status of transmitted
octets in 1 day
This element is only shown in
detail mode.

Released

1405

55 Current Alarm Status Commands

55.43 Alarm Current Ether-Sfp Status Command


Command Description
This command displays the Ether-Sfp related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ether-sfp [ (index) ]

Command Parameters
Table 55.43-1 "Alarm Current Ether-Sfp Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.43-2 "Alarm Current Ether-Sfp Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::EthernetPortIndex>


identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::EthSfpLos>
current status of ethernet sfp los
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
Parameter type: <Alarm::EthSfpTxFail>
current status of ethernet sfp tx
( yes
This element is only shown in

sfp-los

sfp-tx-fail

1406

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

sfp-not-prst

sfp-inv-id

user-sfp-t-exceed

user-sfp-mismatch

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : ethernet sfp Tx Failure
- no : ethernet sfp Tx normal
Parameter type: <Alarm::EthSfpNotPrst>
( yes
| no )
Possible values:
- yes : ethernet sfp not detected
- no : ethernet sfp detected
Parameter type: <Alarm::EthSfpInvalid>
( yes
| no )
Possible values:
- yes : ethernet sfp id invalid
- no : ethernet sfp id normal
Parameter type: <Alarm::EthSfpTempExceed>
( yes
| no )
Possible values:
- yes : ethernet sfp temperature exceed
- no : ethernet sfp temperature normal
Parameter type: <Alarm::EthSfpMismatch>
( yes
| no )
Possible values:
- yes : ethernet sfp mismatch the configured type
- no : ethernet sfp match the configured type

detail mode.

current status of ethernet sfp


presence
This element is only shown in
detail mode.
current status of ethernet sfp id
This element is only shown in
detail mode.

current status of ethernet sfp


temperature
This element is only shown in
detail mode.
current status of ethernet sfp type
This element is only shown in
detail mode.

Released

1407

55 Current Alarm Status Commands

55.44 Alarm Current Qos Slot Status Command


Command Description
This command displays the Qos Slot related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current qos-slot [ (index) ]

Command Parameters
Table 55.44-1 "Alarm Current Qos Slot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.44-2 "Alarm Current Qos Slot Status Command" Display parameters
Specific Information
name
board-position

1408

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>

identify where the alarm has


occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

up-overflow

dw-overflow

upobc-overflow

dwobc-overflow

lwpriority-overflow

fanout

3HH-04416-EBAA-TCZZA 01

Type
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::up-overflow>
( yes
| no )
Possible values:
- yes : up overflow alarm
- no : no up overflow alarm
Parameter type: <Alarm::dw-overflow>
( yes
| no )
Possible values:
- yes : down overflow alarm
- no : no down overflow alarm
Parameter type: <Alarm::upobc-overflow>
( yes
| no )
Possible values:
- yes : up to obc overflow alarm
- no : no up to obc overflow alarm
Parameter type: <Alarm::dwobc-overflow>
( yes
| no )
Possible values:
- yes : down to obc overflow alarm
- no : no down to obc overflow alarm
Parameter type: <Alarm::lwpriority-overflow>
( yes
| no )
Possible values:
- yes : alarm
- no : no dying gasp alarm
Parameter type: <Alarm::fanout>
( yes
| no )
Possible values:
- yes : fan out alarm
- no : no fan out alarm

Description

check LT load in upstream.


This element is only shown in
detail mode.

check LT load in downstream.


This element is only shown in
detail mode.

check LT load to OBC in


upstream.
This element is only shown in
detail mode.
check LT load to OBC in
downstream.
This element is only shown in
detail mode.
check Voice and Video load.
This element is only shown in
detail mode.

check LT Load.
This element is only shown in
detail mode.

Released

1409

55 Current Alarm Status Commands

55.45 Alarm Current Qos Queue Status Command


Command Description
This command displays the Qos Queue related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current qos-queue [ (index) ]

Command Parameters
Table 55.45-1 "Alarm Current Qos Queue Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.45-2 "Alarm Current Qos Queue Status Command" Display parameters
Specific Information
name
port

1410

Type

Description

Parameter type: <Itf::PhyLine>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

Released

identifies the physical position of


/ the port
This element is only shown in
/ detail mode.
/
/
/
/

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

queue

queue-discard-overflow

queue-load

3HH-04416-EBAA-TCZZA 01

Type
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Qos::AlarmQueues>
- identify where the alarm has occurred
- range: [0...7]
Parameter type: <Alarm::queue-discard-overflow>
( yes
| no )
Possible values:
- yes : queue discard alarm
- no : no queue discard alarm
Parameter type: <Alarm::queue-load>
( yes
| no )
Possible values:
- yes : queue load alarm
- no : no queue load alarm

Description

identify where the alarm has


occurred.
This element is only shown in
detail mode.
check the corresponding queue
Load.
This element is only shown in
detail mode.
check the corresponding queue
Load.
This element is only shown in
detail mode.

Released

1411

55 Current Alarm Status Commands

55.46 Alarm File Transfer Server Status Command


Command Description
This command displays the file transfer server related current alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current filetransfer [ (index) ]

Command Parameters
Table 55.46-1 "Alarm File Transfer Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.46-2 "Alarm File Transfer Server Status Command" Display parameters
Specific Information
name
server-id

Description

Parameter type: <Alarm::FileTransfer>


- next hop IP address

identify where the alarm has


occurred.
This element is only shown in
detail mode.
Parameter type: <Alarm::FileTransferUnavial>
current status specifing that
( unavailable
whether file transfer server
| available )
available
Possible values:
This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available

fileserv-unavail

1412

Type

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.47 Alarm LSM Redundancy Status Command


Command Description
This command displays the LSM Redundancy related current alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current lsmredundancy [ (index) ]

Command Parameters
Table 55.47-1 "Alarm LSM Redundancy Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.47-2 "Alarm LSM Redundancy Status Command" Display parameters
Specific Information
name
board-station

loss-lsmswp-cap

inv-xvps-pair-data

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::SwoCap>
( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::DataXvps>
( invalid
| valid )
Possible values:

physical number of the slot for


lsm redundancy alarms
This element is only shown in
detail mode.

current status specifing the


switchover capability
This element is only shown in
detail mode.
log status of the data of xvps pair
This element is only shown in
detail mode.

Released

1413

55 Current Alarm Status Commands

name

Type

Description

- invalid : data of xvps pair is not the same


- valid : data of xvps pair is same

1414

Released

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.48 Alarm L2 Forward Status Command


Command Description
This command displays the l2 forward related current alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current l2forward [ (index) ]

Command Parameters
Table 55.48-1 "Alarm L2 Forward Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.48-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name
bridgeport

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::BridgePort>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identify the bridge port where the


/ alarm has occurred.
This element is only shown in
/ detail mode.
/
/
/
/
/

Released

1415

55 Current Alarm Status Commands

name

Type

vlan-id

mac-conflict

vmac-full

1416

Description

Field type <Eqpt::PortId>


- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlanSigned>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Alarm::MACconflict>
( yes
| no )
Possible values:
- yes : duplicate mac address from this bridge port
- no : no duplicate mac address from this bridge port
Parameter type: <Alarm::VMACFull>
( yes
| no )
Possible values:
- yes : virtual mac entry full on this bridge port
- no : no virtual mac entry full on this bridge port

Released

identify the vlan id where the


alarm has occurred.
This element is only shown in
detail mode.

specifies whether duplicate mac


address from the bridge port.
This element is only shown in
detail mode.
specifies whether virtual mac is
full on the bridge port.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.49 Alarm Current External Device Status


Command
Command Description
This command displays the external-device related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current external-device [ (index) ]

Command Parameters
Table 55.49-1 "Alarm Current External Device Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.49-2 "Alarm Current External Device Status Command" Display parameters
Specific Information
name
loss-env-mon

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::LossEnvMon>


( lost
| not-lost )
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists

current status of env-monitor box


This element is only shown in
detail mode.

Released

1417

55 Current Alarm Status Commands

55.50 Sync Clock Current Alarm Status Command


Command Description
This command displays the synce and bits current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sync [ (index) ]

Command Parameters
Table 55.50-1 "Sync Clock Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 55.50-2 "Sync Clock Current Alarm Status Command" Display parameters
Only Show Details: slot information
name
Type
slot

port

1418

Description

Parameter type: <Alarm::SynceSlot>


( ntio-1
| ntio-2
| nt-a
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot for bits
- nt : active nt slot
- not-used : no interface
Parameter type: <Alarm::SyncePort>
( sfp : <Alarm::SynceClk>
| xfp : <Alarm::SynceClk>

Released

identifies the synce port where


the alarm has occurred.
This element is only shown in
detail mode.

identifies the synce port where


the alarm has occurred.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

Type

Description

| bits-a
| bits-b
| ieee1588-a
| not-used
| ieee1588-b )
Possible values:
- sfp : synce reference on sfp port
- xfp : synce reference on xfp port
- bits-a : bits clock source on nt-a
- bits-b : bits clock source on nt-b
- ieee1588-a : ieee1588 clock source on nt-a
- ieee1588-b : ieee1588 clock source on nt-b
- not-used : not-used
Field type <Alarm::SynceClk>
- value
- range: [0...16]

detail mode.

Only Show Details: current and previous alarm log status


name
Type
bits-fail

synce-fail

bits-output-shutoff

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::BitsFail>


( yes
| no )
Possible values:
- yes : bits source failed
- no : no bits source failed
Parameter type: <Alarm::SynceFail>
( yes
| no )
Possible values:
- yes : synce source failed
- no : no synce source failed
Parameter type: <Alarm::BitsOutputShutoffFail>
( yes
| no )
Possible values:
- yes : bits output shutoff
- no : no bits output shutoff

Description
specifies whether bits clock
source has failed or not
This element is only shown in
detail mode.
specifies whether synce clock
source has failed or not
This element is only shown in
detail mode.
specifies whether bits output
failed or not
This element is only shown in
detail mode.

Released

1419

55 Current Alarm Status Commands

55.51 LT Cfm Current Alarm Status Command


Command Description
This command displays lt cfm current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current cfm [ (index) ]

Command Parameters
Table 55.51-1 "LT Cfm Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 55.51-2 "LT Cfm Current Alarm Status Command" Display parameters
Specific Information
name

Type

Description

cfm-mep-id

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

cfm-unique-id

Parameter type: <Alarm::IdentificationIdxOrZero>


- a signed integer

additional-info

Parameter type: <PrintableString>


- printable string

dot1agCfmMepIdentifier index
where the alarm has occurred.
This element is only shown in
detail mode.
unique identification for the
alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
Additional information regarding
the cfm alarm
This element is only shown in
detail mode.

Only Show Details: current alarm status


name
Type
cfm-defrdiccm

1420

Parameter type: <Alarm::IacmCfmRdiCcm>


( yes
| no )

Released

Description
specifies rdi bit in ccm received
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

cfm-defmacstatus

cfm-defremoteccm

cfm-deferrorccm

cfm-defxconccm

3HH-04416-EBAA-TCZZA 01

Type
Possible values:
- yes : rdi bit in ccm received
- no : no rdi bit in ccm received
Parameter type: <Alarm::IacmCfmMacError>
( yes
| no )
Possible values:
- yes : mac error status
- no : no mac error status
Parameter type: <Alarm::IacmCfmMepCcm>
( yes
| no )
Possible values:
- yes : missing ccm from mep
- no : no missing ccm from mep
Parameter type: <Alarm::IacmCfmInvalidCcm>
( yes
| no )
Possible values:
- yes : invalid ccm received
- no : no invalid ccm received
Parameter type: <Alarm::IacmCfmUnexpectedCcm>
( yes
| no )
Possible values:
- yes : unexpected ccm received
- no : no unexpected ccm received

Description

ccm mac error status


This element is only shown in
detail mode.

specifies missing ccm from mep


This element is only shown in
detail mode.

specifies invalid ccm received


This element is only shown in
detail mode.

specifies
unexpected
ccm
received
This element is only shown in
detail mode.

Released

1421

55 Current Alarm Status Commands

55.52 EFM-OAM Current Alarm Status Command


Command Description
This command displays the EFM-OAM current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current efm-oam [ (index) ]

Command Parameters
Table 55.52-1 "EFM-OAM Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

current alarm index

Command Output
Table 55.52-2 "EFM-OAM Current Alarm Status Command" Display parameters
Specific Information
name
last-updated-on

Type

network time in seconds when


the alarm was logged.
This element is only shown in
detail mode.
Parameter type: <Itf::EfmEthernetIndex>
identifies the line where the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

line

Only Show Details: current alarm status


name
Type
link-fault

1422

Description

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Parameter type: <Alarm::linkFaultType>


( yes

Released

Description
Link fault at cpe
This element is only shown in

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

name

dying-gasp

critical-event

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : link fault at cpe/onu
- no : link fault is not exist
Parameter type: <Alarm::dyingGaspType>
( yes
| no )
Possible values:
- yes : dying gasp is exist
- no : dying gasp is not exist
Parameter type: <Alarm::criticalEventType>
( yes
| no )
Possible values:
- yes : critical event is exist
- no : critical event is not exist

detail mode.

received dying gasp indication


from cpe
This element is only shown in
detail mode.
receive critical event indication
from cpe
This element is only shown in
detail mode.

Released

1423

55 Current Alarm Status Commands

55.53 Alarm Table Current Alarm Status Command


Command Description
This command displays the alarm-table current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current alarm-table [ (index) ]

Command Parameters
Table 55.53-1 "Alarm Table Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.53-2 "Alarm Table Current Alarm Status Command" Display parameters
Specific Information
name
alrm-tbl-overflow

1424

Released

Type

Description

Parameter type: <Alarm::AlrmTblOflow>


( overflow
| no-overflow )
Possible values:
- overflow : alarm table overflow
- no-overflow : no alarm table overflow

identify if the alarm table has


overflowed
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

55 Current Alarm Status Commands

55.54 Auto-Switch Current Alarm Status Command


Command Description
This command displays the auto-switch current alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current auto-switch [ (index) ]

Command Parameters
Table 55.54-1 "Auto-Switch Current Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 55.54-2 "Auto-Switch Current Alarm Status Command" Display parameters
Specific Information
name
port

auto-switch-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::XdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::autoSwitchStatus>
show auto-switch alarm status.
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : auto-switch alarm status
- no : auto-switch alarm status clear

Released

1425

56- Alarm Snap-shot Status Commands

56.1 Alarm Snap-shot Status Command Tree


56.2 Alarm Snapshot Status Command
56.3 Alarm Snapshot Equipment Status Command
56.4 Equipment Holder Alarm Log Status Command
56.5 Equipment Holder Alarm Extended Log Status
Command
56.6 Plug-in Unit Alarm Log Status Command
56.7 ATM Alarm Log Status Command
56.8 Alarm Snapshot Ethernet Interface Status Command
56.9 Alarm Snapshot Software Management Status
Command
56.10 Alarm Snapshot Temporal Filter Status Command
56.11 Alarm Snapshot Spatial Filter Status Command
56.12 Alarm xDSL Snapshot Status Command
56.13 TCA xDSL Alarm Log Status Command
56.14 Alarm Vectoring Line Snapshot Status Command
56.15 Alarm Vectoring Board Snapshot Status Command
56.16 Alarm Electrical-to-Optical Conversion for Snapshot
Status Command
56.17 Authentication Alarms for Snapshot Status
Command
56.18 Alarm xDSL Bonding Snap Shot Status Command
56.19 Alarm Redundancy Snapshot Status Command
56.20 Alarm Custom Snapshot Status Command
56.21 Alarm SFP Snapshot Status Command
56.22 Alarm Custom External Snap Shot Status Command
56.23 Alarm RSSI SFP Snapshot Status Command
56.24 Alarm PPP Cross-Connect Engine TCA Snapshot
Status Command
56.25 2xE1/DS1 SFP Clock Snapshot Status Command
56.26 2xE1/DS1 SFP Framer Snapshot Status Command
56.27 Alarm Plug In Unit Extended Snap Shot Status
Command
56.28 Alarm Snap-shot SIP Server Status Command
56.29 Alarm Snap-shot SIP VSP Status Command
56.30 Alarm Snap-shot SIP Dial Plan Status Command
56.31 Alarm Snap-shot SIP Slot Status Command
56.32 Alarm Snap-shot SIP Termination Status Command
56.33 Alarm Snap-shot Megaco Media Gateway Status
Command
56.34 Alarm Snap-shot Megaco Signaling Gateway Status
Command
56.35 Alarm Snap-shot Megaco Plug Unit Status Command
56.36 Alarm Snap-shot Megaco Termination Status
Command
56.37 Alarm Snap-shot Megaco Signaling Lt Status
Command
56.38 Alarm Snap-shot Shdsl Status Command
56.39 Alarm Snap-shot Shdsl Status Command
56.40 Alarm Snap-shot Ima-Group Status Command

1426

Released

56-1428
56-1431
56-1435
56-1437
56-1439
56-1442
56-1445
56-1447
56-1448
56-1450
56-1454
56-1458
56-1462
56-1466
56-1468
56-1470
56-1471
56-1472
56-1475
56-1476
56-1479
56-1483
56-1485
56-1489
56-1491
56-1494
56-1498
56-1501
56-1502
56-1504
56-1505
56-1506
56-1509
56-1510
56-1511
56-1512
56-1514
56-1516
56-1518
56-1520

3HH-04416-EBAA-TCZZA

01

56.41 Alarm Snap-shot Ima-Link Status Command


56.42 Alarm Snap-shot Ether-Tca Status Command
56.43 Alarm Snap-shot Ether-Sfp Status Command
56.44 Alarm Snap-shot SIP Termination Status Command
56.45 Alarm Snap-shot SIP Termination Status Command
56.46 Alarm File Transfer Server Status Command
56.47 Alarm Lsm Redundancy Status Command
56.48 Alarm L2 Forward Status Command
56.49 Alarm Snap-shot External Device Status Command
56.50 Sync Clock Alarm SnapShot Status Command
56.51 LT CFM Alarm SnapShot Status Command
56.52 EFM-OAM alarm Snap-shot Status Command
56.53 Alarm Table Snapshot Status Command
56.54 Auto-Switch Alarm Snapshot Status Command

3HH-04416-EBAA-TCZZA 01

56-1522
56-1524
56-1526
56-1528
56-1530
56-1532
56-1533
56-1535
56-1537
56-1538
56-1540
56-1542
56-1544
56-1545

Released

1427

56 Alarm Snap-shot Status Commands

56.1 Alarm Snap-shot Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Alarm Snap-shot Status Commands".

Command Tree
----show
----alarm
----snap-shot
----table
- (index)
----equipment
- (index)
----eqpt-holder
- (index)
----eqpt-holder-ext
- (index)
----plug-in-unit
- (index)
----atm
- (index)
----ether-itf
- (index)
----sw-mgmt
- (index)
----temporal
- (index)
----spatial
- (index)
----xdsl
- (index)
----xdsl-tca
- (index)
----vect-line
- (index)
----vect-board
- (index)
----eo-conversion
- (index)
----authentication
- (index)
----bonding-group
- (index)
----redundancy
- (index)
----custom
- (index)
----sfp
- (index)
----custom-ext-alarm
- (index)
----sfprssi

1428

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

- (index)
----pppcc-engine-tca
- (index)
----sfpe1t1-clock
- (index)
----sfpe1t1-framer
- (index)
----plug-in-unit-ext
- (index)
----sip-server
- (index)
----sip-vsp
- (index)
----sip-dial-plan
- (index)
----sip-plugin-unit
- (index)
----sip-termination
- (index)
----megaco-media-gw
- (index)
----megaco-sig-gw
- (index)
----megaco-plug-unit
- (index)
----megaco-term
- (index)
----megaco-sig-lt
- (index)
----shdsl
- (index)
----shdsl-isam
- (index)
----ima-group
- (index)
----ima-link
- (index)
----ether-tca
- (index)
----ether-sfp
- (index)
----qos-slot
- (index)
----qos-queue
- (index)
----filetransfer
- (index)
----lsmredundancy
- (index)
----l2forward
- (index)
----external-device
- (index)
----sync
- (index)
----cfm
- (index)
----efm-oam
- (index)

3HH-04416-EBAA-TCZZA 01

Released

1429

56 Alarm Snap-shot Status Commands

----alarm-table
- (index)
----auto-switch
- (index)

1430

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.2 Alarm Snapshot Status Command


Command Description
This command displays the snapshot alarm entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot table [ (index) ]

Command Parameters
Table 56.2-1 "Alarm Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.2-2 "Alarm Snapshot Status Command" Display parameters
Common Information:general information
name
Type
timeout-period
entries
indeterminate

warning

minor

3HH-04416-EBAA-TCZZA 01

Parameter type: <IgnoredTimeTicks>


- a timeout value
- unit: msec
Parameter type: <IgnoredGauge>
- gauge
Parameter type: <Alarm::IndetSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::WarnSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::MinorSevState>

Description
specifies the time out of the
snapshot table
This element is always shown.
specifies nbr of entries in the
snapshot table.
This element is always shown.
active indeterminate severity
levels of the alarms in the
snapshot table.
This element is always shown.
active warning severity levels of
the alarms in the snapshot table.
This element is always shown.

active minor severity levels of the

Released

1431

56 Alarm Snap-shot Status Commands

name

major

critical

owner-id

Specific Information
name
type

1432

Released

Type

Description

( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::MajorSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::CriticalSevState>
( active
| not-active )
Possible values:
- active : at least one entry of this severity is present
- not-active : no entries of this severity
Parameter type: <Alarm::alarmSnapShotOwner>
- string to identify the owner (example: Tom),the string
should has less than or equal to 128 characters

alarms in the snapshot table.


This element is always shown.

Type

Description

Parameter type: <Alarm::alarmType>


( equipment
| eqpt-holder
| plug-in-unit
| atm
| custom
| ima-group
| ima-link
| redundancy
| shdsl
| ether-itf
| traffic-overflow
| qos-queue
| temporal
| spatial
| ( software-mngt | sw-mgmt )
| xdsl
| xdsl-tca
| eo-conv
| authentication
| bonding
| sfp
| shdsl-isam
| custom-ext-alarm
| plug-in-unit-ext
| sip-user-agent
| sip-plugin-unit
| sip-termination
| filetransfer
| external-device
| l2forward
| ether-tca
| ether-sfp
| megaco-media-gw
| megaco-sig-gw

unique id for an alarm.


This element is always shown.

active major severity levels of the


alarms in the snapshot table.
This element is always shown.

active critical severity levels of


the alarms in the snapshot table.
This element is always shown.

the actual owner of the snap-shot


This element is always shown.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

| megaco-plug-unit
| megaco-term
| megaco-sig-lt
| eqpt-holder-ext
| lsmredundancy
| sync
| vect-line
| vect-board
| sip-dial-plan
| sip-vsp
| sip-server
| sfprssi
| sfpe1t1-framer
| sfpe1t1-clock
| pppcc-engine-tca
| cfm
| efm-oam
| alarm-table
| auto-switch )
Possible values:
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plug-in-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- ima-group : ima-group alarms
- ima-link : ima-link alarms
- redundancy : redundancy alarms
- shdsl : shdsl alarms
- ether-itf : ethernet interface alarms
- traffic-overflow : Traffic overflow alarms
- qos-queue : qos queue alarms
- temporal : temporal alarms
- spatial : spatial alarms
- software-mngt : software management alarms
- sw-mgmt : software management alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related alarms
- bonding : bonding-group related alarms
- sfp : SFP related alarms
- shdsl-isam : shdsl isam alarms
- custom-ext-alarm : customizable external alarms
- plug-in-unit-ext : other plugin unit alarms
- sip-user-agent : sip user agent related alarms
- sip-plugin-unit : sip plug in unit related alarms
- sip-termination : sip termination related alarms
- filetransfer : file transfer server alarms
- external-device : external device related alarms
- l2forward : l2forward related alarms
- ether-tca : ethernet threshold cross alarms
- ether-sfp : ethernet SFP related alarms
- megaco-media-gw : megaco media gateway related alarms
- megaco-sig-gw : megaco signaling gateway related alarms
- megaco-plug-unit : megaco plug unit related alarms
- megaco-term : megaco termination related alarms

3HH-04416-EBAA-TCZZA 01

Released

1433

56 Alarm Snap-shot Status Commands

name

Type

last-updated-on

1434

Description

- megaco-sig-lt : megaco signaling lt related alarms


- eqpt-holder-ext : other equipment holder alarms
- lsmredundancy : lsm redundancy alarms
- sync : synce and bits alarms
- vect-line : xDSL vectoring line alarms
- vect-board : xDSL vectoring board alarms
- sip-dial-plan : sip dial plan related alarms
- sip-vsp : sip vsp related alarms
- sip-server : sip server related alarms
- sfprssi : SFP RSSI related alarms
- sfpe1t1-framer : SFP 2e1t1 framer alarms
- sfpe1t1-clock : SFP 2e1t1 clock alarms
- pppcc-engine-tca : PPPOE Cross Connect Engine TCA
related alarm
- cfm : Cfm related alarms
- efm-oam : EFM-OAM related alarms
- alarm-table : alarm table related alarms
- auto-switch : auto-switch related alarms
Parameter type: <Sys::timeInSecs>
network time in seconds when
- the time (yyyy-mm-dd:hour:minutes:secs)
the alarm was logged.
- unit: UTC
This element is always shown.

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.3 Alarm Snapshot Equipment Status Command


Command Description
This command displays the equipment snapshot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot equipment [ (index) ]

Command Parameters
Table 56.3-1 "Alarm Snapshot Equipment Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.3-2 "Alarm Snapshot Equipment Status Command" Display parameters
Specific Information
name
persist-data

sntp-comm

nt-disk

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::persistDataLoss>


( lost
| not-lost )
Possible values:
- lost : persistant data is lost
- not-lost : persistant data is not lost
Parameter type: <Alarm::sntpCommLoss>
( lost
| not-lost )
Possible values:
- lost : SNTP communication lost
- not-lost : SNTP communication is not lost
Parameter type: <Alarm::ntDiskSpace>
( ( nintyfive-perc | 95%-full )
| ( less-nintyfive-perc | less-than-95% ) )
Possible values:
- nintyfive-perc : NT disk space is 95% full
- 95%-full : NT disk space is 95% full
- less-nintyfive-perc : NT disk space usage less that 95%

current status specifing persistant


data is lost or not
This element is only shown in
detail mode.
current
status
of
sntp
communication is lost or not
This element is only shown in
detail mode.
current status of nt disk space is
95% full or less than that
This element is only shown in
detail mode.

Released

1435

56 Alarm Snap-shot Status Commands

name

Type

preferred-mode

timing-reference

connection-lost

back-pnl-inv
short name: bpnl-inv

shub-conf-lost

1436

Released

Description

- less-than-95% : NT disk space usage less that 95%


Parameter type: <Alarm::clkPrefMode>
( not-available
| available )
Possible values:
- not-available : Preferred timing mode is not available
- available : Preferred Timing mode available
Parameter type: <Alarm::clkFreeMode>
( failed
| available )
Possible values:
- failed : System is in holdover or free-run mode
- available : System is not in holdover or free-run mode
Parameter type: <Alarm::ShubLoc>
( lost
| not-lost )
Possible values:
- lost : NT shub communication lost
- not-lost : NT shub communication intact
Parameter type: <Alarm::BackPnlInv>
( invalid
| valid )
Possible values:
- invalid : BackPanel-type Invalid
- valid : BackPanel-type Valid
Parameter type: <Alarm::SHubCfgLost>
( lost
| not-lost )
Possible values:
- lost : SHub configuration loss - recent changes lost
- not-lost : SHub configuration up to date

current status of preferred timing


mode
This element is only shown in
detail mode.
shows the availability or failure
of timing reference
This element is only shown in
detail mode.
current status of nt shub
communication is lost or intact
This element is only shown in
detail mode.
current status of BackPanel-type
Invalid alarm.
This element is only shown in
detail mode.
actual shub configuration may
differ from lanx database on nt
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.4 Equipment Holder Alarm Log Status


Command
Command Description
This command displays the snapshot equipment holder alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot eqpt-holder [ (index) ]

Command Parameters
Table 56.4-1 "Equipment Holder Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.4-2 "Equipment Holder Alarm Log Status Command" Display parameters
Specific Information
name
shelf

rack-power

fan-unit1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::rackPower>
( failing
| ok )
Possible values:
- failing : the fuse is broken
- ok : the fuse is intact
Parameter type: <Alarm::fanUnit1>
( ( failing | fail )
| ok )
Possible values:

specify which shelf the alarm


occurred on.
This element is only shown in
detail mode.
current status of rack power
alarm, indicating fuse is broken
or intact
This element is only shown in
detail mode.
current status of fan-unit1
This element is only shown in
detail mode.

Released

1437

56 Alarm Snap-shot Status Commands

name

Type

fan-unit2

shelf-type-mismatch

shelf-missing

shelf-install-missing

door

ac-power-fail

1438

Description

- failing : fan unit 1 is failing


- fail : fan unit 1 is failing
- ok : fan unit 1 is ok
Parameter type: <Alarm::fanUnit2>
( ( failing | fail )
| ok )
Possible values:
- failing : fan unit 2 is failing
- fail : fan unit 2 is failing
- ok : fan unit 2 is ok
Parameter type: <Alarm::shelfTypeMismatch>
( mismatch
| no-mismatch )
Possible values:
- mismatch : installed and planned shelf types are different
- no-mismatch : installed and planned shelf types are the
same
Parameter type: <Alarm::shelfMissing>
( missing
| not-missing )
Possible values:
- missing : detected shelf now missing
- not-missing : detected shelf was missing, now reinserted
Parameter type: <Alarm::shelfInstall>
( yes
| no )
Possible values:
- yes : shelf now installed
- no : shelf now not installed
Parameter type: <Alarm::door>
( ( failing | fail )
| ok )
Possible values:
- failing : the cabinet door is opened
- fail : the cabinet door is opened
- ok : the cabinet door is closed
Parameter type: <Alarm::acPowerFail>
( ( failing | fail )
| ok )
Possible values:
- failing : system AC power fails
- fail : system AC power fails
- ok : the system AC power works properly

Released

current status of fan-unit2


This element is only shown in
detail mode.

current status specifies installed


and planned shelf types are
different
This element is only shown in
detail mode.
current status specifies once
inserted shelf has gone missing
This element is only shown in
detail mode.
current status specifies shelf is
planned but not installed
This element is only shown in
detail mode.
current status of door alarm,
indicating the cabinet door is
opened
This element is only shown in
detail mode.
current status of AC power
failure alarm, indicating the AC
Power is broken
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.5 Equipment Holder Alarm Extended Log Status


Command
Command Description
This command displays the snapshot equipment holder extended alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot eqpt-holder-ext [ (index) ]

Command Parameters
Table 56.5-1 "Equipment Holder Alarm Extended Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.5-2 "Equipment Holder Alarm Extended Log Status Command" Display parameters
Specific Information
name
shelf

ctl-com-fail

bat-a-fail

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::Shelf>


<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::ctlComFail>
( ( failing | fail )
| ok )
Possible values:
- failing : shelf controller communication is failing
- fail : shelf controller communication is failing
- ok : shelf controller communication is ok
Parameter type: <Alarm::batAFail>
( yes
| no )

specify which shelf the alarm


occurred on.
This element is only shown in
detail mode.
status
of
shelf
controller
communication failure.
This element is only shown in
detail mode.

status of shelf power source A


failure.
This element is only shown in

Released

1439

56 Alarm Snap-shot Status Commands

name

bat-b-fail

network-power-loss

hw-fault

network-power-loss-b

sem-ac-power-fail

sem-ups-fail

dc-a-fail

plan-power-mismatch

1440

Released

Type

Description

Possible values:
- yes : Power Source Battery A Failure
- no : Power Source Battery A is OK
Parameter type: <Alarm::batBFail>
( yes
| no )
Possible values:
- yes : Power Source Battery B Failure
- no : bfd stale entry not present
Parameter type: <Alarm::netPwrFail>
( ( failing | fail )
| ok )
Possible values:
- failing : network power is failing
- fail : network power is failing
- ok : network power is ok
Parameter type: <Alarm::hwFail>
( ( failing | fail )
| ok )
Possible values:
- failing : hardware is failing
- fail : hardware is failing
- ok : hardware is ok
Parameter type: <Alarm::netPwrFailB>
( ( failing | fail )
| no )
Possible values:
- failing : network power B is failing
- fail : network power B is failing
- no : network power B is ok
Parameter type: <Alarm::semAcPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : AC power input is failing
- fail : AC power input is failing
- no : AC power input is ok
Parameter type: <Alarm::semUpsFail>
( low
| no )
Possible values:
- low : voltage level low
- no : voltage level is ok
Parameter type: <Alarm::dcAPwrFail>
( ( failing | fail )
| no )
Possible values:
- failing : Local DC A power input is failing
- fail : Local DC A power input is failing
- no : Local DC A power input is ok
Parameter type: <Alarm::planPwrMismatch>
( mismatch
| no )
Possible values:
- mismatch : detected and planned power mode are in
mismatch
- no : planned and detected power mode are identic

detail mode.
status of shelf power source B
failure.
This element is only shown in
detail mode.
status of network power failure.
This element is only shown in
detail mode.

status of hardware failure.


This element is only shown in
detail mode.

network power b failure.


This element is only shown in
detail mode.

external ac power supply failure.


This element is only shown in
detail mode.

external power supply failure.


This element is only shown in
detail mode.

local DC A power failure.


This element is only shown in
detail mode.

detected and planned power


mode mismatch failure.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1441

56 Alarm Snap-shot Status Commands

56.6 Plug-in Unit Alarm Log Status Command


Command Description
This command displays the snapshot plug-in unit alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot plug-in-unit [ (index) ]

Command Parameters
Table 56.6-1 "Plug-in Unit Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.6-2 "Plug-in Unit Alarm Log Status Command" Display parameters
Specific Information
name
board-position

1442

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>

identify where the alarm has


occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

board-mismatch

sw-download

temperature

temp-shutoff

sem-power-fail

sem-ups-fail

board-present

board-inserted

board-init

3HH-04416-EBAA-TCZZA 01

Type

Description

- the rack number


Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::boardMismatch>
( yes
| no )
Possible values:
- yes : planned and plugged-in types are different
- no : planned and plugged-in types are same
Parameter type: <Alarm::swStatus>
( waiting
| completed )
Possible values:
- waiting : not able to download all the applicable SW files
- completed : download completed
Parameter type: <Alarm::tempStatus>
( above-thres
| below-thres )
Possible values:
- above-thres : temperature threshold on board exceeded
- below-thres : board temperature within threshold
Parameter type: <Alarm::tempShutoffStatus>
( board-switched-off
| board-switched-on )
Possible values:
- board-switched-off : board switched off - excess
temperature
- board-switched-on : board switched on
Parameter type: <Alarm::extPowerStatus>
( sem-power-fail
| sem-power-ok )
Possible values:
- sem-power-fail : SEM external power failure
- sem-power-ok : SEM external power ok
Parameter type: <Alarm::powerSupplyStatus>
( sem-ups-fail
| sem-ups-ok )
Possible values:
- sem-ups-fail : SEM external power supply failure
- sem-ups-ok : SEM external power supply ok
Parameter type: <Alarm::boardPresence>
( missing
| yes )
Possible values:
- missing : board was present, but now missing
- yes : board present
Parameter type: <Alarm::boardInsertion>
( never-inserted
| inserted )
Possible values:
- never-inserted : board was never inserted
- inserted : board was inserted
Parameter type: <Alarm::boardInit>

alarm specifing the planned and


plugged-in types are different
This element is only shown in
detail mode.
alarm specifing download of the
software is completed or not.
This element is only shown in
detail mode.
alarm
specifing
board
temperature is crossed the
threshold or not.
This element is only shown in
detail mode.
alarm specifing board is swiched
off
because
of
excess
temperature.
This element is only shown in
detail mode.
alarm specifing SEM external
power failure.
This element is only shown in
detail mode.
alarm specifing SEM external
power supply failure.
This element is only shown in
detail mode.
indicates the presence of the
board.
This element is only shown in
detail mode.
indicates the status of board was
inserted or not.
This element is only shown in
detail mode.
specifies board initializaion is

Released

1443

56 Alarm Snap-shot Status Commands

name

board-reset-cf

shub-uplink

1444

Released

Type

Description

( failed
| completed )
Possible values:
- failed : board initialization failed
- completed : board initialization completed
Parameter type: <Alarm::boardResetCommFail>
( yes
| ok )
Possible values:
- yes : board reset/communication failure occurred
- ok : no board reset/communication failure
Parameter type: <Alarm::lanxuplinkbrkdwn>
( failure
| ok )
Possible values:
- failure : lanx uplink breakdown or removal
- ok : no breakdown or removal of lanx uplink

sucessful or failed.
This element is only shown in
detail mode.
indicates there has been a reset
and/or communication failure of
the board.
This element is only shown in
detail mode.
indicates that lanx uplink
breakdown or removal.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.7 ATM Alarm Log Status Command


Command Description
This command displays the ATM alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot atm [ (index) ]

Command Parameters
Table 56.7-1 "ATM Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.7-2 "ATM Alarm Log Status Command" Display parameters
Specific Information
name
port

vpi-vci

cell-discard-up

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::AtmIndex>


identify where the alarm has
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::VpiVciValues>
identify where the alarm has
- the vpi and vci value (vpi/vci)
occurred.
This element is only shown in
detail mode.
Parameter type: <Alarm::CellDiscardUpstream>
specifies ATM cell is discarded
( discarded
or not in upstream direction.
| no-discard )
This element is only shown in
Possible values:
detail mode.

Released

1445

56 Alarm Snap-shot Status Commands

name

Type

cell-discard-down

1446

Description

- discarded : ATM cell discarded in upstream direction


- no-discard : no ATM cell discarded in upstream direction
Parameter type: <Alarm::CellDiscardDownstream>
( discarded
| no-discard )
Possible values:
- discarded : ATM cell discarded in downstream direction
- no-discard : no ATM cell discarded in downstream
direction

Released

specifies ATM cell is discarded


or not in downstream direction.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.8 Alarm Snapshot Ethernet Interface Status


Command
Command Description
This command displays the current Ethernet interface alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ether-itf [ (index) ]

Command Parameters
Table 56.8-1 "Alarm Snapshot Ethernet Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.8-2 "Alarm Snapshot Ethernet Interface Status Command" Display parameters
Specific Information
name
ether-ifindex

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ether::InterfaceIndex>


- index of the collision interface
- range: [0...2147483647]

identify where the alarm has


occurred.
This element is only shown in
detail mode.

Released

1447

56 Alarm Snap-shot Status Commands

56.9 Alarm Snapshot Software Management Status


Command
Command Description
This command displays the snapshot software management status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sw-mgmt [ (index) ]

Command Parameters
Table 56.9-1 "Alarm Snapshot Software Management Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.9-2 "Alarm Snapshot Software Management Status Command" Display parameters
Specific Information
name
board-position

1448

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identifies the physical position of


the slot
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

sw-rollback

db-rollback

xvps-inv-dbase

inv-cde-file

miss-cde-file

cde-hash-error

3HH-04416-EBAA-TCZZA 01

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::SwRollback>
( yes
| no )
Possible values:
- yes : implicit software rollback performed
- no : no implicit software rollback
Parameter type: <Alarm::DbRollback>
( yes
| no )
Possible values:
- yes : implicit database rollback performed
- no : no implicit database rollback
Parameter type: <Alarm::XvpsInvalidDataBase>
( invalid
| valid )
Possible values:
- invalid : invalid xvps dbbase is detected
- valid : xvps dbase is valid
Parameter type: <Alarm::XvpsInvalidCDEFile>
( invalid
| valid )
Possible values:
- invalid : invalid xvps cde file is detected
- valid : xvps cde file is valid
Parameter type: <Alarm::MissingCDEProfile>
( yes
| no )
Possible values:
- yes : cde profile is missed
- no : cde profile is exist
Parameter type: <Alarm::CDEProfileHashErr>
( yes
| no )
Possible values:
- yes : cde profile hash error
- no : cde profile hash correct

Description

specifies
implicit
software
rollback is performed or not.
This element is only shown in
detail mode.
specifies
implicit
database
rollback is performed or not.
This element is only shown in
detail mode.
specifies implicit xvps dbase is
valid or not.
This element is only shown in
detail mode.
specifies implicit xvps dbase is
valid or not.
This element is only shown in
detail mode.
specifies cde profile is missed or
not.
This element is only shown in
detail mode.
specifies cde profile no key.
This element is only shown in
detail mode.

Released

1449

56 Alarm Snap-shot Status Commands

56.10 Alarm Snapshot Temporal Filter Status


Command
Command Description
This command displays the temporal filter snapshot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot temporal [ (index) ]

Command Parameters
Table 56.10-1 "Alarm Snapshot Temporal Filter Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.10-2 "Alarm Snapshot Temporal Filter Status Command" Display parameters
Specific Information
name
tmp-filter1

tmp-filter2

tmp-filter3

1450

Released

Type

Description

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:

current status of temporal filter1


is derived or not
This element is only shown in
detail mode.
current status of temporal filter2
is derived or not
This element is only shown in
detail mode.
current status of temporal filter3
is derived or not
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
tmp-filter4

tmp-filter5

tmp-filter6

tmp-filter7

tmp-filter8

tmp-filter9

tmp-filter10

tmp-filter11

tmp-filter12

tmp-filter13

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>

Description
current status of temporal filter4
is derived or not
This element is only shown in
detail mode.
current status of temporal filter5
is derived or not
This element is only shown in
detail mode.
current status of temporal filter6
is derived or not
This element is only shown in
detail mode.
current status of temporal filter7
is derived or not
This element is only shown in
detail mode.
current status of temporal filter8
is derived or not
This element is only shown in
detail mode.
current status of temporal filter9
is derived or not
This element is only shown in
detail mode.
current status of temporal filter10
is derived or not
This element is only shown in
detail mode.
current status of temporal filter11
is derived or not
This element is only shown in
detail mode.
current status of temporal filter12
is derived or not
This element is only shown in
detail mode.
current status of temporal filter13

Released

1451

56 Alarm Snap-shot Status Commands

name

tmp-filter14

tmp-filter15

tmp-filter16

tmp-filter17

tmp-filter18

tmp-filter19

tmp-filter20

tmp-filter21

tmp-filter22

1452

Released

Type

Description

( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:

is derived or not
This element is only shown in
detail mode.
current status of temporal filter14
is derived or not
This element is only shown in
detail mode.
current status of temporal filter15
is derived or not
This element is only shown in
detail mode.
current status of temporal filter16
is derived or not
This element is only shown in
detail mode.
current status of temporal filter17
is derived or not
This element is only shown in
detail mode.
current status of temporal filter18
is derived or not
This element is only shown in
detail mode.
current status of temporal filter19
is derived or not
This element is only shown in
detail mode.
current status of temporal filter20
is derived or not
This element is only shown in
detail mode.
current status of temporal filter21
is derived or not
This element is only shown in
detail mode.
current status of temporal filter22
is derived or not
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
tmp-filter23

tmp-filter24

tmp-filter25

tmp-filter26

tmp-filter27

tmp-filter28

tmp-filter29

tmp-filter30

tmp-filter31

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

Description
current status of temporal filter23
is derived or not
This element is only shown in
detail mode.
current status of temporal filter24
is derived or not
This element is only shown in
detail mode.
current status of temporal filter25
is derived or not
This element is only shown in
detail mode.
current status of temporal filter26
is derived or not
This element is only shown in
detail mode.
current status of temporal filter27
is derived or not
This element is only shown in
detail mode.
current status of temporal filter28
is derived or not
This element is only shown in
detail mode.
current status of temporal filter29
is derived or not
This element is only shown in
detail mode.
current status of temporal filter30
is derived or not
This element is only shown in
detail mode.
current status of temporal filter31
is derived or not
This element is only shown in
detail mode.

Released

1453

56 Alarm Snap-shot Status Commands

56.11 Alarm Snapshot Spatial Filter Status


Command
Command Description
This command displays the spatial filter snapshot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot spatial [ (index) ]

Command Parameters
Table 56.11-1 "Alarm Snapshot Spatial Filter Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.11-2 "Alarm Snapshot Spatial Filter Status Command" Display parameters
Specific Information
name
spa-filter1

spa-filter2

spa-filter3

1454

Released

Type

Description

Parameter type: <Alarm::alrmFilter1>


( yes
| no )
Possible values:
- yes : derived filter1 alarm
- no : not derived filter1 alarm
Parameter type: <Alarm::alrmFilter2>
( yes
| no )
Possible values:
- yes : derived filter2 alarm
- no : not derived filter2 alarm
Parameter type: <Alarm::alrmFilter3>
( yes
| no )
Possible values:

current status of spatial filter1 is


derived or not
This element is only shown in
detail mode.
current status of spatial filter2 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter3 is
derived or not
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
spa-filter4

spa-filter5

spa-filter6

spa-filter7

spa-filter8

spa-filter9

spa-filter10

spa-filter11

spa-filter12

spa-filter13

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter3 alarm
- no : not derived filter3 alarm
Parameter type: <Alarm::alrmFilter4>
( yes
| no )
Possible values:
- yes : derived filter4 alarm
- no : not derived filter4 alarm
Parameter type: <Alarm::alrmFilter5>
( yes
| no )
Possible values:
- yes : derived filter5 alarm
- no : not derived filter5 alarm
Parameter type: <Alarm::alrmFilter6>
( yes
| no )
Possible values:
- yes : derived filter6 alarm
- no : not derived filter6 alarm
Parameter type: <Alarm::alrmFilter7>
( yes
| no )
Possible values:
- yes : derived filter7 alarm
- no : not derived filter7 alarm
Parameter type: <Alarm::alrmFilter8>
( yes
| no )
Possible values:
- yes : derived filter alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter9>
( yes
| no )
Possible values:
- yes : derived filter9 alarm
- no : not derived filter9 alarm
Parameter type: <Alarm::alrmFilter10>
( yes
| no )
Possible values:
- yes : derived filter10 alarm
- no : not derived filter alarm
Parameter type: <Alarm::alrmFilter11>
( yes
| no )
Possible values:
- yes : derived filter11 alarm
- no : not derived filter11 alarm
Parameter type: <Alarm::alrmFilter12>
( yes
| no )
Possible values:
- yes : derived filter12 alarm
- no : not derived filter12 alarm
Parameter type: <Alarm::alrmFilter13>

Description
current status of spatial filter4 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter5 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter6 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter7 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter8 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter9 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter10 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter11 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter12 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter13 is

Released

1455

56 Alarm Snap-shot Status Commands

name

spa-filter14

spa-filter15

spa-filter16

spa-filter17

spa-filter18

spa-filter19

spa-filter20

spa-filter21

spa-filter22

1456

Released

Type

Description

( yes
| no )
Possible values:
- yes : derived filter13 alarm
- no : not derived filter13 alarm
Parameter type: <Alarm::alrmFilter14>
( yes
| no )
Possible values:
- yes : derived filter14 alarm
- no : not derived filter14 alarm
Parameter type: <Alarm::alrmFilter15>
( yes
| no )
Possible values:
- yes : derived filter15 alarm
- no : not derived filter15 alarm
Parameter type: <Alarm::alrmFilter16>
( yes
| no )
Possible values:
- yes : derived filter16 alarm
- no : not derived filter16 alarm
Parameter type: <Alarm::alrmFilter17>
( yes
| no )
Possible values:
- yes : derived filter17 alarm
- no : not derived filter17 alarm
Parameter type: <Alarm::alrmFilter18>
( yes
| no )
Possible values:
- yes : derived filter18 alarm
- no : not derived filter18 alarm
Parameter type: <Alarm::alrmFilter19>
( yes
| no )
Possible values:
- yes : derived filter19 alarm
- no : not derived filter19 alarm
Parameter type: <Alarm::alrmFilter20>
( yes
| no )
Possible values:
- yes : derived filter20 alarm
- no : not derived filter20 alarm
Parameter type: <Alarm::alrmFilter21>
( yes
| no )
Possible values:
- yes : derived filter21 alarm
- no : not derived filter21 alarm
Parameter type: <Alarm::alrmFilter22>
( yes
| no )
Possible values:

derived or not
This element is only shown in
detail mode.
current status of spatial filter14 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter15 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter16 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter17 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter18 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter19 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter20 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter21 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter22 is
derived or not
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
spa-filter23

spa-filter24

spa-filter25

spa-filter26

spa-filter27

spa-filter28

spa-filter29

spa-filter30

spa-filter31

3HH-04416-EBAA-TCZZA 01

Type
- yes : derived filter22 alarm
- no : not derived filter22 alarm
Parameter type: <Alarm::alrmFilter23>
( yes
| no )
Possible values:
- yes : derived filter23 alarm
- no : not derived filter23 alarm
Parameter type: <Alarm::alrmFilter24>
( yes
| no )
Possible values:
- yes : derived filter24 alarm
- no : not derived filter24 alarm
Parameter type: <Alarm::alrmFilter25>
( yes
| no )
Possible values:
- yes : derived filter25 alarm
- no : not derived filter25 alarm
Parameter type: <Alarm::alrmFilter26>
( yes
| no )
Possible values:
- yes : derived filter26 alarm
- no : not derived filter26 alarm
Parameter type: <Alarm::alrmFilter27>
( yes
| no )
Possible values:
- yes : derived filter27 alarm
- no : not derived filter27 alarm
Parameter type: <Alarm::alrmFilter28>
( yes
| no )
Possible values:
- yes : derived filter28 alarm
- no : not derived filter28 alarm
Parameter type: <Alarm::alrmFilter29>
( yes
| no )
Possible values:
- yes : derived filter29 alarm
- no : not derived filter29 alarm
Parameter type: <Alarm::alrmFilter30>
( yes
| no )
Possible values:
- yes : derived filter30 alarm
- no : not derived filter30 alarm
Parameter type: <Alarm::alrmFilter31>
( yes
| no )
Possible values:
- yes : derived filter31 alarm
- no : not derived filter31 alarm

Description
current status of spatial filter23 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter24 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter25 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter26 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter27 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter28 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter29 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter30 is
derived or not
This element is only shown in
detail mode.
current status of spatial filter31 is
derived or not
This element is only shown in
detail mode.

Released

1457

56 Alarm Snap-shot Status Commands

56.12 Alarm xDSL Snapshot Status Command


Command Description
This command displays the status of the snapshot xDSL alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot xdsl [ (index) ]

Command Parameters
Table 56.12-1 "Alarm xDSL Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.12-2 "Alarm xDSL Snapshot Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::XdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::NearEndLOS>
specifies near end loss of signal
( yes
occured or not.
| no )
This element is only shown in
Possible values:
detail mode.
- yes : near end loss of signal occurred
- no : no near end loss of signal
Parameter type: <Alarm::NearEndLOF>
specifies near end loss of frame
( yes
occured or not.

near-end-los

near-end-lof

1458

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

near-end-lom

near-end-ese

line-config

line-capacity

near-end-bitrate

near-end-ncd

near-end-lcd

far-end-los

far-end-lof

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : near end loss of frame occurred
- no : no near end loss of frame
Parameter type: <Alarm::NearEndLOM>
( yes
| no )
Possible values:
- yes : near end loss of margin occurred
- no : no near end loss of margin
Parameter type: <Alarm::NearEndESE>
( yes
| no )
Possible values:
- yes : near end excessive severe errors occurred
- no : no near end excessive severe errors occurred
Parameter type: <Alarm::LineConfig>
( config-error
| config-ok )
Possible values:
- config-error : line configuration data cannot be used
- config-ok : Line configuration data OK
Parameter type: <Alarm::LineCapacity>
( below-requirement
| meets-requirement )
Possible values:
- below-requirement : line capacity not enough to set up
requested profile
- meets-requirement : line capacity enough to set up
requested profile
Parameter type: <Alarm::NearEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : upstream planned bitrate not reached after
initialization
- meets-plan : upstream planned bitrate reached
Parameter type: <Alarm::NearEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no near end cell delineation
- cell-deline-occurred : near end cell delineation occurred
Parameter type: <Alarm::NearEndLCD>
( yes
| no )
Possible values:
- yes : loss of near end cell deliniation
- no : no loss of near end cell deliniation
Parameter type: <Alarm::FarEndLOS>
( yes
| no )
Possible values:
- yes : far end loss of signal occurred
- no : no far end loss of signal
Parameter type: <Alarm::FarEndLOF>
( yes

This element is only shown in


detail mode.
specifies near end loss of margin
occured or not.
This element is only shown in
detail mode.
specifies near end excessive
severe errors occured or not.
This element is only shown in
detail mode.
specifies
whether
line
configuration data is used or not.
This element is only shown in
detail mode.
specifies whether line capacity is
set up or not.
This element is only shown in
detail mode.

specifies
whether
upstream
planned bitrate reached or not
after initialization.
This element is only shown in
detail mode.
specifies whether near end cell
delineation is occured or not.
This element is only shown in
detail mode.
specifies whether loss of near end
cell deliniation is occured or not.
This element is only shown in
detail mode.
specifies whether far end loss of
signal occured or not.
This element is only shown in
detail mode.
specifies whether far end loss of
frame occured or not.

Released

1459

56 Alarm Snap-shot Status Commands

name

far-end-lpr

far-end-lol

far-end-lom

far-end-ese

xdsl-init

peer-modem

far-end-bitrate

far-end-ncd

far-end-lcd

1460

Released

Type

Description

| no )
Possible values:
- yes : far end loss of frame occurred
- no : no far end loss of frame
Parameter type: <Alarm::FarEndLPR>
( yes
| no )
Possible values:
- yes : far end loss of power detected
- no : no far end loss of power
Parameter type: <Alarm::FarEndLOL>
( yes
| no )
Possible values:
- yes : far end loss of link detected
- no : no far end loss of link
Parameter type: <Alarm::FarEndLOM>
( yes
| no )
Possible values:
- yes : far end loss of margin occurred
- no : no far end loss of margin
Parameter type: <Alarm::FarEndESE>
( yes
| no )
Possible values:
- yes : far end excessive severe errors occurred
- no : no far end excessive severe errors occurred
Parameter type: <Alarm::Initialization>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to comminication
problem
- successful : initialization successful
Parameter type: <Alarm::PeerModem>
( no
| yes )
Possible values:
- no : no peer modem detected
- yes : peer modem detected
Parameter type: <Alarm::FarEndBRthres>
( below-plan
| meets-plan )
Possible values:
- below-plan : downstream planned bitrate not reached after
initialization
- meets-plan : downstream planned bitrate reached
Parameter type: <Alarm::FarEndNCD>
( no-cell-deline
| cell-deline-occurred )
Possible values:
- no-cell-deline : no far end cell delineation
- cell-deline-occurred : far end cell delineation occurred
Parameter type: <Alarm::FarEndLCD>
( yes
| no )

This element is only shown in


detail mode.
specifies whether far end loss of
power detected or not.
This element is only shown in
detail mode.
specifies whether far end loss of
link detected or not.
This element is only shown in
detail mode.
specifies whether far end loss of
margin occured or not.
This element is only shown in
detail mode.
specifies whether far end
excessive severe errors occured
or not.
This element is only shown in
detail mode.
specifies xdsl line initialization is
successful or not.
This element is only shown in
detail mode.

specifies whether peer modem


detected or not.
This element is only shown in
detail mode.
specifies whether downstream
planned bitrate reached or not.
This element is only shown in
detail mode.

specifies whether far end cell


delineation occured or not.
This element is only shown in
detail mode.
specifies there is loss of far end
cell deliniation or not.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

far-end-upbo-vio

far-end-cpe-pol

forced-rtx-init

tpstc-mis

vect-dle

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- yes : loss of far end cell deliniation
- no : no loss of far end cell deliniation
Parameter type: <Alarm::FarEndUPBO>
( yes
| no )
Possible values:
- yes : UPBO violation
- no : no UPBO violation
Parameter type: <Alarm::FarEndActFail>
( yes
| no )
Possible values:
- yes : activation failure due to CPE policing
- no : no activation failure due to CPE policing
Parameter type: <Alarm::ForcedRtxInit>
( failed
| successful )
Possible values:
- failed : initialization unsuccessful due to forced
retransmission
- successful : initialization successful
Parameter type: <Alarm::TpstcMis>
( yes
| no )
Possible values:
- yes : mismatch between the configured tps-tc mode and the
mode supported by the connected cpe
- no : no mismatch between the configured and the tpstc
mode supported by connected cpe
Parameter type: <Alarm::NearEndVectDle>
( yes
| no )
Possible values:
- yes : loss of us signal due to disorderly leaving event
- no : no disorderly leaving detected

detail mode.
UPBO violation
This element is only shown in
detail mode.

activation failure due to CPE


policing
This element is only shown in
detail mode.
specifies forced rtx initialization
is successful or not
This element is only shown in
detail mode.

mismatch between the configured


tps-tc mode and the mode
supported by the connected cpe
This element is only shown in
detail mode.

specifies whether a disorderly


leaving event occured or not.
This element is only shown in
detail mode.

Released

1461

56 Alarm Snap-shot Status Commands

56.13 TCA xDSL Alarm Log Status Command


Command Description
This command displays the xDSL threshold cross alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot xdsl-tca [ (index) ]

Command Parameters
Table 56.13-1 "TCA xDSL Alarm Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.13-2 "TCA xDSL Alarm Log Status Command" Display parameters
Specific Information
name
port

errored-secs

es-in-a-day

1462

Released

Type

Description

Parameter type: <Itf::XdslLine>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::ErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds exceeded
threshold
- below-thres : number of errored seconds below threshold
Parameter type: <Alarm::ErroredSecondsInAday>

identifies where the alarm


occurred
This element is only shown in
detail mode.

number of errored seconds


exceeded or below threshold
This element is only shown in
detail mode.

errored

3HH-04416-EBAA-TCZZA

seconds

in

01

day

56 Alarm Snap-shot Status Commands

name

severely-es

severely-es-in-a-day

unavailable-secs

unavail-secs-in-a-day

far-end-es

fe-severely-es

fe-severely-es/day

3HH-04416-EBAA-TCZZA 01

Type

Description

( above-thres
| below-thres )
Possible values:
- above-thres : number of errored seconds in a day, exceeded
threshold
- below-thres : number of errored seconds in a day, below
threshold
Parameter type: <Alarm::SeverelyErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds exceeded
threshold
- below-thres : number of severely errored seconds below
threshold
Parameter type: <Alarm::SevErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::UnavailableSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds exceeded
threshold
- below-thres : number of unavailable seconds below
threshold
Parameter type: <Alarm::UnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of unavailable seconds in a day,
exceeded threshold
- below-thres : number of unavailable seconds in a day,
below threshold
Parameter type: <Alarm::FarEndErroredSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds exceeded
threshold
- below-thres : number of far end errored seconds below
threshold
Parameter type: <Alarm::FarEndSevErroredSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end severely errored seconds
exceeded threshold
- below-thres : number of far end severely errored seconds
below threshold
Parameter type: <Alarm::FarEndSevErroredSecsInAday>
( above-thres

exceeded or below threshold


This element is only shown in
detail mode.

number of severely errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of unavailable seconds


exceeded or below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end errored


seconds exceeded or below
threshold
This element is only shown in
detail mode.

number of far end severely


errored seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of severely errored


seconds in a day, exceeded or

Released

1463

56 Alarm Snap-shot Status Commands

name

fe-unavail-secs

fe-unavail-sec/day

fe-es-in-a-day

leftrs

leftrs-in-a-day

fe-leftrs

fe-leftrs-in-a-day

1464

Released

Type

Description

| below-thres )
Possible values:
- above-thres : number of severely errored seconds in a day,
exceeded threshold
- below-thres : number of severely errored seconds in a day,
below threshold
Parameter type: <Alarm::FarEndUnavailSecs>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds
exceeded threshold
- below-thres : number of far end unavailable seconds below
threshold
Parameter type: <Alarm::FarEndUnavailSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end unavailable seconds in a
day, exceeded threshold
- below-thres : number of far end unavailable seconds in a
day, below threshold
Parameter type: <Alarm::FarEndErroredSecsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end errored seconds in a day,
exceeded threshold
- below-thres : number of far end errored seconds in a day,
below threshold
Parameter type: <Alarm::LeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
exceeded threshold
- below-thres : number of low error free throughput seconds
below threshold
Parameter type: <Alarm::LeftrSecondsInAday>
( above-thres
| below-thres )
Possible values:
- above-thres : number of low error free throughput seconds
in a day, exceeded threshold
- below-thres : number of low error free throughput seconds
in a day, below threshold
Parameter type: <Alarm::FarEndLeftrSeconds>
( above-thres
| below-thres )
Possible values:
- above-thres : number of far end low error free throughput
seconds exceeded threshold
- below-thres : number of far end low error free throughput
seconds below threshold
Parameter type: <Alarm::FarEndLeftrSecondsInAday>
( above-thres
| below-thres )

below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end unavailable


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of far end errored


seconds in a day, exceeded or
below threshold
This element is only shown in
detail mode.

number of low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of low error free


throughput seconds in a day,
exceeded or below threshold
This element is only shown in
detail mode.

number of far end low error free


throughput seconds exceeded or
below threshold
This element is only shown in
detail mode.

number of far end low error free


throughput seconds in a day,
exceeded or below threshold

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

Possible values:
This element is only shown in
- above-thres : number of far end low error free throughput detail mode.
seconds in a day, exceeded threshold
- below-thres : number of far end low error free throughput
seconds in a day, below threshold

3HH-04416-EBAA-TCZZA 01

Released

1465

56 Alarm Snap-shot Status Commands

56.14 Alarm Vectoring Line Snapshot Status


Command
Command Description
This command displays the status of the snapshot vectoring line alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot vect-line [ (index) ]

Command Parameters
Table 56.14-1 "Alarm Vectoring Line Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

index of the alarm snap shot table

Command Output
Table 56.14-2 "Alarm Vectoring Line Snapshot Status Command" Display parameters
Specific Information
name
port

xtc-variation-vict

1466

Released

Type

Description

Parameter type: <Itf::XdslLine>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::VectXtcVariation>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation in xtc

identifies the physical position of


the port where the alarm has
occurred.
This element is only shown in
detail mode.

excessive : abnormal amplitude


variation in xtc coefficients
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
xtc-variation-dist

corrupted-errf

vect-cpe-cap-mismatch

vect-conf-not-feas

prev-status

3HH-04416-EBAA-TCZZA 01

Type

Description

coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectXtcVariationDist>
( excessive
| normal )
Possible values:
- excessive : abnormal amplitude variation in xtc
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Alarm::VectCorptErrf>
( yes
| no )
Possible values:
- yes : at least 10% corrupted or missing errorf samples
received
- no : received errorf samples ok
Parameter type: <Alarm::VectCpeCapMism>
( yes
| no )
Possible values:
- yes : not allowed Vectoring CPE connected
- no : allowed Vectoring CPE connected
Parameter type: <Alarm::VectConfNotFeas>
( yes
| no )
Possible values:
- yes : vectoring configuration not feasable
- no : vectoring configuration feasable
Parameter type: <Alarm::VectConfNotFeas>
( yes
| no )
Possible values:
- yes : vectoring configuration not feasable
- no : vectoring configuration feasable

specifies if excessive outgoing


crosstalk coefficient variation
occurred or not
This element is only shown in
detail mode.
specifies if corrupted or at least
10% missing errorf samples
received ccurred or not
This element is only shown in
detail mode.
specifies if an allowed Vectoring
CPE is connected or not
This element is only shown in
detail mode.
specifies
if
the
vectoring
configuration is feasable
This element is only shown in
detail mode.
status of vect-conf-not-feas with
its previous logged value
This element is only shown in
detail mode.

Released

1467

56 Alarm Snap-shot Status Commands

56.15 Alarm Vectoring Board Snapshot Status


Command
Command Description
This command displays the status of the snapshot vectoring board alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot vect-board [ (index) ]

Command Parameters
Table 56.15-1 "Alarm Vectoring Board Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

index of the alarm snap shot table

Command Output
Table 56.15-2 "Alarm Vectoring Board Snapshot Status Command" Display parameters
Specific Information
name
board-index

Description

Parameter type: <Equipm::EqptVpSlotIndex>


specifies where the alarm has
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
occurred.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
This element is only shown in
Possible values:
detail mode.
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::VectVpLinkIdx2>
this is the vplink id or the
- specifies the soft-link or the vp-link on the vp-board, or soft-link id. This index has value
zero
zero when it is not used
- range: [0,1...8]
This element is only shown in
detail mode.

vp-link-index

1468

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

vp-lt-mismatch

Parameter type: <Alarm::VectVpLtMism>


( yes
| no )
Possible values:
- yes : mismatch between expected and actual vp-lt mapping
or incompatible sw version on vp and lt
- no : expected and actual vp-lt in line or vp and lt have
compatible sw versions, OR autodiscovery enabled on vp,
autodiscovery disabled on lt

qsfp-id

Parameter type: <Alarm::VectQsfpInvalidAlcatelID>


( invalid
| valid )
Possible values:
- invalid : QSFP does not have valid Alcatel-Lucent ID
- valid : QSFP has valid Alcatel-Lucent ID OR no QSFP
detected.
Parameter type: <Alarm::VPLTLINKFAIL>
( linkdown
| linkup )
Possible values:
- linkdown : vp-lt link problem
- linkup : vp-lt link ok or no lt-expected OR autodiscovery
enabled on vp, autodiscovery disabled on lt

specifies if a mismatch between


expected and actual vp-lt
mapping OR incompatible sw
version on vp and lt is detected or
not. In case vplt-autodiscovery
disabled on vp, failure reported
on
vp-board.
In
case
vplt-autodiscovery enabled on lt,
failure reported on lt-board.
This element is only shown in
detail mode.
specifies if detected QSFP of the
frontcable
has
a
valid
Alcatel-Lucent ID or not
This element is only shown in
detail mode.

vp-lt-link

3HH-04416-EBAA-TCZZA 01

specifies if a VP-LT link failure


is detected or not. In case
vplt-autodiscovery disabled on
vp, failure reported on vp-board
when an lt was expected but no
valid connection between vp-lt.
In
case
vplt-autodiscovery
enabled on lt, failure reported on
lt-board
when
no
valid
connection between vp-lt.
This element is only shown in
detail mode.

Released

1469

56 Alarm Snap-shot Status Commands

56.16 Alarm Electrical-to-Optical Conversion for


Snapshot Status Command
Command Description
This command displays the electrical-to-optical conversion alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot eo-conversion [ (index) ]

Command Parameters
Table 56.16-1 "Alarm Electrical-to-Optical Conversion for Snapshot Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.16-2 "Alarm Electrical-to-Optical Conversion for Snapshot Status Command" Display
parameters
Specific Information
name
loss-of-signal

transmission

1470

Released

Type

Description

Parameter type: <Alarm::EoConvLOS>


( yes
| no )
Possible values:
- yes : loss of signal detected in the EO conversion module
- no : no loss of signal detected in the EO conversion
module
Parameter type: <Alarm::EoConvTx>
( faulty
| ok )
Possible values:
- faulty : transmission fault in the EO module
- ok : transmission OK

specifies whether loss of signal


detected or not in the EO
conversion module
This element is only shown in
detail mode.
specifies whether transmission
fault is occurred or not in the EO
module
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.17 Authentication Alarms for Snapshot Status


Command
Command Description
This command displays the status of authentication-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot authentication [ (index) ]

Command Parameters
Table 56.17-1 " Authentication Alarms for Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.17-2 " Authentication Alarms for Snapshot Status Command" Display parameters
Specific Information
name
vlan-assignment

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::VLANassignment>


( failed
| successful )
Possible values:
- failed : failure to assign a VLAN for a user session
- successful : assigned a VLAN for a user session

specifies whether a VLAN for a


user session is assigned or failed
This element is only shown in
detail mode.

Released

1471

56 Alarm Snap-shot Status Commands

56.18 Alarm xDSL Bonding Snap Shot Status


Command
Command Description
This command displays the alarms of the xDSL bonding snap shot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot bonding-group [ (index) ]

Command Parameters
Table 56.18-1 "Alarm xDSL Bonding Snap Shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.18-2 "Alarm xDSL Bonding Snap Shot Status Command" Display parameters
Specific Information
name
group

up-plan-bitrate

1472

Released

Type

Description

Parameter type: <Xdsl::BondingInterfaceIndex>


<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::UpPlannedBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum

identifies the bonding group


interface index
This element is only shown in
detail mode.

specifies whether the actual


group upstream bit rate is above
the group upstream planned bit
rate or not
This element is only shown in

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

down-plan-bitrate

up-min-bitrate

down-min-bitrate

up-config

down-config

bond-cpe-conn

multiple-cpes

register

3HH-04416-EBAA-TCZZA 01

Type

Description

upstream bitrate but below the group upstream planned


bitrate
- ok : actual group bitrate is above the group upstream
planned bitrate
Parameter type: <Alarm::DownPlanBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is above the minimum
downstream bitrate but below the group downstream
planned bitrate
- ok : actual group bitrate is above the group downstream
planned bitrate
Parameter type: <Alarm::UpMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group upstream
minimum bitrate
- ok : actual group bitrate is above the group upstream
minimum bitrate
Parameter type: <Alarm::DownMinBitrate>
( failure
| ok )
Possible values:
- failure : actual group bitrate is below the group
downstream minimum bitrate
- ok : actual group bitrate is above the group downstream
minimum bitrate
Parameter type: <Alarm::UpConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : upstream configuration not feasible
- feasible : upstream configuration feasible
Parameter type: <Alarm::DownConfig>
( not-feasible
| feasible )
Possible values:
- not-feasible : downstream configuration not feasible
- feasible : downstream configuration feasible
Parameter type: <Alarm::BondCPE>
( not-connected
| connected )
Possible values:
- not-connected : bonding cpe modem not connected
- connected : bonding cpe modem connected
Parameter type: <Alarm::BgConnCPE>
( true
| false )
Possible values:
- true : bonding group has multiple cpe modems connected
- false : bonding group has one cpe modem connected
Parameter type: <Alarm::BgRegFail>
( failure
| ok )
Possible values:

detail mode.

specifies whether the actual


group downstream bit rate is
above the group downstream
planned bit rate or not
This element is only shown in
detail mode.

specifies whether the actual


group upstream bit rate is above
the group upstream minimum bit
rate or not
This element is only shown in
detail mode.
specifies whether the actual
group downstream bit rate is
above the group downstream
minimum bit rate or not
This element is only shown in
detail mode.
specifies whether the upstream
configuration is feasible or not
This element is only shown in
detail mode.
specifies whether the downstream
configuration is feasible or not
This element is only shown in
detail mode.
specifies whether a bonding CPE
modem is connected or not
This element is only shown in
detail mode.
specifies whether the lines of a
bonding group are connected to
multiple CPEs or only one
This element is only shown in
detail mode.
specifies whether a discovery or
aggregation
failure
is
encountered or not
This element is only shown in

Released

1473

56 Alarm Snap-shot Status Commands

name

Type

group-incomplete

1474

Description

- failure : bonding group discovery or aggregation register detail mode.


failure detected
- ok : bonding group discovery or aggregation register
failure not detected
Parameter type: <Alarm::BgNotCompl>
specifies whether all configured
( true
lines of the bonding group are
| false )
part of the bonding group
Possible values:
This element is only shown in
- true : bonding group is incomplete
detail mode.
- false : bonding group is complete

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.19 Alarm Redundancy Snapshot Status


Command
Command Description
This command displays the redundancy snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot redundancy [ (index) ]

Command Parameters
Table 56.19-1 "Alarm Redundancy Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.19-2 "Alarm Redundancy Snapshot Status Command" Display parameters
Specific Information
name
loss-over-cap

ping-check

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SwoCap>


( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::PingCheck>
( failure
| successful )
Possible values:
- failure : system failure of ping check
- successful : system successful of ping check

identify the switchover capability


in a redundant system.
This element is only shown in
detail mode.
identify the ping check in a
redundant system.
This element is only shown in
detail mode.

Released

1475

56 Alarm Snap-shot Status Commands

56.20 Alarm Custom Snapshot Status Command


Command Description
This command displays custom snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot custom [ (index) ]

Command Parameters
Table 56.20-1 "Alarm Custom Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.20-2 "Alarm Custom Snapshot Status Command" Display parameters
Specific Information
name
custom-alarm1

custom-alarm2

custom-alarm3

custom-alarm4

1476

Released

Type

Description

Parameter type: <Alarm::custom1>


( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom4>

identify the customizableAlarm1


.
This element is only shown in
detail mode.
identify the customizableAlarm2
.
This element is only shown in
detail mode.
identify the customizableAlarm3
.
This element is only shown in
detail mode.
identify the customizableAlarm4

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description
.
This element is only shown in
detail mode.

custom-alarm5

( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm

Only Show Details: host expansion shelves customizable alarms


name
Type
shelf

he-custom-alarm1

he-custom-alarm2

he-custom-alarm3

he-custom-alarm4

he-custom-alarm5

he-custom-alarm6

3HH-04416-EBAA-TCZZA 01

Parameter type: <Equipm::HolderId>


( <Eqpt::RackId> / <Eqpt::ShelfId>
| not-applicable )
Possible values:
- not-applicable : not applicable
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Parameter type: <Alarm::he-custom1>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom2>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom3>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom4>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom5>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::he-custom6>
( yes
| no )
Possible values:
- yes : Miscellaneous environment alarm

identify the customizableAlarm5


.
This element is only shown in
detail mode.

Description
this is the shelf id (equipment
hoder id) for host expansion
alarms, otherwise it is the rack ID
This element is only shown in
detail mode.

identify the host expansion's


customizableAlarm1 .
This element is only shown in
detail mode.
identify the host expansion's
customizableAlarm2 .
This element is only shown in
detail mode.
identify the host expansion's
customizableAlarm3 .
This element is only shown in
detail mode.
identify the host expansion's
customizableAlarm4 .
This element is only shown in
detail mode.
identify the host expansion's
customizableAlarm5 .
This element is only shown in
detail mode.
identify the host expansion's
customizableAlarm6 .
This element is only shown in
detail mode.

Released

1477

56 Alarm Snap-shot Status Commands

name

Type

Description

- no : no Miscellaneous environment alarm

1478

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.21 Alarm SFP Snapshot Status Command


This command displays the SFP snapshot-related alarms.

Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sfp [ (index) ]

Command Parameters
Table 56.21-1 "Alarm SFP Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.21-2 "Alarm SFP Snapshot Status Command" Display parameters
Specific Information
name
alarm index 1

alarm index 2

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SfpAlarmIdx1Type>


( <Alarm::SfpAlarmIdx1>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Alarm::SfpAlarmIdx1>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
Parameter type: <Alarm::SfpAlarmIdx2Type>
( <Alarm::SfpAlarmIdx2>
| nt : sfp : <Eqpt::PortIndex>
| nt-a : sfp : <Alarm::SfpAlarmIdx2>
| nt-a : xfp : <Alarm::SfpAlarmIdx2>

this is the host sfp faceplate


number for host alarms or it is the
equipment slot id for expansion
shelf alarms
This element is only shown in
detail mode.

this is the lanx port id for host


alarms. this index is not used for
expansion shelf alarms
This element is only shown in
detail mode.

Released

1479

56 Alarm Snap-shot Status Commands

name

Type

Description

| nt-b : sfp : <Alarm::SfpAlarmIdx2>


| nt-b : xfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-1 : xfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : sfp : <Alarm::SfpAlarmIdx2>
| ntio-2 : xfp : <Alarm::SfpAlarmIdx2>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- nt : active nt slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- lt : the lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Possible values:
- sfp : SFP port
- xfp : XFP port
Field type <Alarm::SfpAlarmIdx2>
- the host port faceplate number or the equipment slot-id for
expansion shelf alarm
Field type <Eqpt::PortIndex>
- the faceplate port number

Only Show Details: host shelf alarms


name
Type
host-sfp-los

host-sfp-tx

host-sfp-pres

host-sfp-id

host-sfp-ctrl

1480

Description

Parameter type: <Alarm::hostSFPLOS>


( failing
| ok )
Possible values:
- failing : host downlink SFP loss of signal
- ok : host downlink SFP signal ok
Parameter type: <Alarm::hostSFPTxFail>
( failing
| ok )
Possible values:
- failing : host downlink SFP tx failure
- ok : host downlink SFP tx ok
Parameter type: <Alarm::hostSFPMissing>
( not-present
| present )
Possible values:
- not-present : host downlink SFP not present
- present : host downlink SFP present
Parameter type: <Alarm::hostSFPInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : host downlink SFP does not have valid
Alcatel-Lucent ID
- valid : host downlink SFP has valid Alcatel-Lucent ID
Parameter type: <Alarm::hostSFPControlFail>
( failing

Released

current status host downlink SFP


loss of signal
This element is only shown in
detail mode.
current status host downlink SFP
tx failure
This element is only shown in
detail mode.
current status host downlink SFP
not present
This element is only shown in
detail mode.
current status host downlink SFP
does
not
have
valid
Alcatel-Lucent ID
This element is only shown in
detail mode.
current status host downlink SFP
control failure

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

host-sfp-rmtlt

host-sfp-mismatch

host-sfp-incompt

Type

Description

| ok )
Possible values:
- failing : host downlink SFP control failure
- ok : host downlink SFP control ok
Parameter type: <Alarm::hostSFPUnexpectedRemoteLT>
( yes
| no )
Possible values:
- yes : host shelf SFP unexpected remote LT plug-in
- no : host shelf SFP expected remote LT plug-in
Parameter type: <Alarm::hostSFPAssignmentMismatch>
( yes
| no )
Possible values:
- yes : host shelf SFP assignment does not match reported
rack/shelf/slot
- no : host shelf SFP assignment matches reported
rack/shelf/slot
Parameter type: <Alarm::hostSFPIncompatibleShelf>
( yes
| no )
Possible values:
- yes : host shelf SFP incompatible shelf type detected
- no : host shelf SFP compatible shelf type detected

This element is only shown in


detail mode.

Only Show Details: expansion shelf alarms


name
Type
exp-sfp-los

exp-sfp-tx

exp-sfp-pres

exp-sfp-id

exp-sfp-ctrl

3HH-04416-EBAA-TCZZA 01

current status of SFP alarm, host


downlink
SFP
detected
unexpected remote plug-in
This element is only shown in
detail mode.
current status of SFP alarm, host
downlink SFP assignment does
not match reported rack/shelf/slot
This element is only shown in
detail mode.

current status of SFP alarm, host


downlink
SFP
detected
incompatible shelf type
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::expansionShelfSFPLos>


( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP loss of signal
- ok : expansion shelf downlink SFP signal ok
Parameter type: <Alarm::expansionShelfSFPTxFail>
( failing
| ok )
Possible values:
- failing : expansion shelf host downlink SFP tx failure
- ok : expansion shelf downlink SFP tx ok
Parameter type: <Alarm::expansionShelfSFPMissing>
( not-present
| present )
Possible values:
- not-present : expansion shelf downlink SFP not present
- present : expansion shelf downlink SFP present
Parameter type: <Alarm::expShelfSFPInvalidAlcatelID>
( invalid
| valid )
Possible values:
- invalid : expansion shelf downlink SFP does not have valid
Alcatel-Lucent ID
- valid : expansion shelf downlink SFP has valid
Alcatel-Lucent ID
Parameter type: <Alarm::expansionShelfSFPControlFail>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP control failure

current status expansion side SFP


loss of signal
This element is only shown in
detail mode.
current status epansion shelf
downlink SFP tx failure
This element is only shown in
detail mode.
current status epansion shelf
downlink SFP not detected
This element is only shown in
detail mode.
current status epansion shelf
downlink SFP does not have
valid Alcatel-Lucent ID
This element is only shown in
detail mode.

current status epansion shelf


downlink SFP control failure
This element is only shown in
detail mode.

Released

1481

56 Alarm Snap-shot Status Commands

name

Type

exp-sfp-1-los

exp-sfp-2-los

1482

Description

- ok : expansion shelf downlink SFP control ok


Parameter type: <Alarm::expansionShelfSFP1Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP1 loss of signal
- ok : expansion shelf downlink SFP1 signal ok
Parameter type: <Alarm::expansionShelfSFP2Los>
( failing
| ok )
Possible values:
- failing : expansion shelf downlink SFP2 loss of signal
- ok : expansion shelf downlink SFP2 signal ok

Released

current status expansion side


SFP1 loss of signal
This element is only shown in
detail mode.
current status expansion side
SFP2 loss of signal
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.22 Alarm Custom External Snap Shot Status


Command
Command Description
This command shows the customizable external alarm snap shot status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot custom-ext-alarm [ (index) ]

Command Parameters
Table 56.22-1 "Alarm Custom External Snap Shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.22-2 "Alarm Custom External Snap Shot Status Command" Display parameters
Specific Information
name
ext-alarm1

ext-alarm2

ext-alarm3

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::custExtAlarm1>


( yes
| no )
Possible values:
- yes : customizable external alarm 1
- no : no customizable external alarm 1
Parameter type: <Alarm::custExtAlarm2>
( yes
| no )
Possible values:
- yes : customizable external alarm 2
- no : no customizable external alarm 2
Parameter type: <Alarm::custExtAlarm3>
( yes
| no )
Possible values:

current status specifying external


alarm 1 is present or not
This element is always shown.

current status specifying external


alarm 2 is present or not
This element is always shown.

current status specifying external


alarm 3 is present or not
This element is always shown.

Released

1483

56 Alarm Snap-shot Status Commands

name

Type
- yes : customizable external alarm 3
- no : no customizable external alarm 3
Parameter type: <Alarm::custExtAlarm4>
( yes
| no )
Possible values:
- yes : customizable external alarm 4
- no : no customizable external alarm 4
Parameter type: <Alarm::custExtAlarm5>
( yes
| no )
Possible values:
- yes : customizable external alarm 5
- no : no customizable external alarm 5

ext-alarm4

ext-alarm5

1484

Released

Description
current status specifying external
alarm 4 is present or not
This element is always shown.

current status specifying external


alarm 5 is present or not
This element is always shown.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.23 Alarm RSSI SFP Snapshot Status Command


Command Description
This command displays the SFP RSSI snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sfprssi [ (index) ]

Command Parameters
Table 56.23-1 "Alarm RSSI SFP Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 56.23-2 "Alarm RSSI SFP Snapshot Status Command" Display parameters
Specific Information
name
alarm index 1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

Released

1485

56 Alarm Snap-shot Status Commands

name

Type

Description

- ext-a : nt-a slot in an extension shelf


- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::RssiPort>
( sfp : <Alarm::RssiPort>
| xfp : <Alarm::RssiPort> )
Possible values:
- sfp : rssi sfp port
- xfp : rssi xfp port
Field type <Alarm::RssiPort>
- value
- range: [0...18]

alarm index 2

Only Show Details: sfp rssi diagnostic threshold control alarms


name
Type
tx-power-high-alarm

tx-power-low-alarm

rx-power-high-alarm

rx-power-low-alarm

1486

Released

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::NTNTIOTXPWHI>


( yes
| no )
Possible values:
- yes : TX optical power is too high than configured alarm
high threshold
- no : The TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLO>
( yes
| no )
Possible values:
- yes : TX optical power is too low than the configured
alarm low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHI>
( yes
| no )
Possible values:
- yes : RX optical power is too high than the configured
alarm high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLO>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
alarm low threshold
- no : RX optical power is ok

current status optical power is too


high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status RX optical power
is too high than the configured
alarm high threshold
This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
alarm low threshold
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

tx-biascur-high-alarm

Parameter type: <Alarm::NTNTIOTXBIASHI>


( yes
| no )
Possible values:
- yes : TX bias is too high than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLO>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured alarm low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHI>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured alarm high
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOVOLLO>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured alarm low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPHI>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured alarm
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPLO>
( yes
| no )
Possible values:
- yes : temperature is too low than the configured alarm low
threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTXPWHIWARN>
( yes
| no )
Possible values:
- yes : TX optical power is too high than the configured
warning high threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIOTXPWLOWARN>
( yes
| no )
Possible values:
- yes : TX optical power is too low than the configured
warning low threshold
- no : TX optical power is ok
Parameter type: <Alarm::NTNTIORXPWHIWARN>

current status TX bias is too high


than the configured alarm low
threshold
This element is only shown in
detail mode.

tx-biascur-low-alarm

volt-high-alarm

volt-low-alarm

temp-high-alarm

temp-low-alarm

tx-power-high-warn

tx-power-low-warn

rx-power-high-warn

3HH-04416-EBAA-TCZZA 01

current status TX bias is too low


than the configured alarm low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured alarm high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured alarm low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured alarm
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured alarm
low threshold
This element is only shown in
detail mode.
current status TX optical power is
too high than the configured
warning high threshold
This element is only shown in
detail mode.
current status TX optical power is
too low than the configured
warning low threshold
This element is only shown in
detail mode.
current status RX optical power

Released

1487

56 Alarm Snap-shot Status Commands

name

rx-power-low-warn

tx-biascur-high-warn

tx-biascur-low-warn

volt-high-warn

volt-low-warn

temp-high-warn

temp-low-warn

1488

Released

Type

Description

( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning high threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIORXPWLOWARN>
( yes
| no )
Possible values:
- yes : RX optical power is too low than the configured
warning low threshold
- no : RX optical power is ok
Parameter type: <Alarm::NTNTIOTXBIASHIWARN>
( yes
| no )
Possible values:
- yes : TX bias is too high than the configured warning high
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOTXBIASLOWARN>
( yes
| no )
Possible values:
- yes : TX bias is too low than the configured warning low
threshold
- no : TX bias current is ok
Parameter type: <Alarm::NTNTIOVOLHIWARN>
( yes
| no )
Possible values:
- yes : voltage is too high than the configured warning high
threshold
- no : no Miscellaneous environment alarm
Parameter type: <Alarm::NTNTIOVOLLOWARN>
( yes
| no )
Possible values:
- yes : voltage is too low than the configured warning low
threshold
- no : voltage is ok
Parameter type: <Alarm::NTNTIOTEMPEHIWARN>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured warning
high threshold
- no : temperature is ok
Parameter type: <Alarm::NTNTIOTEMPELOWARN>
( yes
| no )
Possible values:
- yes : temperature is too high than the configured warning
low threshold
- no : temperature is ok

is too low than the configured


warning high threshold
This element is only shown in
detail mode.
current status RX optical power
is too low than the configured
warning low threshold
This element is only shown in
detail mode.
current status TX bias is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status TX bias is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status voltage is too high
than the configured warning high
threshold
This element is only shown in
detail mode.
current status voltage is too low
than the configured warning low
threshold
This element is only shown in
detail mode.
current status temperature is too
high than the configured warning
high threshold
This element is only shown in
detail mode.
current status temperature is too
low than the configured warning
low threshold
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.24 Alarm PPP Cross-Connect Engine TCA


Snapshot Status Command
Command Description
This command displays the ppp cross-connect engine TCA snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot pppcc-engine-tca [ (index) ]

Command Parameters
Table 56.24-1 "Alarm PPP Cross-Connect Engine TCA Snapshot Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 56.24-2 "Alarm PPP Cross-Connect Engine TCA Snapshot Status Command" Display
parameters
Specific Information
name
engine

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::StackedVlanSigned>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

this is the ppp-cc engine number


This element is only shown in
detail mode.

Released

1489

56 Alarm Snap-shot Status Commands

Only Show Details: pppoe cross-connect engine tca alarms


name
Type
pppcce-trans-15min-tca

pppcce-sess-15min-tca

pppcce-trans-1day-tca

pppcce-sess-1day-tca

1490

Released

Description

Parameter type: <Alarm::PPPCCETRANS15MIN>


( yes
| no )
Possible values:
- yes : 15 minutes transaction timeout count exceeds
configured TCA
- no : 15 minutes transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS15MIN>
( yes
| no )
Possible values:
- yes : 15 minutes session timeout count exceeds configured
TCA
- no : 15 minutes session timeout count is OK
Parameter type: <Alarm::PPPCCETRANS1DAY>
( yes
| no )
Possible values:
- yes : 1day transaction timeout count exceeds configured
TCA
- no : 1day transaction timeout count is OK
Parameter type: <Alarm::PPPCCESESS1DAY>
( yes
| no )
Possible values:
- yes : 1day session timeout count exceeds configured TCA
- no : 1day session timeout count is OK

current 15 minutes transaction


timeout count exceeds configured
tca
This element is only shown in
detail mode.
15 minutes session timeout count
exceeds configured TCA
This element is only shown in
detail mode.

1day transaction timeout count


exceeds configured TCA
This element is only shown in
detail mode.

1day session timeout count


exceeds configured TCA
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.25 2xE1/DS1 SFP Clock Snapshot Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Clock Snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sfpe1t1-clock [ (index) ]

Command Parameters
Table 56.25-1 "2xE1/DS1 SFP Clock Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.25-2 "2xE1/DS1 SFP Clock Snapshot Status Command" Display parameters
Specific Information
name
alarm index 1

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

Released

1491

56 Alarm Snap-shot Status Commands

name

Type

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1Port>
( sfp : <Alarm::E1t1FramerPort>
| xfp : <Alarm::E1t1FramerPort> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]

alarm index 2

Only Show Details: e1t1 sfp clock alarms


name
Type
dsx1-serdes-fail

dsx1-tributary2-fail

dsx1-los-fail

1492

Description

Parameter type: <Alarm::DSX1SERDESFAIL>


( yes
| no )
Possible values:
- yes : SERDES clock failure alarm
- no : SERDES Clock no failure
Parameter type: <Alarm::DSX1TRIB1FAIL>
( yes
| no )
Possible values:
- yes : Tributary 1 clock failure alarm
- no : Tributary 1 clock no failure
Parameter type: <Alarm::DSX1TRIB2FAIL>
( yes
| no )
Possible values:
- yes : Tributary 2 clock failure alarm
- no : Tributary 2 clock no failure
Parameter type: <Alarm::DSX1LOSFAIL>
( yes
| no )
Possible values:
- yes : All selected tributaries in Loss Of Signal
- no : No All selected tributaries in Loss Of Signal

dsx1-tributary1-fail

Released

this is the host sfp faceplate


number
This element is only shown in
detail mode.

SERDES clock alarm failure


This element is only shown in
detail mode.

tributary 1 clock failure alarm


This element is only shown in
detail mode.

tributary 2 clock failure alarm


This element is only shown in
detail mode.

all selected tributaries in loss of


signal
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

dsx1-ais-sync

Parameter type: <Alarm::DSX1AISFAIL>


( yes
| no )
Possible values:
- yes : Alarm Indication Signal on the tributary selected sync
source
- no : No Alarm Indication Signal on the tributary selected
sync source
Parameter type: <Alarm::DSX1LOFSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Frame on the tributary selected sync source
- no : No Loss of Frame on the tributary selected sync
source
Parameter type: <Alarm::DSX1LOSSYNCFAIL>
( yes
| no )
Possible values:
- yes : Loss of Signal on the tributary selected sync source
- no : No Loss of Signal on the tributary selected sync
source
Parameter type: <Alarm::DSX1DEGFAIL>
( yes
| no )
Possible values:
- yes : Signal degrade alarm
- no : Signal degrade alarm

alarm indication signal on the


tributary selected as sync source
This element is only shown in
detail mode.

dsx1-lof-sync

dsx1-los-sync

dsx1-deg-fail

3HH-04416-EBAA-TCZZA 01

loss of frame on the tributary


selected as sync source
This element is only shown in
detail mode.

loss of signal on the tributary


selected as sync source
This element is only shown in
detail mode.

signal degrade alarm


This element is only shown in
detail mode.

Released

1493

56 Alarm Snap-shot Status Commands

56.26 2xE1/DS1 SFP Framer Snapshot Status


Command
Command Description
This command displays the 2xE1/DS1 SFP Framer snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sfpe1t1-framer [ (index) ]

Command Parameters
Table 56.26-1 "2xE1/DS1 SFP Framer Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.26-2 "2xE1/DS1 SFP Framer Snapshot Status Command" Display parameters
Specific Information
name
alarm index 1

1494

Released

Type

Description

Parameter type: <Alarm::SlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| iont : <Eqpt::RackId> / <Eqpt::ShelfId>
|
lp
:
<Eqpt::RackId>
/
<Eqpt::ShelfId>
<Eqpt::LtAppliqueSlotId>
| ntio-1
| ntio-2 )
Possible values:

this is the nt/ntio slot id for host


alarms.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

alarm index 2

Type

Description

- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
- iont : an nt applique slot
- lp : an lt applique slot
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::LtAppliqueSlotId>
- the LT Applique slot number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::e1t1framerPort>
( sfp : <Alarm::E1t1FramerPort> : <Alarm::tributary>
| xfp : <Alarm::E1t1FramerPort> : <Alarm::tributary> )
Possible values:
- sfp : e1t1 sfp port
- xfp : e1t1 xfp port
Field type <Alarm::E1t1FramerPort>
- value
- range: [0...35]
Field type <Alarm::tributary>
- value
- range: [1...2]

Only Show Details: e1t1 framer alarms


name
Type
rei-from-liu

rdi-from-liu

crc6-from-liu

crc4-from-liu

3HH-04416-EBAA-TCZZA 01

this is the host sfp faceplate


number
This element is only shown in
detail mode.

Description

Parameter type: <Alarm::DSX1REILIU>


( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from LIU
- no : No e1t1 sfp Remote Error Indication Alarm from LIU
Parameter type: <Alarm::DSX1RDILIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from LIU
- no : No e1t1 sfp Remote Defect Alarmn from LIU
Parameter type: <Alarm::DSX1CRC6LIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 6 from LIU
Parameter type: <Alarm::DSX1CRC4LIU>
( yes
| no )

remote error indication alarm


from LIU
This element is only shown in
detail mode.
remote defect indication alarm
from LIU
This element is only shown in
detail mode.
cyclic redundancy check 6 from
LIU
This element is only shown in
detail mode.
cyclic redundancy check 4 from
LIU
This element is only shown in

Released

1495

56 Alarm Snap-shot Status Commands

name

crc4-thrshold-from-liu

ais-from-liu

los-from-liu

lof-from-liu

lomf-from-liu

rei-from-iwf

rdi-from-iwf

crc6-from-iwf

crc4-from-iwf

1496

Released

Type

Description

Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 from LIU
Parameter type: <Alarm::DSX1CRC4THLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from LIU
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from LIU
Parameter type: <Alarm::DSX1AISLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from LIU
- no : No e1t1 sfp Alarm Indication Signal alarm from LIU
Parameter type: <Alarm::DSX1LOSLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from LIU
- no : No e1t1 sfp Loss of signal alarm from LIU
Parameter type: <Alarm::DSX1LOFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from LIU
- no : No e1t1 sfp Loss of frame alarm from LIUU
Parameter type: <Alarm::DSX1LOMFLIU>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from LIU
- no : No e1t1 sfp Loss of multi frame alarm from LIU
Parameter type: <Alarm::DSX1REIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Error Indication Alarm from IWF
- no : No e1t1 sfp Remote Error Indication Alarm from IWF
Parameter type: <Alarm::DSX1RDIIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Remote Defect Alarmn from IWF
- no : No e1t1 sfp Remote Defect Alarmn from IWF
Parameter type: <Alarm::DSX1CRC6IWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 6 from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 6 from IWF
Parameter type: <Alarm::DSX1CRC4IWF>
( yes
| no )
Possible values:

detail mode.
cyclic redundancy check 4
threshold alarm from LIU
This element is only shown in
detail mode.

alarm indication signal alarm


from LIU
This element is only shown in
detail mode.
loss of signal alarm from LIU
This element is only shown in
detail mode.

loss of frame alarm from LIU


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.
remote error indication alarm
from IWF
This element is only shown in
detail mode.
remote defect indication alarm
from IWF
This element is only shown in
detail mode.
cyclic redundancy check 6 from
IWF
This element is only shown in
detail mode.
cyclic redundancy check 4 from
IWF
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
crc4-thrshold-from-iwf

ais-from-iwf

los-from-iwf

lof-from-iwf

lomf-from-iwf

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : e1t1 sfp Cyclic Redundancy Check 4 from IWF


- no : No e1t1 sfp Cyclic Redundancy Check 4 from IWF
Parameter type: <Alarm::DSX1CRC4THIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Cyclic Redundancy Check 4 threshold alarm
from IWF
- no : No e1t1 sfp Cyclic Redundancy Check 4 threshold
alarm from IWF
Parameter type: <Alarm::DSX1AISIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Alarm Indication Signal alarm from IWF
- no : No e1t1 sfp Alarm Indication Signal alarm from IWF
Parameter type: <Alarm::DSX1LOSIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of signal alarm from IWF
- no : No e1t1 sfp Loss of signal alarm from IWF
Parameter type: <Alarm::DSX1LOFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of frame alarm from IWF
- no : No e1t1 sfp Loss of frame alarm from IWF
Parameter type: <Alarm::DSX1LOMFIWF>
( yes
| no )
Possible values:
- yes : e1t1 sfp Loss of multi frame alarm from IWF
- no : No e1t1 sfp Loss of multi frame alarm from IWF

cyclic redundancy check 4


threshold alarm from IWF
This element is only shown in
detail mode.

alarm indication signal alarm


from IWF
This element is only shown in
detail mode.
loss of signal alarm from IWF
This element is only shown in
detail mode.

loss of frame alarm from IWF


This element is only shown in
detail mode.

loss of multi frame alarm from


LIU
This element is only shown in
detail mode.

Released

1497

56 Alarm Snap-shot Status Commands

56.27 Alarm Plug In Unit Extended Snap Shot


Status Command
Command Description
This command shows the alarm snap shot status for the extended plug in unit.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot plug-in-unit-ext [ (index) ]

Command Parameters
Table 56.27-1 "Alarm Plug In Unit Extended Snap Shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 56.27-2 "Alarm Plug In Unit Extended Snap Shot Status Command" Display parameters
Specific Information
name
board-position

1498

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identify where the alarm has


occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

fan-alarm

dc-a-alarm

dc-b-alarm

dg-alarm

apsf-alarm

ntr-a-loss

ntr-b-loss

xvps-conf-loss

3HH-04416-EBAA-TCZZA 01

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::pluginFan>
( yes
| no )
Possible values:
- yes : fan alarm
- no : no fan alarm
Parameter type: <Alarm::plugin-dc-a>
( yes
| no )
Possible values:
- yes : dc a failure alarm
- no : no dc a failure alarm
Parameter type: <Alarm::plugin-dc-b>
( yes
| no )
Possible values:
- yes : dc b failure alarm
- no : no dc b failure alarm
Parameter type: <Alarm::plugin-dg>
( yes
| no )
Possible values:
- yes : dying gasp alarm
- no : no dying gasp alarm
Parameter type: <Alarm::pluginApsf>
( yes
| no )
Possible values:
- yes : apsf failure alarm
- no : no apsf failure alarm
Parameter type: <Alarm::NTRALoss>
( yes
| no )
Possible values:
- yes : ntr-a signal unavailable
- no : ntr-a signal available
Parameter type: <Alarm::NTRBLoss>
( yes
| no )
Possible values:
- yes : ntr-b signal unavailable
- no : ntr-b signal available
Parameter type: <Alarm::XvpsConfLoss>
( yes
| no )
Possible values:

Description

current status specifying fan


alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-a
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dc-b
failure alarm is present or not
This element is only shown in
detail mode.
current status specifying dying
gasp alarm is present or not
This element is only shown in
detail mode.
power for the applique is
available or not
This element is only shown in
detail mode.
current status specifying NTR-A
loss alarm is present or not
This element is only shown in
detail mode.
current status specifying NTR-B
loss alarm is present or not
This element is only shown in
detail mode.
implicit xvps configuration loss
or not.
This element is only shown in
detail mode.

Released

1499

56 Alarm Snap-shot Status Commands

name

Type

mac-entry-nofree

fibre-conn-mismatch

link-cap-mismatch

eqpt-cap-mismatch

ctrl-dnld-failure

board-hw-issue

1500

Released

Description

- yes : implicit xvps configuration loss.


- no : no implicit xvps configuration loss.
Parameter type: <Alarm::MacNofree>
( nofree
| free )
Possible values:
- nofree : no free mac entry in the mac table on the lt board.
- free : file transfer server available.
Parameter type: <Alarm::FibreConnMismatch>
( yes
| no )
Possible values:
- yes : REM fibre connection mismatch alarm
- no : no REM fibre connection mismatch alarm
Parameter type: <Alarm::LinkCapMismatch>
( yes
| no )
Possible values:
- yes : actual link speed is not inline with the end-to-end link
capability between NT and LT
- no : actual link speed is inline with the end-to-end link
capability between NT and LT
Parameter type: <Alarm::EqptCapMismatch>
( yes
| no )
Possible values:
- yes : not all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
- no : all equipment between NT and LT can support the
speed that NT and LT can support within the configured
MaxLinkSpeed.
Parameter type: <Alarm::CtrlDownloadFailure>
( yes
| no )
Possible values:
- yes : The downloading of the Software image to the
controller card failed..
- no : The downloading of the Software image to the
controller card passed.
Parameter type: <Alarm::BoardHWIssue>
( yes
| no )
Possible values:
- yes : Board hardware issue
- no : No Board hardware issue.

current status specifying no free


mac entry in the mac table on the
lt board.
This element is only shown in
detail mode.
current status specifying fibre
connection mismatch on detected
control card.
This element is only shown in
detail mode.
log-status specifies that the actual
link speed is not in line with the
end-to-end
link
capability
between NT and LT.
This element is only shown in
detail mode.
log-status specifies that not all
equipment between NT and LT
can support the speed that NT
and LT can support within the
configured MaxLinkSpeed.
This element is only shown in
detail mode.

log-status specifies that the


downloading of the Software
image to the controller card
failed.
This element is only shown in
detail mode.
log-status specifies that Board
hardware issue.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.28 Alarm Snap-shot SIP Server Status


Command
Command Description
This command show the alarm snap-shot of SIP Server

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sip-server [ (index) ]

Command Parameters
Table 56.28-1 "Alarm Snap-shot SIP Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.28-2 "Alarm Snap-shot SIP Server Status Command" Display parameters
Specific Information
name
transport-mismatch

dns-lookup-failure

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::transportMismatch>


( yes
| no )
Possible values:
- yes : mismatch
- no : not mismatch
Parameter type: <Alarm::dnsLookUpFailure>
( yes
| no )
Possible values:
- yes : fail
- no : not fail

specifies isamv and server


transport mismatch or not.
This element is only shown in
detail mode.
specifies dns look up fail or not.
This element is only shown in
detail mode.

Released

1501

56 Alarm Snap-shot Status Commands

56.29 Alarm Snap-shot SIP VSP Status Command


Command Description
This command show the alarm snap-shot of SIP VSP

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sip-vsp [ (index) ]

Command Parameters
Table 56.29-1 "Alarm Snap-shot SIP VSP Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.29-2 "Alarm Snap-shot SIP VSP Status Command" Display parameters
Specific Information
name
none-dns-srv

no-dns-srv

none-srv

no-srv

1502

Released

Type

Description

Parameter type: <Alarm::noneDNSSRV>


( yes
| no )
Possible values:
- yes : none of dns server give reply to to DNS look up
- no : dns server give reply to to DNS look up
Parameter type: <Alarm::noDNSSRV>
( yes
| no )
Possible values:
- yes : no dns server configured when sip request
- no : dns server configured when sip request
Parameter type: <Alarm::noneSRV>
( yes
| no )
Possible values:
- yes : none sip server give reply when send sip request
- no : sip server give reply when send sip request
Parameter type: <Alarm::noSRV>

specifies none of dns server give


reply to to DNS look up or not.
This element is only shown in
detail mode.
specifies
no
dns
server
configured when sip request or
not.
This element is only shown in
detail mode.
specifies none sip server give
reply when send sip request or
not.
This element is only shown in
detail mode.
specifies no sip proxy server

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

reg-srv-unreach

prxy-srv-unreach

3HH-04416-EBAA-TCZZA 01

Type

Description

( yes
| no )
Possible values:
- yes : no sip proxy server configured when send sip request
- no : sip proxy server configured when send sip request
Parameter type: <Alarm::noRegSRV>
( yes
| no )
Possible values:
- yes : no sip register server give reply when send sip
register
- no : sip register server give reply when send sip register
Parameter type: <Alarm::noPrxySRV>
( yes
| no )
Possible values:
- yes : no sip proxy server give reply when send sip request
- no : sip proxy server give reply when send sip request

configured when send sip request


or not.
This element is only shown in
detail mode.
specifies no sip register servers
give reply when send sip register
or not.
This element is only shown in
detail mode.
specifies no sip proxy servers
give reply when send sip request
or not.
This element is only shown in
detail mode.

Released

1503

56 Alarm Snap-shot Status Commands

56.30 Alarm Snap-shot SIP Dial Plan Status


Command
Command Description
This command show the alarm snap-shot of SIP Dial Plan

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sip-dial-plan [ (index) ]

Command Parameters
Table 56.30-1 "Alarm Snap-shot SIP Dial Plan Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.30-2 "Alarm Snap-shot SIP Dial Plan Status Command" Display parameters
Specific Information
name
bad-digitmap

1504

Released

Type

Description

Parameter type: <Alarm::badDigitMap>


( yes
| no )
Possible values:
- yes : digit map unusable
- no : digit map usable

sepcifies the sip digitmap usable


or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.31 Alarm Snap-shot SIP Slot Status Command


Command Description
This command show the alarm snap-shot of SIP Slot

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sip-plugin-unit [ (index) ]

Command Parameters
Table 56.31-1 "Alarm Snap-shot SIP Slot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.31-2 "Alarm Snap-shot SIP Slot Status Command" Display parameters
Specific Information
name
dhcp-unreach

proxy-srv-unreach

reg-srv-unreach

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::dhcpServerUnreach>


( yes
| no )
Possible values:
- yes : DHCP server unreachable
- no : DHCP server reachable
Parameter type: <Alarm::sipProxyServerUnreach>
( yes
| no )
Possible values:
- yes : proxy server unreachable
- no : proxy server reachable
Parameter type: <Alarm::sipRegistratorServerUnreach>
( yes
| no )
Possible values:
- yes : registrator server unreachable
- no : registrator server reachable

specifies DHCP server status.


This element is only shown in
detail mode.

specifies sip proxy server status.


This element is only shown in
detail mode.

specifies sip registrator server


status.
This element is only shown in
detail mode.

Released

1505

56 Alarm Snap-shot Status Commands

56.32 Alarm Snap-shot SIP Termination Status


Command
Command Description
This command show the alarm snap-shot of SIP termination

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sip-termination [ (index) ]

Command Parameters
Table 56.32-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.32-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name
unknown-sub

ground-key

port-hightemp

1506

Released

Type

Description

Parameter type: <Alarm::unknownSubscriber>


( yes
| no )
Possible values:
- yes : wrong subscriber
- no : right subscriber
Parameter type: <Alarm::groundKey>
( yes
| no )
Possible values:
- yes : current to ground
- no : current not to ground
Parameter type: <Alarm::highTemperature>
( yes
| no )
Possible values:

specifies the sip subscriber


unknown or not.
This element is only shown in
detail mode.
status of the ground key.
This element is only shown in
detail mode.

status of the port temperature.


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
port-jbfltca

reg-domainname

reg-auth

reg-timeout

reg-srvfailresp

inv-domainname

inv-auth

inv-timeout

inv-srvfailresp

subs-srvfailresp

3HH-04416-EBAA-TCZZA 01

Type
- yes : high temperature
- no : not high temperature
Parameter type: <Alarm::jbflTca>
( yes
| no )
Possible values:
- yes : high jb fill level
- no : not high jb fill level
Parameter type: <Alarm::regdomainname>
( yes
| no )
Possible values:
- yes : register - resolving domain name failed
- no : register - resolving domain name successful
Parameter type: <Alarm::regauth>
( yes
| no )
Possible values:
- yes : register - authentication failed
- no : register - authentication successful
Parameter type: <Alarm::regtimeout>
( yes
| no )
Possible values:
- yes : register - message timeout
- no : register - message not timeout
Parameter type: <Alarm::regsrvfailresp>
( yes
| no )
Possible values:
- yes : register - failure response from server
- no : register - successful response from server
Parameter type: <Alarm::invdomainname>
( yes
| no )
Possible values:
- yes : invite - resolving domain name failed
- no : invite - resolving domain name successful
Parameter type: <Alarm::invauth>
( yes
| no )
Possible values:
- yes : invite - authentication failed
- no : invite - authentication successful
Parameter type: <Alarm::invtimeout>
( yes
| no )
Possible values:
- yes : invite - message timeout
- no : invite - message not timeout
Parameter type: <Alarm::invsrvfailresp>
( yes
| no )
Possible values:
- yes : invite - failure response from server
- no : invite - successful response from server
Parameter type: <Alarm::subssrvfailresp>

Description
status of the port jb fill level tca.
This element is only shown in
detail mode.

status of resolving domain name


(register).
This element is only shown in
detail mode.
status of authentication (register).
This element is only shown in
detail mode.

status of message timeout


(register).
This element is only shown in
detail mode.
status of failure response from
server (register).
This element is only shown in
detail mode.
status of resolving domain name
(invite).
This element is only shown in
detail mode.
status of authentication (invite).
This element is only shown in
detail mode.

status of message timeout


(invite).
This element is only shown in
detail mode.
status of failure response from
server (invite).
This element is only shown in
detail mode.
status of failure response from

Released

1507

56 Alarm Snap-shot Status Commands

name

subs-domainname

subs-auth

subs-refreshfail

subs-inittimeout

emergency-call

1508

Released

Type

Description

( yes
| no )
Possible values:
- yes : subscribe - failure response from server
- no : subscribe - successful response from server
Parameter type: <Alarm::subsdomainname>
( yes
| no )
Possible values:
- yes : Subscribe - resolving domain name failed
- no : Subscribe - resolving domain name successful
Parameter type: <Alarm::subsauth>
( yes
| no )
Possible values:
- yes : Subscribe - authentication failed
- no : Subscribe - authentication successful
Parameter type: <Alarm::subsrefreshfail>
( yes
| no )
Possible values:
- yes : Subscribe - refresh failure
- no : Subscribe - refresh failure
Parameter type: <Alarm::subsinittimeout>
( yes
| no )
Possible values:
- yes : Subscribe - initial REQ timeout
- no : Subscribe - initial REQ timeout
Parameter type: <Alarm::emergencycall>
( yes
| no )
Possible values:
- yes : emergency call is ongoing
- no : emergency call is not ongoing

server (subscribe).
This element is only shown in
detail mode.
status of resolving domain name
(subscribe).
This element is only shown in
detail mode.
status
of
authentication(subscribe).
This element is only shown in
detail mode.
status of message timeout or 481
received(refresher subscribe).
This element is only shown in
detail mode.
status of message timeouti(inital
subscribe).
This element is only shown in
detail mode.
status of emergency call.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.33 Alarm Snap-shot Megaco Media Gateway


Status Command
Command Description
This command show the alarm snap-shot of Megaco media gateway.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot megaco-media-gw [ (index) ]

Command Parameters
Table 56.33-1 "Alarm Snap-shot Megaco Media Gateway Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.33-2 "Alarm Snap-shot Megaco Media Gateway Status Command" Display parameters
Specific Information
name
mgc-unreachable

failover-to-esamgc

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::mgcUnreachable>


( yes
| no )
Possible values:
- yes : media gateway controller is unreachable
- no : media gateway controller is reachable
Parameter type: <Alarm::failovertoESAMGC>
( yes
| no )
Possible values:
- yes : failover to esa mgc
- no : normal mgc is in service

specifies the media gateway


controller is unreachable or not.
This element is only shown in
detail mode.
specifies the media gateway
failover to esa mgc or not.
This element is only shown in
detail mode.

Released

1509

56 Alarm Snap-shot Status Commands

56.34 Alarm Snap-shot Megaco Signaling Gateway


Status Command
Command Description
This command show the alarm snap-shot of Megaco signaling gateway.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot megaco-sig-gw [ (index) ]

Command Parameters
Table 56.34-1 "Alarm Snap-shot Megaco Signaling Gateway Status Command" Resource
Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.34-2 "Alarm Snap-shot Megaco Signaling Gateway Status Command" Display parameters
Specific Information
name
sig-unreachable

1510

Released

Type

Description

Parameter type: <Alarm::sgcUnreachable>


( yes
| no )
Possible values:
- yes : signallling gateway controller is unreachable
- no : signallling gateway controller is reachable

specifies the signaling gateway


controller is unreachable or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.35 Alarm Snap-shot Megaco Plug Unit Status


Command
Command Description
This command show the alarm snap-shot of Megaco plug unit.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot megaco-plug-unit [ (index) ]

Command Parameters
Table 56.35-1 "Alarm Snap-shot Megaco Plug Unit Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.35-2 "Alarm Snap-shot Megaco Plug Unit Status Command" Display parameters
Specific Information
name
lcard-unreach-srvcard

lcard-type-mismatch

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::lineCardUnreachSrvCard>


( yes
| no )
Possible values:
- yes : line card is unreachable with server card
- no : line card is reachable with server card
Parameter type: <Alarm::lineCardTypeMismathch>
( yes
| no )
Possible values:
- yes : line card type is mismatch
- no : line card type is match

specifies the line card is


unreachable with server card or
not.
This element is only shown in
detail mode.
specifies the line card type is
mismatch or not.
This element is only shown in
detail mode.

Released

1511

56 Alarm Snap-shot Status Commands

56.36 Alarm Snap-shot Megaco Termination Status


Command
Command Description
This command show the alarm snap-shot of Megaco termination.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot megaco-term [ (index) ]

Command Parameters
Table 56.36-1 "Alarm Snap-shot Megaco Termination Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.36-2 "Alarm Snap-shot Megaco Termination Status Command" Display parameters
Specific Information
name
meg-unknown-sub

meg-ground-key

meg-high-temp

1512

Released

Type

Description

Parameter type: <Alarm::megacoUnknownSubscriber>


( yes
| no )
Possible values:
- yes : unknown wrong megaco subscriber
- no : no wrong megaco subscriber
Parameter type: <Alarm::voicePortGroundKey>
( yes
| no )
Possible values:
- yes : voice port ground key
- no : voice port not ground key
Parameter type: <Alarm::voicePortHighTemp>
( yes
| no )
Possible values:

specifies the megaco subscriber is


unknown or not.
This element is only shown in
detail mode.
specifies the voice port ground
key or not.
This element is only shown in
detail mode.
specifies the voice port high
temperature or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
l1-act-fail

over-current

line-showering

low-qos-packetloss

low-qos-jitter

low-qos-delay

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : voice port high temperature


- no : voice port not high temperature
Parameter type: <Alarm::voicePortL1ActFail>
( yes
| no )
Possible values:
- yes : voice port l1 act failure
- no : voice port l1 act not failure
Parameter type: <Alarm::voicePortOverCurrent>
( yes
| no )
Possible values:
- yes : voice port over current
- no : voice port not over current
Parameter type: <Alarm::lineshowering>
( yes
| no )
Possible values:
- yes : line showering
- no : no line showering
Parameter type: <Alarm::lowQosPacketLoss>
( yes
| no )
Possible values:
- yes : the total packet loss has exceeded the configured
threshold
- no : the total packet loss has not exceeded the configured
threshold
Parameter type: <Alarm::lowQosJitter>
( yes
| no )
Possible values:
- yes : the rtp jitter has exceeded the configured threshold
- no : the rtp jitter has not exceeded the configured threshold
Parameter type: <Alarm::lowQosDelay>
( yes
| no )
Possible values:
- yes : the rtp delay has exceeded the configured threshold
- no : the rtp delay has not exceeded the configured
threshold

specifies the voice port l1 act


failure or not.
This element is only shown in
detail mode.
specifies the voice port over
current or not.
This element is only shown in
detail mode.
specifies the line showering or
not.
This element is only shown in
detail mode.
specifies the megaco total packet
loss has exceeded the configured
threshold or not.
This element is only shown in
detail mode.

specifies the megaco rtp jitter has


exceeded
the
configured
threshold or not.
This element is only shown in
detail mode.
specifies the megaco rtp delay
has exceeded the configured
threshold or not.
This element is only shown in
detail mode.

Released

1513

56 Alarm Snap-shot Status Commands

56.37 Alarm Snap-shot Megaco Signaling Lt Status


Command
Command Description
This command show the alarm snap-shot of Megaco signaling lt.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot megaco-sig-lt [ (index) ]

Command Parameters
Table 56.37-1 "Alarm Snap-shot Megaco Signaling Lt Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm type

Command Output
Table 56.37-2 "Alarm Snap-shot Megaco Signaling Lt Status Command" Display parameters
Specific Information
name
sig-brd-persist-loss

sig-brd-disk-full

sig-brd-db-rollback

1514

Released

Type

Description

Parameter type: <Alarm::megacoSigBoardPersDataLoss>


( yes
| no )
Possible values:
- yes : the voice signaling board persistenet data loss
- no : the voice signaling board persistenet data not loss
Parameter type: <Alarm::voiceSigBoard90PercentFull>
( yes
| no )
Possible values:
- yes : specifies the voice signaling board disk 90% full
- no : specifies the voice signaling board disk no 90% full
Parameter type: <Alarm::sigBoardDBRollback>
( yes
| no )
Possible values:

specifies the voice signaling


board persistenet data loss or not.
This element is only shown in
detail mode.
specifies the voice signaling
board disk 90% full or not.
This element is only shown in
detail mode.
specifies he voice signaling board
implicit db rollback or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

mg-overload

3HH-04416-EBAA-TCZZA 01

Type

Description

- yes : specifies the voice signaling board implicit db


rollback
- no : specifies the voice signaling board implicit db no
rollback
Parameter type: <Alarm::megMGOverLoad>
specifies the mg overload or not.
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : specifies the mg overload
- no : specifies the mg no overload

Released

1515

56 Alarm Snap-shot Status Commands

56.38 Alarm Snap-shot Shdsl Status Command


Command Description
This command show the alarm snap-shot of Shdsl

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot shdsl [ (index) ]

Command Parameters
Table 56.38-1 "Alarm Snap-shot Shdsl Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.38-2 "Alarm Snap-shot Shdsl Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValues>
identify where the alarm has
- a signed integer
occurred
This element is only shown in
detail mode.
Parameter type: <Alarm::LoopbackActiveNetwork>
snap shot of loopback active at
( yes
the network side
| no )
This element is only shown in
Possible values:
detail mode.

unit

loop-act-net

1516

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
loop-act-cus

config-error

loss-atm

loss-pr

secu-error

dev-fault

atm-ncd

3HH-04416-EBAA-TCZZA 01

Type
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::LoopbackActiveCustom>
( yes
| no )
Possible values:
- yes : loopback active
- no : no loopback active
Parameter type: <Alarm::ConfigError>
( yes
| no )
Possible values:
- yes : config error
- no : no config error
Parameter type: <Alarm::LossATMCellDel>
( yes
| no )
Possible values:
- yes : loss atm cell delineation
- no : no loss atm cell delineation
Parameter type: <Alarm::LossPowerSTUR>
( yes
| no )
Possible values:
- yes : loss power at stu-r
- no : no loss power at stu-r
Parameter type: <Alarm::UnableDisableSTUR>
( yes
| no )
Possible values:
- yes : loss ability at stu-r
- no : no loss ability at stu-r
Parameter type: <Alarm::DeviceFault>
( yes
| no )
Possible values:
- yes : device fault
- no : no device fault
Parameter type: <Alarm::ATMCellDel>
( yes
| no )
Possible values:
- yes : no atm cell delineation
- no : atm cell delineation

Description
snap shot of loopback active at
the custom side
This element is only shown in
detail mode.
snap shot of configuration error
This element is only shown in
detail mode.

snap shot of loss of atm cell


delineation
This element is only shown in
detail mode.
snap shot of loss of power at stu-r
This element is only shown in
detail mode.

snap shot of loss of ability to


disable stu-r access
This element is only shown in
detail mode.
snap shot of fault of device
This element is only shown in
detail mode.

snap shot of none of atm cell


delineation
This element is only shown in
detail mode.

Released

1517

56 Alarm Snap-shot Status Commands

56.39 Alarm Snap-shot Shdsl Status Command


Command Description
This command show the alarm snap-shot of Shdsl

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot shdsl-isam [ (index) ]

Command Parameters
Table 56.39-1 "Alarm Snap-shot Shdsl Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.39-2 "Alarm Snap-shot Shdsl Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LinkDeviceValuesHigh>
identify where the alarm has
- identify where the alarm occurred
occurred
This element is only shown in
detail mode.
Parameter type: <Alarm::LinkDeviceValuesLow>
identify where the alarm has
- identify where the alarm occurred
occurred
This element is only shown in
detail mode.

wire-pair

unit

1518

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

loss-syn-net

Parameter type: <Alarm::LossSyncWordNetwork>


( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LossSyncWordCustom>
( yes
| no )
Possible values:
- yes : loss sync word
- no : no loss sync word
Parameter type: <Alarm::LoopAttenuationNetwork>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::LoopAttenuationCustom>
( yes
| no )
Possible values:
- yes : loop attenuation
- no : no loop attenuation
Parameter type: <Alarm::SNRNetwork>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::SNRCustom>
( yes
| no )
Possible values:
- yes : snr margin
- no : no snr margin
Parameter type: <Alarm::DCContinuityFaultNetwork>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::DCContinuityFaultCustom>
( yes
| no )
Possible values:
- yes : dc fault
- no : no dc fault
Parameter type: <Alarm::ActivationFailureCustom>
( yes
| no )
Possible values:
- yes : activation failure
- no : no activation failure

snap shot of loss of sync word at


the network side on each pair
This element is only shown in
detail mode.

loss-syn-cus

loop-att-net

loop-att-cus

snr-net

snr-cus

dc-net

dc-cus

act-fail-cus

3HH-04416-EBAA-TCZZA 01

snap shot of loss of sync word at


the custom side on each pair
This element is only shown in
detail mode.
snap shot of loop attenuation
alarm at the network side on each
pair
This element is only shown in
detail mode.
snap shot of loop attenuation
alarm at the custom side on each
pair
This element is only shown in
detail mode.
snap shot of snr margin alarm at
the network side each pair
This element is only shown in
detail mode.
snap shot of snr margin alarm at
the custom side each pair
This element is only shown in
detail mode.
snap shot of dc continuity fault at
the network side on each pair
This element is only shown in
detail mode.
snap shot of dc continuity fault at
the custom side on each pair
This element is only shown in
detail mode.
snap shot of activation failure at
the custom side on each pair
This element is only shown in
detail mode.

Released

1519

56 Alarm Snap-shot Status Commands

56.40 Alarm Snap-shot Ima-Group Status


Command
Command Description
This command show the alarm snap-shot of Ima-Group

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ima-group [ (index) ]

Command Parameters
Table 56.40-1 "Alarm Snap-shot Ima-Group Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.40-2 "Alarm Snap-shot Ima-Group Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Equipm::AtmImaIndex>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::FarEndStartup>
snap shot of far-end starting up
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : far-end startup

far-end-start

1520

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name
far-end-fconf

near-end-fconf

far-end-ins-lnk

near-end-ins-lnk

far-end-blk

3HH-04416-EBAA-TCZZA 01

Type
- no : no far-end startup
Parameter type: <Alarm::FarEndFailedConfig>
( yes
| no )
Possible values:
- yes : far-end failed config
- no : no far-end failed config
Parameter type: <Alarm::NearEndFailedConfig>
( yes
| no )
Possible values:
- yes : near-end failed config
- no : no near-end failed config
Parameter type: <Alarm::FarEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at far-end
- no : no insufficient number of links at far-end
Parameter type: <Alarm::NearEndInsuffLinkNum>
( yes
| no )
Possible values:
- yes : insufficient number of links at near-end
- no : no insufficient number of links at near-end
Parameter type: <Alarm::FarEndBlocked>
( yes
| no )
Possible values:
- yes : far-end blocked
- no : no far-end blocked

Description
snap shot of failed configuration
of far-end
This element is only shown in
detail mode.
snap shot of failed configuration
of near-end
This element is only shown in
detail mode.
snap shot of insufficient number
of links at far-end
This element is only shown in
detail mode.
snap shot of insufficient number
of links at near-end
This element is only shown in
detail mode.
snap shot of status that far-end is
blocked
This element is only shown in
detail mode.

Released

1521

56 Alarm Snap-shot Status Commands

56.41 Alarm Snap-shot Ima-Link Status Command


Command Description
This command show the alarm snap-shot of Ima-Link

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ima-link [ (index) ]

Command Parameters
Table 56.41-1 "Alarm Snap-shot Ima-Link Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.41-2 "Alarm Snap-shot Ima-Link Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::ShdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::LossImaFrame>
snap shot of loss of ima frame
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : loss ima frame
- no : no loss ima frame
Parameter type: <Alarm::LinkOutofDelaySynch>
snap shot of link out of delay
( yes
synchronization

loss-ima-frm

lods

1522

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

link-misc

link-rfi

link-fault

fe-tx-blk

fe-rec-blk

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : link out of delay
- no : no link out of delay
Parameter type: <Alarm::LinkMisconnect>
( yes
| no )
Possible values:
- yes : link misconnect
- no : no link misconnect
Parameter type: <Alarm::LinkRemoteFailureIndication>
( yes
| no )
Possible values:
- yes : link remote failure indication
- no : no link remote failure indication
Parameter type: <Alarm::LinkFault>
( yes
| no )
Possible values:
- yes : fault in link facility
- no : no fault in link facility
Parameter type: <Alarm::FarEndTXBlocked>
( yes
| no )
Possible values:
- yes : transmit blocked due to far-end
- no : no transmit blocked due to far-end
Parameter type: <Alarm::FarEndRXBlocked>
( yes
| no )
Possible values:
- yes : receive blocked due to far-end
- no : no receive blocked due to far-end

This element is only shown in


detail mode.
snap
shot
of
link
of
misconnecting
This element is only shown in
detail mode.
snap shot of link of remote failure
indication
This element is only shown in
detail mode.
snap shot of fault of link
This element is only shown in
detail mode.

snap shot of transmit blocked due


to far-end
This element is only shown in
detail mode.
snap shot of receive blocked due
to far-end
This element is only shown in
detail mode.

Released

1523

56 Alarm Snap-shot Status Commands

56.42 Alarm Snap-shot Ether-Tca Status Command


Command Description
This command show the alarm snap-shot of Ether-Tca

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ether-tca [ (index) ]

Command Parameters
Table 56.42-1 "Alarm Snap-shot Ether-Tca Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.42-2 "Alarm Snap-shot Ether-Tca Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::EthernetPortIndex>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::EthTcaLos>
snap shot of ethernet los in 15
( yes
min
| no )
This element is only shown in
Possible values:
detail mode.
- yes : ethernet loss of signal errors exceeds
- no : ethernet loss of signal errors normal
Parameter type: <Alarm::EthTcaFcs>
snap shot of ethernet fcs in 15
( yes
min

etca-los

etca-fcs

1524

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

etca-rx-octets

etca-tx-octets

etca-day-los

etca-day-fcs

etca-day-rx-octets

etca-day-tx-octets

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : ethernet frame check sequence errors exceeds
- no : ethernet frame check sequence errors normal
Parameter type: <Alarm::EthTcaRxb>
( yes
| no )
Possible values:
- yes : received octets exceeds
- no : received octets normal
Parameter type: <Alarm::EthTcaTxb>
( yes
| no )
Possible values:
- yes : transmitted octets exceeds
- no : transmitted octets normal
Parameter type: <Alarm::EthDayLos>
( yes
| no )
Possible values:
- yes : ethernet day los errors exceeds
- no : ethernet day los errors normal
Parameter type: <Alarm::EthDayFcs>
( yes
| no )
Possible values:
- yes : ethernet day fcs errors exceeds
- no : ethernet day fcs errors normal
Parameter type: <Alarm::EthDayRxb>
( yes
| no )
Possible values:
- yes : received octets day exceeds
- no : received octets day normal
Parameter type: <Alarm::EthDayTxb>
( yes
| no )
Possible values:
- yes : transmitted octets day exceeds
- no : transmitted octets day normal

This element is only shown in


detail mode.
snap shot of received octets in 15
min
This element is only shown in
detail mode.
snap shot of transmitted octets in
15 min
This element is only shown in
detail mode.
snap shot of ethernet day los
This element is only shown in
detail mode.

snap shot of ethernet day fcs


This element is only shown in
detail mode.

snap shot of received octets in 1


day
This element is only shown in
detail mode.
snap shot of transmitted octets in
1 day
This element is only shown in
detail mode.

Released

1525

56 Alarm Snap-shot Status Commands

56.43 Alarm Snap-shot Ether-Sfp Status Command


Command Description
This command show the alarm snap-shot of Ether-Sfp

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ether-sfp [ (index) ]

Command Parameters
Table 56.43-1 "Alarm Snap-shot Ether-Sfp Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.43-2 "Alarm Snap-shot Ether-Sfp Status Command" Display parameters
Specific Information
name
port

Description

Parameter type: <Itf::EthernetPortIndex>


identifies the physical position
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::EthSfpLos>
snap shot of ethernet sfp los
( yes
This element is only shown
| no )
detail mode.
Possible values:
- yes : ethernet sfp los error
- no : ethernet sfp los normal
Parameter type: <Alarm::EthSfpTxFail>
snap shot of ethernet sfp tx
( yes
This element is only shown

sfp-los

sfp-tx-fail

1526

Type

Released

3HH-04416-EBAA-TCZZA

01

of
in

in

in

56 Alarm Snap-shot Status Commands

name

sfp-not-prst

sfp-inv-id

user-sfp-t-exceed

user-sfp-mismatch

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : ethernet sfp Tx Failure
- no : ethernet sfp Tx normal
Parameter type: <Alarm::EthSfpNotPrst>
( yes
| no )
Possible values:
- yes : ethernet sfp not detected
- no : ethernet sfp detected
Parameter type: <Alarm::EthSfpInvalid>
( yes
| no )
Possible values:
- yes : ethernet sfp id invalid
- no : ethernet sfp id normal
Parameter type: <Alarm::EthSfpTempExceed>
( yes
| no )
Possible values:
- yes : ethernet sfp temperature exceed
- no : ethernet sfp temperature normal
Parameter type: <Alarm::EthSfpMismatch>
( yes
| no )
Possible values:
- yes : ethernet sfp mismatch the configured type
- no : ethernet sfp match the configured type

detail mode.

snap shot of ethernet sfp presence


This element is only shown in
detail mode.

snap shot of ethernet sfp id


This element is only shown in
detail mode.

snap shot of ethernet sfp


temperature
This element is only shown in
detail mode.
snap shot of ethernet sfp type
This element is only shown in
detail mode.

Released

1527

56 Alarm Snap-shot Status Commands

56.44 Alarm Snap-shot SIP Termination Status


Command
Command Description
This command show the alarm snap-shot of Qos Slot

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot qos-slot [ (index) ]

Command Parameters
Table 56.44-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 56.44-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name
board-position

1528

Released

Type

Description

Parameter type: <Equipm::EqptSlotIndex>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf

identify where the alarm has


occurred.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

up-overflow

dw-overflow

upobc-overflow

dwobc-overflow

lwpriority-overflow

fanout

3HH-04416-EBAA-TCZZA 01

Type
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Alarm::up-overflow>
( yes
| no )
Possible values:
- yes : up overflow alarm
- no : no up overflow alarm
Parameter type: <Alarm::dw-overflow>
( yes
| no )
Possible values:
- yes : down overflow alarm
- no : no down overflow alarm
Parameter type: <Alarm::upobc-overflow>
( yes
| no )
Possible values:
- yes : up to obc overflow alarm
- no : no up to obc overflow alarm
Parameter type: <Alarm::dwobc-overflow>
( yes
| no )
Possible values:
- yes : down to obc overflow alarm
- no : no down to obc overflow alarm
Parameter type: <Alarm::lwpriority-overflow>
( yes
| no )
Possible values:
- yes : alarm
- no : no dying gasp alarm
Parameter type: <Alarm::fanout>
( yes
| no )
Possible values:
- yes : fan out alarm
- no : no fan out alarm

Description

Check LT load in upstream.


This element is always shown.

Check LT load in downstream.


This element is always shown.

Check LT load to OBC in


upstream.
This element is always shown.

Check LT load to OBC in


downstream.
This element is always shown.

Check Voice and Video load.


This element is always shown.

Check LT Load.
This element is always shown.

Released

1529

56 Alarm Snap-shot Status Commands

56.45 Alarm Snap-shot SIP Termination Status


Command
Command Description
This command show the alarm snap-shot of Qos Queue

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot qos-queue [ (index) ]

Command Parameters
Table 56.45-1 "Alarm Snap-shot SIP Termination Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snapshot table index

Command Output
Table 56.45-2 "Alarm Snap-shot SIP Termination Status Command" Display parameters
Specific Information
name
port

1530

Type

Description

Parameter type: <Itf::PhyLine>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number

Released

identifies the physical position of


/ the port
This element is always shown.
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

queue
queue-discard-overflow

queue-load

3HH-04416-EBAA-TCZZA 01

Type
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Qos::AlarmQueues>
- identify where the alarm has occurred
- range: [0...7]
Parameter type: <Alarm::queue-discard-overflow>
( yes
| no )
Possible values:
- yes : queue discard alarm
- no : no queue discard alarm
Parameter type: <Alarm::queue-load>
( yes
| no )
Possible values:
- yes : queue load alarm
- no : no queue load alarm

Description

identify where the alarm has


occurred.
This element is always shown.
Check the corresponding queue
Load.
This element is always shown.

Check the corresponding queue


Load.
This element is always shown.

Released

1531

56 Alarm Snap-shot Status Commands

56.46 Alarm File Transfer Server Status Command


Command Description
This command displays the snap-shot of file transfer server alarm

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot filetransfer [ (index) ]

Command Parameters
Table 56.46-1 "Alarm File Transfer Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.46-2 "Alarm File Transfer Server Status Command" Display parameters
Specific Information
name
server-id

Description

Parameter type: <Alarm::FileTransfer>


- next hop IP address

identify where the alarm has


occurred.
This element is only shown in
detail mode.
Parameter type: <Alarm::FileTransferUnavial>
current status specifing that
( unavailable
whether file transfer server
| available )
available
Possible values:
This element is only shown in
- unavailable : file transfer Server unavailable or file transfer detail mode.
failed
- available : file transfer server available

fileserv-unavail

1532

Type

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.47 Alarm Lsm Redundancy Status Command


Command Description
This command displays the snap-shot of Lsm Redundancy alarm

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot lsmredundancy [ (index) ]

Command Parameters
Table 56.47-1 "Alarm Lsm Redundancy Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.47-2 "Alarm Lsm Redundancy Status Command" Display parameters
Specific Information
name
board-station

loss-lsmswp-cap

inv-xvps-pair-data

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Equipm::LtSlotIndex>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Alarm::SwoCap>
( loss
| not-loss )
Possible values:
- loss : system loss of the swichover capability
- not-loss : system not loss of the swichover capability
Parameter type: <Alarm::DataXvps>
( invalid
| valid )
Possible values:

physical number of the slot for


lsm redundancy alarms
This element is only shown in
detail mode.

snapshot of the switchover


capability in a redundant system
This element is only shown in
detail mode.
log status of the data of xvps pair
This element is only shown in
detail mode.

Released

1533

56 Alarm Snap-shot Status Commands

name

Type

Description

- invalid : data of xvps pair is not the same


- valid : data of xvps pair is same

1534

Released

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.48 Alarm L2 Forward Status Command


Command Description
This command displays the snap-shot of l2 forward alarm

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot l2forward [ (index) ]

Command Parameters
Table 56.48-1 "Alarm L2 Forward Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.48-2 "Alarm L2 Forward Status Command" Display parameters
Specific Information
name
bridgeport

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::BridgePort>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identify the bridge port where the


/ alarm has occurred.
This element is only shown in
/ detail mode.
/
/
/
/
/

Released

1535

56 Alarm Snap-shot Status Commands

name

Type

vlan-id

mac-conflict

vmac-full

1536

Description

Field type <Eqpt::PortId>


- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlanSigned>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Alarm::MACconflict>
( yes
| no )
Possible values:
- yes : duplicate mac address from this bridge port
- no : no duplicate mac address from this bridge port
Parameter type: <Alarm::VMACFull>
( yes
| no )
Possible values:
- yes : virtual mac entry full on this bridge port
- no : no virtual mac entry full on this bridge port

Released

identify the vlan id where the


alarm has occurred.
This element is only shown in
detail mode.

specifies whether duplicate mac


address from the bridge port.
This element is only shown in
detail mode.
specifies whether virtual mac is
full on the bridge port.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.49 Alarm Snap-shot External Device Status


Command
Command Description
This command show the alarm snap-shot of external-device

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot external-device [ (index) ]

Command Parameters
Table 56.49-1 "Alarm Snap-shot External Device Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.49-2 "Alarm Snap-shot External Device Status Command" Display parameters
Specific Information
name
loss-env-mon

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::LossEnvMon>


( lost
| not-lost )
Possible values:
- lost : env-mon box lost or not alive
- not-lost : env-mon box exists

snap shot status of env-monitor


box
This element is only shown in
detail mode.

Released

1537

56 Alarm Snap-shot Status Commands

56.50 Sync Clock Alarm SnapShot Status


Command
Command Description
This command displays the synce and bits snapShot alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sync [ (index) ]

Command Parameters
Table 56.50-1 "Sync Clock Alarm SnapShot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm log table index

Command Output
Table 56.50-2 "Sync Clock Alarm SnapShot Status Command" Display parameters
Only Show Details: slot information
name
Type
slot

1538

Description

Parameter type: <Alarm::SynceSlot>


( ntio-1
| ntio-2
| nt-a
| nt-b
| nt
| not-used
| nt )
Possible values:
- ntio-1 : an nt applique slot in a single or multiple-ntio-shelf
- ntio-2 : an nt applique slot in a multiple-ntio-shelf
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot for bits
- nt : active nt slot
- not-used : no interface

Released

identifies the synce port where


the alarm has occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

port

Parameter type: <Alarm::SyncePort>


( sfp : <Alarm::SynceClk>
| xfp : <Alarm::SynceClk>
| bits-a
| bits-b
| ieee1588-a
| not-used
| ieee1588-b )
Possible values:
- sfp : synce reference on sfp port
- xfp : synce reference on xfp port
- bits-a : bits clock source on nt-a
- bits-b : bits clock source on nt-b
- ieee1588-a : ieee1588 clock source on nt-a
- ieee1588-b : ieee1588 clock source on nt-b
- not-used : not-used
Field type <Alarm::SynceClk>
- value
- range: [0...16]

identifies the synce port where


the alarm has occurred.
This element is only shown in
detail mode.

Only Show Details: snap-shot alarm status


name
Type
bits-fail

synce-fail

bits-output-shutoff

3HH-04416-EBAA-TCZZA 01

Parameter type: <Alarm::BitsFail>


( yes
| no )
Possible values:
- yes : bits source failed
- no : no bits source failed
Parameter type: <Alarm::SynceFail>
( yes
| no )
Possible values:
- yes : synce source failed
- no : no synce source failed
Parameter type: <Alarm::BitsOutputShutoffFail>
( yes
| no )
Possible values:
- yes : bits output shutoff
- no : no bits output shutoff

Description
specifies whether bits clock
source has failed or not
This element is only shown in
detail mode.
specifies whether synce clock
source has failed or not
This element is only shown in
detail mode.
specifies whether bits output
failed or not
This element is only shown in
detail mode.

Released

1539

56 Alarm Snap-shot Status Commands

56.51 LT CFM Alarm SnapShot Status Command


Command Description
This command displays the SnapShot lt cfm alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot cfm [ (index) ]

Command Parameters
Table 56.51-1 "LT CFM Alarm SnapShot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

cfm log table index

Command Output
Table 56.51-2 "LT CFM Alarm SnapShot Status Command" Display parameters
Specific Information
name

Type

Description

cfm-mep-id

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

cfm-unique-id

Parameter type: <Alarm::IdentificationIdxOrZero>


- a signed integer

additional-info

Parameter type: <PrintableString>


- printable string

dot1agCfmMepIdentifier index
where the alarm has occurred.
This element is only shown in
detail mode.
unique identification for the
alarm or zero when not
applicable, alarm entry is further
specified in additional-info
This element is only shown in
detail mode.
Additional information regarding
the cfm alarm
This element is only shown in
detail mode.

Only Show Details: alarm snap-shot status


name
Type
cfm-defrdiccm

1540

Parameter type: <Alarm::IacmCfmRdiCcm>


( yes
| no )

Released

Description
specifies rdi bit in ccm received
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

cfm-defmacstatus

cfm-defremoteccm

cfm-deferrorccm

cfm-defxconccm

3HH-04416-EBAA-TCZZA 01

Type
Possible values:
- yes : rdi bit in ccm received
- no : no rdi bit in ccm received
Parameter type: <Alarm::IacmCfmMacError>
( yes
| no )
Possible values:
- yes : mac error status
- no : no mac error status
Parameter type: <Alarm::IacmCfmMepCcm>
( yes
| no )
Possible values:
- yes : missing ccm from mep
- no : no missing ccm from mep
Parameter type: <Alarm::IacmCfmInvalidCcm>
( yes
| no )
Possible values:
- yes : invalid ccm received
- no : no invalid ccm received
Parameter type: <Alarm::IacmCfmUnexpectedCcm>
( yes
| no )
Possible values:
- yes : unexpected ccm received
- no : no unexpected ccm received

Description

ccm mac error status


This element is only shown in
detail mode.

specifies missing ccm from mep


This element is only shown in
detail mode.

specifies invalid ccm received


This element is only shown in
detail mode.

specifies
unexpected
ccm
received
This element is only shown in
detail mode.

Released

1541

56 Alarm Snap-shot Status Commands

56.52 EFM-OAM alarm Snap-shot Status Command


Command Description
This command shows the snap-shot of EFM-OAM alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot efm-oam [ (index) ]

Command Parameters
Table 56.52-1 "EFM-OAM alarm Snap-shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

current alarm index

Command Output
Table 56.52-2 "EFM-OAM alarm Snap-shot Status Command" Display parameters
Specific Information
name
line

Type

Only Show Details: snap-shot alarm status


name
Type
link-fault

1542

Description

Parameter type: <Itf::EfmEthernetIndex>


identifies the line where the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / alarm has occurred.
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Parameter type: <Alarm::linkFaultType>


( yes
| no )
Possible values:
- yes : link fault at cpe/onu
- no : link fault is not exist

Released

Description
Link fault at cpe
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

name

Type

Description

dying-gasp

Parameter type: <Alarm::dyingGaspType>


( yes
| no )
Possible values:
- yes : dying gasp is exist
- no : dying gasp is not exist
Parameter type: <Alarm::criticalEventType>
( yes
| no )
Possible values:
- yes : critical event is exist
- no : critical event is not exist

received dying gasp indication


from cpe
This element is only shown in
detail mode.

critical-event

3HH-04416-EBAA-TCZZA 01

receive critical event indication


from cpe
This element is only shown in
detail mode.

Released

1543

56 Alarm Snap-shot Status Commands

56.53 Alarm Table Snapshot Status Command


Command Description
This command displays the alarm-table snapshot-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot alarm-table [ (index) ]

Command Parameters
Table 56.53-1 "Alarm Table Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.53-2 "Alarm Table Snapshot Status Command" Display parameters
Specific Information
name
alrm-tbl-overflow

1544

Released

Type

Description

Parameter type: <Alarm::AlrmTblOflow>


( overflow
| no-overflow )
Possible values:
- overflow : alarm table overflow
- no-overflow : no alarm table overflow

identify if the alarm table has


overflowed
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

56 Alarm Snap-shot Status Commands

56.54 Auto-Switch Alarm Snapshot Status


Command
Command Description
This command displays the status of the snapshot of auto-switch alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot auto-switch [ (index) ]

Command Parameters
Table 56.54-1 "Auto-Switch Alarm Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 56.54-2 "Auto-Switch Alarm Snapshot Status Command" Display parameters
Specific Information
name
port

auto-switch-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::XdslLine>


identifies the physical position of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the port
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Alarm::autoSwitchStatus>
show auto-switch alarm status.
( yes
This element is only shown in
| no )
detail mode.
Possible values:
- yes : auto-switch alarm status

Released

1545

56 Alarm Snap-shot Status Commands

name

Type

Description

- no : auto-switch alarm status clear

1546

Released

3HH-04416-EBAA-TCZZA

01

57- Alarm Delta Log Status Commands

57.1 Alarm Delta Log Status Command Tree


57.2 Alarm Generic Delta Alarm Log Status Command
57.3 Indeterminate Alarm Delta Log Status Command
57.4 Warning Alarm Delta Log Status Command
57.5 Minor Alarm Delta Log Status Command
57.6 Major Alarm Delta Log Status Command
57.7 Critical Alarm Delta Log Status Command

3HH-04416-EBAA-TCZZA 01

57-1548
57-1549
57-1551
57-1569
57-1587
57-1605
57-1623

Released

1547

57 Alarm Delta Log Status Commands

57.1 Alarm Delta Log Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Alarm Delta Log Status Commands".

Command Tree
----show
----alarm
----delta-log
----alarm-changes
----indeterminate
- (index)
----warning
- (index)
----minor
- (index)
----major
- (index)
----critical
- (index)

1548

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.2 Alarm Generic Delta Alarm Log Status


Command
Command Description
This command displays the number of reported alarm changes per severity level and in total.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log alarm-changes

Command Output
Table 57.2-2 "Alarm Generic Delta Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

all

Parameter type: <Counter>


- 32 bit counter

indeterminate

Parameter type: <Counter>


- 32 bit counter

warning

Parameter type: <Counter>


- 32 bit counter

minor

Parameter type: <Counter>


- 32 bit counter

major

Parameter type: <Counter>


- 32 bit counter

critical

Parameter type: <Counter>


- 32 bit counter

total number of changes of all


reported alarms since startup and
is independent of the alarm
severity level.
This element is always shown.
total number of changes of all
reported alarms with a severity
level indeterminate since startup.
This element is always shown.
total number of changes of all
reported alarms with a severity
level warning since startup.
This element is always shown.
total number of changes of all
reported alarms with a severity
level minor since startup.
This element is always shown.
total number of changes of all
reported alarms with a severity
level major since startup.
This element is always shown.
total number of changes of all
reported alarms with a severity
level critical since startup.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1549

57 Alarm Delta Log Status Commands

1550

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.3 Indeterminate Alarm Delta Log Status


Command
Command Description
This command displays alarm values for all reported alarms with a severity level indeterminate.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log indeterminate [ (index) ]

Command Parameters
Table 57.3-1 "Indeterminate Alarm Delta Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

delta log alarm table index

Command Output
Table 57.3-2 "Indeterminate Alarm Delta Log Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmIndex>


( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs

unique id for an alarm.


This element is always shown.

Released

1551

57 Alarm Delta Log Status Commands

name

Type

Description

| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom
| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| auto-fetch-failure
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch

1552

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| shelf-missing
| shelf-install-missing
| door
| ac-power-fail
| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3

3HH-04416-EBAA-TCZZA 01

Released

1553

57 Alarm Delta Log Status Commands

name

Type

Description

| der-temp4
| der-temp5
| der-temp6
| der-temp7
| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29

1554

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1
| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail

3HH-04416-EBAA-TCZZA 01

Released

1555

57 Alarm Delta Log Status Commands

name

Type

Description

| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl
| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp

1556

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss
| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn

3HH-04416-EBAA-TCZZA 01

Released

1557

57 Alarm Delta Log Status Commands

name

Type

Description

| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail
| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault

1558

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus
| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event

3HH-04416-EBAA-TCZZA 01

Released

1559

57 Alarm Delta Log Status Commands

name

Type

Description

- vectline-xtc-var-vict : excessive victim crosstalk


coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation
- vectline-corp-errf : corrupted or missing errorf-samples
- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- auto-fetch-failure : not able to fetch file from specified
server
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure

1560

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- sem-power-fail : SEM external power failure


- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal
- vlan-assign-fail : failure to assign VLAN for a user session
- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6

3HH-04416-EBAA-TCZZA 01

Released

1561

57 Alarm Delta Log Status Commands

name

Type

Description

- der-temp7 : derived alarm for temporal filter 7


- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10
- der-temp11 : derived alarm for temporal filter 11
- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure

1562

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- custextalarm1 : Customizable External Alarm Number 1


- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4
- custextalarm5 : Customizable External Alarm Number 5
- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold

3HH-04416-EBAA-TCZZA 01

Released

1563

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-packets-exceed : protocol cfm packets exceed


threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair
- shdsl-c-losw : loss of sync word at the customer side on
each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).

1564

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- subs-refreshfail : Subscribe failure (refresh failure).


- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch
- dns-lookup-failure : Dns look up failure
- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal

3HH-04416-EBAA-TCZZA 01

Released

1565

57 Alarm Delta Log Status Commands

name

Type

Description

- user-sfp-tx-fail : user sfp tx failure


- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed
- user-sfp-mismatch : user sfp mismatch the configured type
- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm

1566

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from
LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event

3HH-04416-EBAA-TCZZA 01

Released

1567

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-defrdiccm : rdi bit in ccm received


- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received
- cfm-defxconccm : unexpected ccm received
- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::AlarmState>
( active
| non-active )
Possible values:
- active : alarm is active
- non-active : alarm is not active
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

state

last-updated-on
additional-info

Only Show Details: indeterminate alarm table related generic information


name
Type
total-changes

Parameter type: <Counter>


- 32 bit counter

last-entry-id

Parameter type: <SignedInteger>


- a signed integer

last-reset

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed
- no : no buffer overflow

1568

Released

reflect's the state of the alarm as


either active or non-active.
This element is always shown.

network time in seconds when


the alarm was logged.
This element is always shown.
AdditionalInfo
This element is always shown.

Description
total number of changes of all
reported alarms with a severity
level indeterminate since startup.
This element is only shown in
detail mode.
last entry that was added to the
indeterminate delta log.
This element is only shown in
detail mode.
network
time
in
seconds
indicating
when
the
indeterminate delta log was last
reset.
This element is only shown in
detail mode.
specifies
whether
the
indeterminate delta log is
overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.4 Warning Alarm Delta Log Status Command


Command Description
This command displays alarm values for all reported alarms with a severity level warning.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log warning [ (index) ]

Command Parameters
Table 57.4-1 "Warning Alarm Delta Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

delta log alarm table index

Command Output
Table 57.4-2 "Warning Alarm Delta Log Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmIndex>


( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom

unique id for an alarm.


This element is always shown.

Released

1569

57 Alarm Delta Log Status Commands

name

Type

Description

| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| auto-fetch-failure
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail

1570

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7

3HH-04416-EBAA-TCZZA 01

Released

1571

57 Alarm Delta Log Status Commands

name

Type

Description

| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1

1572

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl

3HH-04416-EBAA-TCZZA 01

Released

1573

57 Alarm Delta Log Status Commands

name

Type

Description

| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss

1574

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail

3HH-04416-EBAA-TCZZA 01

Released

1575

57 Alarm Delta Log Status Commands

name

Type

Description

| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus

1576

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation

3HH-04416-EBAA-TCZZA 01

Released

1577

57 Alarm Delta Log Status Commands

name

Type

Description

- vectline-corp-errf : corrupted or missing errorf-samples


- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- auto-fetch-failure : not able to fetch file from specified
server
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal

1578

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- vlan-assign-fail : failure to assign VLAN for a user session


- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6
- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10

3HH-04416-EBAA-TCZZA 01

Released

1579

57 Alarm Delta Log Status Commands

name

Type

Description

- der-temp11 : derived alarm for temporal filter 11


- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure
- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4

1580

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- custextalarm5 : Customizable External Alarm Number 5


- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair

3HH-04416-EBAA-TCZZA 01

Released

1581

57 Alarm Delta Log Status Commands

name

Type

Description

- shdsl-c-losw : loss of sync word at the customer side on


each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).
- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch

1582

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- dns-lookup-failure : Dns look up failure


- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed

3HH-04416-EBAA-TCZZA 01

Released

1583

57 Alarm Delta Log Status Commands

name

Type

Description

- user-sfp-mismatch : user sfp mismatch the configured type


- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm
from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from

1584

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event
- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received

3HH-04416-EBAA-TCZZA 01

Released

1585

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-defxconccm : unexpected ccm received


- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::AlarmState>
( active
| non-active )
Possible values:
- active : alarm is active
- non-active : alarm is not active
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

state

last-updated-on
additional-info

Only Show Details: warning alarm table related generic information


name
Type
changes

Parameter type: <Counter>


- 32 bit counter

last-entry-id

Parameter type: <SignedInteger>


- a signed integer

last-reset

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed
- no : no buffer overflow

1586

Released

reflect's the state of the alarm as


either active or non-active.
This element is always shown.

network time in seconds when


the alarm was logged.
This element is always shown.
AdditionalInfo
This element is always shown.

Description
total number of changes of all
reported alarms with a severity
level warning since startup.
This element is only shown in
detail mode.
last entry that was added to the
warning delta log.
This element is only shown in
detail mode.
network
time
in
seconds
indicating when the warning delta
log was last reset.
This element is only shown in
detail mode.
specifies whether the warning
delta log is overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.5 Minor Alarm Delta Log Status Command


Command Description
This command displays alarm values for all reported alarms with a severity level minor.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log minor [ (index) ]

Command Parameters
Table 57.5-1 "Minor Alarm Delta Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

delta log alarm table index

Command Output
Table 57.5-2 "Minor Alarm Delta Log Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmIndex>


( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom

unique id for an alarm.


This element is always shown.

Released

1587

57 Alarm Delta Log Status Commands

name

Type

Description

| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| auto-fetch-failure
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail

1588

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7

3HH-04416-EBAA-TCZZA 01

Released

1589

57 Alarm Delta Log Status Commands

name

Type

Description

| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1

1590

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl

3HH-04416-EBAA-TCZZA 01

Released

1591

57 Alarm Delta Log Status Commands

name

Type

Description

| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss

1592

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail

3HH-04416-EBAA-TCZZA 01

Released

1593

57 Alarm Delta Log Status Commands

name

Type

Description

| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus

1594

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation

3HH-04416-EBAA-TCZZA 01

Released

1595

57 Alarm Delta Log Status Commands

name

Type

Description

- vectline-corp-errf : corrupted or missing errorf-samples


- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- auto-fetch-failure : not able to fetch file from specified
server
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal

1596

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- vlan-assign-fail : failure to assign VLAN for a user session


- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6
- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10

3HH-04416-EBAA-TCZZA 01

Released

1597

57 Alarm Delta Log Status Commands

name

Type

Description

- der-temp11 : derived alarm for temporal filter 11


- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure
- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4

1598

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- custextalarm5 : Customizable External Alarm Number 5


- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair

3HH-04416-EBAA-TCZZA 01

Released

1599

57 Alarm Delta Log Status Commands

name

Type

Description

- shdsl-c-losw : loss of sync word at the customer side on


each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).
- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch

1600

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- dns-lookup-failure : Dns look up failure


- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed

3HH-04416-EBAA-TCZZA 01

Released

1601

57 Alarm Delta Log Status Commands

name

Type

Description

- user-sfp-mismatch : user sfp mismatch the configured type


- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm
from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from

1602

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event
- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received

3HH-04416-EBAA-TCZZA 01

Released

1603

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-defxconccm : unexpected ccm received


- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::AlarmState>
( active
| non-active )
Possible values:
- active : alarm is active
- non-active : alarm is not active
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

state

last-updated-on
additional-info

Only Show Details: minor alarm table related generic information


name
Type
changes

Parameter type: <Counter>


- 32 bit counter

last-entry-id

Parameter type: <SignedInteger>


- a signed integer

last-reset

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed
- no : no buffer overflow

1604

Released

reflect's the state of the alarm as


either active or non-active.
This element is always shown.

network time in seconds when


the alarm was logged.
This element is always shown.
AdditionalInfo
This element is always shown.

Description
total number of changes of all
reported alarms with a severity
level minor since startup.
This element is only shown in
detail mode.
last entry that was added to the
minor delta log.
This element is only shown in
detail mode.
network
time
in
seconds
indicating when the minor delta
log was last reset.
This element is only shown in
detail mode.
specifies whether the minor delta
log is overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.6 Major Alarm Delta Log Status Command


Command Description
This command displays alarm values for all reported alarms with a severity level major.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log major [ (index) ]

Command Parameters
Table 57.6-1 "Major Alarm Delta Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

delta log alarm table index

Command Output
Table 57.6-2 "Major Alarm Delta Log Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmIndex>


( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom

unique id for an alarm.


This element is always shown.

Released

1605

57 Alarm Delta Log Status Commands

name

Type

Description

| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| auto-fetch-failure
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail

1606

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7

3HH-04416-EBAA-TCZZA 01

Released

1607

57 Alarm Delta Log Status Commands

name

Type

Description

| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1

1608

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl

3HH-04416-EBAA-TCZZA 01

Released

1609

57 Alarm Delta Log Status Commands

name

Type

Description

| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss

1610

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail

3HH-04416-EBAA-TCZZA 01

Released

1611

57 Alarm Delta Log Status Commands

name

Type

Description

| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus

1612

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation

3HH-04416-EBAA-TCZZA 01

Released

1613

57 Alarm Delta Log Status Commands

name

Type

Description

- vectline-corp-errf : corrupted or missing errorf-samples


- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- auto-fetch-failure : not able to fetch file from specified
server
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal

1614

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- vlan-assign-fail : failure to assign VLAN for a user session


- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6
- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10

3HH-04416-EBAA-TCZZA 01

Released

1615

57 Alarm Delta Log Status Commands

name

Type

Description

- der-temp11 : derived alarm for temporal filter 11


- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure
- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4

1616

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- custextalarm5 : Customizable External Alarm Number 5


- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair

3HH-04416-EBAA-TCZZA 01

Released

1617

57 Alarm Delta Log Status Commands

name

Type

Description

- shdsl-c-losw : loss of sync word at the customer side on


each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).
- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch

1618

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- dns-lookup-failure : Dns look up failure


- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed

3HH-04416-EBAA-TCZZA 01

Released

1619

57 Alarm Delta Log Status Commands

name

Type

Description

- user-sfp-mismatch : user sfp mismatch the configured type


- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm
from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from

1620

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event
- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received

3HH-04416-EBAA-TCZZA 01

Released

1621

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-defxconccm : unexpected ccm received


- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::AlarmState>
( active
| non-active )
Possible values:
- active : alarm is active
- non-active : alarm is not active
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

state

last-updated-on
additional-info

Only Show Details: major alarm table related generic information


name
Type
changes

Parameter type: <Counter>


- 32 bit counter

last-entry-id

Parameter type: <SignedInteger>


- a signed integer

last-reset

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed
- no : no buffer overflow

1622

Released

reflect's the state of the alarm as


either active or non-active.
This element is always shown.

network time in seconds when


the alarm was logged.
This element is always shown.
AdditionalInfo
This element is always shown.

Description
total number of changes of all
reported alarms with a severity
level major since startup.
This element is only shown in
detail mode.
last entry that was added to the
major delta log.
This element is only shown in
detail mode.
network
time
in
seconds
indicating when the major delta
log was last reset.
This element is only shown in
detail mode.
specifies whether the major delta
log is overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

57.7 Critical Alarm Delta Log Status Command


Command Description
This command displays alarm values for all reported alarms with a severity level critical.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log critical [ (index) ]

Command Parameters
Table 57.7-1 "Critical Alarm Delta Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

delta log alarm table index

Command Output
Table 57.7-2 "Critical Alarm Delta Log Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::alarmIndex>


( xtca-ne-es
| xtca-ne-ses
| xtca-ne-uas
| xtca-ne-day-es
| xtca-ne-day-ses
| xtca-ne-day-uas
| xtca-fe-es
| xtca-fe-ses
| xtca-fe-uas
| xtca-fe-day-es
| xtca-fe-day-ses
| xtca-fe-day-uas
| xtca-leftrs
| xtca-day-leftrs
| xtca-fe-leftrs
| xtca-fe-day-leftrs
| xdsl-ne-los
| xdsl-ne-lof
| xdsl-ne-lom

unique id for an alarm.


This element is always shown.

Released

1623

57 Alarm Delta Log Status Commands

name

Type

Description

| xdsl-ne-ese
| xdsl-act-cfg-error
| xdsl-act-not-feas
| xdsl-up-br-reach
| xdsl-ne-ncd
| xdsl-ne-lcd
| xdsl-fe-los
| xdsl-fe-lof
| xdsl-fe-lpr
| xdsl-fe-lol
| xdsl-fe-lom
| xdsl-fe-ese
| xdsl-fe-upbo-vio
| xdsl-fe-cpe-pol
| xdsl-tpstc-mis
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| xdsl-frtx-init-fail
| xdsl-vect-dle
| vectline-xtc-var-vict
| vectline-xtc-var-dist
| vectline-corp-errf
| vect-cpe-cap-mismatch
| vectline-conf_notfeas
| vect-vp-lt-mismatch
| vect-inv-qsfp
| vect-vp-lt-fail
| sw-rollback
| db-rollback
| xvps-inv-dbase
| inv-cde-file
| miss-cde-file
| cde-hash-error
| auto-fetch-failure
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| vmac-full
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-95%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| shelf-missing
| shelf-install-missing
| door
| ac-power-fail

1624

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| board-missing
| board-instl-missing
| board-init
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vlan-assign-fail
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas
| non-bonding-cpe
| multiple-cpes
| register
| group-incomplete
| host-sfp-los
| host-sfp-tx-fail
| host-sfp-not-prst
| host-sfp-inv-id
| host-sfp-ctrl-fail
| host-sfp-rmtlt
| host-sfp-mismatch
| host-sfp-incompt
| exp-sfp-los
| exp-sfp-tx-fail
| exp-sfp-not-prst
| exp-sfp-inv-id
| exp-sfp-ctrl-fail
| exp-sfp-1-los
| exp-sfp-2-los
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| ping-check-fail
| der-temp1
| der-temp2
| der-temp3
| der-temp4
| der-temp5
| der-temp6
| der-temp7

3HH-04416-EBAA-TCZZA 01

Released

1625

57 Alarm Delta Log Status Commands

name

Type

Description

| der-temp8
| der-temp9
| der-temp10
| der-temp11
| der-temp12
| der-temp13
| der-temp14
| der-temp15
| der-temp16
| der-temp17
| der-temp18
| der-temp19
| der-temp20
| der-temp21
| der-temp22
| der-temp23
| der-temp24
| der-temp25
| der-temp26
| der-temp27
| der-temp28
| der-temp29
| der-temp30
| der-temp31
| der-spa1
| der-spa2
| der-spa3
| der-spa4
| der-spa5
| der-spa6
| der-spa7
| der-spa8
| der-spa9
| der-spa10
| der-spa11
| der-spa12
| der-spa13
| der-spa14
| der-spa15
| der-spa16
| der-spa17
| der-spa18
| der-spa19
| der-spa20
| der-spa21
| der-spa22
| der-spa23
| der-spa24
| der-spa25
| der-spa26
| der-spa27
| der-spa28
| der-spa29
| der-spa30
| der-spa31
| apsf-alarm
| custextalarm1

1626

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| custextalarm2
| custextalarm3
| custextalarm4
| custextalarm5
| pluginfan
| plugin-dc-a
| plugin-dc-b
| plugin-dg
| ntr-a-loss
| ntr-b-loss
| xvps-conf-loss
| mac-entry-nofree
| fibre-conn-mismatch
| link-cap-mismatch
| eqpt-cap-mismatch
| ctrl-dnld-failure
| board-hw-issue
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| onu-unprovisioned
| signal-loss
| bitrate-high
| opmodule-mismatch
| key-fail-one-churn
| key-fail-three-churn
| oam-discov-fail
| report-timeout
| total-packets-exceed
| arp-packets-exceed
| dhcp-packets-exceed
| igmp-packets-exceed
| pppoe-packets-exceed
| nd-packets-exceed
| icmpv6-packets-exceed
| mld-packets-exceed
| dhcpv6-packets-exceed
| cfm-packets-exceed
| shdsl-n-losw
| shdsl-c-losw
| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| shdsl-c-actfail
| ima-grp-fe-su
| ima-grp-fe-cfg
| ima-grp-ne-cfg
| ima-grp-fe-nl

3HH-04416-EBAA-TCZZA 01

Released

1627

57 Alarm Delta Log Status Commands

name

Type

Description

| ima-grp-ne-nl
| ima-grp-fe-blk
| ima-lnk-lif
| ima-lnk-lods
| ima-lnk-misc
| ima-lnk-rfi
| ima-lnk-fault
| ima-lnk-txblk
| ima-lnk-rxblk
| bad-digitmap
| dhcp-unreach
| unknown-sub
| ground-key
| port-hightemp
| port-jbfltca
| reg-domainname
| reg-auth
| reg-timeout
| reg-srvfailresp
| inv-domainname
| inv-auth
| inv-timeout
| inv-srvfailresp
| subs-srvfailresp
| subs-domainname
| subs-auth
| subs-refreshfail
| subs-inittimeout
| emergency-call
| transport-mismatch
| dns-lookup-failure
| none-dns-srv
| no-dns-srv
| none-srv
| no-srv
| reg-srv-unreach
| proxy-srv-unreach
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| mgc-unreachable
| failover-to-esamgc
| sgc-unreachable
| lcard-unreach-srvcard
| lcard-type-mismatch
| meg-unknown-sub
| meg-ground-key
| meg-high-temp
| meg-act-fail
| meg-over-current
| line-showering
| low-qos-packetloss

1628

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| low-qos-jitter
| low-qos-delay
| sig-brd-persist-loss
| sig-brd-disk-full
| sig-brd-db-rollback
| mg-overload
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| etca-rx-octets
| etca-tx-octets
| etca-day-rx-octets
| etca-day-tx-octets
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id
| user-sfp-t-exceed
| user-sfp-mismatch
| loss-lsmswp-cap
| inv-xvps-pair-data
| network-power-loss
| hw-fault
| bat-a-fail
| bat-b-fail
| network-power-loss-b
| sem-ac-power-fail
| sem-ups-fail
| dc-a-fail
| plan-power-mismatch
| synce-fail
| bits-fail
| bits-output-shutoff
| tx-power-high-alarm
| tx-power-low-alarm
| rx-power-high-alarm
| rx-power-low-alarm
| tx-biascur-high-alarm
| tx-biascur-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| rx-power-high-warn
| rx-power-low-warn
| tx-biascur-high-warn
| tx-biascur-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| dsx1-serdes-fail
| dsx1-tributary1-fail

3HH-04416-EBAA-TCZZA 01

Released

1629

57 Alarm Delta Log Status Commands

name

Type

Description

| dsx1-tributary2-fail
| dsx1-los-fail
| dsx1-ais-sync
| dsx1-lof-sync
| dsx1-los-sync
| dsx1-deg-fail
| dsx1-rei-from-liu
| dsx1-rdi-from-liu
| dsx1-crc6-from-liu
| dsx1-crc4-from-liu
| dsx1-crc4-th-from-liu
| dsx1-ais-from-liu
| dsx1-los-from-liu
| dsx1-lof-from-liu
| dsx1-lomf-from-liu
| dsx1-rei-from-iwf
| dsx1-rdi-from-iwf
| dsx1-crc6-from-iwf
| dsx1-crc4-from-iwf
| dsx1-crc4-th-from-iwf
| dsx1-ais-from-iwf
| dsx1-los-from-iwf
| dsx1-lof-from-iwf
| dsx1-lomf-from-iwf
| tx-power-high-alarm
| tx-power-low-alarm
| tx-bias-high-alarm
| tx-bias-low-alarm
| volt-high-alarm
| volt-low-alarm
| temp-high-alarm
| temp-low-alarm
| tx-power-high-warn
| tx-power-low-warn
| tx-bias-high-warn
| tx-bias-low-warn
| volt-high-warn
| volt-low-warn
| temp-high-warn
| temp-low-warn
| xfp-txpwr-high-alarm
| xfp-txpwr-low-alarm
| xfp-tx-bias-high-alarm
| xfp-tx-bias-low-alarm
| xfp-txpwr-high-warn
| xfp-txpwr-low-warn
| xfp-tx-bias-high-warn
| xfp-tx-bias-low-warn
| pppce-trans-15min-tca
| pppce-sess-15min-tca
| pppce-trans-1day-tca
| pppce-sess-1day-tca
| efm-oam-cpelinkfault
| efm-oam-cpedyinggasp
| efm-oam-cpecrevt
| cfm-defrdiccm
| cfm-defmacstatus

1630

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

| cfm-defremoteccm
| cfm-deferrorccm
| cfm-defxconccm
| alrm-tbl-overflow
| auto-switch-status )
Possible values:
- xtca-ne-es : errored seconds in 15 min
- xtca-ne-ses : severely errored seconds in 15 min
- xtca-ne-uas : unavailable seconds in 15 min
- xtca-ne-day-es : errored seconds in 1 day
- xtca-ne-day-ses : severely errored seconds in 1 day
- xtca-ne-day-uas : unavailable seconds in 1 day
- xtca-fe-es : errored seconds in 15 min
- xtca-fe-ses : severely errored secs in 15 min
- xtca-fe-uas : unavailable seconds in 15 min
- xtca-fe-day-es : errored seconds in 1 day
- xtca-fe-day-ses : severely errored secs in 1 day
- xtca-fe-day-uas : unavailable seconds in 1 day
- xtca-leftrs : low error free throughput seconds in 15 min
- xtca-day-leftrs : low error free throughput seconds in 1 day
- xtca-fe-leftrs : far end low error free throughput seconds in
15 min
- xtca-fe-day-leftrs : far end low error free throughput
seconds in 1 day
- xdsl-ne-los : loss of signal
- xdsl-ne-lof : loss of frame
- xdsl-ne-lom : loss of margin
- xdsl-ne-ese : excessive severe errors
- xdsl-act-cfg-error : line configuration data cannot be used
- xdsl-act-not-feas : line capacity not enough to setup
requested profile
- xdsl-up-br-reach : planned bitrate not reached after
initialization
- xdsl-ne-ncd : no cell delineation
- xdsl-ne-lcd : loss of cell delineation
- xdsl-fe-los : loss of signal
- xdsl-fe-lof : loss of frame
- xdsl-fe-lpr : loss of power
- xdsl-fe-lol : loss of link
- xdsl-fe-lom : loss of margin
- xdsl-fe-ese : excessive severe errors
- xdsl-fe-upbo-vio : upbo violation
- xdsl-fe-cpe-pol : activation failure cpe policing
- xdsl-tpstc-mis : mismatch between the configured tps-tc
mode and the mode supported by the connected cpe
- xdsl-act-comm : init not successful due to communications
problem
- xdsl-act-modem : no peer modem detected
- xdsl-do-br-reach : planned bitrate not reached after init
- xdsl-fe-ncd : no cell delineation
- xdsl-fe-lcd : loss of cell delineation
- xdsl-frtx-init-fail : init not successful due to forced rtx
- xdsl-vect-dle : vectoring disorderly leaving event
- vectline-xtc-var-vict : excessive victim crosstalk
coefficients variation
- vectline-xtc-var-dist : excessive disturber crosstalk
coefficients variation

3HH-04416-EBAA-TCZZA 01

Released

1631

57 Alarm Delta Log Status Commands

name

Type

Description

- vectline-corp-errf : corrupted or missing errorf-samples


- vect-cpe-cap-mismatch : not allowed Vectoring CPE
connected
- vectline-conf_notfeas : vect line configuration not feasable
- vect-vp-lt-mismatch : actual vp-lt connection(s) do not
match expected vp-lt connection(s) or vp-lt connection lost
- vect-inv-qsfp : qsfp has no valid Alcatel-Lucent ID
- vect-vp-lt-fail : vp-lt connection not operational
- sw-rollback : non active oswp,db cannot be operational will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- xvps-inv-dbase : invalid xvps dbase
- inv-cde-file : invalid xvps cde file
- miss-cde-file : missing cde profile
- cde-hash-error : cde profile hash error
- auto-fetch-failure : not able to fetch file from specified
server
- cell-discard-up : cell discarded in the upstream direction
- cell-discard-down : cell discarded in the downstream
direction
- persist-data-loss : all data lost after restart - system not
configured
- mac-conflict : duplicate mac address from this pvc
- vmac-full : virtual mac entry full on this pvc
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-95%full : nt disk 95% full
- shub-loc : communication lost with shub
- back-pnl-inv : BackPanel-type Invalid
- shub-conf-loss : SHub configuration loss - recent changes
lost
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different from planned type
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- ac-power-fail : external power failure - shelf shutdown in
15 minutes
- board-mismatch : board inserted different from planned
- waiting-for-sw : not able to download all the applicable sw
files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- sem-power-fail : SEM external power failure
- sem-ups-fail : SEM external power supply failure
- board-reset-cf : board reset and/or communication failure
- shub-uplink : lanx uplink breakdown or removal

1632

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- vlan-assign-fail : failure to assign VLAN for a user session


- up-plan-bitrate : upstream bitrate is above min and below
planned
- up-min-bitrate : upstream bitrate is below min bitrate
- up-config-not-feas : upstream bitrate is not enough to set
up config group
- down-plan-bitrate : downstream bitrate is above min and
below planned
- down-min-bitrate : downstream bitrate is below min bitrate
- down-config-not-feas : downstream bitrate is not enough to
set up config group
- non-bonding-cpe : no bonding cpe modem is connected
- multiple-cpes : bonding group has multiple cpe modems
connected
- register : bonding group discovery or aggregation register
failure
- group-incomplete : bonding group is incomplete
- host-sfp-los : loss of signal
- host-sfp-tx-fail : Tx failure
- host-sfp-not-prst : not present
- host-sfp-inv-id : no valid Alcatel-Lucent ID
- host-sfp-ctrl-fail : control failure
- host-sfp-rmtlt : unexpected remote plug-in
- host-sfp-mismatch : assignment does not match reported
rack/shelf/slot
- host-sfp-incompt : incompatible shelf type detected
- exp-sfp-los : expansion side loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel-Lucent ID
- exp-sfp-ctrl-fail : control failure
- exp-sfp-1-los : expansion side sfp1 loss of signal
- exp-sfp-2-los : expansion side sfp2 loss of signal
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- he-custom1 : host expansion customizable alarm 1
- he-custom2 : host expansion customizable alarm 2
- he-custom3 : host expansion customizable alarm 3
- he-custom4 : host expansion customizable alarm 4
- he-custom5 : host expansion customizable alarm 5
- he-custom6 : host expansion customizable alarm 6
- loss-over-cap : switch over capability in a redundant
system
- ping-check-fail : ping check in a redundant system
- der-temp1 : derived alarm for temporal filter 1
- der-temp2 : derived alarm for temporal filter 2
- der-temp3 : derived alarm for temporal filter 3
- der-temp4 : derived alarm for temporal filter 4
- der-temp5 : derived alarm for temporal filter 5
- der-temp6 : derived alarm for temporal filter 6
- der-temp7 : derived alarm for temporal filter 7
- der-temp8 : derived alarm for temporal filter 8
- der-temp9 : derived alarm for temporal filter 9
- der-temp10 : derived alarm for temporal filter 10

3HH-04416-EBAA-TCZZA 01

Released

1633

57 Alarm Delta Log Status Commands

name

Type

Description

- der-temp11 : derived alarm for temporal filter 11


- der-temp12 : derived alarm for temporal filter 12
- der-temp13 : derived alarm for temporal filter 13
- der-temp14 : derived alarm for temporal filter 14
- der-temp15 : derived alarm for temporal filter 15
- der-temp16 : derived alarm for temporal filter 16
- der-temp17 : derived alarm for temporal filter 17
- der-temp18 : derived alarm for temporal filter 18
- der-temp19 : derived alarm for temporal filter 19
- der-temp20 : derived alarm for temporal filter 20
- der-temp21 : derived alarm for temporal filter 21
- der-temp22 : derived alarm for temporal filter 22
- der-temp23 : derived alarm for temporal filter 23
- der-temp24 : derived alarm for temporal filter 24
- der-temp25 : derived alarm for temporal filter 25
- der-temp26 : derived alarm for temporal filter 26
- der-temp27 : derived alarm for temporal filter 27
- der-temp28 : derived alarm for temporal filter 28
- der-temp29 : derived alarm for temporal filter 29
- der-temp30 : derived alarm for temporal filter 30
- der-temp31 : derived alarm for temporal filter 31
- der-spa1 : derived alarm for spatial filter 1
- der-spa2 : derived alarm for spatial filter 2
- der-spa3 : derived alarm for spatial filter 3
- der-spa4 : derived alarm for spatial filter 4
- der-spa5 : derived alarm for spatial filter 5
- der-spa6 : derived alarm for spatial filter 6
- der-spa7 : derived alarm for spatial filter 7
- der-spa8 : derived alarm for spatial filter 8
- der-spa9 : derived alarm for spatial filter 9
- der-spa10 : derived alarm for spatial filter 10
- der-spa11 : derived alarm for spatial filter 11
- der-spa12 : derived alarm for spatial filter 12
- der-spa13 : derived alarm for spatial filter 13
- der-spa14 : derived alarm for spatial filter 14
- der-spa15 : derived alarm for spatial filter 15
- der-spa16 : derived alarm for spatial filter 16
- der-spa17 : derived alarm for spatial filter 17
- der-spa18 : derived alarm for spatial filter 18
- der-spa19 : derived alarm for spatial filter 19
- der-spa20 : derived alarm for spatial filter 20
- der-spa21 : derived alarm for spatial filter 21
- der-spa22 : derived alarm for spatial filter 22
- der-spa23 : derived alarm for spatial filter 23
- der-spa24 : derived alarm for spatial filter 24
- der-spa25 : derived alarm for spatial filter 25
- der-spa26 : derived alarm for spatial filter 26
- der-spa27 : derived alarm for spatial filter 27
- der-spa28 : derived alarm for spatial filter 28
- der-spa29 : derived alarm for spatial filter 29
- der-spa30 : derived alarm for spatial filter 30
- der-spa31 : derived alarm for spatial filter 31
- apsf-alarm : Applique Power Supply Failure
- custextalarm1 : Customizable External Alarm Number 1
- custextalarm2 : Customizable External Alarm Number 2
- custextalarm3 : Customizable External Alarm Number 3
- custextalarm4 : Customizable External Alarm Number 4

1634

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- custextalarm5 : Customizable External Alarm Number 5


- pluginfan : REM Fan Alarm
- plugin-dc-a : REM DC A Alarm
- plugin-dc-b : REM DC B Alarm
- plugin-dg : Dying Gasp Alarm
- ntr-a-loss : NTR-A signal is not available
- ntr-b-loss : NTR-B signal is not available
- xvps-conf-loss : xvps configuration loss
- mac-entry-nofree : no free mac entry in the mac table on lt
board
- fibre-conn-mismatch : REM Fibre Connection Mismatch
Alarm
- link-cap-mismatch : Link speed capability mismatch
- eqpt-cap-mismatch : Link equipment capability mismatch
- ctrl-dnld-failure : Controller card download failure
- board-hw-issue : Board hardware issue
- fileserv-unavail : file transfer Server unavailable or file
transfer failed
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the customer side
- shdsl-conferr : configuration error
- shdsl-atm-lcd : loss of atm cell delineation
- shdsl-lpr : loss of power at stu-r
- shdsl-secu-err : unable to disable stu-r access
- shdsl-dev-fault : device fault
- shdsl-atm-ncd : no atm cell delineation
- onu-unprovisioned : unprovisioned ont
- signal-loss : pon loss of signal
- bitrate-high : the error bit rate high at pon interface
- opmodule-mismatch : the optical module mismatched at
pon interface
- key-fail-one-churn : key exchange failure during one
churning time
- key-fail-three-churn : key exchange failure during three
churning time
- oam-discov-fail : extend oam discovery failure
- report-timeout : report timeout detecting
- total-packets-exceed : total amount of protocol packets
exceed threshold
- arp-packets-exceed : protocol arp packets exceed threshold
- dhcp-packets-exceed : protocol dhcp packets exceed
threshold
- igmp-packets-exceed : protocol igmp packets exceed
threshold
- pppoe-packets-exceed : protocol pppoe packets exceed
threshold
- nd-packets-exceed : protocol nd packets exceed threshold
- icmpv6-packets-exceed : protocol icmpv6 packets exceed
threshold
- mld-packets-exceed : protocol mld packets exceed
threshold
- dhcpv6-packets-exceed : protocol dhcpv6 packets exceed
threshold
- cfm-packets-exceed : protocol cfm packets exceed
threshold
- shdsl-n-losw : loss of sync word at the network side on
each pair

3HH-04416-EBAA-TCZZA 01

Released

1635

57 Alarm Delta Log Status Commands

name

Type

Description

- shdsl-c-losw : loss of sync word at the customer side on


each pair
- shdsl-n-aten : loop attenuation alarm at the network side on
each pair
- shdsl-c-aten : loop attenuation alarm at the customer side
on each pair
- shdsl-n-snr : snr margin alarm at the network side each pair
- shdsl-c-snr : snr margin alarm at the customer side on each
pair
- shdsl-n-dccont : dc continuity fault at the network side on
each pair
- shdsl-c-dccont : dc continuity fault at the customer side on
each pair
- shdsl-c-actfail : activation failure at the customer side on
each pair
- ima-grp-fe-su : far-end starting up
- ima-grp-fe-cfg : far-end failed configuration
- ima-grp-ne-cfg : near-end failed configuration
- ima-grp-fe-nl : insufficient number of links at far-end
- ima-grp-ne-nl : insufficient number of links at near-end
- ima-grp-fe-blk : far-end is blocked
- ima-lnk-lif : loss of ima frame
- ima-lnk-lods : link out of delay synchronization
- ima-lnk-misc : link misconnect
- ima-lnk-rfi : link remote failure indication
- ima-lnk-fault : fault in link facility
- ima-lnk-txblk : transmit blocked due to far-end
- ima-lnk-rxblk : receive blocked due to far-end
- bad-digitmap : Configured digitmap is unusable
- dhcp-unreach : The DHCP server is unreachable
- unknown-sub : subscriber exist in the POLT, but not in the
appl server
- ground-key : Return current to the ground
- port-hightemp : Temperature threshold on user port
exceeded.
- port-jbfltca : JB fill level threshold on user port exceeded.
- reg-domainname : Registration failure (resolving domain
name).
- reg-auth : Registration failure (authentication).
- reg-timeout : Registration failure (message timeout).
- reg-srvfailresp : Registration failure (failure response from
server).
- inv-domainname : Invitation failure (resolving domain
name).
- inv-auth : Invitation failure (authentication).
- inv-timeout : Invitation failure (message timeout).
- inv-srvfailresp : Invitation failure (failure response from
server).
- subs-srvfailresp : Subscribe failure (failure response from
server).
- subs-domainname : Subscribe failure (resolving domain
name).
- subs-auth : Subscribe failure (authentication).
- subs-refreshfail : Subscribe failure (refresh failure).
- subs-inittimeout : Subscribe failure (initial REQ timeout).
- emergency-call : Emergency call is ongoing.
- transport-mismatch : Transport protocol mismatch

1636

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

- dns-lookup-failure : Dns look up failure


- none-dns-srv : No reply for all DNS serverd
- no-dns-srv : No DNS servers configured
- none-srv : No reply for all SIP First Hops
- no-srv : No SIP First Hop configured
- reg-srv-unreach : All SIP register servers are unreachable
- proxy-srv-unreach : All SIP proxy servers are unreachable
- fanout : Lt load overflow
- up-overflow : Upstream load overflow
- upobc-overflow : Upstream load to OBC overflow
- dwobc-overflow : Downstream load to OBC overflow
- dw-overflow : Downstream load overflow
- lwpri-overflow : The number of BE and CL pkts dropped
exceed threshold
- queue-drop : The number of pkts dropped by queue
exceeds threshold
- queue-load : The queue load exceeds threshold
- mgc-unreachable : loss of contact with the media gateway
controller
- failover-to-esamgc : failover to esa mgc
- sgc-unreachable : loss of contact with signaling gateway
controller
- lcard-unreach-srvcard : line card unreachable with server
card
- lcard-type-mismatch : associate board of wrong type
- meg-unknown-sub : the megaco subscriber is unknown
- meg-ground-key : voice port ground key
- meg-high-temp : voice port high temperature
- meg-act-fail : the first link layer for isdn subscriber
activation failure
- meg-over-current : voice port over current
- line-showering : line showering
- low-qos-packetloss : the total packet loss has exceeded the
configured threshold
- low-qos-jitter : the rtp jitter has exceeded the configured
threshold
- low-qos-delay : the rtp delay has exceeded the configured
threshold
- sig-brd-persist-loss : voice signaling board persistent data
loss
- sig-brd-disk-full : voice signaling board disk 90% full
- sig-brd-db-rollback : voice signaling board db rollback
- mg-overload : mg overload
- loss-env-mon : env-monitor box lost or not alive
- etca-los : loss of signal errors in 15 min
- etca-fcs : frame check sequence errors in 15 min
- etca-day-los : loss of signal errors in 1 day
- etca-day-fcs : frame check sequence errors in 1 day
- etca-rx-octets : received octets in 15 min
- etca-tx-octets : transmitted octets in 15 min
- etca-day-rx-octets : received octets in 1 day
- etca-day-tx-octets : transmitted octets in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : user sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
- user-sfp-t-exceed : user sfp temperature exceed

3HH-04416-EBAA-TCZZA 01

Released

1637

57 Alarm Delta Log Status Commands

name

Type

Description

- user-sfp-mismatch : user sfp mismatch the configured type


- loss-lsmswp-cap : lsm redundancy
- inv-xvps-pair-data : invalid xvps pair redundancy data
- network-power-loss : Loss of Network Power
- hw-fault : Hardware Failure
- bat-a-fail : Power Source BAT-A Fail
- bat-b-fail : Power Source BAT-B Fail
- network-power-loss-b : Loss of Network Power B
- sem-ac-power-fail : External AC power supply failure
- sem-ups-fail : External power supply low voltage
- dc-a-fail : Local DC A power failure
- plan-power-mismatch : Planned and detected power mode
mismatch
- synce-fail : synce clock source failure
- bits-fail : bits clock source failure
- bits-output-shutoff : bits output failure
- tx-power-high-alarm : tx power more than alarm range
- tx-power-low-alarm : tx power less than alarm range
- rx-power-high-alarm : rx power more than alarm range
- rx-power-low-alarm : rx power less than alarm range
- tx-biascur-high-alarm : tx bias current high alarm
- tx-biascur-low-alarm : tx bias current low alarm
- volt-high-alarm : voltage high alarm
- volt-low-alarm : voltage low alarm
- temp-high-alarm : temperature high alarm
- temp-low-alarm : temperature low alarm
- tx-power-high-warn : tx power more than warn range
- tx-power-low-warn : tx power less than warn range
- rx-power-high-warn : rx power more than warn range
- rx-power-low-warn : rx power less than warn range
- tx-biascur-high-warn : tx bias current high warn
- tx-biascur-low-warn : tx bias current low warn
- volt-high-warn : voltage high warn
- volt-low-warn : voltage low warn
- temp-high-warn : temperature high warn
- temp-low-warn : temperature low warn
- dsx1-serdes-fail : SERDES clock alarm failure
- dsx1-tributary1-fail : The tributary 1 clock is not present
- dsx1-tributary2-fail : The tributary 2 clock is not present
- dsx1-los-fail : All the selected tribs in Loss of Signal
- dsx1-ais-sync : Alarm Indication signal on the tributary
selected as sync source
- dsx1-lof-sync : Loss of Framing on the tributary selected
as sync source
- dsx1-los-sync : Loss of signal on the tributary selected as
sync source
- dsx1-deg-fail : Signal degrade Alarm
- dsx1-rei-from-liu : Remote Error Indication alarm from
LIU
- dsx1-rdi-from-liu : Remote Defect Alarm from LIU
- dsx1-crc6-from-liu : Cylic Redundancy check-6 alarm
from LIU
- dsx1-crc4-from-liu : Cylic Redundancy check-4 alarm
from LIU
- dsx1-crc4-th-from-liu : Cylic Redundancy check-4
threshold alarm from LIU
- dsx1-ais-from-liu : Alarm Indication Signal alarm from

1638

Released

3HH-04416-EBAA-TCZZA

01

57 Alarm Delta Log Status Commands

name

Type

Description

LIU
- dsx1-los-from-liu : Loss of signal alarm from LIU
- dsx1-lof-from-liu : Loss of framing alarm from LIU
- dsx1-lomf-from-liu : Loss of Multi-frame alarm from LIU
- dsx1-rei-from-iwf : Remote Error Indication alarm from
IWF
- dsx1-rdi-from-iwf : Remote Defect Alarm from IWF
- dsx1-crc6-from-iwf : Cylic Redundancy check-6 alarm
from IWF
- dsx1-crc4-from-iwf : Cylic Redundancy check-4 alarm
from IWF
- dsx1-crc4-th-from-iwf : Cylic Redundancy check-4
threshold alarm from IWF
- dsx1-ais-from-iwf : Alarm Indication Signal alarm from
IWF
- dsx1-los-from-iwf : Loss of signal alarm from IWF
- dsx1-lof-from-iwf : Loss of framing alarm from IWF
- dsx1-lomf-from-iwf : Loss of Multi-frame alarm from IWF
- tx-power-high-alarm : Olt sfp tx power high alarm
- tx-power-low-alarm : Olt sfp tx power low alarm
- tx-bias-high-alarm : Olt sfp tx bias high alarm
- tx-bias-low-alarm : Olt sfp tx bias low alarm
- volt-high-alarm : Olt sfp voltage high alarm
- volt-low-alarm : Olt sfp voltage low alarm
- temp-high-alarm : Olt sfp temperature high alarm
- temp-low-alarm : Olt sfp temperature low alarm
- tx-power-high-warn : Olt sfp tx power high warn
- tx-power-low-warn : Olt sfp tx power low warn
- tx-bias-high-warn : Olt sfp tx bias high warn
- tx-bias-low-warn : Olt sfp tx bias low warn
- volt-high-warn : Olt sfp voltage high warn
- volt-low-warn : Olt sfp voltage low warn
- temp-high-warn : Olt sfp temperature high warn
- temp-low-warn : Olt sfp temperature low warn
- xfp-txpwr-high-alarm : Olt Xfp tx power high alarm
- xfp-txpwr-low-alarm : Olt Xfp tx power low alarm
- xfp-tx-bias-high-alarm: Olt Xfp tx bias high alarm
- xfp-tx-bias-low-alarm : Olt Xfp tx bias low alarm
- xfp-txpwr-high-warn : Olt Xfp tx power high alarm
- xfp-txpwr-low-warn : Olt Xfp tx power low alarm
- xfp-tx-bias-high-warn : Olt Xfp tx bias high alarm
- xfp-tx-bias-low-warn : Olt Xfp tx bias low alarm
- pppce-trans-15min-tca : 15 minutes transaction timeout
count exceeds configured TCA
- pppce-sess-15min-tca : 15 minutes session timeout count
exceeds configured TCA
- pppce-trans-1day-tca : 1day transaction timeout count
exceeds configured TCA
- pppce-sess-1day-tca : 1day session timeout count exceeds
configured TCA
- efm-oam-cpelinkfault : EFM-OAM CPE link fault
- efm-oam-cpedyinggasp : EFM-OAM CPE dying gasp
- efm-oam-cpecrevt : EFM-OAM CPE critical event
- cfm-defrdiccm : rdi bit in ccm received
- cfm-defmacstatus : ccm mac error status
- cfm-defremoteccm : missing ccm from mep
- cfm-deferrorccm : invalid ccm received

3HH-04416-EBAA-TCZZA 01

Released

1639

57 Alarm Delta Log Status Commands

name

Type

Description

- cfm-defxconccm : unexpected ccm received


- alrm-tbl-overflow : alarm table has overflowed
- auto-switch-status : auto-switch status
Parameter type: <Alarm::AlarmState>
( active
| non-active )
Possible values:
- active : alarm is active
- non-active : alarm is not active
Parameter type: <Sys::timeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

state

last-updated-on
additional-info

Only Show Details: critical alarm table related generic information


name
Type
changes

Parameter type: <Counter>


- 32 bit counter

last-entry-id

Parameter type: <SignedInteger>


- a signed integer

last-reset

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

log-overflowed

Parameter type: <Alarm::OverflowStatus>


( yes
| no )
Possible values:
- yes : buffer has overflowed
- no : no buffer overflow

1640

Released

reflect's the state of the alarm as


either active or non-active.
This element is always shown.

network time in seconds when


the alarm was logged.
This element is always shown.
AdditionalInfo
This element is always shown.

Description
total number of changes of all
reported alarms with a severity
level critical since startup.
This element is only shown in
detail mode.
last entry that was added to the
warning delta log.
This element is only shown in
detail mode.
network
time
in
seconds
indicating when the warning delta
log was last reset.
This element is only shown in
detail mode.
specifies whether the warning
delta log is overflowed or not.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58- SHub Alarm Status Command

58.1 SHub Alarm Status Command Tree


58.2 SHub Alarm Snapshot Status Command
58.3 SHub Alarm Equipment Snap-shot Status Command
58.4 SHub Alarm Snapshot Ethernet Interface Status
Command
58.5 SHub Alarm RIP Snapshot Status Command
58.6 SHub Alarm OSPF Snap-shot Status Command
58.7 SHub Alarm Uplink Group Snapshot Status Command
58.8 SHub Alarm Forwarding Snapshot Status Command
58.9 SHub Alarm Global RIP Snapshot Status Command
58.10 SHub Alarm Global OSPF Snapshot Status
Command
58.11 SHub Alarm Global Forwarding Snapshot Status
Command
58.12 SHub Alarm Delta Log Changes Status Command

3HH-04416-EBAA-TCZZA 01

58-1642
58-1643
58-1645
58-1647
58-1649
58-1651
58-1653
58-1654
58-1656
58-1657
58-1659
58-1660

Released

1641

58 SHub Alarm Status Command

58.1 SHub Alarm Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "SHub Alarm Status Command".

Command Tree
----show
----alarm
----shub
----snap-shot
----table
- (index)
----shub-gen
- (index)
----eth-shub
- (index)
----rip
- (index)
----ospf
- (index)
----uplink-group
- (index)
----forwarding
- (index)
----global-rip
- (index)
----global-ospf
- (index)
----global-fwd
- (index)
----nbr-changed-alarms

1642

Released

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.2 SHub Alarm Snapshot Status Command


Command Description
This command displays the SHub snapshot table.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot table [ (index) ]

Command Parameters
Table 58.2-1 "SHub Alarm Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.2-2 "SHub Alarm Snapshot Status Command" Display parameters
Common Information:common
name
Type
timeout-period
entries

owner-id

Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <IgnoredTimeTicks>


- a timeout value
- unit: msec
Parameter type: <IgnoredGauge>
- gauge

specifies the time out of the


snapshot table
This element is always shown.
specifies nbr of entries inthe
snapshot table, when table status
is in-use.
This element is always shown.
Parameter type: <Alarm::alarmSnapShotOwner>
the actual owner of the snap-shot
- string to identify the owner (example: Tom),the string This element is always shown.
should has less than or equal to 128 characters

Type

Description

Parameter type: <Alarm::ShubAlarmType>


( shub-gen
| eth-shub
| ospf
| rip
| ip
| uplink-group

specifies the type of the alarm


This element is always shown.

Released

1643

58 SHub Alarm Status Command

name

Type

last-updated-on

additional-info

1644

Description

| global-ospf
| global-rip
| global-fwd )
Possible values:
- shub-gen : general shub related alarms
- eth-shub : alarms related with the ethernet interface
- ospf : alarms related with OSPF routing protocol per VRF
- rip : alarms related with RIP routing protocol per VRF
- ip : alarms related with IP per VRF
- uplink-group : alarms related with uplink group
- global-ospf : alarms related with OSPF for all VRFs
- global-rip : alarms related with RIP for all VRFs
- global-fwd : alarms related with IP for all VRFs
Parameter type: <Sys::TimeRef1970>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Alarm::AdditionalInfo>
- string to identify the owner (example: Tom)
- length: x<=512

Released

gives the time information in


seconds elapsed since the 1st
January 1970, when the entry was
updated/added.
This element is always shown.
specifies
some
additional
information about the considered
table entry.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.3 SHub Alarm Equipment Snap-shot Status


Command
Command Description
This command displays the log generated for equipment-related persistent-data (data that is stored on the system
data disk and that survives power failures and system resets), sntp-communication, nt-disk, and communication
alarms. The log also gives the previous status of the alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot shub-gen [ (index) ]

Command Parameters
Table 58.3-1 "SHub Alarm Equipment Snap-shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.3-2 "SHub Alarm Equipment Snap-shot Status Command" Display parameters
Specific Information
name
db-restore

emergency-reboot

sntp-comm

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::ShubDBrestore>


( failed
| successful )
Possible values:
- failed : DB restore falied
- successful : DB restore successful
Parameter type: <Alarm::ShubEmergencyRebbot>
( yes
| no )
Possible values:
- yes : shub has rebooted from emergency boot package
- no : no shub reboot
Parameter type: <Alarm::ShubSNTPcommLoss>
( lost

specifies whether the DB restore


is successful or not.
This element is only shown in
detail mode.
status of shub reboot from
emergency boot package
This element is only shown in
detail mode.
status of shub - SNTP server
communication

Released

1645

58 SHub Alarm Status Command

name

arp-reply

vrf-id

next-hop

1646

Type

Description

| ok )
Possible values:
- lost : SNTP server not responding to shub messages
- ok : SNTP - shub communication OK
Parameter type: <Alarm::ShubArpReply>
( not-ok
| ok )
Possible values:
- not-ok : arp reply is not there
- ok : arp reply
Parameter type: <SignedInteger>
- a signed integer

This element is only shown in


detail mode.

Parameter type: <Alarm::NextHopIpAddr>


- next hop IP address

Released

status of the arp relay


This element is only shown in
detail mode.

specifies where the alarm has


occurred.
This element is only shown in
detail mode.
IP address of the next hop.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.4 SHub Alarm Snapshot Ethernet Interface


Status Command
Command Description
This command displays whether the Ethernet interface link status is down. This command also displays the
previous status, which allows the operator to see whether the link has previously gone down.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot eth-shub [ (index) ]

Command Parameters
Table 58.4-1 "SHub Alarm Snapshot Ethernet Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.4-2 "SHub Alarm Snapshot Ethernet Interface Status Command" Display parameters
Specific Information
name
port-number

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::NetworkPort>


( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

port number of the shub


This element is only shown in
detail mode.

Released

1647

58 SHub Alarm Status Command

name

Type

Description

link-down

Parameter type: <Alarm::ShubLinkDown>


( yes
| no )
Possible values:
- yes : fan unit falied
- no : fan unit OK
Parameter type: <Alarm::ShubMACconflict>
( yes
| no )
Possible values:
- yes : duplicate MAC address from ethernet port of LAN
switch
- no : no duplciate MAC address
Parameter type: <Alarm::ShubOperSpeedMismatch>
( yes
| no )
Possible values:
- yes : mismatch in administrative and operational speed
- no : no mismatch in administrative and operational speed
Parameter type: <SignedInteger>
- a signed integer

specifies whether the shub link is


down or not.
This element is only shown in
detail mode.

mac-conflict

oper-speed-mismatch

vlan-id

1648

Released

specifies whether there is a


duplicate MAC address from the
ethernet port of LAN switch.
This element is only shown in
detail mode.
specifies whether there is a
mismatch in the administrative
and operational speed in the
ethernet port of LAN switch.
This element is only shown in
detail mode.
specifies where the alarm has
occurred.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.5 SHub Alarm RIP Snapshot Status Command


Command Description
This command displays the SHub snapshot RIP alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot rip [ (index) ]

Command Parameters
Table 58.5-1 "SHub Alarm RIP Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.5-2 "SHub Alarm RIP Snapshot Status Command" Display parameters
Specific Information
name

Type

Description

vrf-id

Parameter type: <SignedInteger>


- a signed integer

config-err

Parameter type: <Alarm::ShubConfigErr>


( failed
| ok )
Possible values:
- failed : configuration error occurred
- ok : configuration error not occurred
Parameter type: <Alarm::ShubAuthFail>
( failed
| ok )
Possible values:
- failed : authentication failed
- ok : authentication not failed
Parameter type: <Alarm::ShubRcvPkt>
( yes
| no )

specifies where the alarm has


occurred.
This element is only shown in
detail mode.
RIP interface configuration error
This element is only shown in
detail mode.

auth-fail

rcv-bad-pkt

3HH-04416-EBAA-TCZZA 01

RIP interface authentication


failure
This element is only shown in
detail mode.
bad packet received on RIP
interface
This element is only shown in

Released

1649

58 SHub Alarm Status Command

name

table-treshold

instance-down

if-index

1650

Released

Type

Description

Possible values:
- yes : bad packets received
- no : no bad packets received
Parameter type: <Alarm::ShubRipTableTreshold>
( yes
| no )
Possible values:
- yes : RIP route table up threshold reached
- no : no RIP route table up threshold reached
Parameter type: <Alarm::ShubRipInstanceDown>
( yes
| no )
Possible values:
- yes : RIP instance down
- no : no RIP instance down
Parameter type: <SignedInteger>
- a signed integer

detail mode.
specifies whether RIP route table
up threshold reached
This element is only shown in
detail mode.
specifies whether RIP instance
down
This element is only shown in
detail mode.
displays the interface index
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.6 SHub Alarm OSPF Snap-shot Status


Command
Command Description
This command displays the SHub snapshot OSPF status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot ospf [ (index) ]

Command Parameters
Table 58.6-1 "SHub Alarm OSPF Snap-shot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.6-2 "SHub Alarm OSPF Snap-shot Status Command" Display parameters
Specific Information
name

Type

Description

vrf-id

Parameter type: <SignedInteger>


- a signed integer

config

Parameter type: <Alarm::ShubConfigErr>


( failed
| ok )
Possible values:
- failed : configuration error occurred
- ok : configuration error not occurred
Parameter type: <Alarm::ShubAuthFail>
( failed
| ok )
Possible values:
- failed : authentication failed
- ok : authentication not failed

specifies where the alarm has


occurred.
This element is only shown in
detail mode.
interface configuration error
This element is only shown in
detail mode.

authen

3HH-04416-EBAA-TCZZA 01

interface authentication failure


This element is only shown in
detail mode.

Released

1651

58 SHub Alarm Status Command

name

Type

Description

rcv-bad-pkt

Parameter type: <Alarm::ShubRcvPkt>


( yes
| no )
Possible values:
- yes : bad packets received
- no : no bad packets received
Parameter type: <Alarm::ShubLSDBOverFlow>
( yes
| no )
Possible values:
- yes : external LSA database count reached overflow limit
- no : external LSA database count not reached overflow
limit
Parameter type: <Alarm::ShubNHBRstatchg>
( yes
| no )
Possible values:
- yes : OSPF neighbor state has changed
- no : OSPF neighbor state has not changed
Parameter type: <Alarm::ShubItfStatchg>
( yes
| no )
Possible values:
- yes : OSPF interface state changed
- no : OSPF interface state change not occurred
Parameter type: <Alarm::ShubOspfExtLsaMax>
( yes
| no )
Possible values:
- yes : OSPF external LSA up threshold reached
- no : no OSPF external LSA up threshold reached
Parameter type: <Alarm::ShubOspfInstanceDown>
( yes
| no )
Possible values:
- yes : OSPF instance down
- no : no OSPF instance down
Parameter type: <SignedInteger>
- a signed integer

bad packet received on the


interface
This element is only shown in
detail mode.

lsdb-ovfl

nhbr-statchg

nhbr-itfchg

ext-lsa-threshold

instance-down

if-index

1652

Released

specifies whether the external


LSA database count reached
overflow limit
This element is only shown in
detail mode.
specifies whether the OSPF
neighbor state has changed
This element is only shown in
detail mode.
specifies OSPF PDU corruption
This element is only shown in
detail mode.

specifies whether OSPF external


LSA up threshold reached
This element is only shown in
detail mode.
specifies whether OSPF instance
down
This element is only shown in
detail mode.
displays the interface index
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.7 SHub Alarm Uplink Group Snapshot Status


Command
Command Description
This command displays the SHub snapshot uplink group alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot uplink-group [ (index) ]

Command Parameters
Table 58.7-1 "SHub Alarm Uplink Group Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.7-2 "SHub Alarm Uplink Group Snapshot Status Command" Display parameters
Specific Information
name

Type

Description

uplink-nbr

Parameter type: <SignedInteger>


- a signed integer

uplink-down

Parameter type: <Alarm::ShubUplinkDown>


( yes
| no )
Possible values:
- yes : uplink group down
- no : no uplink group down
Parameter type: <Alarm::ShubPccpDown>
( down
| up )
Possible values:
- down : network pccp down
- up : network pccp up

specifies uplink group number


This element is only shown in
detail mode.
uplink group down
This element is only shown in
detail mode.

pccp-down

3HH-04416-EBAA-TCZZA 01

snap shot status of network pccp


This element is only shown in
detail mode.

Released

1653

58 SHub Alarm Status Command

58.8 SHub Alarm Forwarding Snapshot Status


Command
Command Description
This command displays the SHub snapshot IP forwarding alarm status.These alarms are specific to a VRF

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot forwarding [ (index) ]

Command Parameters
Table 58.8-1 "SHub Alarm Forwarding Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.8-2 "SHub Alarm Forwarding Snapshot Status Command" Display parameters
Specific Information
name

Type

Description

vrf-id

Parameter type: <SignedInteger>


- a signed integer

arp-table-threshold

Parameter type: <Alarm::ShubArpTableFull>


( yes
| no )
Possible values:
- yes : ARP table up threshold reached
- no : no ARP table up threshold reached
Parameter type: <Alarm::ShubRouteTableFull>
( yes
| no )
Possible values:
- yes : routing table up threshold reached
- no : no routing table up threshold reached

specifies where the alarm has


occurred.
This element is only shown in
detail mode.
specifies whether ARP table full
per VRF
This element is only shown in
detail mode.

routing-tbl-threshold

1654

Released

specifies whether routing table up


threshold is reached
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

3HH-04416-EBAA-TCZZA 01

Released

1655

58 SHub Alarm Status Command

58.9 SHub Alarm Global RIP Snapshot Status


Command
Command Description
This command displays the SHub snapshot Global RIP alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot global-rip [ (index) ]

Command Parameters
Table 58.9-1 "SHub Alarm Global RIP Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.9-2 "SHub Alarm Global RIP Snapshot Status Command" Display parameters
Specific Information
name
route-tbl-threshold

1656

Released

Type

Description

Parameter type: <Alarm::ShubGlobalRipRoute>


( yes
| no )
Possible values:
- yes : RIP global route table up threshold reached
- no : no RIP global route table up threshold reached

specifies whether RIP global


route table up threshold reached
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.10 SHub Alarm Global OSPF Snapshot Status


Command
Command Description
This command displays the SHub snapshot Global OSPF alarm status.These alarms are global for the mode,thus
not related to a specific VRF

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot global-ospf [ (index) ]

Command Parameters
Table 58.10-1 "SHub Alarm Global OSPF Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.10-2 "SHub Alarm Global OSPF Snapshot Status Command" Display parameters
Specific Information
name
route-tbl-threshold

lsa-tbl-threshold

rtrans-tbl-threshold

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::ShubGlobalOspfRoute>


( yes
| no )
Possible values:
- yes : OSPF route table up threshold reached
- no : no OSPF route table up threshold reached
Parameter type: <Alarm::ShubGlobalOspfLsa>
( yes
| no )
Possible values:
- yes : OSPF LSA table up threshold reached
- no : no OSPF LSA table up threshold reached
Parameter type: <Alarm::ShubGlobalOspfRetrms>
( yes
| no )

specifies whether OSPF route


table up threshold reached
This element is only shown in
detail mode.
specifies whether OSPF LSA
table up threshold reached
This element is only shown in
detail mode.
specifies
whether
OSPF
retransmission table up threshold
reached

Released

1657

58 SHub Alarm Status Command

name

lsa-overflow

area-topology-max

1658

Released

Type

Description

Possible values:
- yes : OSPF retransmission table up threshold reached
- no : no OSPF retransmission table up threshold reached
Parameter type: <Alarm::ShubGlobalOspfOvrflw>
( yes
| no )
Possible values:
- yes : self generated LSA table overflow
- no : no self generated LSA table overflow
Parameter type: <Alarm::ShubGlobalOspfTopo>
( yes
| no )
Possible values:
- yes : ospf area topology too big
- no : no ospf area topology too big

This element is only shown in


detail mode.
specifies whether up threshold is
reached for self generated LSA
table
This element is only shown in
detail mode.
specifies whether OSPF area
topology up threshhold is reached
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

58 SHub Alarm Status Command

58.11 SHub Alarm Global Forwarding Snapshot


Status Command
Command Description
This command displays the SHub snapshot Global Forwarding alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot global-fwd [ (index) ]

Command Parameters
Table 58.11-1 "SHub Alarm Global Forwarding Snapshot Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- index of a current alarm entry

alarm snap shot table index

Command Output
Table 58.11-2 "SHub Alarm Global Forwarding Snapshot Status Command" Display parameters
Specific Information
name
arp-table-threshold

fwd-table-threshold

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Alarm::ShubGlobalArpTable>


( yes
| no )
Possible values:
- yes : global ARP route table up threshold reached
- no : no global ARP route table up threshold reached
Parameter type: <Alarm::ShubGlobalRtmRoute>
( yes
| no )
Possible values:
- yes : forwarding table full
- no : no forwarding table full

specifies whether global ARP


route table up threshold reached
This element is only shown in
detail mode.
specifies whether forwarding
table full
This element is only shown in
detail mode.

Released

1659

58 SHub Alarm Status Command

58.12 SHub Alarm Delta Log Changes Status


Command
This command displays a summary report of the number of alarms that have occurred.

Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub nbr-changed-alarms

Command Output
Table 58.12-2 "SHub Alarm Delta Log Changes Status Command" Display parameters
Specific Information
name

Type

Description

all

Parameter type: <Counter>


- 32 bit counter

indeterminate

Parameter type: <Counter>


- 32 bit counter

warning

Parameter type: <Counter>


- 32 bit counter

minor

Parameter type: <Counter>


- 32 bit counter

major

Parameter type: <Counter>


- 32 bit counter

critical

Parameter type: <Counter>


- 32 bit counter

total number of changes of all


alarms since startup.
This element is always shown.
the total number of changes of all
alarms with severity level
indeterminate since startup.
This element is always shown.
the total number of changes of all
alarms with severity level
warning since startup.
This element is always shown.
the total number of changes of all
alarms with severity level minor
since startup.
This element is always shown.
the total number of changes of all
alarms with severity level major
since startup.
This element is always shown.
the total number of changes of all
alarms with severity level critical
since startup.
This element is always shown.

1660

Released

3HH-04416-EBAA-TCZZA

01

59- ATM Status Commands

59.1 ATM Status Command Tree


59.2 ATM Interface Status Command
59.3 PVC Status Command
59.4 TC Adapter Protocol Interval Status Command
59.5 TC Adapter Protocol Current Quarter Performance
Data Command
59.6 TC Adapter Protocol Current Day Performance Data
Command
59.7 TC Adapter Protocol Performance Data for Previous
Quarter Intervals Command
59.8 TC Adapter Protocol Performance Data for Previous
Day Intervals Command

3HH-04416-EBAA-TCZZA 01

59-1662
59-1663
59-1665
59-1667
59-1669
59-1671
59-1673
59-1675

Released

1661

59 ATM Status Commands

59.1 ATM Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "ATM Status Commands".

Command Tree
----show
----atm
----interface
- (port)
----pvc
- (port-index)
----tc-int
- (port)
----tc-current-int
----fifteen-min
- (port)
----one-day
- (port)
----tc-15min-int
- (port)
- intvl-number
----tc-1day-int
- (port)
- intvl-number

1662

Released

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.2 ATM Interface Status Command


Command Description
This command displays the ATM interface configuration table.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm interface [ (port) ]

Command Parameters
Table 59.2-1 "ATM Interface Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
ATM interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 59.2-2 "ATM Interface Status Command" Display parameters
Specific Information
name
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Atm::asamAtmItfType>


( not-specified
| network-termination
| access-to-access
| user-to-access
| internal-server
| external-server )
Possible values:
- not-specified : not specified
- network-termination : network termination
- access-to-access : access to access interface

type of ATM interface.


This element is always shown.

Released

1663

59 ATM Status Commands

name

Type

number-of-pvcs

1664

Description

- user-to-access : user to access interface


- internal-server : internal server interface
- external-server : external server interface
Parameter type: <Atm::CrossConnectedPVccs>
- the number of Vcttp connections
- range: [0...65535]

Released

specifies the number of vcttp


connections on this ATM
interface (only PVC).
This element is always shown.

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.3 PVC Status Command


Command Description
This command displays the status of the PVC.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm pvc [ (port-index) ]

Command Parameters
Table 59.3-1 "PVC Status Command" Resource Parameters
Resource Identifier

Type

(port-index)

Format:
the ATM PVC
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
:
<Eqpt::VpiMandatoryId>
:
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

Description

Command Output
Table 59.3-2 "PVC Status Command" Display parameters
Specific Information
name
admin-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Atm::adminStatus>


( admin-up
| admin-down )
Possible values:
- admin-up : enable traffic flow
- admin-down : disable traffic flow

specifies
the
desired
administrative state of the VCL.
This element is always shown.

Released

1665

59 ATM Status Commands

name

Type

Description

operational-status

Parameter type: <Atm::atmVclOperStatus>


( up
| down
| unknown )
Possible values:
- up : traffic flow is enabled in the virtual link
- down : traffic flow is disabled in the virtual link
- unknown : state is unknown
Parameter type: <Atm::LastChangeTime>
- the time elapsed since a certain event

indicates the current operational


status of the VCL.
This element is always shown.

last-change
curr-encap-type

1666

Parameter type: <Atm::CurVccEncapType>


( llc-snap
| llc-snap-routed
| llc-nlpid
| vc-mux-bridged-8023
| vc-mux-routed
| vc-mux-pppoa
| other
| unknown
| none )
Possible values:
- llc-snap : logical link control encapsulation bridged
protocol
- llc-snap-routed : logical link control encapsulation routed
protocol
- llc-nlpid : logical link control encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel multiplex bridged
protocol
- vc-mux-routed : virtual channel multiplex routed protocol
- vc-mux-pppoa : virtual channel multiplex pppoa protocol
- other : other encapsulation type
- unknown : unknown encapsulation type
- none : no encapsulation type

Released

time the VCL entered its current


operational state.
This element is always shown.
the
current
established
encapsulation type.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.4 TC Adapter Protocol Interval Status Command


Command Description
This command displays the TC adapter protocol interval status.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-int [ (port) ]

Command Parameters
Table 59.4-1 "TC Adapter Protocol Interval Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
ATM
interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / (rack/shelf/slot/port)
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description
index

Command Output
Table 59.4-2 "TC Adapter Protocol Interval Status Command" Display parameters
Specific Information
name
valid-15-min-intervals

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

the number of previous intervals


(maximum 192) for which valid
data has been stored. The value
of this object will be 192 unless
the device was brought online
within the last nx15 minutes, in
which case the value will be the
number of complete 15 minute
intervals the device has been
online
This element is always shown.

Released

1667

59 ATM Status Commands

name

Type

Description

valid-1-day-intervals

Parameter type: <SignedInteger>


- a signed integer

The number of previous intervals


(maximum 2) for which valid
data has been stored. The value
of this object will be 2 unless the
device was brought online within
the last nx24 hours, in which case
the value will be the number of
complete 24 hours intervals the
device has been online
This element is always shown.

1668

Released

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.5 TC Adapter Protocol Current Quarter


Performance Data Command
Command Description
This command displays the TC adapter protocol current quarter performance data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-current-int fifteen-min [ (port) ]

Command Parameters
Table 59.5-1 "TC Adapter Protocol Current Quarter Performance Data Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
ATM interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 59.5-2 "TC Adapter Protocol Current Quarter Performance Data Command" Display
parameters
Specific Information
name
ocd-far-end

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

the number of out of cell


delineations
anomalies
for
incoming cells on a far end ATM
interface connected to this ATM
interface

Released

1669

59 ATM Status Commands

name

Type

hec-far-end

Parameter type: <Counter>


- 32 bit counter

ocd-near-end

Parameter type: <Counter>


- 32 bit counter

hec-near-end

Parameter type: <Counter>


- 32 bit counter

1670

Released

Description
This element is always shown.
the number of ATM cells
discarded on the far end ATM
interface connected to this ATM
interface due to HEC errors
This element is always shown.
the number of out of cell
delineations
anomalies
for
incoming cells on an ATM
interface.An
out
of
cell
delineation anomaly occurs when
there are 7 consecutive ATM
cells received which contain HEC
errors.
This element is always shown.
number of ATM cells discarded
on the ATM interface due to
HEC errors
This element is always shown.

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.6 TC Adapter Protocol Current Day Performance


Data Command
Command Description
This command displays the TC adapter protocol current day performance data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-current-int one-day [ (port) ]

Command Parameters
Table 59.6-1 "TC Adapter Protocol Current Day Performance Data Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
ATM interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 59.6-2 "TC Adapter Protocol Current Day Performance Data Command" Display
parameters
Specific Information
name
ocd-far-end

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

the number of out of cell


delineations
anomalies
for
incoming cells on a far end ATM
interface connected to this ATM
interface

Released

1671

59 ATM Status Commands

name

Type

hec-far-end

Parameter type: <Counter>


- 32 bit counter

ocd-near-end

Parameter type: <Counter>


- 32 bit counter

hec-near-end

Parameter type: <Counter>


- 32 bit counter

1672

Released

Description
This element is always shown.
the number of ATM cells
discarded on the far end ATM
interface connected to this ATM
interface due to HEC errors
This element is always shown.
the number of out of cell
delineations
anomalies
for
incoming cells on an ATM
interface.An
out
of
cell
delineation anomaly occurs when
there are 7 consecutive ATM
cells received which contain HEC
errors.
This element is always shown.
number of ATM cells discarded
on the ATM interface due to
HEC errors
This element is always shown.

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.7 TC Adapter Protocol Performance Data for


Previous Quarter Intervals Command
Command Description
This command displays the TC adapter protocol-monitoring 15-min interval data parameters.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-15min-int [ (port) [ intvl-number <Atm::AtmItvlNumber> ] ]

Command Parameters
Table 59.7-1 "TC Adapter Protocol Performance Data for Previous Quarter Intervals Command"
Resource Parameters
Resource Identifier

Type

(port)

Format:
ATM interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Atm::AtmItvlNumber>
interval for which statistics are
Format:
available
- interval for which statistics is available
- range: [1...192]

intvl-number

Description

Command Output
Table 59.7-2 "TC Adapter Protocol Performance Data for Previous Quarter Intervals Command"
Display parameters
Specific Information
name

Type

Description

ocd-near-end

Parameter type: <Counter>

the number of out of cell

3HH-04416-EBAA-TCZZA 01

Released

1673

59 ATM Status Commands

name

Type

Description

- 32 bit counter

delineations
anomalies
for
incoming cells on an ATM
interface.An
out
of
cell
delineation anomaly occurs when
there are 7 consecutive ATM
cells received which contain HEC
errors
This element is always shown.
number of ATM cells discarded
on the ATM interface due to
HEC errors
This element is always shown.
the number of out of cell
delineations
anomalies
for
incoming cells on a far end ATM
interface connected to this ATM
interface
This element is always shown.
the number of ATM cells
discarded on the far end ATM
interface connected to this ATM
interface due to HEC errors
This element is always shown.

hec-near-end

Parameter type: <Counter>


- 32 bit counter

ocd-far-end

Parameter type: <Counter>


- 32 bit counter

hec-far-end

Parameter type: <Counter>


- 32 bit counter

1674

Released

3HH-04416-EBAA-TCZZA

01

59 ATM Status Commands

59.8 TC Adapter Protocol Performance Data for


Previous Day Intervals Command
Command Description
This command displays the TC adapter protocol-monitoring 1-day interval data parameters.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-1day-int [ (port) [ intvl-number <Atm::AtmItvlNo1day> ] ]

Command Parameters
Table 59.8-1 "TC Adapter Protocol Performance Data for Previous Day Intervals Command"
Resource Parameters
Resource Identifier

Type

(port)

Format:
ATM interface
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Atm::AtmItvlNo1day>
interval for which statistics are
Format:
available
- itvl for which statistics is available
- range: [1...2]

intvl-number

Description

Command Output
Table 59.8-2 "TC Adapter Protocol Performance Data for Previous Day Intervals Command"
Display parameters
Specific Information
name

Type

Description

ocd-near-end

Parameter type: <Counter>

the number of out of cell

3HH-04416-EBAA-TCZZA 01

Released

1675

59 ATM Status Commands

name

Type

Description

- 32 bit counter

delineations
anomalies
for
incoming cells on an ATM
interface.An
out
of
cell
delineation anomaly occurs when
there are 7 consecutive ATM
cells received which contain HEC
errors.
This element is always shown.
number of ATM cells discarded
on the ATM interface due to
HEC errors
This element is always shown.
the number of out of cell
delineations
anomalies
for
incoming cells on a far end ATM
interface connected to this ATM
interface
This element is always shown.
the number of ATM cells
discarded on the far end ATM
interface connected to this ATM
interface due to HEC errors
This element is always shown.

hec-near-end

Parameter type: <Counter>


- 32 bit counter

ocd-far-end

Parameter type: <Counter>


- 32 bit counter

hec-far-end

Parameter type: <Counter>


- 32 bit counter

1676

Released

3HH-04416-EBAA-TCZZA

01

60- Bridge Status Commands

60.1 Bridge Status Command Tree


60.2 SHub Bridge Status Command
60.3 SHub Bridge Port Status Command

3HH-04416-EBAA-TCZZA 01

60-1678
60-1679
60-1680

Released

1677

60 Bridge Status Commands

60.1 Bridge Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Bridge Status Commands".

Command Tree
----show
----bridge
----shub-info
----network-port
- (port)

1678

Released

3HH-04416-EBAA-TCZZA

01

60 Bridge Status Commands

60.2 SHub Bridge Status Command


Command Description
This command displays global information regarding the bridge on the SHub.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge shub-info

Command Output
Table 60.2-2 "SHub Bridge Status Command" Display parameters
Specific Information
name

Type

Description

mac-address

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

learnt-entry-discards

Parameter type: <Vlan::Counter>


- an unsigned integer

the MAC address used by this


bridge when it must be referred to
in a unique fashion
This element is always shown.
the total number of Filtering
Database entries, which have
been or would have been learnt,
but have been discarded due to a
lack of space in the FDB. If this
Counter is increasing it indicates
that the Filtering Database is
regularly becoming full. This
event may be of temporary
nature.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1679

60 Bridge Status Commands

60.3 SHub Bridge Port Status Command


Command Description
This command displays port related parameters for a bridge port on the SHub.
When detailed information is requested, statistics regarding frames received and transmitted on the bridge port are
displayed.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge network-port [ (port) ]

Command Parameters
Table 60.3-1 "SHub Bridge Port Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

port number

Command Output
Table 60.3-2 "SHub Bridge Port Status Command" Display parameters
Common Information:bridge parameters
name
Type
mac-address

1680

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

Released

Description
the MAC address used by this
bridge when it must be referred to
in a unique fashion
This element is always shown.

3HH-04416-EBAA-TCZZA

01

60 Bridge Status Commands

name

Type

Description

learned-entry-discards

Parameter type: <Vlan::Counter>


- an unsigned integer

the total number of Filtering


Database entries, which have
been or would have been learnt,
but have been discarded due to a
lack of space in the FDB. If this
Counter is increasing it indicates
that the Filtering Database is
regularly becoming full. This
event may be of temporary
nature.
This element is always shown.

Type

Description

Parameter type: <Shub::PortOperStatus>


( down
| up )
Possible values:
- down : down
- up : up
Parameter type: <Vlan::Integer>
- a signed integer

the operational status of the port.


This status is only valid if the
administrative status of the
corresponding interface is up.
This element is always shown.

Specific Information
name
operation-status

max-frame-info

traffic-class

Parameter type: <Shub::TrafficClass>


- port priority
- range: [1...8]

Only Show Details: frame stats


name
Type
in-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

in-overflow-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

out-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

out-overflow-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

3HH-04416-EBAA-TCZZA 01

the maximum size of the INFO


(non-MAC) field that this port
will receive or transmit
This element is always shown.
The number of egress traffic
classes supported on this port.
This element is always shown.

Description
32 bits counter holding the
number of frames that have been
received by this port from its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
the high order 32 bits of a 64 bits
in-frames counter, in case of high
capacity interfaces
This element is only shown in
detail mode.
32 bits counter holding the
number of frames that have been
transmitted by this port port to its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
the high order 32 bits of a 64 bits
out-frames counter, in case of
high capacity interfaces
This element is only shown in
detail mode.

Released

1681

60 Bridge Status Commands

name

Type

Description

discard-valid-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

discard-valid-overflow

Parameter type: <Vlan::Counter>


- an unsigned integer

delay-exceed-discards

Parameter type: <Vlan::Counter>


- an unsigned integer

mtu-exceed-discards

Parameter type: <Vlan::Counter>


- an unsigned integer

bcast-out-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

mcast-out-frames

Parameter type: <Vlan::Counter>


- an unsigned integer

in-frames-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-frames-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

32 bits counter holding the


number of valid frames received
which were discarded (i.e.,
filtered) by the Forwarding
Process
This element is only shown in
detail mode.
the high order 32 bits of a 64 bits
discard-valid-frames counter, in
case of high capacity interfaces
This element is only shown in
detail mode.
the number of frames discarded
by this port due to excessive
transit delay through the bridge
This element is only shown in
detail mode.
the number of frames discarded
by this port due to an excessive
size
This element is only shown in
detail mode.
count of broadcasted frame that
are transmitted through this
interface. This counter is only
incremented for frames with
broadcast destination address
(ff.ff.ff.ff.ff.ff) and frames which
are broadcasted because of no
learned entry in the Filtering
Database.
This element is only shown in
detail mode.
count of frames transmitted
through this interface with
destination address in which the
Mac layer multicast bit set. This
counter is not incremented for
frames tranmitted with broadcast
destination
address
(i.e
ff.ff.ff.ff.ff.ff).
This element is only shown in
detail mode.
64 bits counter holding the
number of frames that have been
received by this port from its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
64 bits counter holding the
number of frames that have been
transmitted by this port to its
segment; only frames for a
protocol being processed by the

1682

Released

3HH-04416-EBAA-TCZZA

01

60 Bridge Status Commands

name

discard-frames-hc

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

local bridging function are


counted
This element is only shown in
detail mode.
64 bits counter holding the
number of valid frames received
which
were
discarded
(i.e.,filtered) by the Forwarding
Process
This element is only shown in
detail mode.

Released

1683

61- VLAN Status Commands

61.1 VLAN Status Command Tree


61.2 Global VLAN Status Command
61.3 Residential Bridge VLAN Summary Status Command
61.4 Residential Bridge VLAN Extensive Status Command
61.5 Cross-connect VLAN Status Command
61.6 Stacked VLAN Status Command
61.7 Stacked QoS VLAN Status Command
61.8 QoS C-VLAN Status Command
61.9 Layer-2 Terminated VLAN Status Command
61.10 VLAN Name Mapping Status Command
61.11 VLAN Filtering Database Per LIM Status Command
61.12 Bridge Port Filtering Database Status Command
61.13 VLAN Priority Regeneration Profile Status Command
61.14 VLAN Priority Regeneration Profile Name Status
Command
61.15 Show Next Free ID of VLAN Priority Regeneration
Profile
61.16 Duplicate MAC Alarm Status Command
61.17 Port Event Status Command
61.18 Port Statistics for Current Quarter Status Command
61.19 Port Statistics for Current Day Status Command
61.20 Port Statistics for Previous Quarter Intervals Status
Command
61.21 Port Statistics for Previous Day Intervals Status
Command
61.22 VLAN Port Statistics for Current Quarter Status
Command
61.23 VLAN Port Statistics for Current Day Status
Command
61.24 VLAN Port Statistics for Previous Quarter Intervals
Status Command
61.25 VLAN Port Statistics for Previous Day Intervals
Status Command
61.26 SHub Port VLAN Association Status Command
61.27 SHub VLAN Name Mapping Status Command
61.28 SHub VLAN Filtering Database Status Command
61.29 SHub Filtering Database Entry Status Command
61.30 SHub Duplicate MAC Alarm Status Command
61.31 SHub Number Of Active Multicast Entries Status
Command
61.32 VLAN Filtering Database Status Command
61.33 P-bit Traffic Counters Status Command
61.34 Current VLAN Filtering Database Status Command
61.35 Accumulated Port Statistics

1684

Released

61-1685
61-1687
61-1688
61-1691
61-1696
61-1701
61-1703
61-1705
61-1706
61-1708
61-1709
61-1712
61-1715
61-1718
61-1721
61-1722
61-1725
61-1727
61-1730
61-1733
61-1736
61-1739
61-1742
61-1745
61-1748
61-1751
61-1753
61-1754
61-1756
61-1758
61-1760
61-1761
61-1764
61-1767
61-1769

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.1 VLAN Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "VLAN Status Commands".

Command Tree
----show
----vlan
----global
----residential-bridge
----summary
- (vlan-id)
- vlan-port
----extensive
- (vlan-id)
- vlan-port
----cross-connect
- (vlan-id)
- vlan-port
----stacked-vlan
- (s-vlanid)
- vlan-id
----stacked-qos-vlan
- (s-vlanid)
- vlan-id
----qos-cvlan-list
- (vlan-id)
----layer2-terminated
- (vlanid)
----name
- (name)
----fdb-board
- (slot)
- fdb-id
- mac
----bridge-port-fdb
- (port)
- vlan-id
- mac
----priority-regen
- (profile-id)
----prio-regen-name
- (name)
----prio-regen-next
----dup-mac-alarm
- (dup-port)
- dup-fdb-id
- dup-mac
----port-event
- (port)
----port-curr-15min-stats
- (port)

3HH-04416-EBAA-TCZZA 01

Released

1685

61 VLAN Status Commands

----port-curr-day-stats
- (port)
----port-15min-stats
- (port)
- interval-number
----port-prev-day-stats
- (port)
- interval-number
----current-15min-stats
- (vlanid)
- port
----current-day-stats
- (vlanid)
- port
----previous-15min-stats
- (vlanid)
- port
- interval-number
----vlan-day-stats
- (vlanid)
- port
- interval-number
----shub-port-vlan-map
- (port)
- vlan-id
----shub-vlan-name
- (name)
----shub-fdb
- (vlanid)
----shub-filter-entry
- (vlanid)
- unicast-mac
----shub-dup-mac-alarm
- (dup-vlan-id)
- dup-port
----shub-nr-mcast-entries
----X vmac-bridge-port-fdb
- (port)
- vlan-id
- mac
----pbit-statistics
----port
- (vlan-port)
- min-dot1p
- max-dot1p
----fdbid
- (vlan-id)
----port-accumu-stats
- (port)

1686

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.2 Global VLAN Status Command


Command Description
This command displays information common to all VLANs.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan global

Command Output
Table 61.2-2 "Global VLAN Status Command" Display parameters
Common Information:vlan parameters
name
Type
configured-vlans

Parameter type: <Vlan::Gauge>


- an unsigned integer

management

Parameter type: <Vlan::MgntVlanMode>


( inband
| outband )
Possible values:
- inband : inband
- outband : outband
Parameter type: <Vlan::Gauge>
- an unsigned integer

max-rb-vlan
max-layer2-term-vlan

3HH-04416-EBAA-TCZZA 01

Parameter type: <Vlan::Gauge>


- an unsigned integer

Description
current number of configured and
auto configured vlans
This element is always shown.
specifies how the node is
managed
This element is always shown.

maximum number of residential


bridge vlans that are supported
This element is always shown.
maximum number of layer2
terminated
vlans
that
are
supported
This element is always shown.

Released

1687

61 VLAN Status Commands

61.3 Residential Bridge VLAN Summary Status


Command
Command Description
This command displays a list of ports attached to a particular VLAN of the type residential bridge VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan residential-bridge summary [ (vlan-id) [ vlan-port <Itf::VlanPortInterface> ] ]

Command Parameters
Table 61.3-1 "Residential Bridge VLAN Summary Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::VlanPortInterface>
Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>

network vlan id

vlan-port

1688

Released

vlan port
/
:
/
/
:
/
:

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity

3HH-04416-EBAA-TCZZA 01

Released

1689

61 VLAN Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

1690

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.4 Residential Bridge VLAN Extensive Status


Command
Command Description
This command displays a list of ports, each with an extensive set of parameters, for a particular VLAN of the type
residential bridge VLAN in detail mode. Execution of this command may take a long time.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan residential-bridge extensive [ (vlan-id) [ vlan-port <Itf::VlanPortInterface> ] ]

Command Parameters
Table 61.4-1 "Residential Bridge VLAN Extensive Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::VlanPortInterface>
Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>

network vlan id

vlan-port

3HH-04416-EBAA-TCZZA 01

vlan port
/
:
/
/
:
/

Released

1691

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:

1692

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

- stacked : stacked vlan identity


Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 61.4-2 "Residential Bridge VLAN Extensive Status Command" Display parameters
Specific Information
name
qos-profile

qos

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::QosProfileName>


( none
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
Parameter type: <Vlan::QosPolicy>
( priority : <Vlan::Priority>
| profile : none
| profile : trusted-port
| profile : best-effort
| profile : cl-all-prio-3
| profile : cl-all-prio-4
| profile : background
| profile : be-cl-voice
| profile : be-cl-1d-voice
| profile : be-voice
| profile : l2-vpn-3
| profile : l2-vpn-4
| profile : 11
| profile : 12
| profile : 13
| profile : 14
| profile : 15
| profile : 16
| profile : 17
| profile : 18
| profile : 19
| profile : 20
| profile : 21
| profile : 22
| profile : 23
| profile : 24
| profile : 25
| profile : 26
| profile : 27
| profile : 28
| profile : 29
| profile : 30
| profile : 31

QOS profile, dynamically or


statically (if no dynamic)
assigned to a port
This element is always shown.

the qos policy


This element is always shown.

Released

1693

61 VLAN Status Commands

name

Type

prio-regen-name

1694

Description

| profile : 32
| prio-regen-name : none
|
prio-regen-name
:
name
:
<Vlan::IgnoredVlanProfileName> )
Possible values:
- priority : fixed priority identify
- profile : regeneration profile identify
- prio-regen-name : priority regeneration profile name
Field type <Vlan::Priority>
- priority of ethernet frames
- range: [0...7]
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::PrioRegenProfileName>
priority regeneration profile name
( none
This element is always shown.
| name : <Vlan::IgnoredVlanProfileName> )
Possible values:

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

transmit-mode

3HH-04416-EBAA-TCZZA 01

Type

Description

- none : no profile name to associate


- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::PortUntagStatus>
( untagged
| single-tagged
| priority-tagged )
Possible values:
- untagged : untagged outgoing frames
- single-tagged : singletagged outgoing frames
- priority-tagged : prioritytagged outgoing frames

transmit
mode
on
egress
forwarding interface as tagged,
untagged or priority tagged
This element is always shown.

Released

1695

61 VLAN Status Commands

61.5 Cross-connect VLAN Status Command


Command Description
This command displays all parameters for the ports attached to a particular VLAN of the type cross-connect VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan cross-connect [ (vlan-id) [ vlan-port <Itf::VlanPortInterface> ] ]

Command Parameters
Table 61.5-1 "Cross-connect VLAN Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::VlanPortInterface>
Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>

network vlan id

vlan-port

1696

Released

vlan port
/
:
/
/
:
/
:
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>

3HH-04416-EBAA-TCZZA 01

Released

1697

61 VLAN Status Commands

Resource Identifier

Type

Description

- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 61.5-2 "Cross-connect VLAN Status Command" Display parameters
Specific Information
name
qos-profile

qos

1698

Released

Type

Description

Parameter type: <Vlan::QosProfileName>


( none
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64
Parameter type: <Vlan::QosPolicy>
( priority : <Vlan::Priority>
| profile : none
| profile : trusted-port
| profile : best-effort
| profile : cl-all-prio-3
| profile : cl-all-prio-4
| profile : background
| profile : be-cl-voice
| profile : be-cl-1d-voice
| profile : be-voice
| profile : l2-vpn-3
| profile : l2-vpn-4
| profile : 11
| profile : 12
| profile : 13
| profile : 14
| profile : 15
| profile : 16
| profile : 17
| profile : 18
| profile : 19
| profile : 20
| profile : 21
| profile : 22
| profile : 23
| profile : 24
| profile : 25
| profile : 26
| profile : 27
| profile : 28
| profile : 29
| profile : 30
| profile : 31
| profile : 32
| prio-regen-name : none
|
prio-regen-name
:
name
<Vlan::IgnoredVlanProfileName> )

QOS profile, dynamically or


statically (if no dynamic)
assigned to a port
This element is always shown.

the qos policy


This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

prio-regen-name

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- priority : fixed priority identify
- profile : regeneration profile identify
- prio-regen-name : priority regeneration profile name
Field type <Vlan::Priority>
- priority of ethernet frames
- range: [0...7]
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::PrioRegenProfileName>
priority regeneration profile name
( none
This element is always shown.
| name : <Vlan::IgnoredVlanProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration

Released

1699

61 VLAN Status Commands

name

Type

transmit-mode

1700

Description

and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::PortUntagStatus>
( untagged
| single-tagged
| priority-tagged )
Possible values:
- untagged : untagged outgoing frames
- single-tagged : singletagged outgoing frames
- priority-tagged : prioritytagged outgoing frames

Released

transmit
mode
on
egress
forwarding interface as tagged,
untagged or priority tagged
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.6 Stacked VLAN Status Command


Command Description
This command displays the stacked VLANs configured in the system.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan stacked-vlan [ (s-vlanid) [ vlan-id <Vlan::StackedVlan> ] ]

Command Parameters
Table 61.6-1 "Stacked VLAN Status Command" Resource Parameters
Resource Identifier

Type

Description

(s-vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

vlan-id

3HH-04416-EBAA-TCZZA 01

customer vlan

Released

1701

61 VLAN Status Commands

1702

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.7 Stacked QoS VLAN Status Command


Command Description
This command displays the stacked VLANs configured in the system.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan stacked-qos-vlan [ (s-vlanid) [ vlan-id <Vlan::StackedVlan> ] ]

Command Parameters
Table 61.7-1 "Stacked QoS VLAN Status Command" Resource Parameters
Resource Identifier

Type

Description

(s-vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

vlan-id

3HH-04416-EBAA-TCZZA 01

customer vlan

Released

1703

61 VLAN Status Commands

1704

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.8 QoS C-VLAN Status Command


Command Description
This command shows the QOS CVlans configured in the system.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan qos-cvlan-list [ (vlan-id) ]

Command Parameters
Table 61.8-1 "QoS C-VLAN Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

customer vlan

3HH-04416-EBAA-TCZZA 01

Released

1705

61 VLAN Status Commands

61.9 Layer-2 Terminated VLAN Status Command


Command Description
This command displays all parameters for a particular VLAN of the type Layer 2 terminated VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan layer2-terminated [ (vlanid) ]

Command Parameters
Table 61.9-1 "Layer-2 Terminated VLAN Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

Command Output
Table 61.9-2 "Layer-2 Terminated VLAN Status Command" Display parameters
Specific Information
name
fdb-id

1706

Released

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]

identity of the filtering database


This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

filter-entries
network-ifindex

3HH-04416-EBAA-TCZZA 01

Type
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Vlan::Counter>
- an unsigned integer
Parameter type: <Vlan::Integer>
- a signed integer

Description

number of entries in the filtering


database
This element is always shown.
interface index of the IpoE
interface related to this VLAN, at
the network side
This element is always shown.

Released

1707

61 VLAN Status Commands

61.10 VLAN Name Mapping Status Command


Command Description
This command displays the VLAN identity that corresponds to a given VLAN name.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan name [ (name) ]

Command Parameters
Table 61.10-1 "VLAN Name Mapping Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- char string
- length: x<=80

name used to identify the vlan

Command Output
Table 61.10-2 "VLAN Name Mapping Status Command" Display parameters
Specific Information
name
id

1708

Released

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

the vlan identity


This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.11 VLAN Filtering Database Per LIM Status


Command
Command Description
This command displays, given a particular VLAN, a unicast MAC address and a vlan port, an entry of the filtering
database, if any. The filtering dabatase is used by the bridging function in determining how to propagate a received
frame.This command displays information about an entry of the filtering database associated to a network VLAN. It
can also be used to display all fdb entries associated to a network VLAN.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan fdb-board [ (slot) [ fdb-id <Vlan::StackedVlan> ] [ mac <Vlan::MacAddr> ] ]

Command Parameters
Table 61.11-1 "VLAN Filtering Database Per LIM Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>

the physical slot position

fdb-id

3HH-04416-EBAA-TCZZA 01

fdb id

Released

1709

61 VLAN Status Commands

Resource Identifier

Type

Description

- service vlan identity


- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

mac

the network mac address

Command Output
Table 61.11-2 "VLAN Filtering Database Per LIM Status Command" Display parameters
Specific Information
name
vlan-port

1710

Type

Description

Parameter type: <Itf::VlanPortInterface>


( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>

Released

vlan port
/ This element is only shown in
: detail mode.
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:
/
:
/
:
/
/
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

status

sub-mac

3HH-04416-EBAA-TCZZA 01

Type

Description

- the rack number


Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::FdbEntryStatus>
( other
| invalid
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

the origin of the entry, unless


invalid. Invalid indicates the
entry is in progress of being
deleted.
This element is always shown.

the user mac address ,when vmac


is enabled, it identifies a vmac
This element is always shown.

Released

1711

61 VLAN Status Commands

61.12 Bridge Port Filtering Database Status


Command
Command Description
This command displays information about an entry of the filtering database on a particular vlan port. The filtering
database is used by the bridging function in determining how to propagate a received frame. It can also be used to
display all fdb entries on a vlan port or all fdb entries on a bridge port.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
The command should be executed with atleast the bridgeport as mandatory input otherwise it will take longer
execution time to retrieve the information in larger systems where large number of bridgeports / vlan ports are
configured while limited fdb entries on part of the vlan ports.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan bridge-port-fdb [ (port) [ vlan-id <Vlan::StackedVlan> ] [ mac <Vlan::MacAddr> ] ]

Command Parameters
Table 61.12-1 "Bridge Port Filtering Database Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

1712

Released

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SlotId>


- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

vlan-id

mac

the subscriber vlan id

mac address

Command Output
Table 61.12-2 "Bridge Port Filtering Database Status Command" Display parameters
Specific Information
name
fdb-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>

the identity of this filtering


database
This element is always shown.

Released

1713

61 VLAN Status Commands

name

Type

status

vmac

1714

Description

- service vlan identity


- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Vlan::FdbEntryStatus>
( other
| invalid
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

Released

the origin of the entry, unless


invalid
This element is always shown.

unicast virtual mac address


This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.13 VLAN Priority Regeneration Profile Status


Command
Command Description
This command displays, for a given priority regeneration profile, the mapping of the external p-bit codepoints
versus the internal priority. Such a profile provides a mapping for both the upstream and the downstream direction.
These priority regeneration profiles and their contents are predetermined and cannot be changed by the operator.
A priority regeneration profile is assigned to a bridge port when configuring the bridge port.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan priority-regen [ (profile-id) ]

Command Parameters
Table 61.13-1 "VLAN Priority Regeneration Profile Status Command" Resource Parameters
Resource Identifier

Type

Description

(profile-id)

Format:
( trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3
| l2-vpn-4
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21

profile id

3HH-04416-EBAA-TCZZA 01

Released

1715

61 VLAN Status Commands

Resource Identifier

Type

Description

| 22
| 23
| 24
| 25
| 26
| 27
| 28
| 29
| 30
| 31
| 32 )
Possible values:
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile

Command Output
Table 61.13-2 "VLAN Priority Regeneration Profile Status Command" Display parameters
Specific Information
name
name
reference-count

1716

Released

Type

Description

Parameter type: <Vlan::AdminString>


- char string
- length: x<=80
Parameter type: <Vlan::Integer>
- a signed integer

name of the profile


This element is always shown.
the reference count for the profile
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Only Show Details: priority regeneration profile


name
Type
priority-0

Parameter type: <Vlan::NibbleMask_0>


- nibble mask

priority-1

Parameter type: <Vlan::NibbleMask_1>


- nibble mask

priority-2

Parameter type: <Vlan::NibbleMask_2>


- nibble mask

priority-3

Parameter type: <Vlan::NibbleMask_3>


- nibble mask

priority-4

Parameter type: <Vlan::NibbleMask_4>


- nibble mask

priority-5

Parameter type: <Vlan::NibbleMask_5>


- nibble mask

priority-6

Parameter type: <Vlan::NibbleMask_6>


- nibble mask

priority-7

Parameter type: <Vlan::NibbleMask_7>


- nibble mask

3HH-04416-EBAA-TCZZA 01

Description
the regenerated priority for .1p
priority codepoint 0
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 1
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 2
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 3
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 4
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 5
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 6
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 7
This element is only shown in
detail mode.

Released

1717

61 VLAN Status Commands

61.14 VLAN Priority Regeneration Profile Name


Status Command
Command Description
This command displays, for a given priority regeneration profile Name, the mapping of the external p-bit
codepoints versus the internal priority. Such a profile provides a mapping for both the upstream and the
downstream direction.
These priority regeneration profiles and their contents are predetermined and cannot be changed by the operator.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan prio-regen-name [ (name) ]

Command Parameters
Table 61.14-1 "VLAN Priority Regeneration Profile Name Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A unique profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 61.14-2 "VLAN Priority Regeneration Profile Name Status Command" Display parameters
Specific Information
name
profile-id

1718

Released

Type

Description

Parameter type: <Vlan::ShowPrioRegenProfile>


( trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3

name of the profile


This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

Type

Description

| l2-vpn-4
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
| 21
| 22
| 23
| 24
| 25
| 26
| 27
| 28
| 29
| 30
| 31
| 32 )
Possible values:
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile

3HH-04416-EBAA-TCZZA 01

Released

1719

61 VLAN Status Commands

name

Type

Description

reference-count

Parameter type: <Vlan::Integer>


- a signed integer

the reference count for the profile


This element is always shown.

Only Show Details: priority regeneration profile


name
Type
priority-0

Parameter type: <Vlan::NibbleMask_0>


- nibble mask

priority-1

Parameter type: <Vlan::NibbleMask_1>


- nibble mask

priority-2

Parameter type: <Vlan::NibbleMask_2>


- nibble mask

priority-3

Parameter type: <Vlan::NibbleMask_3>


- nibble mask

priority-4

Parameter type: <Vlan::NibbleMask_4>


- nibble mask

priority-5

Parameter type: <Vlan::NibbleMask_5>


- nibble mask

priority-6

Parameter type: <Vlan::NibbleMask_6>


- nibble mask

priority-7

Parameter type: <Vlan::NibbleMask_7>


- nibble mask

1720

Released

Description
the regenerated priority for .1p
priority codepoint 0
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 1
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 2
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 3
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 4
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 5
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 6
This element is only shown in
detail mode.
the regenerated priority for .1p
priority codepoint 7
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.15 Show Next Free ID of VLAN Priority


Regeneration Profile
Command Description
This command displays next free id of VLAN Priority Regeneration Profile.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan prio-regen-next

Command Output
Table 61.15-2 "Show Next Free ID of VLAN Priority Regeneration Profile " Display parameters
Specific Information
name
next-free-index

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamNextProfileIndex>


- a profile index
- range: [0...65535]

next free profile index


This element is always shown.

Released

1721

61 VLAN Status Commands

61.16 Duplicate MAC Alarm Status Command


Command Description
This command is useful when a duplicate MAC alarm has occurred. A duplicate MAC alarm is raised when a new
MAC address could not be learned on a port because this MAC address already exists on another port for the same
VLAN, that is, within the same filtering database. The information displayed indicates the port where the MAC
address is assigned, that is, the original port.
The duplicate MAC alarm information is available as long as the alarm is on.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan dup-mac-alarm [ (dup-port) [ dup-fdb-id <Vlan::StackedVlan> ] [ dup-mac <Vlan::MacAddr> ] ]

Command Parameters
Table 61.16-1 "Duplicate MAC Alarm Status Command" Resource Parameters
Resource Identifier

Type

(dup-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

1722

Released

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

dup-fdb-id

dup-mac

duplicate fdb id

duplicate mac address

Command Output
Table 61.16-2 "Duplicate MAC Alarm Status Command" Display parameters
Specific Information
name
port

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::BridgePort>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number

identity of a port(e.g. atm PVC,


/ EFM port, ...)
This element is always shown.
/
/
/
/
/
/

Released

1723

61 VLAN Status Commands

name

Type

sub-vlan

dup-sub-vlan

1724

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlan>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Vlan::StackedVlan>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

Released

the subscriber vlan associated to


bridge port
This element is always shown.

the subscriber vlan associated to


duplicate bridge port
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.17 Port Event Status Command


Command Description
This command displays all the kinds of events that occurred on a given port. These events relate to error cases.
The display element no-mac-learn that indicates that not all mac addresses are learned, is not applicable for
intel/CATE boards.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-event [ (port) ]

Command Parameters
Table 61.17-1 "Port Event Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>

3HH-04416-EBAA-TCZZA 01

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

Released

1725

61 VLAN Status Commands

Resource Identifier

Type

Description

- the PON identifier


Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.17-2 "Port Event Status Command" Display parameters
Specific Information
name
event-time
aal5-fcs-error
short name: aal5-fcs

llc-error
short name: llc

no-mac-learn
short name: no-mac

dup-mac

1726

Released

Type

Description

Parameter type: <Vlan::StatsTime>


- time
- unit: sec
Parameter type: <Vlan::Aal5FcsError>
( ( aal5-fcs | yes )
| ( no-aal5-fcs | no ) )
Possible values:
- aal5-fcs : aal5 or fcs error
- yes : aal5 or fcs error
- no-aal5-fcs : no aal5 or fcs error
- no : no aal5 or fcs error
Parameter type: <Vlan::LlcError>
( ( llc | yes )
| ( no-llc | no ) )
Possible values:
- llc : incorrect llc
- yes : incorrect llc
- no-llc : correct llc
- no : correct llc
Parameter type: <Vlan::MacNoLearnError>
( ( mac-learn-error | yes )
| ( no-mac-learn-error | no ) )
Possible values:
- mac-learn-error : mac learn error
- yes : mac learn error
- no-mac-learn-error : no mac learn error
- no : no mac learn error
Parameter type: <Vlan::MacDuplicateError>
( ( mac-dup-error | yes )
| ( no-mac-dup-error | no ) )
Possible values:
- mac-dup-error : mac duplicate error
- yes : mac duplicate error
- no-mac-dup-error : no mac duplicate error
- no : no mac duplicate error

the time in seconds when the


event ocurred
This element is always shown.
error of the aal5 frame or fcs
error
This element is always shown.

incorrect llc format


This element is always shown.

new MAC address could not be


learned,
upstream
pkt
is
discarded
This element is always shown.

failure of MAC address learning


while MAC address already
exists on another port within the
same VLAN
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.18 Port Statistics for Current Quarter Status


Command
Command Description
This command displays performance statistics for the current quarter for a particular port. Counters for upstream
and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-curr-15min-stats [ (port) ]

Command Parameters
Table 61.18-1 "Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>

3HH-04416-EBAA-TCZZA 01

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

Released

1727

61 VLAN Status Commands

Resource Identifier

Type

Description

- the port number


Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.18-2 "Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

measure-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

elapsed time in this interval, i.e.


for the current 15 minutes
interval; expressed in seconds
This element is always shown.
actually measured time in this
interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1728

Released

Description
number of frames forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
number of frames forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

Released

1729

61 VLAN Status Commands

61.19 Port Statistics for Current Day Status


Command
Command Description
This command shows Performance Statistics for the current day for a particular port. Counters for upstream and
downstream traffic are displayed. These counters include all traffic on the port, including PPPoE Relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-curr-day-stats [ (port) ]

Command Parameters
Table 61.19-1 "Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>

1730

Released

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

- the port number


Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.19-2 "Port Statistics for Current Day Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

measure-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

elapsed time in this interval, i.e.


for the current day interval;
expressed in seconds
This element is always shown.
actually measured time in this
interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
number of frames forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

Released

1731

61 VLAN Status Commands

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1732

Released

Description
number of frames forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.20 Port Statistics for Previous Quarter Intervals


Status Command
Command Description
This command displays performance statistics for the previous quarter intervals, for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent completed quarter interval. From there
onward, interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-15min-stats [ (port) [ interval-number <Vlan::IntervalNumber> ] ]

Command Parameters
Table 61.20-1 "Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

3HH-04416-EBAA-TCZZA 01

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

Released

1733

61 VLAN Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SlotId>


- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::IntervalNumber>
Format:
- [1...32] for gpon,[1...96] for others
- range: [1...96]

interval-number

interval number, where 1 is the


most recent completed interval

Command Output
Table 61.20-2 "Port Statistics for Previous Quarter Intervals Status Command" Display parameters
Specific Information
name
measure-time

Type

Description

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

actually measured time in this


interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>

1734

Released

Description
number of frames forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction on a bridge
port, for the specified interval.
Frames are discarded as a result
of buffer acceptance or policing
This element is only shown in
detail mode.
number of discarded bytes in

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

Type

Description

- vlan counter

upstream direction on a bridge


port, for the specified interval.
Discarding is a result of buffer
acceptance or policing
This element is only shown in
detail mode.

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
number of frames forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

Released

1735

61 VLAN Status Commands

61.21 Port Statistics for Previous Day Intervals


Status Command
Command Description
This command displays performance statistics for the previous day intervals for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent completed day interval. From there onward,
interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-prev-day-stats [ (port) [ interval-number <Vlan::DayIntervalNumber> ] ]

Command Parameters
Table 61.21-1 "Port Statistics for Previous Day Intervals Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>

1736

Released

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

interval-number

Type

Description

- the LT slot number


Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::DayIntervalNumber>
Format:
- IntervalNumber for one day pm
- range: [1]

interval number

Command Output
Table 61.21-2 "Port Statistics for Previous Day Intervals Status Command" Display parameters
Specific Information
name
measure-time

Type

Description

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

actually measured time in this


interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
number of frames forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction on a bridge
port, for the specified interval
This element is only shown in

Released

1737

61 VLAN Status Commands

name

Type

Description
detail mode.

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1738

Released

Description
number of frames forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction on a bridge
port, for the specified interval
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.22 VLAN Port Statistics for Current Quarter


Status Command
Command Description
This command displays performance statistics for the current quarter for a particular VLAN and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan current-15min-stats [ (vlanid) [ port <Itf::BridgePort> ] ]

Command Parameters
Table 61.22-1 "VLAN Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::BridgePort>
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>

vlan id

port

3HH-04416-EBAA-TCZZA 01

identity of a port(e.g. atm PVC,


EFM port, ...)
/
/
/
/
/

Released

1739

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / voip


| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.22-2 "VLAN Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

measure-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

elapsed time in this interval, i.e.


for the current 15 minutes
interval; expressed in seconds
This element is always shown.
actually measured time in this
interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1740

Released

Description
number of frames forwarded in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of frames forwarded in
upstream direction per VLAN on
a bridge port, for the specified

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

Type

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.

Description
number of frames forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.

Released

1741

61 VLAN Status Commands

61.23 VLAN Port Statistics for Current Day Status


Command
Command Description
This command displays performance statistics for the current day for a particular VLAN and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan current-day-stats [ (vlanid) [ port <Itf::BridgePort> ] ]

Command Parameters
Table 61.23-1 "VLAN Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier

Type

(vlanid)

Format:
vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::BridgePort>
identity of a port(e.g. atm PVC,
Format:
EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

port

1742

Released

Description

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /


<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.23-2 "VLAN Port Statistics for Current Day Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

measure-time

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

elapsed time in this interval, i.e.


for the current 15 minutes
interval; expressed in seconds
This element is always shown.
actually measured time in this
interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

3HH-04416-EBAA-TCZZA 01

Parameter type: <Vlan::OctetCounter>


- vlan counter

Description
number of frames forwarded in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.

Released

1743

61 VLAN Status Commands

name

Type

Description

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

number of bytes forwarded in


upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1744

Released

Description
number of frames forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.24 VLAN Port Statistics for Previous Quarter


Intervals Status Command
Command Description
This command displays performance statistics for the previous quarter intervals for a particular VLAN and port.
Counters for upstream and downstream traffic are displayed. These counters include all traffic on the port,
including PPPoE relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent completed quarter interval. From there
onward, interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan previous-15min-stats [ (vlanid) [ port <Itf::BridgePort> ] [ interval-number <Vlan::IntervalNumber> ]
]

Command Parameters
Table 61.24-1 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier

Type

(vlanid)

Format:
vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::BridgePort>
identity of a port(e.g. atm PVC,
Format:
EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

port

3HH-04416-EBAA-TCZZA 01

Description

Released

1745

61 VLAN Status Commands

Resource Identifier

Type

Description

<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>


| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::IntervalNumber>
interval number
Format:
- [1...32] for gpon,[1...96] for others
- range: [1...96]

interval-number

Command Output
Table 61.24-2 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Display
parameters
Specific Information
name
measure-time

Type

Description

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

actually measured time in this


interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type

Description

forward-frame

number of frames forwarded in

1746

Parameter type: <Vlan::OctetCounter>

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

Type

Description

- vlan counter

upstream direction per VLAN on


a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
number of frames forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.

Released

1747

61 VLAN Status Commands

61.25 VLAN Port Statistics for Previous Day


Intervals Status Command
Command Description
This command displays performance statistics for the previous day intervals for a particular VLAN and port.
Counters for upstream and downstream traffic are displayed. These counters include all traffic on the port,
including PPPoE relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent completed day interval. From there onward,
interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan vlan-day-stats [ (vlanid) [ port <Itf::BridgePort> ] [ interval-number <Vlan::DayIntervalNumber> ] ]

Command Parameters
Table 61.25-1 "VLAN Port Statistics for Previous Day Intervals Status Command" Resource
Parameters
Resource Identifier

Type

(vlanid)

Format:
vlan id
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Itf::BridgePort>
identity of a port(e.g. atm PVC,
Format:
EFM port, ...)
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>

port

1748

Released

Description

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

interval-number

Type

Description

| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::DayIntervalNumber>
interval number
Format:
- IntervalNumber for one day pm
- range: [1]

Command Output
Table 61.25-2 "VLAN Port Statistics for Previous Day Intervals Status Command" Display
parameters
Specific Information
name
measure-time

Type

Description

Parameter type: <Vlan::StatsTime>


- time
- unit: sec

actually measured time in this


interval; expressed in seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

3HH-04416-EBAA-TCZZA 01

Parameter type: <Vlan::OctetCounter>


- vlan counter

Description
number of frames forwarded in
upstream direction per VLAN on

Released

1749

61 VLAN Status Commands

name

Type

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

Only Show Details: down stream counters


name
Type
forward-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

forward-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

discard-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

1750

Released

Description
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
upstream direction per VLAN on
a bridge port, for the specified
interval
This element is only shown in
detail mode.

Description
number of frames forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of bytes forwarded in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded frames in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.
number of discarded bytes in
downstream direction per VLAN
on a bridge port, for the specified
interval
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.26 SHub Port VLAN Association Status


Command
Command Description
This command displays all VLANs associated with a given port on the SHub. This association is configured, but
can be overruled as a result of authentication of the port using RADIUS protocol.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-port-vlan-map [ (port) [ vlan-id <Sys::VlanId> ] ]

Command Parameters
Table 61.26-1 "SHub Port VLAN Association Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>

port

3HH-04416-EBAA-TCZZA 01

Released

1751

61 VLAN Status Commands

Resource Identifier

- network port on Shub


Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port
Parameter type: <Sys::VlanId>
Format:
- vlan id
- range: [1...4093]

vlan-id

1752

Type

Released

Description

identity of the vlan

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.27 SHub VLAN Name Mapping Status Command


Command Description
This command displays the VLAN identity that corresponds to a given VLAN name, for a VLAN configured on the
SHub.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-vlan-name [ (name) ]

Command Parameters
Table 61.27-1 "SHub VLAN Name Mapping Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- char string
- length: x<=80

name identifying the vlan

Command Output
Table 61.27-2 "SHub VLAN Name Mapping Status Command" Display parameters
Specific Information
name
vlan-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::VlanNameIndex>


- vlan id
- range: [1...4093,4097]

vlan identity
This element is always shown.

Released

1753

61 VLAN Status Commands

61.28 SHub VLAN Filtering Database Status


Command
Command Description
This command displays all entries of the filtering database given a particular VLAN on the SHub. The filtering
dabatase is used by the bridging function in determining how to propagate a received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.
Ports in a LAG configuration are treated as a single port. In our system, this single port is the lowest port of the
LAG. Therefore, the MAC@ is always displayed for the same networkport, independent of which port is the active
one of the LA.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-fdb [ (vlanid) ]

Command Parameters
Table 61.28-1 "SHub VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]

vlan id

Command Output
Table 61.28-2 "SHub VLAN Filtering Database Status Command" Display parameters
Specific Information
name
mac
bridge-port

1754

Released

Type

Description

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Shub::Port>
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>

mac address
This element is always shown.
bridge port
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

status

fdb-id
filter-entries

3HH-04416-EBAA-TCZZA 01

Type

Description

| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port
Parameter type: <Vlan::FdbEntryStatus>
( other
| invalid
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager
Parameter type: <Vlan::Gauge>
- an unsigned integer
Parameter type: <Vlan::Counter>
- an unsigned integer

the origin of the entry, unless


invalid
This element is always shown.

filtering database identity


This element is only shown in
detail mode.
current number of entries in this
fdb
This element is only shown in
detail mode.

Released

1755

61 VLAN Status Commands

61.29 SHub Filtering Database Entry Status


Command
Command Description
This command displays one entry of the filtering database -if any- given a particular VLAN, a unicast MAC address
and a bridge port on the SHub. The filtering dabatase is used by the bridging function in determining how to
propagate a received frame.
The status parameter indicates what the trigger was for creation of the filtering database entry, that is, a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-filter-entry [ (vlanid) [ unicast-mac <Vlan::MacAddr> ] ]

Command Parameters
Table 61.29-1 "SHub Filtering Database Entry Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

vlan id

unicast-mac

mac address

Command Output
Table 61.29-2 "SHub Filtering Database Entry Status Command" Display parameters
Specific Information
name
port

1756

Released

Type

Description

Parameter type: <Shub::Port>


( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>

port where the mac address was


learnt
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

status

3HH-04416-EBAA-TCZZA 01

Type

Description

| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port
Parameter type: <Vlan::FdbEntryStatus>
( other
| invalid
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager

the origin of the entry, unless


invalid
This element is always shown.

Released

1757

61 VLAN Status Commands

61.30 SHub Duplicate MAC Alarm Status Command


Command Description
This command displays the status of a duplicate MAC alarm. This command is useful when a duplicate MAC alarm
has occurred. A duplicate MAC alarm is raised when a new MAC address could not be learned on a port of the
SHub because this MAC address already exists on another port of the SHub for the same VLAN, that is, within the
same filtering database.
When a duplicate MAC alarm is raised, it provides the port and VLAN identity where the alarm occurred, but it
does not carry the MAC address.
This command is helpful in displaying the list of duplicate MAC Addresses on the specific port and VLAN.
The duplicate MAC alarm information is available as long as the alarm is "on".

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-dup-mac-alarm [ (dup-vlan-id) [ dup-port <Shub::Port> ] ]

Command Parameters
Table 61.30-1 "SHub Duplicate MAC Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(dup-vlan-id)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Shub::Port>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port

duplicate vlan id

dup-port

1758

Released

duplicate bridge port

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

Type

Description

- eth : ethernet port (or lemi)


Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

Command Output
Table 61.30-2 "SHub Duplicate MAC Alarm Status Command" Display parameters
Specific Information
name
duplicate-mac

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

duplicate mac address


This element is always shown.

Released

1759

61 VLAN Status Commands

61.31 SHub Number Of Active Multicast Entries


Status Command
Command Description
This command displays the number of active multicast entries in the SHub.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-nr-mcast-entries

Command Output
Table 61.31-2 "SHub Number Of Active Multicast Entries Status Command" Display parameters
Specific Information
name
nrmcast-entries

1760

Released

Type

Description

Parameter type: <Vlan::ActiveNrMcastEntries>


- a signed integer

number of active multicast


entries.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.32 VLAN Filtering Database Status Command


Command Description
Obsolete command, replaced by show vlan bridge-port-fdb.
This command displays the contents of the virtual MAC table. The display can be filtered by Vlan, bridge port,
and/or subscriber MAC address.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan vmac-bridge-port-fdb [ (port) [ vlan-id <Vlan::StackedVlan> ] [ mac <Vlan::MacAddr> ] ]
Obsolete command, replaced by show vlan bridge-port-fdb.

Command Parameters
Table 61.32-1 "VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description
identity of the PVC
/
/
/
/
/
/
/

Released

1761

61 VLAN Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::MacAddr>
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

vlan-id

mac

subscriber vlan id

mac address

Command Output
Table 61.32-2 "VLAN Filtering Database Status Command" Display parameters
Specific Information
name
fdb-id

status

1762

Released

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Vlan::FdbEntryStatus>
( other

the identity of this filtering


database
This element is always shown.

the origin of the entry, unless


invalid

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

name

vmac

3HH-04416-EBAA-TCZZA 01

Type

Description

| invalid
| learned
| self
| static )
Possible values:
- other : entry does not determine the forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned dynamically
- self : entry represents one of the device's addresses
- static : entry has been configured by a manager
Parameter type: <Vlan::FilterVMacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

This element is always shown.

unicast virtual mac address


This element is always shown.

Released

1763

61 VLAN Status Commands

61.33 P-bit Traffic Counters Status Command


Command Description
This command allows the operator to show the p-bit traffic counters.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan pbit-statistics port [ (vlan-port) [ min-dot1p <Vlan::Dot1pMin> ] [ max-dot1p <Vlan::Dot1pMax> ] ]

Command Parameters
Table 61.33-1 "P-bit Traffic Counters Status Command" Resource Parameters
Resource Identifier

Type

(vlan-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>

1764

Released

Description
vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:
/
:

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

Resource Identifier

min-dot1p

max-dot1p

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::Dot1pMin>
the min pbit value
Format:
- dot1p value range
- range: [0...7]
Parameter type: <Vlan::Dot1pMax>
the max pbit value
Format:
- dot1p value range
- range: [0...7]

Command Output

3HH-04416-EBAA-TCZZA 01

Released

1765

61 VLAN Status Commands

Table 61.33-2 "P-bit Traffic Counters Status Command" Display parameters


Specific Information
name

Type

Description

up-forward-byte

Parameter type: <Vlan::Dot1pTraffCounter>


- 64 bit counter,range:[0-9223372036854775808]

dn-forward-byte

Parameter type: <Vlan::Dot1pTraffCounter>


- 64 bit counter,range:[0-9223372036854775808]

all forwarded bytes in upstream


directions on a vlan port for the
given P-bit range.
This element is always shown.
all
forwarded
bytes
in
downstream directions on a vlan
port for the given P-bit range.
This element is always shown.

1766

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.34 Current VLAN Filtering Database Status


Command
Command Description
This command displays filtering database used by this VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan fdbid [ (vlan-id) ]

Command Parameters
Table 61.34-1 "Current VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

network vlan id

Command Output
Table 61.34-2 "Current VLAN Filtering Database Status Command" Display parameters
Specific Information
name
fdb-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:

identity of the filtering database


This element is always shown.

Released

1767

61 VLAN Status Commands

name

Type

Description

- stacked : stacked vlan identity


Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

1768

Released

3HH-04416-EBAA-TCZZA

01

61 VLAN Status Commands

61.35 Accumulated Port Statistics


Command Description
This command displays performance statistics for a particular port. Counters for upstream and downstream traffic
are displayed. These counters do not include broadcast/multicast frames per bridge port in downstream direction.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-accumu-stats [ (port) ]

Command Parameters
Table 61.35-1 "Accumulated Port Statistics" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier

3HH-04416-EBAA-TCZZA 01

Description
identity of a port(e.g. atm PVC,
/ EFM port, ...)
/
/
/
/
/
/

Released

1769

61 VLAN Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntId>


- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 61.35-2 "Accumulated Port Statistics" Display parameters
Specific Information
name

Type

Description

up-fwd-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

up-fwd-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

up-dis-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

up-dis-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

dn-fwd-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

dn-fwd-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

dn-dis-frame

Parameter type: <Vlan::OctetCounter>


- vlan counter

dn-dis-byte

Parameter type: <Vlan::OctetCounter>


- vlan counter

number of frames forwarded in


upstream direction on a bridge
port, for the specified interval
This element is always shown.
number of bytes forwarded in
upstream direction on a bridge
port, for the specified interval
This element is always shown.
number of discarded frames in
upstream direction on a bridge
port, for the specified interval
This element is always shown.
number of discarded bytes in
upstream direction on a bridge
port, for the specified interval
This element is always shown.
number of frames forwarded in
downstream direction on a bridge
port, for the specified interval
This element is always shown.
number of bytes forwarded in
downstream direction on a bridge
port, for the specified interval
This element is always shown.
number of discarded frames in
downstream direction on a bridge
port, for the specified interval
This element is always shown.
number of discarded bytes in
downstream direction on a bridge
port, for the specified interval
This element is always shown.

1770

Released

3HH-04416-EBAA-TCZZA

01

62- Link Aggregation Status Commands

62.1 Link Aggregation Status Command Tree


62.2 Link Aggregation Group Status Command
62.3 Link Aggregation Member List Status Command
62.4 Link Aggregate Member Link Status Command

3HH-04416-EBAA-TCZZA 01

62-1772
62-1773
62-1778
62-1780

Released

1771

62 Link Aggregation Status Commands

62.1 Link Aggregation Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Link Aggregation Status Commands".

Command Tree
----show
----la
----aggregator-info
- (port)
----aggregate-list
- (network-port)
- participant-port
----network-port-info
- (port)

1772

Released

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

62.2 Link Aggregation Group Status Command


Command Description
This command displays information about a Link Aggregation Group configured on the SHub. The information
pertains to the Group. The operator identifies the group by means of the primary link or primary port. (See "Link
Aggregation Group Configuration Command" section for the definition of primary link.)

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la aggregator-info [ (port) ]

Command Parameters
Table 62.2-1 "Link Aggregation Group Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

interface index of the port

Command Output
Table 62.2-2 "Link Aggregation Group Status Command" Display parameters
Specific Information
name

Type

Description

mac-address

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

aggregate

Parameter type: <Shub::AggregateFlag>

Specifies MAC address assigned


to the Aggregator.
This element is shown in normal
mode.
Specifies whether the aggregator

3HH-04416-EBAA-TCZZA 01

Released

1773

62 Link Aggregation Status Commands

name

actor-oper-key
short name: actor-key

Type

Description

( ( aggregate | yes )
| ( individual | no ) )
Possible values:
- aggregate : aggregate
- yes : aggregate
- individual : individual
- no : individual
Parameter type: <Shub::LacpKey>
- link aggregate key
- range: [0...65535]

represents an aggregate or an
individual link.
This element is shown in normal
mode.

partner-sys-id

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

partner-sys-priority
short name: prio

Parameter type: <Shub::LaPartnerSysPriority>


- la actor system priority
- range: [0...65535]

partner-oper-key
short name: partner-key

Parameter type: <Shub::LacpKey>


- link aggregate key
- range: [0...65535]

Only Show Details: aggregator parameters


name
Type
mac-address

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

aggregate

Parameter type: <Shub::AggregateFlag>


( ( aggregate | yes )
| ( individual | no ) )
Possible values:
- aggregate : aggregate
- yes : aggregate
- individual : individual
- no : individual
Parameter type: <Shub::LacpKey>
- link aggregate key
- range: [0...65535]

actor-oper-key

actor-sys-id

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

partner-sys-id

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

partner-sys-priority

Parameter type: <Shub::LaPartnerSysPriority>


- la actor system priority
- range: [0...65535]

1774

Released

The current operational value of


the key for the aggregator.
This element is shown in normal
mode.
Specifies MAC address for the
current protocol partner of this
aggregator
This element is shown in normal
mode.
Specifies
priority
value
associated with the partner's
system id.
This element is shown in normal
mode.
The current operational value for
the aggregator's current protocol
partner.
This element is shown in normal
mode.

Description
Specifies MAC address assigned
to the Aggregator.
This element is only shown in
detail mode.
Specifies whether the aggregator
represents an aggregate or an
individual link.
This element is only shown in
detail mode.

The current operational value of


the key for the aggregator.
This element is only shown in
detail mode.
Specifies MAC address for the
current protocol actor of this
aggregator
This element is only shown in
detail mode.
Specifies MAC address for the
current protocol partner of this
aggregator
This element is only shown in
detail mode.
Specifies
priority
value
associated with the partner's
system id.

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

name
partner-oper-key

Type

Description

Parameter type: <Shub::LacpKey>


- link aggregate key
- range: [0...65535]

This element is only shown in


detail mode.
The current operational value for
the aggregator's current protocol
partner.
This element is only shown in
detail mode.

Only Show Details: statistics


name
Type
rx-octets

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-ucast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-mcast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-bcast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-discard-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

rx-error-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

3HH-04416-EBAA-TCZZA 01

Description
A count of the data and padding
octets received by the aggregator,
from the aggregation ports that
are members of the aggregation.
This element is only shown in
detail mode.
A count of the data frames
received by the aggregator, from
the aggregation ports that are
members of the aggregation.
This element is only shown in
detail mode.
The total number of unicast user
data frames received by the
aggregation.
This element is only shown in
detail mode.
A count of the data frames
received by this aggregator, from
the aggregation ports that are
members of the aggregation,that
were addressed to an active group
address other than the broadcast
address.
This element is only shown in
detail mode.
A count of the broadcast data
frames
received
by
this
Aggregator,
from
the
Aggregation Ports that are
members of the aggregation.
This element is only shown in
detail mode.
A count of data frames,received
on all ports that are members of
the
aggregation,that
were
discarded by the collection
function of the aggregator as they
were received on ports whose
collection function was disabled.
This element is only shown in
detail mode.
A count of data frames discarded
on reception by all ports that are
members of the aggregation,or
that were discarded by the
collection function of the
aggregator,or that were discarded

Released

1775

62 Link Aggregation Status Commands

name

Type

rx-unknown-prot-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-octets

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-ucast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-mcast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-bcast-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

tx-discard-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

1776

Released

Description
by the aggregator due to the
detection of an illegal slow
protocols PDU
This element is only shown in
detail mode.
A count of data frames discarded
on reception by all ports that are
members of the aggregation,due
to the detection of an unknown
slow protocols PDU .
This element is only shown in
detail mode.
A count of the data and padding
octets transmitted by this
aggregator on all aggregation
ports that are members of the
aggregation.
This element is only shown in
detail mode.
A count of the data frames
transmitted by this aggregator on
all aggregation ports that are
members of the aggregation.
This element is only shown in
detail mode.
The total number of unicast user
data frames transmitted by
aggregation.
This element is only shown in
detail mode.
A count of the data frames
transmitted by this aggregator on
all aggregation ports that are
members of the aggregation,to a
group destination address other
than the broadcast address.
This element is only shown in
detail mode.
A count of the broadcast data
frames transmitted by this
aggregator on all aggregation
ports that are members of the
aggregation.
This element is only shown in
detail mode.
A count of data frames requested
to be transmitted by this
aggregator that were discarded by
the distribution function of the
aggregator when conversations
are re-allocated to different
ports,due to the requirement to
ensure that the conversations are
flushed on the old ports in order
to maintain proper frame ordering
,or discarded as a result of
excessive collisions by ports that

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

name

Type

tx-error-frames

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

trap-port

Parameter type: <Shub::NetworkPort>


( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-EBAA-TCZZA 01

Description
are members of the aggregation.
This element is only shown in
detail mode.
A count of data frames requested
to be transmitted by this
aggregator
that
experienced
transmission errors on ports that
are
members
of
the
aggregation.This count does not
include frames discarded due to
excess collisions.
This element is only shown in
detail mode.
Specifies index used to generate
TRAP
for
the
particular
aggregator
This element is only shown in
detail mode.

Released

1777

62 Link Aggregation Status Commands

62.3 Link Aggregation Member List Status


Command
Command Description
This command displays the list of ports that are members of a Link Aggregation Group.
The Link Aggregation Group should be identified by means of its primary link, otherwise, the list of ports will be
empty. (See "Link Aggregation Group Configuration Command" section for the definition of primary link.)

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la aggregate-list [ (network-port) [ participant-port <Shub::NetworkPort> ] ]

Command Parameters
Table 62.3-1 "Link Aggregation Member List Status Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Parameter type: <Shub::NetworkPort>
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot

port

participant-port

1778

Released

participants in the aggregation


group

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

Resource Identifier

Type

Description

Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-EBAA-TCZZA 01

Released

1779

62 Link Aggregation Status Commands

62.4 Link Aggregate Member Link Status Command


Command Description
This command displays information for a member of a Link Aggregation Group configured on the SHub. The
member link is identified by its port number.
Detailed information can be obtained on LACP protocol statistics and debugging information.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la network-port-info [ (port) ]

Command Parameters
Table 62.4-1 "Link Aggregate Member Link Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

interface index of the network


port

Command Output
Table 62.4-2 "Link Aggregate Member Link Status Command" Display parameters
Specific Information
name
aggregate

1780

Released

Type

Description

Parameter type: <Shub::AggregateFlag>


( ( aggregate | yes )
| ( individual | no ) )
Possible values:

specifies whether the aggregation


port is able to aggregate or only
able to operate as an individual
link.

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

name

standby

Type

Description

- aggregate : aggregate
- yes : aggregate
- individual : individual
- no : individual
Parameter type: <Shub::SbyStatus>
( ( active | no )
| ( standby | yes ) )
Possible values:
- active : active
- no : active
- standby : standby
- yes : standby

This element is always shown.

Only Show Details: aggregate/individual parameters


name
Type
actor-sys-id

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

actor-key

Parameter type: <Shub::LacpKey>


- link aggregate key
- range: [0...65535]

partner-sys-priority

Parameter type: <Shub::LaPortPartnerAdminSysPrio>


- la aggregate partner admin system priority
- range: [0...65535]

partner-sys-id

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

partner-key

Parameter type: <Shub::LacpKey>


- link aggregate key
- range: [0...65535]

actual-aggregator-port

Parameter type: <Shub::RstpNetworkPort>


( network : <Shub::NetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- nt : active nt slot
- none : no port
- network : network port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-EBAA-TCZZA 01

specifies whether aggregation


port is in active or standby
This element is always shown.

Description
specifies MAC addr that defines
the value of the system id for the
system
that
contains
this
aggregation port.
This element is only shown in
detail mode.
current operational value of the
key for the aggregation port.
This element is only shown in
detail mode.
operational value of priority
associated with the partner's
system id.
This element is only shown in
detail mode.
specifies MAC addr value
representing the current value of
the aggregation port's protocol
partner's system id.
This element is only shown in
detail mode.
current operational value of the
key for the protocol partner.
This element is only shown in
detail mode.
specifies the aggregator that this
aggregation port has currently
selected
This element is only shown in
detail mode.

Released

1781

62 Link Aggregation Status Commands

name

Type

Description

attached-aggreg-port

Parameter type: <Shub::RstpNetworkPort>


( network : <Shub::NetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- nt : active nt slot
- none : no port
- network : network port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Parameter type: <Shub::RstpNetworkPort>
( network : <Shub::NetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- nt : active nt slot
- none : no port
- network : network port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Parameter type: <Shub::LaPartnerAdminPort>
- la aggregate partner admin port
- range: [0...65535]

specifies the aggregator that this


aggregation port is currently
attached to. Zero indicates that
the aggregation port is not
currently
attached
to
an
aggregator.
This element is only shown in
detail mode.

actor-port

partner-port

port number locally assigned to


the aggregation port.
This element is only shown in
detail mode.

partner-port-priority

Parameter type: <Shub::LaActorPortPriority>


- la aggregate actor port priority
- range: [0...65535]

actor-synch-state

Parameter type: <Shub::ActorOperLacpSynchState>


( ( synchronised | yes )
| ( not-synchronised | no ) )
Possible values:
- synchronised : actor is syncronised
- yes : actor is syncronised
- not-synchronised : actor is not synchronised
- no : actor is not synchronised
Parameter type: <Shub::ActorOperLacpCollectState>
( ( collecting | yes )
| ( not-collecting | no ) )

actor-collect-state

1782

Released

operational port number assigned


to this aggregation port by the
aggregation
port's
protocol
partner.
This element is only shown in
detail mode.
priority value assigned to this
aggregation port by the partner.
This element is only shown in
detail mode.
actor oper lacp synch state
This element is only shown in
detail mode.

actor oper lacp collecting state


This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

name

actor-distribute-state

actor-defaulted-state

actor-expired-state

partner-synch-state

partner-collect-state

partn-distribute-state

partn-defaulted-state

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- collecting : the actor is collecting
- yes : the actor is collecting
- not-collecting : the actor is not collecting
- no : the actor is not collecting
Parameter type: <Shub::ActorOperLacpDistributeState>
( ( distributing | yes )
| ( not-distributing | no ) )
Possible values:
- distributing : the actor is distributing
- yes : the actor is distributing
- not-distributing : the actor is not distributing
- no : the actor is not distributing
Parameter type: <Shub::ActorOperLacpDefaultedState>
( ( is-defaulted | yes )
| ( is-not-defaulted | no ) )
Possible values:
- is-defaulted : the actor is defaulted
- yes : the actor is defaulted
- is-not-defaulted : the actor is not defaulted
- no : the actor is not defaulted
Parameter type: <Shub::ActorOperLacpExpiredState>
( ( is-expired | yes )
| ( is-not-expired | no ) )
Possible values:
- is-expired : actor is in lacp expired state
- yes : actor is in lacp expired state
- is-not-expired : actor is not in lacp expired state
- no : actor is not in lacp expired state
Parameter type: <Shub::ActorOperLacpSynchState>
( ( synchronised | yes )
| ( not-synchronised | no ) )
Possible values:
- synchronised : actor is syncronised
- yes : actor is syncronised
- not-synchronised : actor is not synchronised
- no : actor is not synchronised
Parameter type: <Shub::ActorOperLacpCollectState>
( ( collecting | yes )
| ( not-collecting | no ) )
Possible values:
- collecting : the actor is collecting
- yes : the actor is collecting
- not-collecting : the actor is not collecting
- no : the actor is not collecting
Parameter type: <Shub::ActorOperLacpDistributeState>
( ( distributing | yes )
| ( not-distributing | no ) )
Possible values:
- distributing : the actor is distributing
- yes : the actor is distributing
- not-distributing : the actor is not distributing
- no : the actor is not distributing
Parameter type: <Shub::ActorOperLacpDefaultedState>
( ( is-defaulted | yes )
| ( is-not-defaulted | no ) )
Possible values:

actor oper lacp distributing state


This element is only shown in
detail mode.

actor oper lacp defaulted state


This element is only shown in
detail mode.

actor oper lacp expired state


This element is only shown in
detail mode.

partner oper lacp synch state


This element is only shown in
detail mode.

partner oper lacp collecting state


This element is only shown in
detail mode.

partner oper lacp distributing


state
This element is only shown in
detail mode.

partner oper lacp defaulted state


This element is only shown in
detail mode.

Released

1783

62 Link Aggregation Status Commands

name

Type

partner-expired-state

Only Show Details: link aggregation control protocol statistics


name
Type
lacp-pdus-rx

Parameter type: <Vlan::Counter>


- an unsigned integer

marker-rx

Parameter type: <Vlan::Counter>


- an unsigned integer

marker-response-rx

Parameter type: <Vlan::Counter>


- an unsigned integer

unknown-rx

Parameter type: <Vlan::Counter>


- an unsigned integer

illegal-rx

Parameter type: <Vlan::Counter>


- an unsigned integer

lacp-pdus-tx

Parameter type: <Vlan::Counter>


- an unsigned integer

marker-tx

Parameter type: <Vlan::Counter>


- an unsigned integer

marker-response-tx

Parameter type: <Vlan::Counter>


- an unsigned integer

1784

Released

Description

- is-defaulted : the actor is defaulted


- yes : the actor is defaulted
- is-not-defaulted : the actor is not defaulted
- no : the actor is not defaulted
Parameter type: <Shub::ActorOperLacpExpiredState>
( ( is-expired | yes )
| ( is-not-expired | no ) )
Possible values:
- is-expired : actor is in lacp expired state
- yes : actor is in lacp expired state
- is-not-expired : actor is not in lacp expired state
- no : actor is not in lacp expired state

partner oper lacp expired state


This element is only shown in
detail mode.

Description
number of valid LACPDUs
received on this aggregation port.
This element is only shown in
detail mode.
nbr of valid marker PDUs
received on this aggregation port.
This element is only shown in
detail mode.
nbr of valid marker response
PDUs
received
on
this
aggregation port.
This element is only shown in
detail mode.
nbr of frames rx that either: carry
the slow protocols ethernet type
value, but contain an unknown
PDU,or: are addressed to the
slow protocols group MAC addr,
but do not carry the slow
protocols ethernet type.
This element is only shown in
detail mode.
nbr of frames rx that carry the
slow protocols ethernet type
value, but contain a badly formed
PDU or an illegal value of
protocol subtype.
This element is only shown in
detail mode.
number of LACPDUs transmitted
on this aggregation port.
This element is only shown in
detail mode.
number
of
marker
PDUs
transmitted on this aggregation
port.
This element is only shown in
detail mode.
nbr of marker response PDUs
transmitted on this aggregation
port.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

62 Link Aggregation Status Commands

Only Show Details: debugging information


name
Type
rx-state

mux-state

mux-reason

actor-churn-state

actor-churn-count

Parameter type: <Vlan::LaRxState>


( present
| expired
| defaulted
| initialize
| lacpdisabled
| portdisabled )
Possible values:
- present : present
- expired : expired
- defaulted : defaulted
- initialize : initialize
- lacpdisabled : lacp Disabled
- portdisabled : port Disabled
Parameter type: <Shub::LaMuxState>
( detached
| waiting
| attached
| collecting
| distributing
| collect-distributing )
Possible values:
- detached : detached
- waiting : waiting
- attached : attached
- collecting : collecting
- distributing : distributing
- collect-distributing : collecting and distributing
Parameter type: <Vlan::String>
- printable string

Parameter type: <Shub::LaChurnState>


( no-churn
| churn
| churn-monitor )
Possible values:
- no-churn : no churn
- churn : churn
- churn-monitor : churn monitor
Parameter type: <Vlan::Counter>
- an unsigned integer

actor-sync-transit-cnt

Parameter type: <Vlan::Counter>


- an unsigned integer

actor-lag-id-chg-count

Parameter type: <Vlan::Counter>


- an unsigned integer

3HH-04416-EBAA-TCZZA 01

Description
specifies receive state machine
for the aggregation port
This element is only shown in
detail mode.

specifies the mux state machine


for the aggregation port
This element is only shown in
detail mode.

specifies the reason for the most


recent change of mux machine
state.
This element is only shown in
detail mode.
specifies the state of the actor
churn detection machine for the
aggregation port.
This element is only shown in
detail mode.

nbr of times the actor churn state


machine
has
entered
the
ACTOR_CHURN state.
This element is only shown in
detail mode.
nbr of times the actor's mux state
machine
has
entered
the
IN_SYNC state.
This element is only shown in
detail mode.
nbr of times the actor's perception
of the lag id for this aggregation
port has changed.
This element is only shown in
detail mode.

Released

1785

62 Link Aggregation Status Commands

name

Type

Description

partner-churn-state

Parameter type: <Shub::LaChurnState>


( no-churn
| churn
| churn-monitor )
Possible values:
- no-churn : no churn
- churn : churn
- churn-monitor : churn monitor
Parameter type: <Vlan::Counter>
- an unsigned integer

specifies the state of the partner


churn detection machine for the
aggregation port.
This element is only shown in
detail mode.

partner-churn-count

partn-sync-transit-cnt

Parameter type: <Vlan::Counter>


- an unsigned integer

partner-lag-id-chg-cnt

Parameter type: <Vlan::Counter>


- an unsigned integer

1786

Released

nbr of times the partner churn


state machine has entered the
PARTNER_CHURN state.
This element is only shown in
detail mode.
nbr of times the partner's mux
state machine has entered the
IN_SYNC state.
This element is only shown in
detail mode.
nbr of times the partner's
perception of the lag id for this
aggregation port has changed.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

63- QOS Status Commands

63.1 QOS Status Command Tree


63.2 QoS Session Profile Status Command
63.3 QoS Marker Profile Status Command
63.4 QoS Policer Profile Status Command
63.5 QoS Queue Profile Status Command
63.6 QoS Scheduler Node Profile Status Command
63.7 QoS CAC Profile Status Command
63.8 QoS Policy Profile Status Command
63.9 QoS L2 Filter Profile Status Command
63.10 QoS L3 Filter Profile Status Command
63.11 QoS Policy Action Profile Status Command
63.12 QoS IngressQoS Profile Status Command
63.13 QoS Shaper Profile Status Command
63.14 QoS Bandwidth Profile Status Command
63.15 QoS Rate Limit Profile Status Command
63.16 QoS DSCP to PBIT Profile Status Command
63.17 QoS Ingress filter Resource Usage Status Command
63.18 QoS DSL Bandwidth Status Command
63.19 QoS Shdsl Bandwidth Status Command
63.20 QoS Ethernet Bandwidth Status Command
63.21 QoS Interface Bandwidth Status Command
63.22 QoS Total Buffer Overflow Statistics for Previous
Quarter
63.23 QoS Total Buffer Overflow Statistics for Current
Quarter
63.24 QoS Total Buffer Overflow Statistics for Previous
Day Command
63.25 QoS Total Buffer Overflow Statistics for Current Day
63.26 QoS Total Buffer Overflow Statistics Total Status
Command
63.27 QoS Interface Buffer Overflow Statistics for Previous
Quarter
63.28 QoS Interface Buffer Overflow Statistics for Current
Quarter
63.29 QoS Fan Out Statistics for Previous Quarter
63.30 QoS Fan Out Statistics for Current 15 minutes
63.31 QoS Fan Out Statistics for Previous Day
63.32 QoS Fan Out Statistics for Current Day
63.33 QoS LT Queue Overflow Statistics for Previous
Quarter
63.34 QoS LT Queue Overflow Statistics for current
Quarter
63.35 QoS SHub Meter Statistics Status Command
63.36 QoS SHub Flow Statistics Status Command
63.37 QoS TC2QMapping Status Command

3HH-04416-EBAA-TCZZA 01

63-1788
63-1790
63-1791
63-1792
63-1793
63-1794
63-1795
63-1796
63-1797
63-1798
63-1799
63-1800
63-1801
63-1802
63-1803
63-1804
63-1805
63-1807
63-1809
63-1811
63-1813
63-1817
63-1820
63-1823
63-1826
63-1829
63-1833
63-1836
63-1839
63-1841
63-1843
63-1845
63-1847
63-1849
63-1851
63-1852
63-1853

Released

1787

63 QOS Status Commands

63.1 QOS Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "QOS Status Commands".

Command Tree
----show
----qos
----profile-usage
----session
- (name)
----marker
- (name)
----policer
- (name)
----queue
- (name)
----scheduler-node
- (name)
----cac
- (name)
----policy
- (name)
----l2-filter
- (name)
----l3-filter
- (name)
----policy-action
- (name)
----ingress-qos
- (name)
----shaper
- (name)
----bandwidth
- (name)
----rate-limit
- (name)
----dscp-pbit
- (name)
----resource-usage
----ingress-hw-filter
- (equip-slot)
----X dsl-bandwidth
- (index)
----X shdsl-bandwidth
- (index)
----X ethernet-bandwidth
- (index)
----interface-bandwidth
- (index)
----statistics
----buffer-overflow

1788

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

----prev-15min
- (equip-slot)
- interval-num
----current-15min
- (equip-slot)
----prev-1day
- (equip-slot)
----current-1day
- (equip-slot)
----total
- (equip-slot)
----queue
----prev-15min
- (index)
- queue
- interval-num
----current-15min
- (index)
- queue
----lt-cos
----prev-15min
- (equip-slot)
- traffic-class
- interval-num
----current-15min
- (equip-slot)
- traffic-class
----prev-1day
- (equip-slot)
- interval-num
----current-1day
- (equip-slot)
----lt-queue
----prev-15min
- (index)
----current-15min
- (index)
----shub
----meter
- (index)
----flow
- (index)
----tc-to-qmap
- (name)

3HH-04416-EBAA-TCZZA 01

Released

1789

63 QOS Status Commands

63.2 QoS Session Profile Status Command


Command Description
This command displays the QoS session profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS session profiles. The QoS session profile usage
represents the total user sessions (both for statically configured and dynamic sessions).

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage session [ (name) ]

Command Parameters
Table 63.2-1 "QoS Session Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A session profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.2-2 "QoS Session Profile Status Command" Display parameters
Specific Information
name
ref-count

1790

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.3 QoS Marker Profile Status Command


Command Description
This command displays the QoS marker profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS marker profiles. The QoS marker profile usage shows
the references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage marker [ (name) ]

Command Parameters
Table 63.3-1 "QoS Marker Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A marker profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.3-2 "QoS Marker Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile 'is in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1791

63 QOS Status Commands

63.4 QoS Policer Profile Status Command


Command Description
This command displays the QoS policer profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS policer profiles. The QoS policer profile usage shows
the references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage policer [ (name) ]

Command Parameters
Table 63.4-1 "QoS Policer Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A policer profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.4-2 "QoS Policer Profile Status Command" Display parameters
Specific Information
name
ref-count

1792

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.5 QoS Queue Profile Status Command


Command Description
This command displays the QoS queue profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS queue profiles. The QoS queue profile usage shows the
references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage queue [ (name) ]

Command Parameters
Table 63.5-1 "QoS Queue Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A queue profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.5-2 "QoS Queue Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

indicates the number of entities


using this profile. If the reference
count is not 0, then this profile is
'in use', and can not be deleted. If
the value is 0, then this profile is
'not in use', and can be deleted.
This element is always shown.

Released

1793

63 QOS Status Commands

63.6 QoS Scheduler Node Profile Status Command


Command Description
This command displays the QoS scheduler-node profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS scheduler-node profiles. The QoS scheduler-node
profile usage shows the references from existing QoS session profiles because these profiles are not applied on
their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage scheduler-node [ (name) ]

Command Parameters
Table 63.6-1 "QoS Scheduler Node Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A scheduler-node profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.6-2 "QoS Scheduler Node Profile Status Command" Display parameters
Specific Information
name
ref-count

1794

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.7 QoS CAC Profile Status Command


Command Description
This command displays the QoS CAC profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS CAC profiles. The QoS CAC profile usage displays the
references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage cac [ (name) ]

Command Parameters
Table 63.7-1 "QoS CAC Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A unique profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.7-2 "QoS CAC Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount>


- number of entities using this particular profile
- range: [0...65535]

indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1795

63 QOS Status Commands

63.8 QoS Policy Profile Status Command


Command Description
This command displays the QoS policy profile status. A QoS profile in use cannot be deleted. Use this command to
display the usage of QoS policy profiles. The QoS policy profile usage shows the references from existing QoS
session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage policy [ (name) ]

Command Parameters
Table 63.8-1 "QoS Policy Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A unique policy profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.8-2 "QoS Policy Profile Status Command" Display parameters
Specific Information
name
ref-count

1796

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.9 QoS L2 Filter Profile Status Command


Command Description
This command displays the QoS L2 filter profile status. A QoS profile in use cannot be deleted. Use this command
to display the usage of QoS L2 filter profiles. The QoS L2 filter profile usage shows the references from existing
QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage l2-filter [ (name) ]

Command Parameters
Table 63.9-1 "QoS L2 Filter Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A l2 filter name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.9-2 "QoS L2 Filter Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1797

63 QOS Status Commands

63.10 QoS L3 Filter Profile Status Command


Command Description
This command displays the QoS L3 filter profile status. A QoS profile in use cannot be deleted. Use this command
to display the usage of QoS L3 Filter profiles. The QoS L3 filter profile usage shows the references from existing
QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage l3-filter [ (name) ]

Command Parameters
Table 63.10-1 "QoS L3 Filter Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A l3 filter name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.10-2 "QoS L3 Filter Profile Status Command" Display parameters
Specific Information
name
ref-count

1798

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.11 QoS Policy Action Profile Status Command


Command Description
This command displays the QoS policy action profile status. A QoS profile in use cannot be deleted. Use this
command to display the usage of policy action profiles. The QoS policy action profile usage shows the references
from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage policy-action [ (name) ]

Command Parameters
Table 63.11-1 "QoS Policy Action Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A policy action profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.11-2 "QoS Policy Action Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1799

63 QOS Status Commands

63.12 QoS IngressQoS Profile Status Command


Command Description
This command displays the QoS Ingress profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS Ingress profiles. The QoS Ingress profile usage shows
the references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage ingress-qos [ (name) ]

Command Parameters
Table 63.12-1 "QoS IngressQoS Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
An ingress profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.12-2 "QoS IngressQoS Profile Status Command" Display parameters
Specific Information
name
ref-count

1800

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.13 QoS Shaper Profile Status Command


Command Description
This command displays the QoS shaper profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS shaper profiles. The QoS shaper profile usage shows
the reference from existing QoS shaper profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage shaper [ (name) ]

Command Parameters
Table 63.13-1 "QoS Shaper Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A shaper profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.13-2 "QoS Shaper Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1801

63 QOS Status Commands

63.14 QoS Bandwidth Profile Status Command


Command Description
This command displays the QoS Bandwidth profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS scheduler-node profiles. The QoS Bandwidth profile
usage shows the references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage bandwidth [ (name) ]

Command Parameters
Table 63.14-1 "QoS Bandwidth Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A scheduler profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.14-2 "QoS Bandwidth Profile Status Command" Display parameters
Specific Information
name
ref-count

1802

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.15 QoS Rate Limit Profile Status Command


Command Description
This command displays the QoS Rate Limit profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS rate limit profiles. The QoS rate limit profile usage
shows the reference from existing QoS rate limit profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage rate-limit [ (name) ]

Command Parameters
Table 63.15-1 "QoS Rate Limit Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
Protocol Rate Limit profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.15-2 "QoS Rate Limit Profile Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile is 'in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

1803

63 QOS Status Commands

63.16 QoS DSCP to PBIT Profile Status Command


Command Description
This command displays the QoS DSCP to PBIT profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS DSCP to PBIT profiles. The QoS DSCP to PBIT profile
usage shows the references from existing QoS Marker profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage dscp-pbit [ (name) ]

Command Parameters
Table 63.16-1 "QoS DSCP to PBIT Profile Status Command" Resource Parameters
Resource Identifier

Type

(name)

Format:
A DSCP to PBIT profile name
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Description

Command Output
Table 63.16-2 "QoS DSCP to PBIT Profile Status Command" Display parameters
Specific Information
name
ref-count

1804

Released

Type

Description

Parameter type: <AsamProfileRefCount32>


- number of entities using this particular profile
- range: [0...4294967295]

Indicates the number of entities


using this profile. If the reference
count is greater than 0, then this
profile 'is in use', and may NOT
be deleted. If the value is 0, then
this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.17 QoS Ingress filter Resource Usage Status


Command
Command Description
This command displays QOS resource usage information for line cards of type NELT-B: -the available and used
ingress hardware filters. Qos ingress hardware filters are used for next QOS items: 1. The supported QOS Policies
of a sessionprofile attached to a bridge/vlan port. 2. The supported Policers (SAP level) of a sessionprofile
attached to a bridge/vlan port. 3. DSCP enforcement (SAP level) of a sessionprofile attached to a bridge/vlan port.
- the number of ingress hardware filters which must be released, via adapting QOS configuration, to be able to
apply ip antispoofing on ports of type HC-UNI. These values are only applicable for NELT_B boards. In
particular, the command is to be used in case secure forwarding enablement or static ip address configuration fails
on a NELT-B HC-UNI interface, due to insufficient resources.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos resource-usage ingress-hw-filter [ (equip-slot) ]

Command Parameters
Table 63.17-1 "QoS Ingress filter Resource Usage Status Command" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.17-2 "QoS Ingress filter Resource Usage Status Command" Display parameters

3HH-04416-EBAA-TCZZA 01

Released

1805

63 QOS Status Commands

Specific Information
name

Type

Description

max-val

Parameter type: <UnsignedInteger>


- an unsigned integer

cur-val-portgrp1

Parameter type: <UnsignedInteger>


- an unsigned integer

cur-val-portgrp2

Parameter type: <UnsignedInteger>


- an unsigned integer

excess-ipantispoof-pg1

Parameter type: <UnsignedInteger>


- an unsigned integer

excess-ipantispoof-pg2

Parameter type: <UnsignedInteger>


- an unsigned integer

The actual available Qos Ingress


hardware filters.The displayed
maximum value applies on each
of the two port-groups of the
NELT-B.
This element is always shown.
The number of used Qos Ingress
hardware filters on the first
port-group of the concerned
NELT-B. The first port-group
consists out of lines 1-18.
This element is always shown.
The number of used Qos Ingress
hardware filters on the second
port-group of the concerned
NELT-B. The second port-group
consists out of lines 19-36.
This element is always shown.
The number of Qos ingress
hardware filters which must be
released for interfaces 1 unitil 18,
to
be
able
to
apply
IpAntispoofing on ports of type
Hicap-UNI.
This element is always shown.
The number of Qos ingress
hardware filters which must be
released for interfaces 19 unitil
36, to be able to apply
IpAntispoofing on ports of type
Hicap-UNI.
This element is always shown.

1806

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.18 QoS DSL Bandwidth Status Command


Command Description
Obsolete command, replaced by show qos interface-bandwidth.
This command displays the bandwidth allocation and usage for each DSL link.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos dsl-bandwidth [ (index) ]
Obsolete command, replaced by show qos interface-bandwidth.

Command Parameters
Table 63.18-1 "QoS DSL Bandwidth Status Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a dsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 63.18-2 "QoS DSL Bandwidth Status Command" Display parameters
Specific Information
name
frame-net-bw

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

Represents an approximation of
the bandwidth available for
Ethernet
frames.
This
approximation is made by using
an appropriate overhead factor
(ATM, EFM, ..). The basis for
the calculus can be minimum

Released

1807

63 QOS Status Commands

name

Type

res-data-bw

Parameter type: <SignedInteger>


- a signed integer

res-voice-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-max-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-used-bw

Parameter type: <SignedInteger>


- a signed integer

1808

Released

Description
sync rate or actual sync rate, or
the
native
bandwidth
for
non-xDSL interfaces.
This element is always shown.
The portion the frame-net-bw that
is reserved for all data services
(typically HSI user traffic). This
is a reserved value per DSL
interface (and not per user
session) and applicable in the
downstream direction only.
This element is only shown in
detail mode.
The portion of the frame-net-bw
that is reserved for all voice
services (typically HSI user
traffic). This is a reserved value
per DSL interface (and not per
voice call) and applicable in the
downstream direction only. The
usage of this value is to set apart
a minimum rate such that video
and voice services can never
impact each other.
This element is only shown in
detail mode.
Represents the rate limitation
imposed by the operator upon the
maximum bandwidth to be
consumed by user multicast video
sessions. This limit can enforce a
smaller value than actually
available on the DSL link.
This element is only shown in
detail mode.
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
This element is always shown.
Shows the bandwidth currently in
use by pre-configured multicast
streams.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.19 QoS Shdsl Bandwidth Status Command


Command Description
Obsolete command, replaced by show qos interface-bandwidth.
This command displays the bandwidth allocation and usage for each Shdsl link.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos shdsl-bandwidth [ (index) ]
Obsolete command, replaced by show qos interface-bandwidth.

Command Parameters
Table 63.19-1 "QoS Shdsl Bandwidth Status Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a shdsl link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 63.19-2 "QoS Shdsl Bandwidth Status Command" Display parameters
Specific Information
name
frame-net-bw

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

Represents
the
approximate
bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.

Released

1809

63 QOS Status Commands

name

Type

res-data-bw

Parameter type: <SignedInteger>


- a signed integer

res-voice-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-max-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-used-bw

Parameter type: <SignedInteger>


- a signed integer

1810

Released

Description
This element is always shown.
The portion the frame-net-bw that
is reserved for all data services
(typically HSI user traffic). This
is a reserved value per DSL
interface (and not per user
session) and applicable in the
downstream direction only.
This element is only shown in
detail mode.
The portion of the frame-net-bw
that is reserved for all voice
services (typically HSI user
traffic). This is a reserved value
per DSL interface (and not per
voice call) and applicable in the
downstream direction only. The
usage of this value is to set apart
a minimum rate such that video
and voice services can never
impact each other.
This element is only shown in
detail mode.
Represents the rate limitation
imposed by the operator upon the
maximum bandwidth to be
consumed by user multicast video
sessions. This limit can enforce a
smaller value than actually
available on the DSL link.
This element is only shown in
detail mode.
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
This element is always shown.
Shows the bandwidth currently in
use by pre-configured multicast
streams.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.20 QoS Ethernet Bandwidth Status Command


Command Description
Obsolete command, replaced by show qos interface-bandwidth.
This command displays the bandwidth allocation and usage for each Ethernet link.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos ethernet-bandwidth [ (index) ]
Obsolete command, replaced by show qos interface-bandwidth.

Command Parameters
Table 63.20-1 "QoS Ethernet Bandwidth Status Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
physical port of a ethernet link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 63.20-2 "QoS Ethernet Bandwidth Status Command" Display parameters
Specific Information
name
frame-net-bw

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

Represents
the
approximate
bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.

Released

1811

63 QOS Status Commands

name

Type

res-data-bw

Parameter type: <SignedInteger>


- a signed integer

res-voice-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-max-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-used-bw

Parameter type: <SignedInteger>


- a signed integer

1812

Released

Description
This element is always shown.
The portion the frame-net-bw that
is reserved for all data services
(typically HSI user traffic). This
is a reserved value per DSL
interface (and not per user
session) and applicable in the
downstream direction only.
This element is only shown in
detail mode.
The portion of the frame-net-bw
that is reserved for all voice
services (typically HSI user
traffic). This is a reserved value
per DSL interface (and not per
voice call) and applicable in the
downstream direction only. The
usage of this value is to set apart
a minimum rate such that video
and voice services can never
impact each other.
This element is only shown in
detail mode.
Represents the rate limitation
imposed by the operator upon the
maximum bandwidth to be
consumed by user multicast video
sessions. This limit can enforce a
smaller value than actually
available on the DSL link.
This element is only shown in
detail mode.
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
This element is always shown.
Shows the bandwidth currently in
use by pre-configured multicast
streams.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.21 QoS Interface Bandwidth Status Command


Command Description
This command displays the bandwidth allocation and usage for each interface.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos interface-bandwidth [ (index) ]

Command Parameters
Table 63.21-1 "QoS Interface Bandwidth Status Command" Resource Parameters
Resource Identifier

Type

(index)

Format:
port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:

3HH-04416-EBAA-TCZZA 01

Description

Released

1813

63 QOS Status Commands

Resource Identifier

Type

Description

<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 63.21-2 "QoS Interface Bandwidth Status Command" Display parameters
Specific Information

1814

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

Type

Description

frame-net-bw

Parameter type: <SignedInteger>


- a signed integer

res-data-bw

Parameter type: <Qos::IgnoredSignedInteger>


- a signed integer

res-voice-bw

Parameter type: <Qos::IgnoredSignedInteger>


- a signed integer

m-cast-max-bw

Parameter type: <Qos::IgnoredSignedInteger>


- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


- a signed integer

m-cast-used-bw

Parameter type: <SignedInteger>


- a signed integer

u-cast-avail-us-bw

Parameter type: <SignedInteger>


- a signed integer

Represents
the
approximate
bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
This element is always shown.
The portion the frame-net-bw that
is reserved for all data services
(typically HSI user traffic). This
is a reserved value per DSL
interface (and not per user
session) and applicable in the
downstream direction only.
This element is only shown in
detail mode.
The portion of the frame-net-bw
that is reserved for all voice
services (typically HSI user
traffic). This is a reserved value
per DSL interface (and not per
voice call) and applicable in the
downstream direction only. The
usage of this value is to set apart
a minimum rate such that video
and voice services can never
impact each other.
This element is only shown in
detail mode.
Represents the rate limitation
imposed by the operator upon the
maximum bandwidth to be
consumed by user multicast video
sessions. This limit can enforce a
smaller value than actually
available on the DSL link.
This element is only shown in
detail mode.
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
This element is always shown.
Shows the bandwidth currently in
use by pre-configured multicast
streams.
This element is always shown.
Shows the up stream bandwidth
currently available.

3HH-04416-EBAA-TCZZA 01

Released

1815

63 QOS Status Commands

name

Type

Description

u-cast-avail-ds-bw

Parameter type: <SignedInteger>


- a signed integer

This element is always shown.


Shows
the
down
stream
bandwidth currently available.
This element is always shown.

1816

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.22 QoS Total Buffer Overflow Statistics for


Previous Quarter
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-15min [ (equip-slot) [ interval-num <Qos::CounterInterval> ] ]

Command Parameters
Table 63.22-1 "QoS Total Buffer Overflow Statistics for Previous Quarter" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Qos::CounterInterval>
Format:
- time interval interms of 15 mins
- range: [1...32]

physical position of the board

interval-num

time interval interms of 15 min

Command Output
Table 63.22-2 "QoS Total Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

1817

63 QOS Status Commands

name

Type

Description

upstream

Parameter type: <Counter>


- 32 bit counter

upstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-unicast

Parameter type: <Counter>


- 32 bit counter

downstream-multicast

Parameter type: <Counter>


- 32 bit counter

obc-injected

Parameter type: <Counter>


- 32 bit counter

the number of buffer overflows


on an LIM module in the
upstream direction on a 15
minute interval basis. The
upstream direction on the LIM is
non-blocking, hence this value
should always read zero under
normal working conditions.
This element is always shown.
the number of buffer overflows
on an LIM module for the
OBC-directed traffic upstream on
a 15 minute interval basis. In
some special conditions such as
system startup or re-start packet
loss may occur here but under
normal
circumstances
this
counter should read zero.
This element is always shown.
the number of buffer overflows
on an LIM module for the
OBC-directed traffic downstream
on a 15 minute interval basis.
Under normal circumstances this
counter should always read zero.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream unicast pool. This
even should not occur. Queue
fill-up and tail drop is a normal
condition
for
data
traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that non-QoS
aware packet loss will occur.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream multicast pool. This
even should be a rather rare
event. On the long term, buffer
overflow in the multicast pool
may occur a few times a day (less
than a few tens under heavy
multicast usage).
This element is always shown.
Previous
15
minute
for
OBC-injected buffer overflow
event on LIM, This event
happens if the processor cannot
cope with the extensive load of
the system and cannot reassemble
a frame in due time. This event
should not occur under normal

1818

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

measured-time
partial-aggr-buf-ovflw

3HH-04416-EBAA-TCZZA 01

Type

Parameter type: <Qos::TimeTicks>


- timer value for parameters
- unit: 1/100 sec
Parameter type: <Vlan::OctetCounter>
- vlan counter

Description
working conditions. This counter
is used for both upstream and
downstream
OBC-injected
frames on an LIM.
This element is always shown.
the amount of time, that statistics
for this entry have been counted.
This element is always shown.
the number of lower traffic class
packets discarded due to global
buffer
occupancy
threshold
overflow
This element is always shown.

Released

1819

63 QOS Status Commands

63.23 QoS Total Buffer Overflow Statistics for


Current Quarter
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-15min [ (equip-slot) ]

Command Parameters
Table 63.23-1 "QoS Total Buffer Overflow Statistics for Current Quarter" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.23-2 "QoS Total Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name
upstream

1820

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of buffer overflows on an


EBLT LIM module in the
upstream direction on a 15

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

Type

upstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-unicast

Parameter type: <Counter>


- 32 bit counter

downstream-multicast

Parameter type: <Counter>


- 32 bit counter

obc-injected

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
minute interval basis in the
current measurement epoch. The
upstream direction on the LIM is
non-blocking, hence this value
should read always zero under
normal working conditions.
This element is always shown.
number of buffer overflows on an
EBLT LIM module for the
OBC-directed traffic upstream on
a 15 minute interval basis in the
current measurement. In some
special conditions such as system
startup or re-start packet loss may
occur here but under normal
circumstances this counter should
read zero.
This element is always shown.
number of buffer overflows on an
EBLT LIM module for the
OBC-directed traffic downstream
on a 15 minute interval basis in
the current measurement.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream unicast pool. This
even should not occur. Queue
fill-up and tail drop is a normal
condition
for
data
traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that QoS
un-aware packet loss will occur.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream multicast pool. This
even should be a rather rare
event. On the long term, buffer
overflow in the multicast pool
may occur a few times a day (less
than a few tens under heavy
multicast usage).
This element is always shown.
Current
15
minute
for
OBC-injected buffer overflow
event on LIM, there is a reserved
buffer pool for OBC-injected
traffic which under very heavy
load conditions may eventually
get full, and the LIM OBC will
be unable to communicate with
the external world for a very
short time interval.

Released

1821

63 QOS Status Commands

name

Type

elapse-time

Parameter type: <Qos::TimeTicks>


- timer value for parameters
- unit: 1/100 sec
Parameter type: <Qos::TimeTicks>
- timer value for parameters
- unit: 1/100 sec
Parameter type: <Vlan::OctetCounter>
- vlan counter

measured-time
partial-aggr-buf-ovflw

1822

Released

Description
This element is always shown.
elapsed time interval since the
last measurement epoch started.
This element is always shown.
the amount of time, that statistics
for this entry have been counted.
This element is always shown.
the number of lower traffic class
packets discarded due to global
buffer
occupancy
threshold
overflow
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.24 QoS Total Buffer Overflow Statistics for


Previous Day Command
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-1day [ (equip-slot) ]

Command Parameters
Table 63.24-1 "QoS Total Buffer Overflow Statistics for Previous Day Command" Resource
Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.24-2 "QoS Total Buffer Overflow Statistics for Previous Day Command" Display
parameters
Specific Information
name

Type

Description

upstream

Parameter type: <Counter>

the number of buffer overflows

3HH-04416-EBAA-TCZZA 01

Released

1823

63 QOS Status Commands

name

Type

Description

- 32 bit counter

on an EBLT LIM module in the


upstream direction on a one day
interval basis. The upstream
direction on the LIM is
non-blocking, hence this value
should read always zero under
normal working conditions.
This element is always shown.
the number of buffer overflows
on an EBLT LIM module for the
OBC-directed traffic upstream on
a one day interval basis. In some
special conditions such as system
startup or re-start packet loss may
occur here but under normal
circumstances this counter should
read zero.
This element is always shown.
the number of buffer overflows
on a EBLT LIM module for the
OBC-directed traffic downstream
on a one day interval basis.
Under normal circumstances this
counter should always read zero.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream unicast pool. This
even should not occur. Queue
fill-up and tail drop is a normal
condition
for
data
traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that non-QoS
aware packet loss will occur.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream multicast pool. On
the long term, buffer overflow in
the multicast pool may occur a
few times a day (less than a few
tens under heavy multicast
usage).
This element is always shown.
previous one day OBC-injected
buffer-pool overflow. In some
heavy load conditions this event
may occur as the OBC-injected
frames fill up completely the
buffer space reserved for this
purpose.
This element is always shown.
actual time elapsed during which
the measurement was made

upstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-unicast

Parameter type: <Counter>


- 32 bit counter

downstream-multicast

Parameter type: <Counter>


- 32 bit counter

obc-injected

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Qos::TimeTicks>


- timer value for parameters

1824

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

Type

Description

partial-aggr-buf-ovflw

- unit: 1/100 sec


Parameter type: <Vlan::OctetCounter>
- vlan counter

This element is always shown.


the number of lower traffic class
packets discarded due to global
buffer
occupancy
threshold
overflow.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1825

63 QOS Status Commands

63.25 QoS Total Buffer Overflow Statistics for


Current Day
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. These counters are supported on L3 units. Under normal working conditions, all these counters should
read zero.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-1day [ (equip-slot) ]

Command Parameters
Table 63.25-1 "QoS Total Buffer Overflow Statistics for Current Day" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.25-2 "QoS Total Buffer Overflow Statistics for Current Day" Display parameters
Specific Information
name
upstream

1826

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

the number of buffer overflows


on EBLT LIM modules in the
upstream direction on a one day

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

Type

upstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-unicast

Parameter type: <Counter>


- 32 bit counter

downstream-multicast

Parameter type: <Counter>


- 32 bit counter

obc-injected

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
interval basis in the current
measurement
period.
The
upstream direction on the LIM is
non-blocking, hence this value
should read always zero under
normal working conditions.
This element is always shown.
the number of buffer overflows
on EBLT LIM modules for the
OBC-directed traffic upstream on
a one day interval basis in the
current measurement period. In
some special conditions such as
system startup or re-start packet
loss may occur here but under
normal
circumstances
this
counter should read zero.
This element is always shown.
the number of buffer overflows
on an EBLT LIM module for the
OBC-directed traffic downstream
on a one day interval basis in the
current measurement epoch.
under normal circumstances this
counter should always read zero.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream unicast pool. Queue
fill-up and tail drop is a normal
condition
for
data
traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that QoS
un-aware packet loss will occur.
This element is always shown.
specifies number of times,
current one day downstream
multicast total buffer pool
overflow - total buffer overflow
of the downstream multicast
pool. This even should be a rather
rare event. On the long term,
buffer overflow in the multicast
pool may occur a few times a day
(less than a few tens under heavy
multicast usage).
This element is always shown.
specifies number of times,
current one day obc-injected
buffer overflow occurred. There
is a reserved buffer pool for
obc-injected traffic which under
very heavy load conditions may
eventually get full, and the LIM

Released

1827

63 QOS Status Commands

name

Type

elapse-time

Parameter type: <Qos::TimeTicks>


- timer value for parameters
- unit: 1/100 sec
Parameter type: <Qos::TimeTicks>
- timer value for parameters
- unit: 1/100 sec

measured-time

partial-aggr-buf-ovflw

1828

Released

Parameter type: <Vlan::OctetCounter>


- vlan counter

Description
OBC will be unable to
communicate with the external
world for a very short time
interval.
This element is always shown.
elapsed time interval since the
last measurement period started.
This element is always shown.
the measured time interval since
the last measurement period
started.
This element is always shown.
the number of lower traffic class
packets discarded due to global
buffer
occupancy
threshold
overflow.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.26 QoS Total Buffer Overflow Statistics Total


Status Command
Command Description
This command displays the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. The L3 units have four isolated buffer pools for upstream, downstream, multicast, and OBC-injected
traffic. Under normal working conditions, all these counters should read zero. Check these counters for QoS
problems, which can occur under heavy load conditions.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow total [ (equip-slot) ]

Command Parameters
Table 63.26-1 "QoS Total Buffer Overflow Statistics Total Status Command" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.26-2 "QoS Total Buffer Overflow Statistics Total Status Command" Display parameters
Specific Information
name
upstream

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

the number of buffer overflows


per EBLT LIM module in the

Released

1829

63 QOS Status Commands

name

Type

upstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-obc

Parameter type: <Counter>


- 32 bit counter

downstream-unicast

Parameter type: <Counter>


- 32 bit counter

downstream-multicast

Parameter type: <Counter>


- 32 bit counter

obc-injected

Parameter type: <Counter>


- 32 bit counter

1830

Released

Description
upstream direction since the
statistics were last reset. The
upstream direction on the LIM is
non-blocking, hence this value
should read always zero under
normal working conditions.
This element is always shown.
the number of buffer overflows
on a LIM module for the
OBC-directed traffic upstream
since the statistic was last reset.
In some special conditions such
as system startup or re-start
packet loss may occur here but
under normal circumstances this
counter should read zero.
This element is only shown in
detail mode.
the number of buffer overflows
on a LIM module for the
OBC-directed traffic downstream
since the statistic was last reset.
Under normal circumstances this
counter should always read zero.
This element is only shown in
detail mode.
a counter for the event of total
buffer
overflow
of
the
downstream unicast pool. This
even should not occur. Queue
fill-up and tail drop is a normal
condition
for
data
traffic
(individual queues) but not for
voice and video on demand
services (individual queues). If
the total downstream pool is
filled, that means that QoS
un-aware packet loss will occur.
This element is always shown.
a counter for the event of total
buffer
overflow
of
the
downstream multicast pool. This
even should be a rather rare
event. On the long term, buffer
overflow in the multicast pool
may occur a few times a day (less
than a few tens under heavy
multicast usage).
This element is always shown.
the total OBC-injected buffer
overflow event on EBLT LIMs.
There is a reserved buffer pool
for OBC-injected traffic which
under very heavy load conditions
may eventually get full, and the
LIM OBC will be unable to
communicate with the external

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

name

Type

elapse-time

Parameter type: <Qos::TimeTicks>


- timer value for parameters
- unit: 1/100 sec

measured-time

Parameter type: <Qos::TimeTicks>


- timer value for parameters
- unit: 1/100 sec

valid-15min-intervals

Parameter type: <Qos::Valid15mInterval>


- number of valid 15m intervals
- range: [0...96]

valid-1day-intervals

Parameter type: <Qos::Valid1dInterval>


- number of valid 1 day intervals
- range: [0...1]

total-policer-inuse

Parameter type: <SignedInteger>


- a signed integer

policers-in-vlan

Parameter type: <SignedInteger>


- a signed integer

policers-in-dot1x

Parameter type: <SignedInteger>


- a signed integer

policers-in-ppp

Parameter type: <SignedInteger>


- a signed integer

policers-in-ip

Parameter type: <SignedInteger>


- a signed integer

policers-in-subflow

Parameter type: <SignedInteger>


- a signed integer

total-downstr-bytes

Parameter type: <Vlan::OctetCounter>


- vlan counter

total-downstr-frames

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Description
world for a very short time
interval.
This element is only shown in
detail mode.
the elapsed time interval since the
last measurement period started.
This element is only shown in
detail mode.
the measured time interval since
the last measurement period
started.
This element is only shown in
detail mode.
the number of statistics of 15
minutes collected so far. At most
96 such entries are stored.
This element is always shown.
the number of statistics of one
day collected so far. At most one
entry is stored from the past.
This element is always shown.
the total number of policers in
use per EBLT LIM. The policers
are managed in hardware in pairs,
so even if a Session is using both
up and downstream policers, it is
counted as one policer.
This element is always shown.
this counter is no longer
applicable.
This element is only shown in
detail mode.
this counter is no longer
applicable.
This element is only shown in
detail mode.
this counter is no longer
applicable.
This element is only shown in
detail mode.
this counter is no longer
applicable.
This element is only shown in
detail mode.
this counter is no longer
applicable.
This element is only shown in
detail mode.
the number of LIM physical bus
total-downstream passed bytes
per LIM module at subscriber
side since the statistics were last
reset.
This element is always shown.
the number of LIM physical bus
total-downstream passed frames
per LIM module at subscriber

Released

1831

63 QOS Status Commands

name

Type

partial-aggr-buf-ovflw

1832

Released

Parameter type: <Vlan::OctetCounter>


- vlan counter

Description
side since the statistics were last
reset.
This element is always shown.
the number of buffer overflows
on a LIM module for the
discarded lower traffic class
packets due to global buffer
occupancy threshold overflow
since the statistic was last reset.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.27 QoS Interface Buffer Overflow Statistics for


Previous Quarter
Command Description
This command displays the interface-level QoS buffer overflow statistics of the previous 15 minute interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics queue prev-15min [ (index) [ queue <Qos::ExpandQueues> ] [ interval-num
<Qos::NumInterval> ] ]

Command Parameters
Table 63.27-1 "QoS Interface Buffer Overflow Statistics for Previous Quarter" Resource
Parameters
Resource Identifier

Type

(index)

Format:
physical port or lag port of a dsl
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / link
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

1833

63 QOS Status Commands

Resource Identifier

Type

queue

<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /


<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Qos::ExpandQueues>
This object is used to index the

1834

Released

Description

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

Resource Identifier

interval-num

Type

Description

Format:
( all
| <Qos::ExpandQueues> )
Possible values:
- all : total physical line on the LIM
Field type <Qos::ExpandQueues>
- output dsl port expand queue number
- range: [0...7]
Parameter type: <Qos::NumInterval>
Format:
- time interval interms of 15 mins
- range: [1]

queue within the scope of one


physical link on the LIM

time interval interms of 15 min

Command Output
Table 63.27-2 "QoS Interface Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information
name
queue-load
forward-byte

Type

Description

Parameter type: <Qos::Load>


- load percentage
- range: [0...100]
Parameter type: <Qos::OctetCounter>
- qos counter

Average queue load percentage


This element is always shown.

forward-frame

Parameter type: <Qos::OctetCounter>


- qos counter

discard-byte

Parameter type: <Qos::OctetCounter>


- qos counter

discard-frame

Parameter type: <Qos::OctetCounter>


- qos counter

measured-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

3HH-04416-EBAA-TCZZA 01

number of bytes forwareded in


this queue.
This element is always shown.
number of frames forwared in
this queue.
This element is always shown.
number of bytes discarded in this
queue.
This element is always shown.
number of frames discarded in
this queue.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

Released

1835

63 QOS Status Commands

63.28 QoS Interface Buffer Overflow Statistics for


Current Quarter
Command Description
This command displays the interface-level QoS buffer overflow statistics of the current 15 minute interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics queue current-15min [ (index) [ queue <Qos::ExpandQueues> ] ]

Command Parameters
Table 63.28-1 "QoS Interface Buffer Overflow Statistics for Current Quarter" Resource
Parameters
Resource Identifier

Type

(index)

Format:
physical port or lag port of a dsl
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / link
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

1836

Released

Description

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

Resource Identifier

queue

3HH-04416-EBAA-TCZZA 01

Type

Description

<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- pon : pon
- ont : ont
- epon : epon
- eont : eont
- ellid : ellid
- vlan : vlan
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Qos::ExpandQueues>
This object is used to index the
Format:
queue within the scope of one

Released

1837

63 QOS Status Commands

Resource Identifier

Type

Description

( all
| <Qos::ExpandQueues> )
Possible values:
- all : total physical line on the LIM
Field type <Qos::ExpandQueues>
- output dsl port expand queue number
- range: [0...7]

physical link on the LIM

Command Output
Table 63.28-2 "QoS Interface Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name
queue-load
forward-byte

Type

Description

Parameter type: <Qos::Load>


- load percentage
- range: [0...100]
Parameter type: <Qos::OctetCounter>
- qos counter

Average queue load percentage


This element is always shown.

forward-frame

Parameter type: <Qos::OctetCounter>


- qos counter

discard-byte

Parameter type: <Qos::OctetCounter>


- qos counter

discard-frame

Parameter type: <Qos::OctetCounter>


- qos counter

measured-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

elapsed-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

1838

Released

number of bytes forwareded in


this queue.
This element is always shown.
number of frames forwared in
this queue.
This element is always shown.
number of bytes discarded in this
queue.
This element is always shown.
number of frames discarded in
this queue.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.29 QoS Fan Out Statistics for Previous Quarter


Command Description
This command shows the QoS Fan Out statistics of the previous 15 minute interval.
Currently,only traffic classes [0...3] are supported for traffic class voice,resp.video,CL,BE and traffic class 8 for
the aggregate of the previous mentioned traffic classes

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-cos prev-15min [ (equip-slot) [ traffic-class <Qos::TrafficClass> ] [ interval-num
<Qos::NumIntervalExpand> ] ]

Command Parameters
Table 63.29-1 "QoS Fan Out Statistics for Previous Quarter" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Qos::TrafficClass>
Format:
- value of traffic class, the received frame is mapped to
- range: [0...8]
Parameter type: <Qos::NumIntervalExpand>
Format:
- time interval interms of 15 mins
- range: [1...96]

physical position of the board

traffic-class

interval-num

This object is used to index the


traffic class on the LIM
time interval interms of 15 min

Command Output

3HH-04416-EBAA-TCZZA 01

Released

1839

63 QOS Status Commands

Table 63.29-2 "QoS Fan Out Statistics for Previous Quarter" Display parameters
Specific Information
name
load
forward-byte

Type

Description

Parameter type: <Qos::Load>


- load percentage
- range: [0...100]
Parameter type: <Qos::OctetCounter>
- qos counter

traffic class load percentage


This element is always shown.

forward-frame

Parameter type: <Qos::OctetCounter>


- qos counter

measured-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

1840

Released

number of bytes forwarded in this


traffic class.
This element is always shown.
number of frames forwarded in
this traffic class.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.30 QoS Fan Out Statistics for Current 15


minutes
Command Description
This command shows the QoS Fan Out statistics of the current 15 minutes interval.
Currently,only traffic classes [0...3] are supported for traffic class voice, resp. video,CL,BE and traffic class 8 for
the aggregate of the previous mentioned traffic classes

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-cos current-15min [ (equip-slot) [ traffic-class <Qos::TrafficClass> ] ]

Command Parameters
Table 63.30-1 "QoS Fan Out Statistics for Current 15 minutes" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Qos::TrafficClass>
Format:
- value of traffic class, the received frame is mapped to
- range: [0...8]

physical position of the board

traffic-class

This object is used to index the


traffic class on the LIM

Command Output
Table 63.30-2 "QoS Fan Out Statistics for Current 15 minutes" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

1841

63 QOS Status Commands

name

Type

Description

load

Parameter type: <Qos::Load>


- load percentage
- range: [0...100]
Parameter type: <Qos::OctetCounter>
- qos counter

traffic class load percentage


This element is always shown.

forward-byte
forward-frame

Parameter type: <Qos::OctetCounter>


- qos counter

elapsed-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

measured-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

1842

Released

number of bytes forwarded in this


traffic class.
This element is always shown.
number of frames forwarded in
this traffic class.
This element is always shown.
The elapsed time interval since
the last measurement epoch
started.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.31 QoS Fan Out Statistics for Previous Day


Command Description
This command shows the QoS Fan Out statistics of the previous 1 day interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-cos prev-1day [ (equip-slot) [ interval-num <Qos::NumInterval> ] ]

Command Parameters
Table 63.31-1 "QoS Fan Out Statistics for Previous Day " Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Qos::NumInterval>
Format:
- time interval interms of 15 mins
- range: [1]

physical position of the board

interval-num

time interval interms of one day

Command Output
Table 63.31-2 "QoS Fan Out Statistics for Previous Day " Display parameters
Specific Information
name

Type

Description

forward-byte

Parameter type: <Qos::OctetCounter>


- qos counter

forward-frame

Parameter type: <Qos::OctetCounter>

number of bytes forwarded in this


LIM.
This element is always shown.
number of frames forwarded in

3HH-04416-EBAA-TCZZA 01

Released

1843

63 QOS Status Commands

name
measured-time

1844

Type

Description

- qos counter

this LIM.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.32 QoS Fan Out Statistics for Current Day


Command Description
This command shows the QoS fan out statistics of the current 1 day interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-cos current-1day [ (equip-slot) ]

Command Parameters
Table 63.32-1 "QoS Fan Out Statistics for Current Day" Resource Parameters
Resource Identifier

Type

Description

(equip-slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

physical position of the board

Command Output
Table 63.32-2 "QoS Fan Out Statistics for Current Day" Display parameters
Specific Information
name

Type

Description

forward-byte

Parameter type: <Qos::OctetCounter>


- qos counter

forward-frame

Parameter type: <Qos::OctetCounter>


- qos counter

elapsed-time

Parameter type: <TimeTicks>


- a timeout value

number of bytes forwarded in this


LIM.
This element is always shown.
number of frames forwarded in
this LIM.
This element is always shown.
The elapsed time interval since
the last measurement epoch

3HH-04416-EBAA-TCZZA 01

Released

1845

63 QOS Status Commands

name
measured-time

1846

Type

Description

- unit: msec

started.
This element is always shown.
The measured time interval since
the last measurement period
started.
This element is always shown.

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.33 QoS LT Queue Overflow Statistics for


Previous Quarter
Command Description
This command displays the previous 15 min QoS statistics on a per GLT LIM basis of packets discarded towards
OBC and backplane.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-queue prev-15min [ (index) ]

Command Parameters
Table 63.33-1 "QoS LT Queue Overflow Statistics for Previous Quarter" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

physical position of the board

Command Output
Table 63.33-2 "QoS LT Queue Overflow Statistics for Previous Quarter" Display parameters
Specific Information
name

Type

Description

bckpln-low-dis-frame

Parameter type: <Counter>


- 32 bit counter

bckpln-low-dis-bytes

Parameter type: <Counter>


- 32 bit counter

Current discarded packet count


towards backplane due to low
water mark crossing.
This element is always shown.
Current discarded bytes count
towards backplane due to low
water mark crossing.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1847

63 QOS Status Commands

name

Type

Description

bckpln-high-dis-frame

Parameter type: <Counter>


- 32 bit counter

bckpln-high-dis-bytes

Parameter type: <Counter>


- 32 bit counter

obc-low-discard-frame

Parameter type: <Counter>


- 32 bit counter

obc-low-discard-bytes

Parameter type: <Counter>


- 32 bit counter

obc-high-discard-frame

Parameter type: <Counter>


- 32 bit counter

obc-high-discard-bytes

Parameter type: <Counter>


- 32 bit counter

bckpln_down_dis_frame

Parameter type: <Counter>


- 32 bit counter

Current discarded packet count


towards backplane due to high
water mark crossing.
This element is always shown.
Current discarded bytes count
towards backplane due to high
water mark crossing.
This element is always shown.
Current discarded packet count
towards OBC due to low water
mark crossing.
This element is always shown.
Current discarded bytes count
towards OBC due to low water
mark crossing.
This element is always shown.
Current discarded packet count
towards OBC due to high water
mark crossing.
This element is always shown.
Current discarded byte count
towards OBC due to high water
mark crossing.
This element is always shown.
Current discarded downstream
packets due to conjestion or
oversized.
This element is always shown.

1848

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.34 QoS LT Queue Overflow Statistics for current


Quarter
Command Description
This command displays the current 15 min QoS statistics on a per GLT LIM basis of packets discarded towards
OBC and backplane.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics lt-queue current-15min [ (index) ]

Command Parameters
Table 63.34-1 "QoS LT Queue Overflow Statistics for current Quarter" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

physical position of the board

Command Output
Table 63.34-2 "QoS LT Queue Overflow Statistics for current Quarter" Display parameters
Specific Information
name

Type

Description

bckpln-low-dis-frame

Parameter type: <Counter>


- 32 bit counter

bckpln-low-dis-bytes

Parameter type: <Counter>


- 32 bit counter

Current discarded packet count


towards backplane due to low
water mark crossing.
This element is always shown.
Current discarded bytes count
towards backplane due to low
water mark crossing.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1849

63 QOS Status Commands

name

Type

Description

bckpln-high-dis-frame

Parameter type: <Counter>


- 32 bit counter

bckpln-high-dis-bytes

Parameter type: <Counter>


- 32 bit counter

obc-low-discard-frame

Parameter type: <Counter>


- 32 bit counter

obc-low-discard-bytes

Parameter type: <Counter>


- 32 bit counter

obc-high-discard-frame

Parameter type: <Counter>


- 32 bit counter

obc-high-discard-bytes

Parameter type: <Counter>


- 32 bit counter

bckpln_down_dis_frame

Parameter type: <Counter>


- 32 bit counter

Current discarded packet count


towards backplane due to high
water mark crossing.
This element is always shown.
Current discarded bytes count
towards backplane due to high
water mark crossing.
This element is always shown.
Current discarded packet count
towards OBC due to low water
mark crossing.
This element is always shown.
Current discarded byte count
towards OBC due to low water
mark crossing.
This element is always shown.
Current discarded packet count
towards OBC due to high water
mark crossing.
This element is always shown.
Current discarded byte count
towards OBC due to high water
mark crossing.
This element is always shown.
Current discarded downstream
packets due to conjestion or
oversized.
This element is always shown.

1850

Released

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.35 QoS SHub Meter Statistics Status Command


Command Description
This command displays the number of times the meter entry has been instantiated on any port.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos shub meter [ (index) ]

Command Parameters
Table 63.35-1 "QoS SHub Meter Statistics Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- unique index for meter
- range: [1...64]

index used to identify a meter

Command Output
Table 63.35-2 "QoS SHub Meter Statistics Status Command" Display parameters
Specific Information
name
ref-count

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

nbr of times the meter is


instantiated/used on any port
This element is always shown.

Released

1851

63 QOS Status Commands

63.36 QoS SHub Flow Statistics Status Command


Command Description
This command displays the number of times the flow has been instantiated on any port.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos shub flow [ (index) ]

Command Parameters
Table 63.36-1 "QoS SHub Flow Statistics Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- unique index for the flow
- range: [1...64]

index used to identify a flow

Command Output
Table 63.36-2 "QoS SHub Flow Statistics Status Command" Display parameters
Specific Information
name
ref-count

1852

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

nbr of times the flow is


instantiated/used on any port
This element is always shown.

3HH-04416-EBAA-TCZZA

01

63 QOS Status Commands

63.37 QoS TC2QMapping Status Command


Command Description
This command shows the mapping between the traffic class and the queue of a UNI. Three rows in the table will be
automatically created with default values and can only be edited but the operator. Row 1 is used for the case when
the LIM has 4 queues per UNI and 4 TCs, Row 2 is used for the case when the LIM has 4 queues per UNI but 8
TCs,Row 3 is used for the case when the LIM has 8 queues per UNI but 8 TCs.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos tc-to-qmap [ (name) ]

Command Parameters
Table 63.37-1 "QoS TC2QMapping Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
( legacy4queue
| 4queuemapping
| 8queuemapping )
Possible values:
- legacy4queue : LIM has 4 queues per UNI and 4 TCs
- 4queuemapping : LIM has 4 queues per UNI but 8 TCs
- 8queuemapping : LIM has 8 queues per UNI but 8 TCs

name of the mapping

Command Output
Table 63.37-2 "QoS TC2QMapping Status Command" Display parameters
Specific Information
name

Type

Description

traffic-class0

Parameter type: <Vlan::NibbleMask_0>


- nibble mask

traffic-class1

Parameter type: <Vlan::NibbleMask_1>


- nibble mask

traffic-class2

Parameter type: <Vlan::NibbleMask_2>


- nibble mask

traffic-class3

Parameter type: <Vlan::NibbleMask_3>

the queue corresponding


Traffic Class 0.
This element is always shown.
the queue corresponding
Traffic Class 1.
This element is always shown.
the queue corresponding
Traffic Class 2.
This element is always shown.
the queue corresponding

3HH-04416-EBAA-TCZZA 01

Released

1853

to
to
to
to

63 QOS Status Commands

name

Type

Description

- nibble mask

Traffic Class 3.
This element is always shown.
the queue corresponding
Traffic Class 4.
This element is always shown.
the queue corresponding
Traffic Class 5.
This element is always shown.
the queue corresponding
Traffic Class 6.
This element is always shown.
the queue corresponding
Traffic Class 7.
This element is always shown.

traffic-class4

Parameter type: <Vlan::NibbleMask_4>


- nibble mask

traffic-class5

Parameter type: <Vlan::NibbleMask_5>


- nibble mask

traffic-class6

Parameter type: <Vlan::NibbleMask_6>


- nibble mask

traffic-class7

Parameter type: <Vlan::NibbleMask_7>


- nibble mask

1854

Released

3HH-04416-EBAA-TCZZA

01

to
to
to
to

64- IP Status Commands

64.1 IP Status Command Tree


64.2 IP VRF Statistics
64.3 IP Interface Status Command
64.4 IP VRF Interface User Port Status Command
64.5 IP VRF Interface User Port Status Command
64.6 IP VRF Routes Status Command
64.7 IP VRF Net-to-Media Statistics Command
64.8 IP VRF Mapping
64.9 IP VRF Next Index
64.10 IP SHub VRF Status Command
64.11 IP SHub VRF Route Status Command
64.12 IP SHub ARP Statistics Command
64.13 IP SHub VRF Media Status Command
64.14 IP SHub VRF Routing Status Command
64.15 IP DHCP Session Status Command
64.16 IP User Port ARP Proxy Statistics Status Command
64.17 IP Untagged User Port ARP Proxy Statistics Status
Command
64.18 IP Untagged User Port ARP Proxy Summary
Statistics Status Command
64.19 IP Untagged User Port ARP Proxy Detailed Statistics
Status Command
64.20 IP Tagged User Port ARP Proxy Statistics Status
Command
64.21 IP Tagged User Port ARP Proxy Summary Statistics
Status Command
64.22 IP Tagged User Port ARP Proxy Detailed Statistics
Status Command

3HH-04416-EBAA-TCZZA 01

64-1856
64-1858
64-1859
64-1863
64-1866
64-1868
64-1872
64-1874
64-1875
64-1876
64-1878
64-1880
64-1883
64-1885
64-1886
64-1889
64-1890
64-1891
64-1893
64-1896
64-1898
64-1900

Released

1855

64 IP Status Commands

64.1 IP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IP Status Commands".

Command Tree
----show
----ip
----vrf-statistics
- (vrf-id)
----ip-statistics
- (index)
----vrf-interface
----user
----port
- (port-interface)
----X bridgeport
- (port-interface)
----vrf-route
- (index)
- dest-ip-address
- next-hop-address
----vrf-media
- (slot:vrf)
- ip-address
----vrf-mapping
- (name)
----vrf-next-index
----shub
----vrf
- (index)
- vlan-id
----vrf-route
- (index)
- dest
- next-hop
----arp-stats
- (vrf-id)
----vrf-media
- (vrf)
- ip-address
----vrf-routing
- (vrf)
----dhcp-session
- (client)
- ip-addr
----arp-proxy-stats
- (port-interface)
----untagged-ip
----summary
----extensive
----vlan

1856

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

- (subscr-vlan)
----summary
----extensive

3HH-04416-EBAA-TCZZA 01

Released

1857

64 IP Status Commands

64.2 IP VRF Statistics


Command Description
This command displays VRF statistics.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-statistics [ (vrf-id) ]

Command Parameters
Table 64.2-1 "IP VRF Statistics" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- a profile index
- range: [1...250]

an unique id of a VRF.

Command Output
Table 64.2-2 "IP VRF Statistics" Display parameters
Common Information:system statistics
name
Type
ip-route-entries

Parameter type: <Counter>


- 32 bit counter

ip-net2media-entries

Parameter type: <Counter>


- 32 bit counter

Specific Information
name

Description
the total number of IP routes in
the system.
This element is always shown.
the total number of IP net2media
entries.
This element is always shown.

Type

Description

ip-route-entries

Parameter type: <Counter>


- 32 bit counter

ip-net2media-entries

Parameter type: <Counter>


- 32 bit counter

the total number of routes in the


system.
This element is always shown.
the total number net2media
entries.
This element is always shown.

1858

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.3 IP Interface Status Command


Command Description
Displays the IP interface statistics.
14 ethernet ports are supported.
Port 1 : Internal port used for management
Port 2 : External port used for management
Port 3 : Used for Layer 2 Control Protocol traffic to BRAS
Ports 4-14 : Not used

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip ip-statistics [ (index) ]

Command Parameters
Table 64.3-1 "IP Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
<Eqpt::EthernetId>
Field type <Eqpt::EthernetId>
- ethernet id

specifies the if-index uniquely


indentifying each interface

Command Output
Table 64.3-2 "IP Interface Status Command" Display parameters
Specific Information
name

Type

Description

description

Parameter type: <PrintableString>


- printable string

oper-status

Parameter type: <Ip::OperStatus>


( up
| down
| testing
| unknown
| dormant )
Possible values:

shows the description of the


interface
This element is only shown in
detail mode.
shows the operational status of
the interface
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1859

64 IP Status Commands

name

Type

last-changed

in-octets

Parameter type: <Counter>


- 32 bit counter

in-ucast-pkts

Parameter type: <Counter>


- 32 bit counter

in-nucast-pkts

Parameter type: <Counter>


- 32 bit counter

in-discards

Parameter type: <Counter>


- 32 bit counter

in-errors

Parameter type: <Counter>


- 32 bit counter

in-unknown-proto

Parameter type: <Counter>


- 32 bit counter

1860

Description

- up : the interface in operational state


- down : the interface in down state
- testing : testing state, no operational packet can be passed
- unknown : state not known
- dormant : ready to transmit, but waiting for action
Parameter type: <Atm::LastChangeTime>
- the time elapsed since a certain event

Released

shows the time when the


interface is changed for the
last-time
This element is only shown in
detail mode.
shows the total number of octets
recieved on the interface
This element is only shown in
detail mode.
shows the number of packets
delivered by this sub-layer, which
were not addressed to a multicast
or broadcast address at this
sub-layer
This element is only shown in
detail mode.
shows the number of packets,
delivered by this sub-layer to a
higher (sub-)layer, which were
addressed to a multicast or
broadcast
address
at
this
sub-layer
This element is only shown in
detail mode.
shows the number of inbound
packets which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space
This element is only shown in
detail mode.
shows
for
packet-oriented
interfaces, the number of inbound
packets that contained errors
preventing them from being
deliverable to a higher-layer
protocol
and
shows
for
character-oriented or fixed-length
interfaces, the number of inbound
transmission units that contained
errors preventing them from
being
deliverable
to
a
higher-layer protocol
This element is only shown in
detail mode.
shown
for
packet-oriented
interfaces, the number of packets
received via the interface which

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

out-octets

Parameter type: <Counter>


- 32 bit counter

out-ucast-pkts

Parameter type: <Counter>


- 32 bit counter

out-nucast-pkts

Parameter type: <Counter>


- 32 bit counter

out-discards

Parameter type: <Counter>


- 32 bit counter

out-errors

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
were discarded because of an
unknown or unsupported protocol
and shows for character-oriented
or fixed-length interfaces which
support protocol multiplexing the
number of transmission units
received via the interface which
were discarded because of an
unknown
or
unsupported
protocol. For any interface which
does not support protocol
multiplexing, this counter will
always be 0
This element is only shown in
detail mode.
shows the total number of octets
transmitted out of the interface,
including framing characters
This element is only shown in
detail mode.
shows the total number of
packets
that
higher-level
protocols
requested
be
transmitted, and which were
addressed to a multicast or
broadcast
address
at
this
sub-layer, including those that
were discarded or not sent
This element is only shown in
detail mode.
shows the total number of
packets
that
higher-level
protocols
requested
be
transmitted, and which were
addressed to a multicast or
broadcast
address
at
this
sub-layer, including those that
were discarded or not sent
This element is only shown in
detail mode.
shows the number of outbound
packets which were chosen to be
discarded even though no errors
had been detected to prevent their
being transmitted. One possible
reason for discarding such a
packet could be to free up buffer
space
This element is only shown in
detail mode.
shows
for
packet-oriented
interfaces, the number of
outbound packets that could not
be transmitted because of errors
and shows for character-oriented
or fixed-length interfaces, the
number of outbound transmission

Released

1861

64 IP Status Commands

name

Type

out-queue-len

1862

Parameter type: <Gauge>


- gauge

Released

Description
units that could not be
transmitted because of errors
This element is only shown in
detail mode.
shows the length of the output
packet queue (in packets)
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.4 IP VRF Interface User Port Status Command


Command Description
This command displays the user-side VRF IP interface statistics parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-interface user port [ (port-interface) ]

Command Parameters
Table 64.4-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
:
/
/
:
/
:
/
/
:
/
:
/
/
/

Released

1863

64 IP Status Commands

Resource Identifier

Type

Description

- vlan-port : vlan port


Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 64.4-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name

Type

Description

rx-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

rx-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

rx-drop-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

rx-drop-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-drop-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-drop-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

show the number of received


packets
This element is always shown.
show the number of received
octets
This element is only shown in
detail mode.
show the number of received
packets which are dropped
This element is always shown.
show the number of received
octets which are dropped
This element is only shown in
detail mode.
show the number of transmitted
packets
This element is always shown.
show the number of transmitted
octets
This element is only shown in
detail mode.
show the number of transmitted
packets which are dropped
This element is only shown in
detail mode.
show the number of transmitted
octets which are dropped
This element is only shown in
detail mode.

1864

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

3HH-04416-EBAA-TCZZA 01

Released

1865

64 IP Status Commands

64.5 IP VRF Interface User Port Status Command


Command Description
Obsolete command, replaced by show ip vrf-interface user port.
This command displays the user-side VRF IP interface statistics parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-interface user bridgeport [ (port-interface) ]
Obsolete command, replaced by show ip vrf-interface user port.

Command Parameters
Table 64.5-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Command Output
Table 64.5-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name

Type

Description

rx-pkts

Parameter type: <Vlan::OctetCounter>

show the number of received

1866

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

Description

- vlan counter

packets
This element is always shown.
show the number of received
octets
This element is only shown in
detail mode.
show the number of received
packets which are dropped
This element is always shown.
show the number of received
octets which are dropped
This element is only shown in
detail mode.
show the number of transmitted
packets
This element is always shown.
show the number of transmitted
octets
This element is only shown in
detail mode.
show the number of transmitted
packets which are dropped
This element is only shown in
detail mode.
show the number of transmitted
octets which are dropped
This element is only shown in
detail mode.

rx-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

rx-drop-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

rx-drop-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-drop-pkts

Parameter type: <Vlan::OctetCounter>


- vlan counter

tx-drop-octets

Parameter type: <Vlan::OctetCounter>


- vlan counter

3HH-04416-EBAA-TCZZA 01

Released

1867

64 IP Status Commands

64.6 IP VRF Routes Status Command


Command Description
This command displays the VRF routes.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-route [ (index) [ dest-ip-address <Ip::AddressAndMaskFull> ] [ next-hop-address
<Ip::V4AddressHex> ] ]

Command Parameters
Table 64.6-1 "IP VRF Routes Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Parameter type: <Ip::AddressAndMaskFull>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

an unique index of a vrf

dest-ip-address

next-hop-address

inet-address with prefix

next hop IP address

Command Output
Table 64.6-2 "IP VRF Routes Status Command" Display parameters
Specific Information
name
layer3-itf

1868

Type

Description

Parameter type: <Itf::IpoeItf>


the ipox interface on NT.
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / This element is always shown.
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

Description

/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| pppoe : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| pppoeses : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::LogicalSesId>
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| pppoe : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| no-interface
| vlan-port : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| pppoe : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| pppoe : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| pppoe : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| pppoe : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /

3HH-04416-EBAA-TCZZA 01

Released

1869

64 IP Status Commands

name

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| pppoeses : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
:
<Eqpt::UnstackedVlan>
:
<Eqpt::LogicalSesId>
| pppoeses : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan> :
<Eqpt::LogicalSesId>
| pppoeses : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
<Eqpt::LogicalSesId>
| pppoeses : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan> <Eqpt::LogicalSesId>
| pppoeses : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::LogicalSesId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface
- atm-if : a static atm interface
- atm-pvc : an atm pvc interface
- bridge-port : a vlan bridge-port
- vlan-port : a vlan port interface
- pppoe : a pppoe interface
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- pppoeses : pppoe session interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- no-interface : no interface
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id

1870

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

route-type

route-proto

last-changed

3HH-04416-EBAA-TCZZA 01

Type
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id
Field type <Eqpt::LogicalId>
- logical id
Field type <Eqpt::LogicalSesId>
- logical id
Field type <Eqpt::VrfId>
- VRF id
Parameter type: <Vrf::RouteType>
( local
| remote )
Possible values:
- local : local destination or direct route
- remote : remote destination or indirect route
Parameter type: <Vrf::RouteProtocol>
( local
| net-mgnt )
Possible values:
- local : direct route
- net-mgnt : indirect route
Parameter type: <Ip::Age>
- age

Description

the type of route.


This element is only shown in
detail mode.

the routing protocol via which


this route was learned.
This element is only shown in
detail mode.
the network time when this was
last changed.
This element is only shown in
detail mode.

Released

1871

64 IP Status Commands

64.7 IP VRF Net-to-Media Statistics Command


Command Description
This command displays the VRF net-to-media statistics. The table does not display all the arp-cach table entries.
Only the entries obtained from the received ARP-msgs are shown.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-media [ (slot:vrf) [ ip-address <Ip::V4Address> ] ]

Command Parameters
Table 64.7-1 "IP VRF Net-to-Media Statistics Command" Resource Parameters
Resource Identifier

Type

(slot:vrf)

Format:
rack/shelf/slot:vrfID
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
<Eqpt::VrfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::VrfId>
- VRF id
Parameter type: <Ip::V4Address>
the IP-address.
Format:
- IPv4-address

ip-address

Description

Command Output
Table 64.7-2 "IP VRF Net-to-Media Statistics Command" Display parameters
Specific Information
name
mac-addr:vlan
last-changed

1872

Released

Type

Description

Parameter type: <Ip::PhysicalAddress>


- media dependent physical address
- length: 8
Parameter type: <Ip::TimeInSecs>
- age

format is <mac-address:vlanId>
This element is always shown.
date when it is changed for the
last time.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

Description
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

1873

64 IP Status Commands

64.8 IP VRF Mapping


Command Description
This command displays the VRF mapping.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-mapping [ (name) ]

Command Parameters
Table 64.8-1 "IP VRF Mapping" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the name which uniquely identify a VRF
- length: 1<=x<=32

name of the vrf

Command Output
Table 64.8-2 "IP VRF Mapping" Display parameters
Specific Information
name
vrf-index

1874

Released

Type

Description

Parameter type: <Vrf::VrfIndex>


- the VRF ID which uniquely identify a VRF
- range: [1...127]

A number which uniquely


identifies a particular VRF
context within the system.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.9 IP VRF Next Index


Command Description
This command displays the next VRF index.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-next-index

Command Output
Table 64.9-2 "IP VRF Next Index" Display parameters
Specific Information
name
next-vrf-index

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Vrf::VrfIndex>


- the VRF ID which uniquely identify a VRF
- range: [1...127]

The next free Virtual Routing and


Forwarding (VRF) index.
This element is always shown.

Released

1875

64 IP Status Commands

64.10 IP SHub VRF Status Command


Command Description
This command displays SHub IP VRF information.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf [ (index) [ vlan-id <Vlan::VlanIndex> ] ]

Command Parameters
Table 64.10-1 "IP SHub VRF Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Parameter type: <Vlan::VlanIndex>
Format:
- vlan id
- range: [1...4093]

the VRF ID.

vlan-id

vlan id

Command Output
Table 64.10-2 "IP SHub VRF Status Command" Display parameters
Specific Information
name
admin-status

oper-status

1876

Released

Type

Description

Parameter type: <Vrf::ShubIpIfAdminStatus>


( up
| down
| testing )
Possible values:
- up : ready to pass packets
- down : not ready
- testing : in some test mode
Parameter type: <Vrf::ShubIpIfOperStatus>
( up
| down
| testing )
Possible values:
- up : ready to pass packets

the administrative status of the


VLAN IP interface.
This element is always shown.

the operational status of the


VLAN IP interface.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name
name

Type
- down : not ready
- testing : in some test mode
Parameter type: <PrintableString>
- printable string

ip-address

Parameter type: <Ip::V4Address>


- IPv4-address

mask

Parameter type: <Ip::V4Address>


- IPv4-address

3HH-04416-EBAA-TCZZA 01

Description
the name of the VLAN
interface.
This element is only shown
detail mode.
the IP-address of the VLAN
interface.
This element is always shown.
the mask of the VLAN
interface.
This element is always shown.

Released

1877

IP
in
IP
IP

64 IP Status Commands

64.11 IP SHub VRF Route Status Command


Command Description
This command displays the IP SHub VRF route status parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf-route [ (index) [ dest <Ip::HexAddressAndFullMask> ] [ next-hop <Ip::V4AddressHex> ] ]

Command Parameters
Table 64.11-1 "IP SHub VRF Route Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Parameter type: <Ip::HexAddressAndFullMask>
Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

the vrf id

dest

next-hop

the destination ip address and


mask of this route

the next hop ip address of this


route

Command Output
Table 64.11-2 "IP SHub VRF Route Status Command" Display parameters
Specific Information
name
protocol

1878

Released

Type

Description

Parameter type: <Vrf::ShubRouteProtocol>


( other
| local
| netmgmt
| rip
| ospf )
Possible values:

The routing mechanism that was


responsible for adding this route
This element is always shown.

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

vlan-index
status

age

metric1

3HH-04416-EBAA-TCZZA 01

Type
- other : not specified
- local : local interface
- netmgmt : static route
- rip : rip route
- ospf : ospf route
Parameter type: <Itf::ShubVlanAlias>
- an alias for a vlan
Parameter type: <Ip::ActivateRowStatus>
( active
| not-active )
Possible values:
- active : active route
- not-active : active route
Parameter type: <Vrf::ShubRouteAge>
- a signed integer
Parameter type: <Ip::ShubIpRouteMetric>
( not-applicable
| <SignedInteger> )
Possible values:
- not-applicable : metric
Field type <SignedInteger>
- a signed integer

Description

The local interface through which


the next hop should be reached
This element is always shown.
the status of the route which
indicates whether the route is
active or inactive.
This element is always shown.
The number of seconds since this
route was last updated
This element is only shown in
detail mode.
the primary routing metric for
this route
This element is only shown in
detail mode.

Released

1879

64 IP Status Commands

64.12 IP SHub ARP Statistics Command


Command Description
This command displays the ARP Statistics for the Shub. Statistics are provided per VRF as well as global statistics
for the node.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub arp-stats [ (vrf-id) ]

Command Parameters
Table 64.12-1 "IP SHub ARP Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf number

Command Output
Table 64.12-2 "IP SHub ARP Statistics Command" Display parameters
Common Information:statistics for the node
name
Type
in-packets

Parameter type: <Counter>


- 32 bit counter

discard

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

in-request
in-resp

Parameter type: <Counter>


- 32 bit counter

out-request

Parameter type: <Counter>


- 32 bit counter

out-resp

Parameter type: <Counter>


- 32 bit counter

1880

Released

Description
total number of arp datagrams
received
from
interfaces,
including those received in error.
This element is always shown.
total number of packets discarded
This element is always shown.
total number of arp request
packets received
This element is always shown.
total number of arp response
packets received
This element is always shown.
total number of arp requests
transmitted
This element is always shown.
total number of arp responses
transmitted

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

Description

total-arp-entries
short name:
arp-entries/total

Parameter type: <SignedInteger>


- a signed integer

This element is always shown.


number of total arp entries
learned for all vrfs
This element is always shown.

Specific Information
name

Type

Description

arp-discards
short name: discard

Parameter type: <Counter>


- 32 bit counter

rx-arp-pkts
short name: rx-arp/pkts
rx-arp-req
short name: rx-arp/req

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

rx-arp-rsp
short name: rx-arp/rsp

Parameter type: <Counter>


- 32 bit counter

tx-arp-req
short name: tx-arp/req

Parameter type: <Counter>


- 32 bit counter

tx-arp-rsp
short name: tx-arp/rsp

Parameter type: <Counter>


- 32 bit counter

curr-arp-entries
short name:
arp-entries/curr
invalid-op-code
short name: inv/op-code

Parameter type: <SignedInteger>


- a signed integer

number of arp packets discarded.


This counter summarizes all
cases where packets are dropped.
This element is always shown.
number of arp packets received
This element is always shown.
number of arp request packets
received
This element is always shown.
number of arp response packets
received
This element is always shown.
number of arp request packets
transmitted
This element is always shown.
number of arp repsonse packets
transmitted
This element is always shown.
number of current arp entries
This element is always shown.

unsupported-hw-type
short name:
unsupported/hw-type

Parameter type: <Counter>


- 32 bit counter

unsupported-l3-proto
short name:
unsupported/l3-proto

Parameter type: <Counter>


- 32 bit counter

unsupported-addr-len
short name:
unsupported/addr-len

Parameter type: <Counter>


- 32 bit counter

invalid-src-mac
short name: inv-mac/src

Parameter type: <Counter>


- 32 bit counter

invalid-user-mac
short name: inv-mac/user

Parameter type: <Counter>


- 32 bit counter

internal-ctxt-err

Parameter type: <Counter>

3HH-04416-EBAA-TCZZA 01

Parameter type: <Counter>


- 32 bit counter

number of packets dropped due


to invalid opcode
This element is only shown in
detail mode.
number of packets dropped
because the hardware type in the
ethernet header is not supported.
This element is only shown in
detail mode.
number of packets droppend
because the layer 3 in the ethernet
header is not supported.
This element is only shown in
detail mode.
number of packets dropped
because of the address length in
the ethernet header is not
supported.
This element is only shown in
detail mode.
number of packets dropped
because the source mac address
us broadcast/multicast
This element is always shown.
number of packets dropped
because the source mac address is
the default mac of the interface.
This element is always shown.
number of dropped packets

Released

1881

64 IP Status Commands

name

Type

Description

short name: int-ctxt-err

- 32 bit counter

no-free-arp-entry
short name: no-free-entry

Parameter type: <Counter>


- 32 bit counter

because of internal context error


This element is only shown in
detail mode.
number of packets dropped
because of memory allocation
errors when adding entry to arp
cache.
This element is only shown in
detail mode.

1882

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.13 IP SHub VRF Media Status Command


Command Description
Displays the ARP cache on the SHub holding the IP-MAC relationship.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf-media [ (vrf) [ ip-address <Ip::V4Address> ] ]

Command Parameters
Table 64.13-1 "IP SHub VRF Media Status Command" Resource Parameters
Resource Identifier

Type

Description

(vrf)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

the VRF id

ip-address

the IP-address.

Command Output
Table 64.13-2 "IP SHub VRF Media Status Command" Display parameters
Specific Information
name
physical-addr
type

vlan

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ip::PhysicalAddress>


- media dependent physical address
- length: 8
Parameter type: <Transport::ipNetToMediaType>
( other
| invalid
| dynamic
| static )
Possible values:
- other : none of the following
- invalid : invalidating the corresponding entry
- dynamic : dynamic mapping
- static : static mapping
Parameter type: <PrintableString>
- printable string

the physical IP-address.


This element is always shown.
type of mapping
This element is always shown.

type of mapping
This element is always shown.

Released

1883

64 IP Status Commands

1884

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.14 IP SHub VRF Routing Status Command


Command Description
This command displays IP Shub VRF route status parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf-routing [ (vrf) ]

Command Parameters
Table 64.14-1 "IP SHub VRF Routing Status Command" Resource Parameters
Resource Identifier

Type

Description

(vrf)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the VRF id

Command Output
Table 64.14-2 "IP SHub VRF Routing Status Command" Display parameters
Specific Information
name
current-rtg-entries

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

the current number of routing


table entries
This element is always shown.

Released

1885

64 IP Status Commands

64.15 IP DHCP Session Status Command


Command Description
This command displays the dhcp-sessions information on a per client-port and per user IP address basis.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip dhcp-session [ (client) [ ip-addr <Ip::V4Address> ] ]

Command Parameters
Table 64.15-1 "IP DHCP Session Status Command" Resource Parameters
Resource Identifier

Type

(client)

Format:
specifies the if-index uniquely
( port : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / indentifying each interface
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| port : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| bridgeport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /

1886

Released

Description

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

Resource Identifier

Type

Description

<Eqpt::LLId> : <Eqpt::UnstackedVlan> )
Possible values:
- port : an atm pvc interface
- bridgeport : an bridge port interface
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip-addr

client ip address assigned by


dhcp server

Command Output
Table 64.15-2 "IP DHCP Session Status Command" Display parameters
Specific Information
name
subnet
lease-time

Type

Description

Parameter type: <Ip::PrefixLength>


- IP address prefix length
- range: [0...30]
Parameter type: <Ip::LeaseTimeInSec>
- the lease time

the subnet mask of the client ip


address
This element is always shown.
time period for which DHCP
server leases ip address to a client
This element is always shown.
number which uniquely identifies
a particular VRF context within
the system
This element is always shown.
the gateway ip address
This element is only shown in
detail mode.
ip address of dhcp server
This element is only shown in
detail mode.

vrf

Parameter type: <Vrf::UnsignedVrfIndex>


- the VRF ID which uniquely identify a VRF
- range: [1...127]

gateway-ip-addr

Parameter type: <Ip::V4Address>


- IPv4-address

dhcp-ip-addr

Parameter type: <Ip::V4Address>


- IPv4-address

3HH-04416-EBAA-TCZZA 01

Released

1887

64 IP Status Commands

1888

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.16 IP User Port ARP Proxy Statistics Status


Command
Command Description
This command allows the operator to display the ARP statistic commands. When this show command is invoked, all
commands in underlying nodes are automatically executed.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats [ (port-interface) ]

Command Parameters
Table 64.16-1 "IP User Port ARP Proxy Statistics Status Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

3HH-04416-EBAA-TCZZA 01

Description

Released

1889

64 IP Status Commands

64.17 IP Untagged User Port ARP Proxy Statistics


Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to untagged frames.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) untagged-ip

Command Parameters
Table 64.17-1 "IP Untagged User Port ARP Proxy Statistics Status Command" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

1890

Released

Description

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.18 IP Untagged User Port ARP Proxy Summary


Statistics Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to untagged frames. These summary counters are always available.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) untagged-ip summary

Command Parameters
Table 64.18-1 "IP Untagged User Port ARP Proxy Summary Statistics Status Command" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Command Output
Table 64.18-2 "IP Untagged User Port ARP Proxy Summary Statistics Status Command" Display
parameters

3HH-04416-EBAA-TCZZA 01

Released

1891

64 IP Status Commands

Specific Information
name
error-summary

1892

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

show the total of ARP packets


that have been dropped because
of errors
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

64.19 IP Untagged User Port ARP Proxy Detailed


Statistics Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to untagged frames.
The detailed counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) untagged-ip extensive

Command Parameters
Table 64.19-1 "IP Untagged User Port ARP Proxy Detailed Statistics Status Command" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Command Output
Table 64.19-2 "IP Untagged User Port ARP Proxy Detailed Statistics Status Command" Display

3HH-04416-EBAA-TCZZA 01

Released

1893

64 IP Status Commands

parameters
Specific Information
name

Type

Description

internal-ctxt-err

Parameter type: <Counter>


- 32 bit counter

unsupported-hw-type

Parameter type: <Counter>


- 32 bit counter

unsupported-l3-proto

Parameter type: <Counter>


- 32 bit counter

unsupported-addr-len

Parameter type: <Counter>


- 32 bit counter

invalid-op-code

Parameter type: <Counter>


- 32 bit counter

invalid-src-mac

Parameter type: <Counter>


- 32 bit counter

arp-cache-overflow

Parameter type: <Counter>


- 32 bit counter

unsupported-user-itf

Parameter type: <Counter>


- 32 bit counter

invalid-target-ip

Parameter type: <Counter>


- 32 bit counter

invalid-src-ip

Parameter type: <Counter>


- 32 bit counter

unknown-user

Parameter type: <Counter>


- 32 bit counter

show the number of ARP packets


dropped due to internal context
errors
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid HW type
in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid L3
protocol in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid address
lengths in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid opcode in
received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid source
mac address in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to arp cache
overflow
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid configured
user interface. Only IPoE
supported
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid target IP
in the received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid source IP
in the received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to unknown source
IP in the received packet

1894

Released

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

name

Type

identical-user-itf

Parameter type: <Counter>


- 32 bit counter

unknown-target-ip

Parameter type: <Counter>


- 32 bit counter

unsupported-probe-pkt

Parameter type: <Counter>


- 32 bit counter

req-rx-and-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-and-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-no-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-wait-reply

Parameter type: <Counter>


- 32 bit counter

grat-rx-and-accept

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to source and target
IP being learnt on same user
interface
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to unknown target
IP in the received packet
This element is only shown in
detail mode.
show the number of ARP probe
packets received and dropped as
these are not supported
This element is only shown in
detail mode.
show the number of ARP
requests received from user and
responded
This element is only shown in
detail mode.
show the number of ARP
requests sent out and responded
by user
This element is only shown in
detail mode.
show the number of ARP
requests sent out and not
responded by user
This element is only shown in
detail mode.
show the number of ARP
requests sent out and waiting for
reply
This element is only shown in
detail mode.
show the number of ARP
gratuitous requests received and
accepted
This element is only shown in
detail mode.

Released

1895

64 IP Status Commands

64.20 IP Tagged User Port ARP Proxy Statistics


Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to the specified vlan tagged frames.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) vlan [ (subscr-vlan) ]

Command Parameters
Table 64.20-1 "IP Tagged User Port ARP Proxy Statistics Status Command" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
the subscriber vlan id
( stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::UnstackedVlan> )
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>

(subscr-vlan)

1896

Released

Description

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

Resource Identifier

Type

Description

- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

1897

64 IP Status Commands

64.21 IP Tagged User Port ARP Proxy Summary


Statistics Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to the specified vlan tagged frames. These summary counters are always available.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) vlan (subscr-vlan) summary

Command Parameters
Table 64.21-1 "IP Tagged User Port ARP Proxy Summary Statistics Status Command" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
the subscriber vlan id
( stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::UnstackedVlan> )
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id

(subscr-vlan)

1898

Released

Description

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SVlan>


- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 64.21-2 "IP Tagged User Port ARP Proxy Summary Statistics Status Command" Display
parameters
Specific Information
name
error-summary

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

show the total of ARP packets


that have been dropped because
of errors
This element is only shown in
detail mode.

Released

1899

64 IP Status Commands

64.22 IP Tagged User Port ARP Proxy Detailed


Statistics Status Command
Command Description
This command allows the operator to display the ARP statistic commands. The command will show all counters
related to the specified vlan tagged frames.
The detailed counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip arp-proxy-stats (port-interface) vlan (subscr-vlan) extensive

Command Parameters
Table 64.22-1 "IP Tagged User Port ARP Proxy Detailed Statistics Status Command" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
user interface
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
the subscriber vlan id
( stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::UnstackedVlan> )
Possible values:
- stacked : stacked vlan identity

(subscr-vlan)

1900

Released

Description

3HH-04416-EBAA-TCZZA

01

64 IP Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 64.22-2 "IP Tagged User Port ARP Proxy Detailed Statistics Status Command" Display
parameters
Specific Information
name

Type

Description

internal-ctxt-err

Parameter type: <Counter>


- 32 bit counter

unsupported-hw-type

Parameter type: <Counter>


- 32 bit counter

unsupported-l3-proto

Parameter type: <Counter>


- 32 bit counter

unsupported-addr-len

Parameter type: <Counter>


- 32 bit counter

invalid-op-code

Parameter type: <Counter>


- 32 bit counter

invalid-src-mac

Parameter type: <Counter>


- 32 bit counter

arp-cache-overflow

Parameter type: <Counter>


- 32 bit counter

unsupported-user-itf

Parameter type: <Counter>


- 32 bit counter

invalid-target-ip

Parameter type: <Counter>


- 32 bit counter

show the number of ARP packets


dropped due to internal context
errors
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid HW type
in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid L3
protocol in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid address
lengths in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid opcode in
received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid source
mac address in received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to arp cache
overflow
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid configured
user interface. Only IPoE
supported
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid target IP

3HH-04416-EBAA-TCZZA 01

Released

1901

64 IP Status Commands

name

Type

invalid-src-ip

Parameter type: <Counter>


- 32 bit counter

unknown-user

Parameter type: <Counter>


- 32 bit counter

identical-user-itf

Parameter type: <Counter>


- 32 bit counter

unknown-target-ip

Parameter type: <Counter>


- 32 bit counter

unsupported-probe-pkt

Parameter type: <Counter>


- 32 bit counter

req-rx-and-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-and-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-no-reply

Parameter type: <Counter>


- 32 bit counter

req-tx-wait-reply

Parameter type: <Counter>


- 32 bit counter

grat-rx-and-accept

Parameter type: <Counter>


- 32 bit counter

1902

Released

Description
in the received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to invalid source IP
in the received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to unknown source
IP in the received packet
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to source and target
IP being learnt on same user
interface
This element is only shown in
detail mode.
show the number of ARP packets
dropped due to unknown target
IP in the received packet
This element is only shown in
detail mode.
show the number of ARP probe
packets received and dropped as
these are not supported
This element is only shown in
detail mode.
show the number of ARP
requests received from user and
responded
This element is only shown in
detail mode.
show the number of ARP
requests sent out and responded
by user
This element is only shown in
detail mode.
show the number of ARP
requests sent out and not
responded by user
This element is only shown in
detail mode.
show the number of ARP
requests sent out and waiting for
reply
This element is only shown in
detail mode.
show the number of ARP
gratuitous requests received and
accepted
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

65- ARP-RELAY Status Commands

65.1 ARP-RELAY Status Command Tree


65.2 ARP-RELAY statistics Status Command
65.3 ARP-RELAY summary statistics Status Command
65.4 ARP-RELAY detailed statistics Status Command

3HH-04416-EBAA-TCZZA 01

65-1904
65-1905
65-1907
65-1909

Released

1903

65 ARP-RELAY Status Commands

65.1 ARP-RELAY Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "ARP-RELAY Status Commands".

Command Tree
----show
----arp-relay-stats
- (user-port)
----vlan
- (subscr-vlan)
----summary
----extensive

1904

Released

3HH-04416-EBAA-TCZZA

01

65 ARP-RELAY Status Commands

65.2 ARP-RELAY statistics Status Command


Command Description
This command displays the detailed and summary ARP-RELAY statistics for static/dynamic VLAN-ports associated
to a user interface.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show arp-relay-stats (user-port) vlan [ (subscr-vlan) ]

Command Parameters
Table 65.2-1 "ARP-RELAY statistics Status Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

Released

1905

65 ARP-RELAY Status Commands

Resource Identifier

Description

Field type <Eqpt::OntId>


- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

1906

Type

Released

the subscriber vlan id

3HH-04416-EBAA-TCZZA

01

65 ARP-RELAY Status Commands

65.3 ARP-RELAY summary statistics Status


Command
Command Description
This command displays the summary ARP-RELAY statistics for static/dynamic VLAN-ports associated to a user
interface.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show arp-relay-stats (user-port) vlan (subscr-vlan) summary

Command Parameters
Table 65.3-1 "ARP-RELAY summary statistics Status Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

Released

1907

65 ARP-RELAY Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

the subscriber vlan id

Command Output
Table 65.3-2 "ARP-RELAY summary statistics Status Command" Display parameters
Specific Information
name

Type

Description

error-summary-ctr

Parameter type: <ArpRelay::Counter>


- an unsigned integer

antispf-disc-ctr

Parameter type: <ArpRelay::Counter>


- an unsigned integer

all ARP pkts dropped because of


errors
This element is always shown.
all ARP pkts dropped because of
anti-spoofing check failed
This element is always shown.

1908

Released

3HH-04416-EBAA-TCZZA

01

65 ARP-RELAY Status Commands

65.4 ARP-RELAY detailed statistics Status


Command
Command Description
This command displays the detailed ARP-RELAY statistics for static/dynamic VLAN-ports associated to a user
interface.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show arp-relay-stats (user-port) vlan (subscr-vlan) extensive

Command Parameters
Table 65.4-1 "ARP-RELAY detailed statistics Status Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

Released

1909

65 ARP-RELAY Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

the subscriber vlan id

Command Output
Table 65.4-2 "ARP-RELAY detailed statistics Status Command" Display parameters
Specific Information
name

Type

Description

unsupported-hwtype

Parameter type: <ArpRelay::Counter>


- an unsigned integer

unsupported-l3proto

Parameter type: <ArpRelay::Counter>


- an unsigned integer

unsupported-addrlen

Parameter type: <ArpRelay::Counter>


- an unsigned integer

unsupported-probepkt

Parameter type: <ArpRelay::Counter>


- an unsigned integer

inv-pktlen

Parameter type: <ArpRelay::Counter>


- an unsigned integer
Parameter type: <ArpRelay::Counter>
- an unsigned integer

wrong hardware type in ARP pkt


header
This element is always shown.
wrong protocol type in ARP pkt
header
This element is always shown.
wrong adress length in ARP pkt
header
This element is always shown.
nbr ARP probe pkts(i.e source ip
address all zero's)
This element is always shown.
invalid ARP pkt length
This element is always shown.
invalid /not supported opcode in
ARP pkt
This element is always shown.
invalid source mac addr in ARP
request
This element is always shown.
invalid target IP addr in ARP

inv-opcode
inv-arpreq-srcmac

Parameter type: <ArpRelay::Counter>


- an unsigned integer

inv-arpreq-dstip

Parameter type: <ArpRelay::Counter>

1910

Released

3HH-04416-EBAA-TCZZA

01

65 ARP-RELAY Status Commands

name

Type

Description

- an unsigned integer

request
This element is always shown.
invalid source IP addr in ARP
request
This element is always shown.
invalid source mac addr in ARP
reply
This element is always shown.
invalid target IP addr in ARP
reply
This element is always shown.
invalid target IP addr in ARP
request
This element is always shown.
arp-req pkts dropped because
sender and target IP addr learnt
on same user interface
This element is always shown.
arp-req IP antispoofing check
failure
This element is always shown.
nbr upstream arp-request pkts
relayed
This element is always shown.
nbr downstream arp-request pkts
relayed
This element is always shown.
arp-req pkts dropped because
sender and target IP addr learnt
on same user interface
This element is always shown.
arp-reply IP antispoofing check
failure
This element is always shown.
nbr upstream arp-reply pkts
relayed
This element is always shown.

inv-arpreq-srcip

Parameter type: <ArpRelay::Counter>


- an unsigned integer

inv-arpreply-srcmac

Parameter type: <ArpRelay::Counter>


- an unsigned integer

inv-arpreply-dstip

Parameter type: <ArpRelay::Counter>


- an unsigned integer

inv-arpreply-srcip

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreq-same-itf

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreq-antispoof

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreq-up

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreq-dn

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreply-same-itf

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreply-antispoof

Parameter type: <ArpRelay::Counter>


- an unsigned integer

arpreply-up

Parameter type: <ArpRelay::Counter>


- an unsigned integer

3HH-04416-EBAA-TCZZA 01

Released

1911

66- xDSL Status Commands

66.1 xDSL Status Command Tree


66.2 xDSL Profiles Status Command
66.3 xDSL PM Interval Per Interface Status Command
66.4 xDSL Operational Data Near End Line Status
Command
66.5 xDSL Operational Data Near End Channel Status
Command
66.6 xDSL Operational Data Far End Line Status Command
66.7 xDSL Operational Data Far End Channel Status
Command
66.8 xDSL Operational Data Statistics
66.9 xDSL Carrier Data Near End Status Command
66.10 xDSL Carrier Data Far End Status Command
66.11 xDSL Failure Status Near End Status Command
66.12 xDSL Failure Status Far End Status Command
66.13 xDSL Vectored Line Failure Status Command
66.14 xDSL Vectoring Board Failure Status Command
66.15 xDSL Counters Near End Line Current 15 Min
66.16 xDSL Counters Near End Line Current Day
66.17 xDSL Counters Near End Line Previous 15 Min
66.18 xDSL Counters Near End Of Line Previous Day
66.19 xDSL Counters Near End Channel Current 15 Min
66.20 xDSL Counters Near End Channel Current Day
66.21 xDSL Counters Near End Channel Previous 15 Min
66.22 xDSL Counters Near End Channel Previous Day
66.23 xDSL Counters Far End Line Current 15 Min
66.24 xDSL Counters Far End Line Current Day
66.25 xDSL Counters Far End Line Previous 15 Min
66.26 xDSL Counters Far End Line Previous Day
66.27 xDSL Counters Far End Channel Current 15 Min
66.28 xDSL Counters Far End Channel Current Day
66.29 xDSL Counters Far End Channel Previous 15 Min
66.30 xDSL Counters Far End Channel Previous Day
66.31 xDSL XTU-R Inventory Status Command
66.32 xDSL XTU-C Inventory Status Command
66.33 xDSL Board Capability Status Command
66.34 xDSL Low Rate Alarm Timestamp Command
66.35 xDSL Low Rate Alarm Line Bitmap Status Command
66.36 xDSL Low Rate Alarm Linkup Record Data
Command
66.37 xDSL INS Near End Operational Data Status
Command
66.38 xDSL INS Near End Current 15Min Data Status
Command
66.39 xDSL INS Near End Current 15Min IAT Histogram
66.40 xDSL INS Near End Current 15Min EINP Histogram
66.41 xDSL INS Near End Current Day Data Status
Command
66.42 xDSL INS Near End Current Day IAT Histogram
66.43 xDSL INS Near End Current Day EINP Histogram

1912

Released

66-1914
66-1918
66-1920
66-1922
66-1931
66-1933
66-1941
66-1943
66-1947
66-1952
66-1955
66-1958
66-1961
66-1963
66-1965
66-1967
66-1969
66-1972
66-1975
66-1977
66-1979
66-1981
66-1983
66-1985
66-1987
66-1989
66-1991
66-1993
66-1995
66-1997
66-1999
66-2001
66-2003
66-2009
66-2010
66-2011
66-2014
66-2016
66-2017
66-2018
66-2019
66-2020
66-2021

3HH-04416-EBAA-TCZZA

01

66.44 xDSL INS Near End Previous 15Min Data Status


Command
66.45 xDSL INS Near End Previous 15Min IAT Histogram
66.46 xDSL INS Near End Previous 15Min EINP Histogram
66.47 xDSL INS Near End Previous Day Data Status
Command
66.48 xDSL INS Near End Previous Day IAT Histogram
66.49 xDSL INS Near End Previous Day EINP Histogram
66.50 xDSL INS Far End Operational Data Status
Command
66.51 xDSL INS Far End Current 15Min Data Status
Command
66.52 xDSL INS Far End Current 15Min IAT Histogram
66.53 xDSL INS Far End Current 15Min EINP Histogram
66.54 xDSL INS Far End Current Day Data Status
Command
66.55 xDSL INS Far End Current Day IAT Histogram
66.56 xDSL INS Far End Current Day EINP Histogram
66.57 xDSL INS Far End Previous 15Min Data Status
Command
66.58 xDSL INS Far End Previous 15Min IAT Histogram
66.59 xDSL INS Far End Previous 15Min EINP Histogram
66.60 xDSL INS Far End Previous Day Status Command
66.61 xDSL INS Far End Previous Day IAT Histogram
66.62 xDSL INS Far End Previous Day EINP Histogram
66.63 xDSL Downstream Vectoring Disturberlist Status
Command
66.64 xDSL Upstream Vectoring Disturberlist Status
Command
66.65 xDSL Downstream Vectoring Disturberlist Status
Command
66.66 xDSL Vectoring Carrier Data Near End Status
Command
66.67 xDSL Vectoring Carrier Data Far End Status
Command
66.68 xDSL Vectoring Processing Board Status Command
66.69 xDSL Vectoring Processing Group Status Command

3HH-04416-EBAA-TCZZA 01

66-2022
66-2023
66-2024
66-2025
66-2026
66-2027
66-2028
66-2030
66-2031
66-2032
66-2033
66-2034
66-2035
66-2036
66-2037
66-2038
66-2039
66-2040
66-2041
66-2042
66-2044
66-2046
66-2048
66-2051
66-2054
66-2056

Released

1913

66 xDSL Status Commands

66.1 xDSL Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "xDSL Status Commands".

Command Tree
----show
----xdsl
----profiles
----xdsl-int
- (if-index)
----operational-data
----near-end
----line
- (if-index)
----channel
- (if-index)
----far-end
----line
- (if-index)
----channel
- (if-index)
----line
- (if-index)
----carrier-data
----near-end
- (if-index)
----far-end
- (if-index)
----failure-status
----near-end
- (if-index)
----far-end
- (if-index)
----vect-line-near-end
- (if-index)
----vect-board
- (board-index)
----counters
----near-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----channel

1914

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----far-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----channel
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----cpe-inventory
- (if-index)
----co-inventory
- (if-index)
----board
- (if-index)
----link-up-changes
- (linkup-timestamp)
----slot
- (slot)
----linkup-record
- (line)
----imp-noise-sensor
----near-end
----oper-data
- (if-index)
----current-interval
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----current-1day
- (if-index)
----inm-iat-histo
- (class-interval)

3HH-04416-EBAA-TCZZA 01

Released

1915

66 xDSL Status Commands

----inm-equiv-inp-histo
- (class-interval)
----previous-interval
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----previous-1day
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----far-end
----oper-data
- (if-index)
----current-interval
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----current-1day
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----previous-interval
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----previous-1day
- (if-index)
----inm-iat-histo
- (class-interval)
----inm-equiv-inp-histo
- (class-interval)
----X vect-disturbers
- (victim-line)
- [no] max-reported-dist
----vect-disturber-list
----upstream
- (victim-line)
- [no] max-reported-dist
----downstream
- (victim-line)
- [no] max-reported-dist
----vect-carrier-data
----near-end
- (line)
- disturber-line
- [no] vgr-link
- [no] group-sampling
----far-end
- (line)

1916

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

- disturber-line
- [no] vgr-link
- [no] group-sampling
----vp-board
- (board-index)
- vp-link
----vect-group
- (board-index)
- vgr-link

3HH-04416-EBAA-TCZZA 01

Released

1917

66 xDSL Status Commands

66.2 xDSL Profiles Status Command


Command Description
This command displays xDSL profiles.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl profiles

Command Output
Table 66.2-2 "xDSL Profiles Status Command" Display parameters
Specific Information
name
next-av-serv-pr
max-serv-pr
next-av-spec-pr
max-spec-pr
next-av-dpbo-pr
max-dpbo-pr
next-av-rtx-pr
max-rtx-pr
next-av-vect-pr
max-vect-pr

1918

Released

Type

Description

Parameter type: <AsamNextProfileIndex>


- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]
Parameter type: <AsamNextProfileIndex>
- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]
Parameter type: <AsamNextProfileIndex>
- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]
Parameter type: <AsamNextProfileIndex>
- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]
Parameter type: <AsamNextProfileIndex>
- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>

next available service profile


index
This element is always shown.
max number of service profiles
that can be created
This element is always shown.
next available spectrum profile
index
This element is always shown.
max number of spectrum profiles
that can be created
This element is always shown.
next available dpbo profile index
This element is always shown.
max number of dpbo profiles that
can be created
This element is always shown.
next available rtx profile index
This element is always shown.
max number of rtx profiles that
can be created
This element is always shown.
next available vectoring profile
index
This element is always shown.
max number of vectoring profiles

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name
next-av-vce-pr
max-vce-pr

3HH-04416-EBAA-TCZZA 01

Type

Description

- a maximum value of a profile index


- range: [0...65535]
Parameter type: <AsamNextProfileIndex>
- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]

that can be created


This element is always shown.
next available vectoring control
entity profile index
This element is always shown.
max number of vectoring control
entity profiles that can be created
This element is always shown.

Released

1919

66 xDSL Status Commands

66.3 xDSL PM Interval Per Interface Status


Command
Command Description
This command displays the number of available pm intervals per xdsl interface.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl xdsl-int [ (if-index) ]

Command Parameters
Table 66.3-1 "xDSL PM Interval Per Interface Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.3-2 "xDSL PM Interval Per Interface Status Command" Display parameters
Specific Information
name

Type

Description

cur-int-elapsedtime

Parameter type: <SignedInteger>


- a signed integer

cur-1day-elapsedtime

Parameter type: <SignedInteger>


- a signed integer

valid-intervals

Parameter type: <SignedInteger>

nbr of sec elapsed in cur intvl


err-measurement
This element is always shown.
nbr of sec elapsed in cur one day
err-measurement
This element is always shown.
nbr of prev intvl for which valid

1920

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name
valid-1days

Type

Description

- a signed integer

data has been stored


This element is always shown.
nbr of prev 1Days for which valid
data has been stored
This element is always shown.

Parameter type: <SignedInteger>


- a signed integer

Only Show Details: global settings


name
Type
xdsl-coding-type

3HH-04416-EBAA-TCZZA 01

Parameter type: <Xdsl::Coding>


( other
| dmt
| cap )
Possible values:
- other : other type
- dmt : DMT type
- cap : CAP type

Description
type of modulation technique
This element is only shown in
detail mode.

Released

1921

66 xDSL Status Commands

66.4 xDSL Operational Data Near End Line Status


Command
Command Description
This command displays the xDSL operational data for the near end of line.
upbo-aele-pb-up: Specifies the line Electrical Length Estimation per band calculated by the XTU-C when mode is
VDSL2 and unit is 1/10dB. First two octets represent value for band 0 and specifies supported range 0..1280 and
2047. Similarly next two octets represent value for band 1 and so on. Default value 0xFFFF per band specifies that
no data is available.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end line [ (if-index) ]

Command Parameters
Table 66.4-1 "xDSL Operational Data Near End Line Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.4-2 "xDSL Operational Data Near End Line Status Command" Display parameters
Specific Information
name
rel-cap-occ-up

1922

Released

Type

Description

Parameter type: <Xdsl::CapacityUtil>


- utilization of the capacity available
- unit: %

ratio of actual bitrate over the


max attainable bitrate
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

Description

- range: [0...100]
noise-margin-up
Parameter type: <Xdsl::NoiseValue>
- a noise value
- unit: 1/10 dB
output-power-down
Parameter type: <Xdsl::OutputPwr>
short name: output-pwr-dn - a power value
- unit: 1/10 dBm
sig-attenuation-up
Parameter type: <Xdsl::SigAttenuation>
short name: sig-attn-up
- an attenuation value
- unit: 1/10 dB
loop-attenuation-up
short name: loop-attn-up

Parameter type: <Xdsl::SigAttenuation>


- an attenuation value
- unit: 1/10 dB

actual-opmode

Parameter type: <Xdsl::OneOpModeTypeLinePreDef>


( ansi-t1413
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2
| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1

3HH-04416-EBAA-TCZZA 01

current noise margin for the


upstream direction
This element is always shown.
actual aggregate output power for
the downstream carriers
This element is always shown.
diff btw pwr at near-end rx-ver
and that tx-ed from far-end
This element is only shown in
detail mode.
diff btw pwr at near-end rx-ver
and tx-ed from far-end over all
sub-carriers
This element is only shown in
detail mode.
actual value of the operational
mode
This element is only shown in
detail mode.

Released

1923

66 xDSL Status Commands

name

Type

xtu-c-opmode

1924

Description

- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US


mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A
- default : default value
Parameter type: <Xdsl::OpModeTypeLinePreDef>
( ansi-t1413
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2
| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default
| <Xdsl::OpModeType> )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum

Released

bitmap which represents the


operational modes
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

ansi-t1413

etsi-dts

g992-1-a

g992-1-b

3HH-04416-EBAA-TCZZA 01

Type

Description

- g992-1-b : G.992.1 ISDN non-overlapped spectrum


- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A
- default : default value
Field type <Xdsl::OpModeType>
- octet string bitmask defining operational mode
- length: 16
Parameter type: <Xdsl::T1413>
( dis-ansi-t1413
| ansi-t1413 )
Possible values:
- dis-ansi-t1413 : disable ANSI T1.413-1998
- ansi-t1413 : ANSI T1.413-1998
Parameter type: <Xdsl::Etsidts>
( dis-etsi-dts
| etsi-dts )
Possible values:
- dis-etsi-dts : disable ETSI DTS/TM06006
- etsi-dts : ETSI DTS/TM06006
Parameter type: <Xdsl::G21potsnos>
( dis-g992-1-a
| g992-1-a )
Possible values:
- dis-g992-1-a : disable G.992.1 POTS non-overlapped
spectrum
- g992-1-a : G.992.1 POTS non-overlapped spectrum
Parameter type: <Xdsl::G21isdnnos>
( dis-g992-1-b
| g992-1-b )
Possible values:

ANSI T1.413-1998
This element is only shown in
detail mode.

ETSI DTS/TM06006
This element is only shown in
detail mode.

G.992.1 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.1 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

Released

1925

66 xDSL Status Commands

name

Type

g992-2-a

g992-3-a

g992-3-b

g992-3-aj

g992-3-l1

g992-3-l2

g992-3-am

g992-5-a

1926

Description

- dis-g992-1-b : disable G.992.1 ISDN non-overlapped


spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G22potsnos>
( dis-g992-2-a
| g992-2-a )
Possible values:
- dis-g992-2-a : disable G.992.2 POTS non-overlapped
spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23potsnos>
( dis-g992-3-a
| g992-3-a )
Possible values:
- dis-g992-3-a : disable G.992.3 POTS non-overlapped
spectrum
- g992-3-a : G.992.3 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23isdnnos>
( dis-g992-3-b
| g992-3-b )
Possible values:
- dis-g992-3-b : disable G.992.3 ISDN non-overlapped
spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G23AllDigNos>
( dis-g992-3-aj
| g992-3-aj )
Possible values:
- dis-g992-3-aj : disable G.992.3 all digital mode
non-overlapped spectrum
- g992-3-aj : G.992.3 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G23PotsnosUs1>
( dis-g992-3-l1
| g992-3-l1 )
Possible values:
- dis-g992-3-l1 : disable G.992.3 POTS non-overlapped
spectrum US mask 1
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
Parameter type: <Xdsl::G23PotsNosUs2>
( dis-g992-3-l2
| g992-3-l2 )
Possible values:
- dis-g992-3-l2 : disable G.992.3 POTS non-overlapped
spectrum US mask 2
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
Parameter type: <Xdsl::G23ExtPotsNos>
( dis-g992-3-am
| g992-3-am )
Possible values:
- dis-g992-3-am : disable G.992.3 extended POTS with
non-overlapped spectrum
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
Parameter type: <Xdsl::G25PotsNos>

Released

G.992.2 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 1
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 2
This element is only shown in
detail mode.

G.992.3 extended POTS with


non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5 POTS non-overlapped

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

g992-5-b

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

g992-5-aj

g992-5-am

g993-2-8a

3HH-04416-EBAA-TCZZA 01

Type

Description

( dis-g992-5-a
| g992-5-a )
Possible values:
- dis-g992-5-a : disable G.992.5 POTS non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
Parameter type: <Xdsl::G25IsdnNos>
( dis-g992-5-b
| g992-5-b )
Possible values:
- dis-g992-5-b : disable G.992.5 ISDN non-overlapped
spectrum
- g992-5-b : G.992.5 ISDN non-overlapped spectrum
Parameter type: <Xdsl::AnsiT1424>
( dis-ansi-t1.424
| ansi-t1.424 )
Possible values:
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
Parameter type: <Xdsl::EtsiTs>
( dis-etsi-ts
| etsi-ts )
Possible values:
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
Parameter type: <Xdsl::ItuG9931>
( dis-itu-g993-1
| itu-g993-1 )
Possible values:
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
Parameter type: <Xdsl::Ieee802.3Ah>
( dis-ieee-802.3ah
| ieee-802.3ah )
Possible values:
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
Parameter type: <Xdsl::G25AllDigNos>
( dis-g992-5-aj
| g992-5-aj )
Possible values:
- dis-g992-5-aj : disable G.992.5 all digital mode
non-overlapped spectrum
- g992-5-aj : G.992.5 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G25ExtPotsNos>
( dis-g992-5-am
| g992-5-am )
Possible values:
- dis-g992-5-am : disable G.992.5 extended POTS
non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
Parameter type: <Xdsl::GProfile8A>
( dis-g993-2-8a
| g993-2-8a )
Possible values:

spectrum
This element is only shown in
detail mode.

G.992.5 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

ansi T1.424
This element is only shown in
detail mode.

ETSI TS 101 270


This element is only shown in
detail mode.

ITU G993-1
This element is only shown in
detail mode.

IEEE 802.3ah
This element is only shown in
detail mode.

G.992.5
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5
extended
POTS
non-overlapped spectrum
This element is only shown in
detail mode.

VDSL-2 with profile 8A


This element is only shown in
detail mode.

Released

1927

66 xDSL Status Commands

name

Type

g993-2-8b

g993-2-8c

g993-2-8d

g993-2-12a

g993-2-12b

g993-2-17a

g993-2-30a

actual-psd-down
short name: act-psd-dn
power-mgnt-state
short name: pwr-mgnt

1928

Released

Description

- dis-g993-2-8a : disable G.993.2_8A VDSL-2 with profile


8A
- g993-2-8a : G.993.2_8A VDSL-2 with profile 8A
Parameter type: <Xdsl::GProfile8B>
( dis-g993-2-8b
| g993-2-8b )
Possible values:
- dis-g993-2-8b : disable G.993.2_8B VDSL-2 with profile
8B
- g993-2-8b : G.993.2_8B VDSL-2 with profile 8B
Parameter type: <Xdsl::GProfile8C>
( dis-g993-2-8c
| g993-2-8c )
Possible values:
- dis-g993-2-8c : disable G.993.2_8C VDSL-2 with profile
8C
- g993-2-8c : G.993.2_8C VDSL-2 with profile 8C
Parameter type: <Xdsl::GProfile8D>
( dis-g993-2-8d
| g993-2-8d )
Possible values:
- dis-g993-2-8d : disable G.993.2_8D VDSL-2 with profile
8D
- g993-2-8d : G.993.2_8D VDSL-2 with profile 8D
Parameter type: <Xdsl::GProfile12A>
( dis-g993-2-12a
| g993-2-12a )
Possible values:
- dis-g993-2-12a : disable G.993.2_12A VDSL-2 with
profile 12A
- g993-2-12a : G.993.2_12A VDSL-2 with profile 12A
Parameter type: <Xdsl::GProfile12B>
( dis-g993-2-12b
| g993-2-12b )
Possible values:
- dis-g993-2-12b : disable G.993.2_12B VDSL-2 with
profile 12B
- g993-2-12b : G.993.2_12B VDSL-2 with profile 12B
Parameter type: <Xdsl::GProfile17A>
( dis-g993-2-17a
| g993-2-17a )
Possible values:
- dis-g993-2-17a : disable G.993.2_17A VDSL-2 with
profile 17A
- g993-2-17a : G.993.2_17A VDSL-2 with profile 17A
Parameter type: <Xdsl::GProfile30A>
( dis-g993-2-30a
| g993-2-30a )
Possible values:
- dis-g993-2-30a : disable G.993.2_30A VDSL-2 with
profile 30A
- g993-2-30a : G.993.2_30A VDSL-2 with profile 30A
Parameter type: <Xdsl::SignedIntegerDBHZ>
- a power spectral density value
- unit: 1/10 dbm/hz
Parameter type: <Xdsl::PowerMgtState>
( l0

VDSL-2 with profile 8B


This element is only shown in
detail mode.

VDSL-2 with profile 8C


This element is only shown in
detail mode.

VDSL-2 with profile 8D


This element is only shown in
detail mode.

VDSL-2 with profile 12A


This element is only shown in
detail mode.

VDSL-2 with profile 12B


This element is only shown in
detail mode.

VDSL-2 with profile 17A


This element is only shown in
detail mode.

VDSL-2 with profile 30A


This element is only shown in
detail mode.

avg transmit power spectrum


density over used carriers
This element is always shown.
actual power management state
of the line

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

per-bnd-lp-att-up

pr-bnd-sgn-att-up

pr-bnd-nois-mg-up

high-freq-up

elect-length

time-adv-corr

actual-tps-tc-mode

actual-ra-mode-up

3HH-04416-EBAA-TCZZA 01

Type

Description

| l2
| l3 )
Possible values:
- l0 : full transmission
- l2 : downstream net data rate is reduced
- l3 : no transmission
Parameter type: <Xdsl::PerBandOperDataType>
- printable string
- length: 10

This element is always shown.

loop attenuation for each


upstream band in case of VDSL2
This element is only shown in
detail mode.
Parameter type: <Xdsl::PerBandOperDataType>
signal attenuation for each
- printable string
upstream band in case of VDSL2
- length: 10
This element is only shown in
detail mode.
Parameter type: <Xdsl::PerBandOperDataType>
noise margin for each upstream
- printable string
band in case of VDSL2
- length: 10
This element is only shown in
detail mode.
Parameter type: <Xdsl::HighFreqType>
highest carrier frequency used in
- a frequency
the upstream direction in case of
- unit: kHz
VDSL2
This element is only shown in
detail mode.
Parameter type: <Xdsl::ElectrLengthType>
Line Electrical Length actually
( no-operational-data
used by XTU-C when mode is
| <Xdsl::ElectrLengthType> )
VDSL2
Possible values:
This element is only shown in
- no-operational-data : The value specifies that this detail mode.
parameter is not supported when ELE-M1 is used
Field type <Xdsl::ElectrLengthType>
- electrical length
- unit: 1/2 * dB @ 1MHz
- range: [0...255]
Parameter type: <Xdsl::TimingAdvanceType>
the timing advance of transmitted
- a time value
symbol with respect to the
- unit: ns * 10
received symbol when mode is
- range: [-25000...25000]
VDSL-2
This element is only shown in
detail mode.
Parameter type: <Xdsl::ActualTpsTcMode>
actual transfer mode
( no-value
This element is only shown in
| atm
detail mode.
| ptm
| system-default )
Possible values:
- no-value : no value
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type
Parameter type: <Xdsl::ActualRaMode>
actual ra mode for upstream in
( no-value
case of VDSL2
| operator-ctrld
This element is only shown in
| automatic
detail mode.
| dynamic )
Possible values:
- no-value : not supported

Released

1929

66 xDSL Status Commands

name

Type

vect-cpe-type

vect-fallback

vect-legacy-cancel

upbo-aele-mode

upbo-aele-pb-up

upbo-aele-rx-thrs-up

1930

Released

Description

- operator-ctrld : operatorControlledRateAdaptive
- automatic : automaticRateAdaptiveAtStartup
- dynamic : dynamicRateAdaptive
Parameter type: <Xdsl::ActualVectCpeType>
( gvector
| gvect-friendly
| gvect-friendly-dn
| legacy
| unknown )
Possible values:
- gvector : g.vector capable cpe type
- gvect-friendly : full vector friendly cpe type
(downstream/upstream)
- gvect-friendly-dn : vector friendly cpe type downstream
- legacy : legacy cpe type
- unknown : unknown,not suppported cpe type
Parameter type: <Xdsl::ActualVectFallbackState>
( normal-mode
| fallback-mode )
Possible values:
- normal-mode : line is operating using normal profiles
- fallback-mode : line is operating using vectoring fallback
configured profiles
Parameter
type:
<Xdsl::ActualVectLegacyFextCancelMethodDownstream>
( no-legacy-fext-cancel
| method-1
| method-2 )
Possible values:
- no-legacy-fext-cancel : crosstalk cancellation of legacy line
is disabled
- method-1 : method 1 is used to cancel crosstalk of legacy
lines into g.vect lines
- method-2 : method 2 is used to cancel crosstalk of legacy
lines into g.vect lines
Parameter type: <Xdsl::UpboAeleModeUsed>
- the actual electrical length estimation mode used in Aele
Method
- range: [0...3]
Parameter type: <Xdsl::ElectricalLengthTypeUp>
- First two octets represent value for band 0 and specifies
supported range 0..1280 and 2047. Similarly next two octets
represent value for band 1 and so on. Default value 0xFFFF
per band specifies that no data is available.
- unit: 1/10dB
- length: 10
Parameter type: <Xdsl::UpboAEleRxThrsUp>
- the upstream received signal level threshold value used in
AELE.This parameter represents an offset from -100
dBm/Hz
- unit: db
- range: [-64...0,255]

actual operating mode of the cpe


connected to the line
This element is only shown in
detail mode.

actual vectoring fallback stateof


the line
This element is only shown in
detail mode.

method used to cancel crosstalk


from legacy lines into g.vect lines
This element is only shown in
detail mode.

the actual AELE mode of a line


This element is only shown in
detail mode.
the Line Electrical Length
Estimation per band calculated by
the XTU-C when mode is
VDSL2
This element is only shown in
detail mode.
the upstream received signal level
threshold value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.5 xDSL Operational Data Near End Channel


Status Command
Command Description
This command displays the xDSL operational data for the near and of line.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end channel [ (if-index) ]

Command Parameters
Table 66.5-1 "xDSL Operational Data Near End Channel Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.5-2 "xDSL Operational Data Near End Channel Status Command" Display parameters
Specific Information
name

Type

Description

actual-bitrate-up

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

attain-bitrate-up

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

bitrate or expected throughput for


upstream fast or interleaved data
flow
This element is always shown.
maximum attainable bit rate or
expected throughput the modem
can support

3HH-04416-EBAA-TCZZA 01

Released

1931

66 xDSL Status Commands

name

Type

interleave-delay-down

Parameter type: <Xdsl::SignedIntegerMSEC>


- milli-second
- unit: msec

imp-noise-prot-down

Parameter type: <Xdsl::SignedIntegerSYMBOL>


- impulse noise protection
- unit: 1/10 symbols

net-data-rate-rtx-up

Parameter type: <Xdsl::BitRate>


- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::SignedIntegerSYMBOL>
- impulse noise protection
- unit: 1/10 symbols

inp-rein-dn

attain-netrate-rtx-up

Parameter type: <Xdsl::BitRate>


- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::DtuSizeUS>
- dtu size in units of 1/10000 symbols
- range: [0,5000...40000]

prev-bitrate-up

actual-dtusize-up

1932

Released

Description
This element is always shown.
delay caused by the interleaving
and deinterleaving functionality
or delay caused by rtx
functionality
This element is always shown.
actual impulse noise protection or
actual impulse noise protection
against shine when the rtx
functionality is in use.
This element is always shown.
actual net data rate in upstream
direction
This element is only shown in
detail mode.
actual impulse noise protection or
actual impulse noise protection
against rein when the rtx
functionality is in use.
This element is only shown in
detail mode.
maximum attainable net data rate
in upstream direction
This element is only shown in
detail mode.
previous bit rate in upstream
direction
This element is only shown in
detail mode.
actual dtu size in upstream
direction
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.6 xDSL Operational Data Far End Line Status


Command
Command Description
This command displays the xDSL operational data for the line far end.
upbo-aele-pb-dn: Specifies the line Electrical Length Estimation per band calculated by the XTU-R when mode is
VDSL2 and unit is 1/10dB. First two octets represent value for band 0 and specifies supported range 0..1280 and
2047. Similarly next two octets represent value for band 1 and so on. Default value 0xFFFF per band specifies that
no data is available.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end line [ (if-index) ]

Command Parameters
Table 66.6-1 "xDSL Operational Data Far End Line Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.6-2 "xDSL Operational Data Far End Line Status Command" Display parameters
Specific Information
name
rel-cap-occ-down

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::CapacityUtil>


- utilization of the capacity available
- unit: %

ratio of actual bitrate over the


max attainable bitrate
This element is always shown.

Released

1933

66 xDSL Status Commands

name

Type

noise-margin-down
output-power-up
sig-attenuation-down
short name: sig-attn-dn

Description

- range: [0...100]
Parameter type: <Xdsl::NoiseValue>
- a noise value
- unit: 1/10 dB
Parameter type: <Xdsl::OutputPwr>
- a power value
- unit: 1/10 dBm
Parameter type: <Xdsl::SigAttenuation>
- an attenuation value
- unit: 1/10 dB

loop-attenuation-down
short name: loop-attn-dn

Parameter type: <Xdsl::SigAttenuation>


- an attenuation value
- unit: 1/10 dB

xtu-r-opmode

Parameter type: <Xdsl::OpModeTypeLinePreDef>


( ansi-t1413
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2
| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default
| <Xdsl::OpModeType> )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US

1934

Released

current noise margin for the


downstream direction
This element is always shown.
actual aggregate output power for
the upstream carriers
This element is always shown.
diff btw pwr at far-end rx-ver and
tx-ed from near-end
This element is only shown in
detail mode.
diff btw pwr at far-end rx-ver and
tx-ed from near-end over all
sub-carriers
This element is only shown in
detail mode.
bitmap which represents the
operational modes
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

ansi-t1413

etsi-dts

g992-1-a

g992-1-b

g992-2-a

3HH-04416-EBAA-TCZZA 01

Type

Description

mask 1
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A
- default : default value
Field type <Xdsl::OpModeType>
- octet string bitmask defining operational mode
- length: 16
Parameter type: <Xdsl::T1413>
( dis-ansi-t1413
| ansi-t1413 )
Possible values:
- dis-ansi-t1413 : disable ANSI T1.413-1998
- ansi-t1413 : ANSI T1.413-1998
Parameter type: <Xdsl::Etsidts>
( dis-etsi-dts
| etsi-dts )
Possible values:
- dis-etsi-dts : disable ETSI DTS/TM06006
- etsi-dts : ETSI DTS/TM06006
Parameter type: <Xdsl::G21potsnos>
( dis-g992-1-a
| g992-1-a )
Possible values:
- dis-g992-1-a : disable G.992.1 POTS non-overlapped
spectrum
- g992-1-a : G.992.1 POTS non-overlapped spectrum
Parameter type: <Xdsl::G21isdnnos>
( dis-g992-1-b
| g992-1-b )
Possible values:
- dis-g992-1-b : disable G.992.1 ISDN non-overlapped
spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G22potsnos>
( dis-g992-2-a
| g992-2-a )
Possible values:

ANSI T1.413-1998
This element is only shown in
detail mode.

ETSI DTS/TM06006
This element is only shown in
detail mode.

G.992.1 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.1 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.2 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

Released

1935

66 xDSL Status Commands

name

Type

g992-3-a

g992-3-b

g992-3-aj

g992-3-l1

g992-3-l2

g992-3-am

g992-5-a

g992-5-b

1936

Description

- dis-g992-2-a : disable G.992.2 POTS non-overlapped


spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23potsnos>
( dis-g992-3-a
| g992-3-a )
Possible values:
- dis-g992-3-a : disable G.992.3 POTS non-overlapped
spectrum
- g992-3-a : G.992.3 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23isdnnos>
( dis-g992-3-b
| g992-3-b )
Possible values:
- dis-g992-3-b : disable G.992.3 ISDN non-overlapped
spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G23AllDigNos>
( dis-g992-3-aj
| g992-3-aj )
Possible values:
- dis-g992-3-aj : disable G.992.3 all digital mode
non-overlapped spectrum
- g992-3-aj : G.992.3 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G23PotsnosUs1>
( dis-g992-3-l1
| g992-3-l1 )
Possible values:
- dis-g992-3-l1 : disable G.992.3 POTS non-overlapped
spectrum US mask 1
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
Parameter type: <Xdsl::G23PotsNosUs2>
( dis-g992-3-l2
| g992-3-l2 )
Possible values:
- dis-g992-3-l2 : disable G.992.3 POTS non-overlapped
spectrum US mask 2
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
Parameter type: <Xdsl::G23ExtPotsNos>
( dis-g992-3-am
| g992-3-am )
Possible values:
- dis-g992-3-am : disable G.992.3 extended POTS with
non-overlapped spectrum
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
Parameter type: <Xdsl::G25PotsNos>
( dis-g992-5-a
| g992-5-a )
Possible values:
- dis-g992-5-a : disable G.992.5 POTS non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
Parameter type: <Xdsl::G25IsdnNos>

Released

G.992.3 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 1
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 2
This element is only shown in
detail mode.

G.992.3 extended POTS with


non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.5 ISDN non-overlapped

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

g992-5-aj

g992-5-am

g993-2-8a

g993-2-8b

3HH-04416-EBAA-TCZZA 01

Type

Description

( dis-g992-5-b
| g992-5-b )
Possible values:
- dis-g992-5-b : disable G.992.5 ISDN non-overlapped
spectrum
- g992-5-b : G.992.5 ISDN non-overlapped spectrum
Parameter type: <Xdsl::AnsiT1424>
( dis-ansi-t1.424
| ansi-t1.424 )
Possible values:
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
Parameter type: <Xdsl::EtsiTs>
( dis-etsi-ts
| etsi-ts )
Possible values:
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
Parameter type: <Xdsl::ItuG9931>
( dis-itu-g993-1
| itu-g993-1 )
Possible values:
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
Parameter type: <Xdsl::Ieee802.3Ah>
( dis-ieee-802.3ah
| ieee-802.3ah )
Possible values:
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
Parameter type: <Xdsl::G25AllDigNos>
( dis-g992-5-aj
| g992-5-aj )
Possible values:
- dis-g992-5-aj : disable G.992.5 all digital mode
non-overlapped spectrum
- g992-5-aj : G.992.5 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G25ExtPotsNos>
( dis-g992-5-am
| g992-5-am )
Possible values:
- dis-g992-5-am : disable G.992.5 extended POTS
non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
Parameter type: <Xdsl::GProfile8A>
( dis-g993-2-8a
| g993-2-8a )
Possible values:
- dis-g993-2-8a : disable G.993.2_8A VDSL-2 with profile
8A
- g993-2-8a : G.993.2_8A VDSL-2 with profile 8A
Parameter type: <Xdsl::GProfile8B>
( dis-g993-2-8b
| g993-2-8b )
Possible values:

spectrum
This element is only shown in
detail mode.

ansi T1.424
This element is only shown in
detail mode.

ETSI TS 101 270


This element is only shown in
detail mode.

ITU G993-1
This element is only shown in
detail mode.

IEEE 802.3ah
This element is only shown in
detail mode.

G.992.5
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5
extended
POTS
non-overlapped spectrum
This element is only shown in
detail mode.

VDSL-2 with profile 8A


This element is only shown in
detail mode.

VDSL-2 with profile 8B


This element is only shown in
detail mode.

Released

1937

66 xDSL Status Commands

name

Type

g993-2-8c

g993-2-8d

g993-2-12a

g993-2-12b

g993-2-17a

g993-2-30a

actual-psd-up
pr-bnd-lp-att-dn

pr-bnd-sig-att-dn

1938

Description

- dis-g993-2-8b : disable G.993.2_8B VDSL-2 with profile


8B
- g993-2-8b : G.993.2_8B VDSL-2 with profile 8B
Parameter type: <Xdsl::GProfile8C>
( dis-g993-2-8c
| g993-2-8c )
Possible values:
- dis-g993-2-8c : disable G.993.2_8C VDSL-2 with profile
8C
- g993-2-8c : G.993.2_8C VDSL-2 with profile 8C
Parameter type: <Xdsl::GProfile8D>
( dis-g993-2-8d
| g993-2-8d )
Possible values:
- dis-g993-2-8d : disable G.993.2_8D VDSL-2 with profile
8D
- g993-2-8d : G.993.2_8D VDSL-2 with profile 8D
Parameter type: <Xdsl::GProfile12A>
( dis-g993-2-12a
| g993-2-12a )
Possible values:
- dis-g993-2-12a : disable G.993.2_12A VDSL-2 with
profile 12A
- g993-2-12a : G.993.2_12A VDSL-2 with profile 12A
Parameter type: <Xdsl::GProfile12B>
( dis-g993-2-12b
| g993-2-12b )
Possible values:
- dis-g993-2-12b : disable G.993.2_12B VDSL-2 with
profile 12B
- g993-2-12b : G.993.2_12B VDSL-2 with profile 12B
Parameter type: <Xdsl::GProfile17A>
( dis-g993-2-17a
| g993-2-17a )
Possible values:
- dis-g993-2-17a : disable G.993.2_17A VDSL-2 with
profile 17A
- g993-2-17a : G.993.2_17A VDSL-2 with profile 17A
Parameter type: <Xdsl::GProfile30A>
( dis-g993-2-30a
| g993-2-30a )
Possible values:
- dis-g993-2-30a : disable G.993.2_30A VDSL-2 with
profile 30A
- g993-2-30a : G.993.2_30A VDSL-2 with profile 30A
Parameter type: <Xdsl::SignedIntegerDBHZ>
- a power spectral density value
- unit: 1/10 dbm/hz
Parameter type: <Xdsl::PerBandOperDataType>
- printable string
- length: 10
Parameter type: <Xdsl::PerBandOperDataType>
- printable string
- length: 10

Released

VDSL-2 with profile 8C


This element is only shown in
detail mode.

VDSL-2 with profile 8D


This element is only shown in
detail mode.

VDSL-2 with profile 12A


This element is only shown in
detail mode.

VDSL-2 with profile 12B


This element is only shown in
detail mode.

VDSL-2 with profile 17A


This element is only shown in
detail mode.

VDSL-2 with profile 30A


This element is only shown in
detail mode.

avg transmit power spectrum


density over used carriers
This element is always shown.
loop attenuation for each
downstream band in case of
VDSL2
This element is only shown in
detail mode.
loop attenuation for each
downstream band in case of
VDSL2
This element is only shown in

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

pr-bnd-nmgn-dn

Parameter type: <Xdsl::PerBandOperDataType>


- printable string
- length: 10

elect-length-est

time-adv-prp

high-freq-dn

actual-ra-mode-dn

cpecap-recvd

3HH-04416-EBAA-TCZZA 01

Description

detail mode.
loop attenuation for each
downstream band in case of
VDSL2
This element is only shown in
detail mode.
Parameter type: <Xdsl::ElectrLengthType>
Line Electrical Length actually
( no-operational-data
estimated by XTU-R when mode
| <Xdsl::ElectrLengthType> )
is VDSL2
Possible values:
This element is only shown in
- no-operational-data : The value specifies that this detail mode.
parameter is not supported when ELE-M1 is used
Field type <Xdsl::ElectrLengthType>
- electrical length
- unit: 1/2 * dB @ 1MHz
- range: [0...255]
Parameter type: <Xdsl::TimingAdvanceType>
the timing advance of transmitted
- a time value
symbol with respect to the
- unit: ns * 10
received symbol when mode is
- range: [-25000...25000]
VDSL-2
This element is only shown in
detail mode.
Parameter type: <Xdsl::HighFreqType>
highest carrier frequency used in
- a frequency
the downstream direction in case
- unit: kHz
of VDSL2
This element is only shown in
detail mode.
Parameter type: <Xdsl::ActualRaMode>
actual ra mode for downstream in
( no-value
case of VDSL2
| operator-ctrld
This element is only shown in
| automatic
detail mode.
| dynamic )
Possible values:
- no-value : not supported
- operator-ctrld : operatorControlledRateAdaptive
- automatic : automaticRateAdaptiveAtStartup
- dynamic : dynamicRateAdaptive
Parameter type: <Xdsl::VectCpeReceived>
vectoring CPE capabilites are
( no
received from the CPE
| yes
This element is only shown in
| yes
detail mode.
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes
| yes )
Possible values:
- no : Vectoring Cpe Capabilities are not reported
- yes : Vectoring Cpe Capabilities are reported

Released

1939

66 xDSL Status Commands

name

Type

cpecap-gvector

cpecap-gvect-friendly

cpecap-gvect-friend-dn

cpecap-legacy

upbo-aele-pb-dn

upbo-aele-rx-thrs-dn

1940

Released

Description

- yes : Vectoring Cpe Capabilities are reported


- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
- yes : Vectoring Cpe Capabilities are reported
Parameter type: <Xdsl::GvectorCpeShow>
( no
| yes )
Possible values:
- no : not g.vector capable cpe
- yes : g.vector capable cpe
Parameter type: <Xdsl::FullVectFriendlyCpeShow>
( no
| yes )
Possible values:
- no : no full vector friendly (dn/up) cpe
- yes : full vector friendly (dn/up) cpe
Parameter type: <Xdsl::VectFriendlyCpeShow>
( no
| yes )
Possible values:
- no : not vector friendly downstream cpe
- yes : vector friendly downstream cpe
Parameter type: <Xdsl::LegacyCpeShow>
( no
| yes )
Possible values:
- no : no legacy cpe
- yes : legacy cpe
Parameter type: <Xdsl::ElectricalLengthTypeDn>
- First two octets represent value for band 0 and specifies
supported range 0..1280 and 2047. Similarly next two octets
represent value for band 1 and so on. Default value 0xFFFF
per band specifies that no data is available.
- unit: 1/10dB
- length: 10
Parameter type: <Xdsl::UpboAEleRxThrsDn>
- the downstream received signal level threshold value used
in AELE.This parameter represents an offset from -100
dBm/Hz
- unit: db
- range: [-64...0,255]

g.vector capable cpe


This element is only shown in
detail mode.

full g.vector friendly cpe


This element is only shown in
detail mode.

g.vector friendly downstream cpe


This element is only shown in
detail mode.

legacy cpe
This element is only shown in
detail mode.

the Line Electrical Length


Estimation per band calculated by
the XTU-R when mode is
VDSL2
This element is only shown in
detail mode.
the downstream received signal
level threshold value
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.7 xDSL Operational Data Far End Channel


Status Command
Command Description
This command displays the xDSL operational data for the far end of the channel.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end channel [ (if-index) ]

Command Parameters
Table 66.7-1 "xDSL Operational Data Far End Channel Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.7-2 "xDSL Operational Data Far End Channel Status Command" Display parameters
Specific Information
name

Type

Description

actual-bitrate-down
short name: act-br-down

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

attain-bitrate-down
short name: att-br-down

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

bitrate or expected throughput for


downstream fast or interleaved
data flow
This element is always shown.
maximum attainable bit rate or
expected throughput the modem
can support

3HH-04416-EBAA-TCZZA 01

Released

1941

66 xDSL Status Commands

name

Type

interleave-delay-up

Parameter type: <Xdsl::SignedIntegerMSEC>


- milli-second
- unit: msec

imp-noise-prot-up

Parameter type: <Xdsl::SignedIntegerSYMBOL>


- impulse noise protection
- unit: 1/10 symbols

act-l2-bitrt-down
short name: act-l2-br-dn

Parameter type: <Xdsl::Bitrate>


- bitrate
- unit: kbits/sec
- range: [0...65535]
Parameter type: <Xdsl::BitRate>
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::SignedIntegerSYMBOL>
- impulse noise protection
- unit: 1/10 symbols

net-data-rate-rtx-dn

inp-rein-up

attain-netrate-rtx-dn

Parameter type: <Xdsl::BitRate>


- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::BitRate>
- a bit rate value
- unit: kbps
- range: [0...262143]
Parameter type: <Xdsl::DtuSizeDS>
- dtu size in units of 1/10000 symbols
- range: [0,5000...40000]

prev-bitrate-dw

actual-dtusize-down

1942

Released

Description
This element is always shown.
delay caused by the interleaving
and deinterleaving functionality
or delay caused by rtx
functionality
This element is always shown.
actual impulse noise protection or
actual impulse noise protection
against shine when the rtx
functionality is in use
This element is always shown.
actual L2 bitrate when in L2 state
This element is always shown.
actual
net
data
rate
in
downstream direction
This element is only shown in
detail mode.
actual impulse noise protection or
actual impulse noise protection
against rein when the rtx
functionality is in use
This element is only shown in
detail mode.
maximum attainable net data rate
in downstream direction
This element is only shown in
detail mode.
previous bit rate in downstream
direction
This element is only shown in
detail mode.
actual dtu size in downstream
direction
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.8 xDSL Operational Data Statistics


Command Description
This command displays the xDSL operational data statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data line [ (if-index) ]

Command Parameters
Table 66.8-1 "xDSL Operational Data Statistics" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.8-2 "xDSL Operational Data Statistics" Display parameters
Specific Information
name
adm-state

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::ifAdminStatus>


( not-appl
| up
| down
| testing )
Possible values:
- not-appl : not-applicable
- up : admin status is up
- down : admin status is down
- testing : no operational packets can be passed

specifies state of the interface


This element is always shown.

Released

1943

66 xDSL Status Commands

name

Type

Description

opr-state/tx-rate-ds

Parameter type: <Xdsl::combinedCol>


( down
| testing
| unknown
| dormant
| up : <Xdsl::bitrate> )
Possible values:
- up : up,traffic can pass
- down : down,no traffic is passing
- testing : testing,no traffic is passing
- unknown : unknown
- dormant : dormant,no traffic is passing
Field type <Xdsl::bitrate>
- bitrate
- unit: kbits/sec
Parameter type: <Xdsl::SignedIntegerKBPS>
- bitrate
- unit: kbits/sec

current operational state of the


interface.
This element is always shown.

tx-rate/us

tx-rate/ds

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

max-tx-rate-us

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

max-tx-rate-ds

Parameter type: <Xdsl::SignedIntegerKBPS>


- bitrate
- unit: kbits/sec

inp-up

Parameter type: <Xdsl::SignedIntegerSYMBOL>


- impulse noise protection
- unit: 1/10 symbols
Parameter type: <Xdsl::SignedIntegerSYMBOL>
- impulse noise protection
- unit: 1/10 symbols
Parameter type: <Xdsl::SignedIntegerMSEC>
- milli-second
- unit: msec

inp-dn
interl-us

interl-ds

Parameter type: <Xdsl::SignedIntegerMSEC>


- milli-second
- unit: msec

cur-op-mode

Parameter type: <Xdsl::OneOpModeTypeLinePreDef>


( ansi-t1413
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a

1944

Released

bitrate or expected throughput for


upstream fast or interleaved data
flow
This element is always shown.
bitrate or expected throughput for
downstream fast or interleaved
data flow
This element is always shown.
maximum attainable bit rate or
expected throughput the modem
can support
This element is only shown in
detail mode.
maximum attainable bit rate or
expected throughput the modem
can support
This element is only shown in
detail mode.
actual impulse noise protection
This element is only shown in
detail mode.
actual impulse noise protection
This element is only shown in
detail mode.
delay caused by the interleaving
and deinterleaving functionality
or delay caused by the rtx
functionality
This element is only shown in
detail mode.
delay caused by the interleaving
and deinterleaving functionality
or delay caused by the rtx
functionality
This element is only shown in
detail mode.
actual operational mode
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

Description

| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2
| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A

3HH-04416-EBAA-TCZZA 01

Released

1945

66 xDSL Status Commands

name

Type

rinit-1d

- default : default value


Parameter type: <Counter>
- 32 bit counter

actual-tps-tc-mode

Parameter type: <Xdsl::ActualTpsTcMode>


( no-value
| atm
| ptm
| system-default )
Possible values:
- no-value : no value
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type
Parameter type: <Xdsl::ActualRtxModeType>
( in-use
| forbidden
| no-xtuc
| no-xtur
| no-xtuc-xtur
| supported
| unknown )
Possible values:
- in-use : retransmission in use
- forbidden : retransmission not_in_use forbidden
- no-xtuc : retransmission not_in_use and not_supported for
xtuc
- no-xtur : retransmission not_in_use and not_supported for
xtur
- no-xtuc-xtur : retransmission not_in_use and
not_supported for xtuc and xtur
- supported : retransmission not selected but supported
- unknown : retransmission not supported
Parameter type: <Xdsl::ActualRtxModeType>
( in-use
| forbidden
| no-xtuc
| no-xtur
| no-xtuc-xtur
| supported
| unknown )
Possible values:
- in-use : retransmission in use
- forbidden : retransmission not_in_use forbidden
- no-xtuc : retransmission not_in_use and not_supported for
xtuc
- no-xtur : retransmission not_in_use and not_supported for
xtur
- no-xtuc-xtur : retransmission not_in_use and
not_supported for xtuc and xtur
- supported : retransmission not selected but supported
- unknown : retransmission not supported

rtx-mode-up

rtx-mode-dn

1946

Description

Released

number of times the modem


re-initialize the line in a day
This element is only shown in
detail mode.
actual transfer mode
This element is only shown in
detail mode.

actual retransmission mode in


upstream direction
This element is only shown in
detail mode.

actual retransmission mode in


downstream direction
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.9 xDSL Carrier Data Near End Status Command


Command Description
This command displays xDSL carrier data near end.
Carrier data is displayed in raw format so the actual data interpretation is described in this section.
The XDSL passband (downstream or upstream) is composed of one or more bands (max 5, including VDSL
optional band). Each carrier is coded as a bitmap. When the data are not available because the measurement is not
completed, not enabled or not supported, an empty string will be returned. Below is the definition of the carrier
specific bitmap.
Carrier load (Load-distribution-down) : When the modem is not in showtime this object will have the previously
measured value. Each carrier can carry up to 15 bits. The carrier load is coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER (0..4096), index of the start carrier group of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the stop carrier group of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTET 4: contains the bit load of the first two carrier groups of the band. The load of the first carrier group
uses the most significant 4 bits nibble. Range is 0-15 bits per carrier group, with a granularity of 1 bit/carrier
group.
OCTETS 5..L: and so on, up to the last carrier group of the first downstream band. The last nibble of OCTET L
is set to 0x0 if not used.
OCTETS L+1..M: contain the start/stop carrier groups and the carrier load of the second downstream band
when available.
OCTETS M+1..N: contain the start/stop carrier groups and the carrier load of the third downstream band
when available.
OCTETS N+1..P: contain the start/stop carrier groups and the carrier load of the fourth downstream band
when available.
OCTETS P+1..Q: contain the start/stop carrier groups and the carrier load of the fifth downstream band when
available.
Carrier gain (gain-allocation-down) : When the modem is not in showtime this object will have the previously
measured value. The gain has a range of approximately 0 - 8, in steps of 1/512. The gain value is represented as
gi/512 on a linear scale with gi a 12 bits unsigned integer in the 0 to 4095 range given by the 12 LSB bits of a 2
bytes integer. The carrier gain allocation is coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER (0..4096), index of the start carrier group of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the stop carrier group of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 4,5: INTEGER, contains the gain of the first carrier group of the band (start carrier group).
OCTETS 6..L: and so on until the last carrier group of the first downstream band (stop carrier group).
OCTETS L+1..M: contain the start/stop carrier groups and the carrier gain of the second downstream band
when available.
OCTETS M+1..N: contain the start/stop carrier groups and the carrier gain of the third downstream band
when available.
OCTETS N+1..P: contain the start/stop carrier groups and the carrier gain of the fourth downstream band
when available.
OCTETS P+1..Q: contain the start/stop carrier groups and the carrier gain of the fifth downstream band when
available.
Carrier snr (snr-up): When the modem is not in showtime this object will have the previously measured value. The
SNR has a range from -32 to 95 dB in steps of 0.5 dB. It is represented as SNRi = -32 + snri/2, with snri an 8 bit
unsigned integer in the range 0 to 254. The special value 255 indicates that no measurement is available for the

3HH-04416-EBAA-TCZZA 01

Released

1947

66 xDSL Status Commands

carrier or that the measurement is out of range. The carrier snrs are coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, contains the number of symbols used to measure the data. The value is defined as
MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the start carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 4,5: INTEGER (0..4096), index of the stop carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6: INTEGER, contains the snr of the first carrier group of the band (start carrier group).
OCTETS 7..L: and so on until the last carrier group of the first upstream band (stop carrier group).
OCTETS L+1..M: contain the start/stop carrier groups and the carrier snr of the second upstream band when
available.
OCTETS M+1..N: contain the start/stop carrier groups and the carrier snr of the third upstream band when
available.
OCTETS N+1..P: contain the start/stop carrier groups and the carrier snr of the fourth upstream band when
available.
OCTETS P+1..Q: contain the start/stop carrier groups and the carrier snr of the fifth upstream band when
available.
Carrier qln (qln-up): The QLN has a range from -150 dBm/Hz to -23 dBm/Hz in steps of 0.5 dB. It is represented
as QLNi = -23 - qlni/2, with qlni an 8 bit unsigned integer in the range 0 to 254. The special value 255 indicates
that no measurement is available for the carrier or that the measurement is out of range. The carrier qlns are
coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, contains the number of symbols used to measure the data. The value is defined as
MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the start carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 4,5: INTEGER (0..4096), index of the stop carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6: INTEGER, contains the qln of the first carrier group of the band (start carrier group).
OCTETS 7..L: and so on until the last carrier group of the first upstream band (stop carrier group).
OCTETS L+1..M: contain the start/stop carrier groups and the carrier qln of the second downstream band
when available.
OCTETS M+1..N: contain the start/stop carrier groups and the carrier qln of the third upstream band when
available.
OCTETS N+1..P: contain the start/stop carrier groups and the carrier qln of the fourth upstream band when
available.
OCTETS P+1..Q: contain the start/stop carrier groups and the carrier qln of the fifth upstream band when
available.
Carrier HLIN (char-func-complex): HLIN has a range of approximately +6 dB to -90 dB, with a granularity of
2^-15. The Hlin is represented as HLINi = (scale/2^15)*((ai+j*bi)/2^15), with ai and bi 2 bytes signed integers in
the range -32767 to 32767. The special value -32768 indicates that no measurement is available for the carrier or
that the measurement is out of range. The scale factor is a 2 bytes unsigned integer. The scale factor must be
chosen such that: max(|Ai|,|Bi|) over all i is equal to 2^15-1, i.e. over all carriers of the XDSL band(s) of the
corresponding direction. The carrier HLINs are coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, contains the number of symbols used to measure the data. The value is defined as
MSB-LSB (big-endian).
OCTETS 2,3: INTEGER(0..65535), contains the scale factor to apply to the hlin values, over the upstream
band(s). The value is defined as MSB-LSB (big-endian).
OCTETS 4,5: INTEGER (0..4096), index of the start carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6,7: INTEGER (0..4096), index of the stop carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 8,9: SIGNED INTEGER , contains the ai for the first carrier group of the band (start carrier group).
The value is defined as MSB-LSB (big-endian).
OCTETS 10,11: SIGNED INTEGER , contains the bi for the first carrier group of the band (start carrier
group). The value is defined as MSB-LSB (big-endian).
OCTETS 12..L: ai and bi for the next carrier group and so on until the last carrier group of the first upstream
band (stop carrier group).

1948

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

OCTETS L+1..M: contain the start/stop carrier groups and the HLIN ai and bi of the second upstream band
when available.
OCTETS M+1..N: contain the start/stop carrier groups and the HLIN ai and bi of the third upstream band
when available.
OCTETS N+1..P: contain the start/stop carrier groups and the HLIN ai and bi of the fourth upstream band
when available.
OCTETS P+1..Q: contain the start/stop carrier groups and the HLIN ai and bi of the fifth upstream band when
available.

Carrier HLOG (char-func-real): Hlog has a range of approximately +6 dB to -96 dB in steps of 0.1 dB. The Hlog
is represented as HLOGi = 6 - mi/10, with mi a 10 bits unsigned integer in the range 0 to 1022. The special value
1023 indicates that no measurement is available for the carrier or that the measurement is out of range. The
carrier HLOGs are coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, contains the number of symbols used to measure the data. The value is defined as
MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the start carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 4,5: INTEGER (0..4096), index of the stop carrier group of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6,7: INTEGER (0..1023), contains the HLOG mi of the first carrier group of the band (start carrier
group). The value is defined as MSB-LSB (big-endian).
OCTETS 8..L: mi for the next carrier group and so on until the last carrier group of the first upstream band
(stop carrier group).
OCTETS L+1..M: contain the start/stop carrier groups and the HLOG mi of the second upstream band when
available.
OCTETS M+1..N: contain the start/stop carrier groups and the HLOG mi of the third upstream band when
available.
OCTETS N+1..P: contain the start/stop carrier groups and the HLOG mi of the fourth upstream band when
available.
OCTETS P+1..Q: contain the start/stop carrier groups and the HLOG mi of the fifth upstream band when
available.
Carrier Tx PSD (tx-psd-dn): When the modem is not in showtime this object will have the previously measured
value. The PSD has a range from -127 dBm/Hz to 0 dBm/Hz in steps of 0.5 dB. It is represented as PSDi = - psdi/2,
with psdi an 8 bit unsigned integer in the range 0 to 254. The special value 255 indicates that no measurement is
available for the carrier, the carrier is not loaded, or that the measurement is out of range. The carrier Tx PSD is
coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER (0..4096), index of the start carrier group of the downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 2,3: INTEGER (0..4096), index of the stop carrier group of the downstream band. The value is defined
as MSB-LSB (big-endian).
OCTET 4: INTEGER(0..255), PSD of the first carrier group of the band (start carrier group).
OCTETS 5..L: and so on until the last carrier group of the first downstream band (stop carrier group).
OCTETS L+1..M: contain the start/stop carrier groups and the carrier PSD of the second downstream band
when available.
OCTETS M+1..N: contain the start/stop carrier groups and the carrier PSD of the third downstream band
when available.
OCTETS N+1..P: contain the start/stop carrier groups and the carrier PSD of the fourth downstream band
when available.
OCTETS P+1..Q: contain the start/stop carrier groups and the carrier PSD of the fifth downstream band when
available.

User Level
The command can be accessed by operators with xdsl privileges.

3HH-04416-EBAA-TCZZA 01

Released

1949

66 xDSL Status Commands

Command Syntax
The command has the following syntax:
> show xdsl carrier-data near-end [ (if-index) ]

Command Parameters
Table 66.9-1 "xDSL Carrier Data Near End Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.9-2 "xDSL Carrier Data Near End Status Command" Display parameters
Specific Information
name
spacing

load-distribution-down

Type

Description

Parameter type: <Xdsl::CarrierSpacingType>


( single
| double
| half
| quarter )
Possible values:
- single : single
- double : double
- half : half
- quarter : quarter
Parameter type: <Xdsl::OctetStingType>
- a binary string

the actual carrier spacing used on


the XDSL line in the downstream
direction
This element is always shown.

gain-allocation-down

Parameter type: <Xdsl::OctetStingType>


- a binary string

snr-up

Parameter type: <Xdsl::OctetStingType>


- a binary string

qln-up

Parameter type: <Xdsl::OctetStingType>


- a binary string

char-func-complex

Parameter type: <Xdsl::OctetStingType>


- a binary string

1950

Released

nbr of bits per carrier group over


the downstream passband
This element is always shown.
gain allocation (i.e. gi) per carrier
group over the downstream
passband
This element is always shown.
signal to noise ratio per carrier
group
over
the
upstream
passband
This element is always shown.
quiet line noise per carrier group
over the upstream passband
This element is always shown.
provides
the
channel
characteristics function complex

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

char-func-real

Parameter type: <Xdsl::OctetStingType>


- a binary string

tx-psd-dn

Parameter type: <Xdsl::OctetStingType>


- a binary string

tx-psd-carr-grop

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

load-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]
Parameter type: <Xdsl::SubCarrierGroupSizeType>
- grouping factor per carrier data octet-string
- range: [1...2,4,8]

gain-carr-grp

snr-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

qln-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]
Parameter type: <Xdsl::SubCarrierGroupSizeType>
- grouping factor per carrier data octet-string
- range: [1...2,4,8]

hlin-carr-grp

hlog-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

vect-qln-mode-up

Parameter type: <Xdsl::ActualQlnMode>


( with-cancel
| without-cancel
| unknown )
Possible values:
- with-cancel : with xtalk cancellation
- without-cancel : without xtalk cancellation
- unknown : qln reporting mode not known

3HH-04416-EBAA-TCZZA 01

Description
values in linear scale for each
carrier group over upstream
passband (hlin)
This element is always shown.
char func real values in dB over
upstream passband (hlog)
This element is always shown.
the actual transmit PSD per
carrier
group
over
the
downstream passband
This element is always shown.
the grouping factor for Actual Tx
Power Spectrum Density carrier
data octet-string
This element is always shown.
Provides the grouping factor for
carrier load data octet-string
This element is always shown.
Provides the grouping factor for
carrier gain allocation data
octet-string
This element is always shown.
Provides the grouping factor for
Signal to Noise Ratio per carrier
data octet-string
This element is always shown.
Provides the grouping factor for
Quiet Line Noise data octet-string
This element is always shown.
Provides the grouping factor for
Complex Channel Characteristics
data in linear scale
This element is always shown.
Provides the grouping factor for
Channel Characteristics data in
dB
This element is always shown.
actual reported line carrier data
quiet line noise
This element is only shown in
detail mode.

Released

1951

66 xDSL Status Commands

66.10 xDSL Carrier Data Far End Status Command


Command Description
This command displays xDSL carrier data far end.
Each carrier is coded as a bitmap. For more details related to : the bitmap definition and the description of ranges,
specific values,.. of the carriers, we refer to the command description section of the "xDSL Carrier Data Near End
Status Command" section. When reading this in scope of "Far End", "downstream" becomes "upstream" and vice
versa.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl carrier-data far-end [ (if-index) ]

Command Parameters
Table 66.10-1 "xDSL Carrier Data Far End Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.10-2 "xDSL Carrier Data Far End Status Command" Display parameters
Specific Information
name
spacing

1952

Released

Type

Description

Parameter type: <Xdsl::CarrierSpacingType>


( single
| double
| half
| quarter )
Possible values:

the actual carrier spacing used on


the XDSL line in the upstream
direction
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

load-distribution-up

Type
- single : single
- double : double
- half : half
- quarter : quarter
Parameter type: <Xdsl::OctetStingType>
- a binary string

gain-allocation-up

Parameter type: <Xdsl::OctetStingType>


- a binary string

snr-down

Parameter type: <Xdsl::OctetStingType>


- a binary string

qln-down

Parameter type: <Xdsl::OctetStingType>


- a binary string

char-func-complex

Parameter type: <Xdsl::OctetStingType>


- a binary string

char-func-real

Parameter type: <Xdsl::OctetStingType>


- a binary string

tx-psd-up

Parameter type: <Xdsl::OctetStingType>


- a binary string

tx-psd-carr-grop

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

load-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]
Parameter type: <Xdsl::SubCarrierGroupSizeType>
- grouping factor per carrier data octet-string
- range: [1...2,4,8]

gain-carr-grp

snr-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

qln-carr-grp

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]
Parameter type: <Xdsl::SubCarrierGroupSizeType>
- grouping factor per carrier data octet-string
- range: [1...2,4,8]

hlin-carr-grp

hlog-carr-grp

3HH-04416-EBAA-TCZZA 01

Parameter type: <Xdsl::SubCarrierGroupSizeType>


- grouping factor per carrier data octet-string
- range: [1...2,4,8]

Description

nbr of bits per carrier group over


the upstream passband
This element is always shown.
gain allocation (i.e.gi) per carrier
group
over
the
upstream
passband
This element is always shown.
signal to noise ratio per carrier
group over the downstream
passband
This element is always shown.
quiet line noise per carrier group
over the downstream passband
This element is always shown.
provides
the
channel
characteristics function complex
values in linear scale per carrier
group over downstream passband
(hlin)
This element is always shown.
char func real values in dB over
downstream passband (hlog)
This element is always shown.
the actual transmit PSD per
carrier group over the upstream
passband
This element is always shown.
the grouping factor for Actual Tx
Power Spectrum Density carrier
data octet-string
This element is always shown.
Provides the grouping factor for
carrier load data octet-string
This element is always shown.
Provides the grouping factor for
carrier gain allocation data
octet-string
This element is always shown.
Provides the grouping factor for
Signal to Noise Ratio per carrier
data octet-string
This element is always shown.
Provides the grouping factor for
Quiet Line Noise data octet-string
This element is always shown.
Provides the grouping factor for
Complex Channel Characteristics
data in linear scale
This element is always shown.
Provides the grouping factor for
Channel Characteristics data in
dB
This element is always shown.

Released

1953

66 xDSL Status Commands

name

Type

Description

vect-qln-mode-down

Parameter type: <Xdsl::ActualQlnMode>


( with-cancel
| without-cancel
| unknown )
Possible values:
- with-cancel : with xtalk cancellation
- without-cancel : without xtalk cancellation
- unknown : qln reporting mode not known

actual reported line carrier data


quiet line noise
This element is only shown in
detail mode.

1954

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.11 xDSL Failure Status Near End Status


Command
Command Description
This command displays the xDSL failure status near end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status near-end [ (if-index) ]

Command Parameters
Table 66.11-1 "xDSL Failure Status Near End Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.11-2 "xDSL Failure Status Near End Status Command" Display parameters
Specific Information
name
line-defect

los

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::FailureStatusNearEnd>


( yes
| no )
Possible values:
- yes : defect in the near-end failure sta tus
- no : no defect in the near-end failure s tatus
Parameter type: <Xdsl::FailureStatusNELOS>

specifies the defect status in the


near-end
This element is always shown.

specifies status of the Loss of

Released

1955

66 xDSL Status Commands

name

lof

lom

lpr

ese

act-fail-conf-err

act-fail-conf-not-feas

bitrate-threshold

tpstc-mismatch

forced-rtx-init-fail

1956

Released

Type

Description

( no
| yes )
Possible values:
- no : no LOS in upstream direction
- yes : LOS in the upstream direction
Parameter type: <Xdsl::FailureStatusNELOF>
( no
| yes )
Possible values:
- no : no LOF in upstream direction
- yes : LOF in the upstream direction
Parameter type: <Xdsl::FailureStatusNELOM>
( no
| yes )
Possible values:
- no : no LOM in upstream direction
- yes : LOM in the upstream direction
Parameter type: <Xdsl::FailureStatusNELPR>
( no
| yes )
Possible values:
- no : no LPR of the ATU-C
- yes : LPR of the ATU-C
Parameter type: <Xdsl::FailureStatusNEESE>
( no
| yes )
Possible values:
- no : no ESE in upstream direction
- yes : ESE in the upstream direction
Parameter type: <Xdsl::NEActFailConfErr>
( no
| yes )
Possible values:
- no : no Activation Failure due to configuration error
- yes : Line Activation Fail due to configuration error
Parameter type: <Xdsl::NEActFailConfNotFeasible>
( no
| yes )
Possible values:
- no : Line Activation Fail due to configuration not feasible
- yes : no Activation Failure due to configuration not
feasible
Parameter type: <Xdsl::FailureStatusNEBitRateThrs>
( no-low-rate
| low-rate )
Possible values:
- no-low-rate : no Bit rate threshold for the upstream
direction
- low-rate : Bit rate threshold for upstream direction
Parameter type: <Xdsl::FailureStatusNETpstcMism>
( no
| yes )
Possible values:
- no : no TpsTc mismatch is detected
- yes : a TpsTc mismatch is detected
Parameter type: <Xdsl::FailureStatusNERtxInitFail>
( no

Signal in upstream direction


This element is always shown.

specifies status of the Loss of


Frame in upstream direction
This element is always shown.

specifies status of the Loss of


Margin in upstream direction
This element is always shown.

specifies status of the Loss of


Power of the ATU-C
This element is always shown.

specifies status of the Excessive


Severe Errors in upstream
direction
This element is always shown.
specifies status of line Activation
This element is always shown.

specifies status of line Activation


This element is always shown.

specifies status of Bit Rate


Threshold
This element is always shown.

indicates a Tpstc mismatch


This element is always shown.

specifies
status
of
line
initialisation when forced RTX

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

vect-dle

act-fail-err-code
act-fail-err-descr

3HH-04416-EBAA-TCZZA 01

Type

Description

| yes )
Possible values:
- no : No line initialisation failure due to forced Rtx request
- yes : Line Initialisation failure due to forced Rtx request
Parameter type: <Xdsl::FailureStatusNEDLE>
( yes
| no )
Possible values:
- yes : loss of us signal due to disorderly leaving event
- no : no disorderly leaving detected
Parameter type: <SignedInteger>
- a signed integer
Parameter type: <Xdsl::IgnoredPrintableString>
- ignored printable string

This element is always shown.

counter for disorderly leaving


failure events
This element is always shown.

activation failure error code


This element is always shown.
activation
failure
error
description
This element is only shown in
detail mode.

Released

1957

66 xDSL Status Commands

66.12 xDSL Failure Status Far End Status


Command
Command Description
This command displays the xDSL failure of the far end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status far-end [ (if-index) ]

Command Parameters
Table 66.12-1 "xDSL Failure Status Far End Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.12-2 "xDSL Failure Status Far End Status Command" Display parameters
Specific Information
name
line-defect

los

1958

Released

Type

Description

Parameter type: <Xdsl::FailureStatusNoDefect>


( yes
| no )
Possible values:
- yes : defect in the far-end failure status
- no : no defect in the far-end failure status
Parameter type: <Xdsl::FailureStatusFELOS>

specifies the defect status in the


far-end
This element is always shown.

specifies status of the Loss of

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

lof

lom

lpr

lol

ese

act-fail-comm-prob

act-fail-no-xtu-r

bitrate-threshold

upbo-vio

3HH-04416-EBAA-TCZZA 01

Type

Description

( no
| yes )
Possible values:
- no : no LOS in downstream direction
- yes : LOS in the downstream direction
Parameter type: <Xdsl::FailureStatusFELOF>
( no
| yes )
Possible values:
- no : no LOF in downstream direction
- yes : LOF in the downstream direction
Parameter type: <Xdsl::FailureStatusFELOM>
( no
| yes )
Possible values:
- no : no LOM in downstream direction
- yes : LOM in the downstream direction
Parameter type: <Xdsl::FailureStatusFELPR>
( no
| yes )
Possible values:
- no : no LPR of the XTU-R
- yes : LPR of the XTU-R
Parameter type: <Xdsl::FailureStatusFELOL>
( no
| yes )
Possible values:
- no : no LOL in line
- yes : LOL in line
Parameter type: <Xdsl::FailureStatusFEESE>
( no
| yes )
Possible values:
- no : no ESE in downstream direction
- yes : ESE in the downstream direction
Parameter type: <Xdsl::FEActFailCommProb>
( no
| yes )
Possible values:
- no : no Activation Failure due to communication problems
- yes : Line Activation Fail due to communication problems
Parameter type: <Xdsl::FEActFailNoXTUR>
( no
| yes )
Possible values:
- no : Line Activation Fail due to no XTU-R detected
- yes : no Activation Failure due to no XTU-R detected
Parameter type: <Xdsl::FailureStatusFEBitRateThrs>
( no-low-rate
| low-rate )
Possible values:
- no-low-rate : no Bit rate threshold for the downstream
direction
- low-rate : Bit rate threshold for downstream direction
Parameter type: <Xdsl::FailureStatusFEUPBOViolate>
( no
| yes )

Signal in downstream direction


This element is always shown.

specifies status of the Loss of


Frame in downstream direction
This element is always shown.

specifies status of the Loss of


Margin in downstream direction
This element is always shown.

specifies status of the Loss of


Power of the XTU-C
This element is always shown.

specifies status of the Loss of


Link
This element is always shown.

specifies status of the Excessive


Severe Errors
This element is always shown.

specifies status of line Activation


This element is always shown.

specifies status of line Activation


This element is always shown.

specifies status of Bit Rate


Threshold
This element is always shown.

specifies far end UPBO violation


status
This element is always shown.

Released

1959

66 xDSL Status Commands

name

Type

cpe-pol

act-fail-err-code
act-fail-err-descr

1960

Description

Possible values:
- no : no far end UPBO violation
- yes : far end UPBO violation
Parameter type: <Xdsl::FailureStatusFECPEPolicing>
( no
| yes )
Possible values:
- no : no activation failure due to CPE policing
- yes : activation failure due to CPE policing
Parameter type: <SignedInteger>
- a signed integer
Parameter type: <Xdsl::IgnoredPrintableString>
- ignored printable string

Released

specifies Activation Failure status


due to CPE policing
This element is always shown.

activation failure error code


This element is always shown.
activation
failure
error
description
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.13 xDSL Vectored Line Failure Status Command


Command Description
This command displays the xDSL vectored line failure status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status vect-line-near-end [ (if-index) ]

Command Parameters
Table 66.13-1 "xDSL Vectored Line Failure Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.13-2 "xDSL Vectored Line Failure Status Command" Display parameters
Specific Information
name
xtc-variation-vict

xtc-variation-dist

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::FailureStatusXTCVARVICT>


specifies status of excessive
( excessive
victim
crosstalk
coefficient
| normal )
variation
Possible values:
This element is always shown.
- excessive : abnormal amplitude variation in xtc
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Xdsl::FailureStatusXTCVARDIST>
specifies status of excessive
( excessive
disturber crosstalk coefficient
| normal )
variation

Released

1961

66 xDSL Status Commands

name

corrupted-errf

vect-cpe-cap-mismatch

vect-conf-not-feas

1962

Released

Type

Description

Possible values:
- excessive : abnormal amplitude variation in xtc
coefficients
- normal : no excessive xtc coefficients variation
Parameter type: <Xdsl::FailureStatusCorpERRF>
( yes
| no )
Possible values:
- yes : at least 10% corrupted or missing errorf samples
received
- no : received errorf samples ok
Parameter type: <Xdsl::FailureStatusVectCpeCapMism>
( yes
| no )
Possible values:
- yes : not allowed Vectoring CPE connected
- no : allowed Vectoring CPE connected
Parameter type: <Xdsl::FailureStatusVectConfigNotFeas>
( yes
| no )
Possible values:
- yes : Vectoring Configuration Not Feasable
- no : Vectoring Configuration Feasable

This element is always shown.

specifies status of received


corrupted errorf samples
This element is always shown.

specifies if an allowed Vectoring


CPE is connected or not
This element is always shown.

specifies
if
the
vectoring
configuration is feasable
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.14 xDSL Vectoring Board Failure Status


Command
Command Description
This command displays the xDSL vectoring board failure status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status vect-board [ (board-index) ]

Command Parameters
Table 66.14-1 "xDSL Vectoring Board Failure Status Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

interface index of the board

Command Output
Table 66.14-2 "xDSL Vectoring Board Failure Status Command" Display parameters
Specific Information
name
vp-lt-mismatch

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::FailureStatusVPLTMISM>


( yes
| no )
Possible values:
- yes : mismatch between expected and actual vp-lt mapping
or incompatible sw version on vp and lt.
- no : expected and actual vp-lt in line or vp and lt have

specifies failure status of vp and


its expected connected lt's OR
incompatible sw versions. In case
vplt-autodiscovery disabled on
vp, failure reported on vp-board.
In
case
vplt-autodiscovery
enabled on lt, failure reported on

Released

1963

66 xDSL Status Commands

name
qsfp-id

vp-lt-link

1964

Released

Type

Description

compatible sw versions OR autodiscovery enabled on vp,


autodiscovery disabled on lt
Parameter type: <Xdsl::FailureStatusINVQSFP>
( invalid
| valid )
Possible values:
- invalid : QSFP does not have a valid Alcatel-Lucent ID
- valid : QSFP has a valid Alcatel-Lucent ID or no QSFP
detected or not applicable.
Parameter type: <Xdsl::FailureStatusVPLTLINKFAIL>
( linkdown
| linkup )
Possible values:
- linkdown : vp-lt link problem
- linkup : vp-lt link ok or no lt-expected OR autodiscovery
enabled on vp, autodiscovery disabled on lt

lt-board.
This element is always shown.
specifies the failure status of the
detected qsfp-id of the frontcable
This element is always shown.

specifies the failure status of the


VP-LT
Link.
In
case
vplt-autodiscovery disabled on
vp, failure reported on vp-board
when an lt was expected but no
valid connection between vp-lt.
In
case
vplt-autodiscovery
enabled on lt, failure reported on
lt-board
when
no
valid
connection between vp-lt.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.15 xDSL Counters Near End Line Current 15 Min


Command Description
This command displays xDSL counters near end line current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-interval [ (if-index) ]

Command Parameters
Table 66.15-1 "xDSL Counters Near End Line Current 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.15-2 "xDSL Counters Near End Line Current 15 Min" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>

number of occurences of an LOS


failure event
This element is always shown.
number of occurences of an LOF
failure event
This element is always shown.
number of occurences of a LOM
failure event
This element is always shown.
number of occurences of an ESE

3HH-04416-EBAA-TCZZA 01

Released

1965

66 xDSL Status Commands

name

Type

Description

- 32 bit counter

failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
number of times the modem
re-initialize the line
This element is always shown.
number of times the modem
failed to initialize the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

re-init

Parameter type: <Counter>


- 32 bit counter

failed-init

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

dle

Parameter type: <Counter>


- 32 bit counter

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

init-count

1966

Released

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
minimum error free throughput
observed
This element is always shown.
counter for disorderly leaving
failure events
This element is always shown.
forward error correction second
This element is always shown.
full init counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.16 xDSL Counters Near End Line Current Day


Command Description
This command displays the xDSL counters near end line current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-1day [ (if-index) ]

Command Parameters
Table 66.16-1 "xDSL Counters Near End Line Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.16-2 "xDSL Counters Near End Line Current Day" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>

number of occurences of an LOS


failure event
This element is always shown.
number of occurences of an LOF
failure event
This element is always shown.
number of occurences of a LOM
failure event
This element is always shown.
number of occurences of an ESE

3HH-04416-EBAA-TCZZA 01

Released

1967

66 xDSL Status Commands

name

Type

Description

- 32 bit counter

failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
number of times the modem
re-initialize the line
This element is always shown.
number of times the modem
failed to initialize the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

re-init

Parameter type: <Counter>


- 32 bit counter

failed-init

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

dle

Parameter type: <Counter>


- 32 bit counter

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

init-count

1968

Released

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
minimum error free throughput
observed
This element is always shown.
counter for disorderly leaving
failure events
This element is always shown.
forward error correction second
This element is always shown.
full init counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.17 xDSL Counters Near End Line Previous 15


Min
Command Description
This command displays the xDSL counters near end line previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]

Command Parameters
Table 66.17-1 "xDSL Counters Near End Line Previous 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber15min>
identifies prev 15min intvls,val 1
Format:
as the latest intvl
- a number identifying 15 minutes interval time
- range: [1...192]

interval-no

Description

Command Output
Table 66.17-2 "xDSL Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name
los

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of occurences of an LOS


failure event
This element is always shown.

Released

1969

66 xDSL Status Commands

name

Type

Description

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

re-init

Parameter type: <Counter>


- 32 bit counter

fail-init

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of occurences of an LOF


failure event
This element is always shown.
number of occurences of a LOM
failure event
This element is always shown.
number of occurences of an ESE
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
number of times the modem
re-initialize the line
This element is always shown.
number of times the modem
failed to initialize the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

dle

Parameter type: <Counter>


- 32 bit counter

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Xdsl::PmTimeStamp>

invalid-flag

init-count
interval-time

1970

Released

validity of the corresponding PM


data
This element is always shown.

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
counter for disorderly leaving
failure events
This element is always shown.
forward error correction second
This element is always shown.
full init counter
This element is always shown.
specifies the start time of interval

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

- Timestamp for Pm interval(yyyymmdd:hour:minutes)

This element is always shown.

Released

1971

66 xDSL Status Commands

66.18 xDSL Counters Near End Of Line Previous


Day
Command Description
This command displays the xDSL counters near end of the previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]

Command Parameters
Table 66.18-1 "xDSL Counters Near End Of Line Previous Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber1day>
nbr identifying previous 1 day
Format:
intvl time, value 1 is the most
- a number identifying 1 day interval time
recently completed 1 day intvl
- range: [1...7]

interval-no

Description

Command Output
Table 66.18-2 "xDSL Counters Near End Of Line Previous Day" Display parameters
Specific Information
name
los

1972

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of occurences of an LOS


failure event
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

Description

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

re-init

Parameter type: <Counter>


- 32 bit counter

failed-init

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of occurences of an LOF


failure event
This element is always shown.
number of occurences of a LOM
failure event
This element is always shown.
number of occurences of an ESE
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
number of times the modem
re-initialize the line
This element is always shown.
number of times the modem
failed to initialize the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

dle

Parameter type: <Counter>


- 32 bit counter

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Xdsl::PmTimeStamp>

in-valid-flag

init-count
interval-time

3HH-04416-EBAA-TCZZA 01

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
counter for disorderly leaving
failure events
This element is always shown.
forward error correction second
This element is always shown.
full init counter
This element is always shown.
specifies the start time of interval

Released

1973

66 xDSL Status Commands

name

1974

Released

Type

Description

- Timestamp for Pm interval(yyyymmdd:hour:minutes)

This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.19 xDSL Counters Near End Channel Current 15


Min
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-interval [ (if-index) ]

Command Parameters
Table 66.19-1 "xDSL Counters Near End Channel Current 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.19-2 "xDSL Counters Near End Channel Current 15 Min" Display parameters
Specific Information
name

Type

Description

cv

Parameter type: <Counter>


- 32 bit counter

fecc

Parameter type: <Counter>


- 32 bit counter

number of coding violations


encountered by the channel
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in

3HH-04416-EBAA-TCZZA 01

Released

1975

66 xDSL Status Commands

name

Type

Description

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-up

rtx-uc-up

Parameter type: <Counter>


- 32 bit counter

rtx-tx-down

Parameter type: <Counter>


- 32 bit counter

1976

Released

case of vdsl1 G.993.1


This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the near end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
near-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.20 xDSL Counters Near End Channel Current


Day
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-1day [ (if-index) ]

Command Parameters
Table 66.20-1 "xDSL Counters Near End Channel Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.20-2 "xDSL Counters Near End Channel Current Day" Display parameters
Specific Information
name

Type

Description

cv

Parameter type: <Counter>


- 32 bit counter

fecc

Parameter type: <Counter>


- 32 bit counter

number of coding violations


encountered by the channel
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in

3HH-04416-EBAA-TCZZA 01

Released

1977

66 xDSL Status Commands

name

Type

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-up

rtx-uc-up

Parameter type: <Counter>


- 32 bit counter

rtx-tx-down

Parameter type: <Counter>


- 32 bit counter

1978

Released

Description
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the near end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
near-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.21 xDSL Counters Near End Channel Previous


15 Min
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ]
]

Command Parameters
Table 66.21-1 "xDSL Counters Near End Channel Previous 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber15min>
nbr identifying previous 15 min
Format:
intvl time, value 1 is the most
- a number identifying 15 minutes interval time
recently completed 15 min intvl
- range: [1...192]

interval-no

Description

Command Output
Table 66.21-2 "xDSL Counters Near End Channel Previous 15 Min" Display parameters
Specific Information
name

Type

Description

cv

Parameter type: <Counter>

number

3HH-04416-EBAA-TCZZA 01

Released

of

coding

1979

violations

66 xDSL Status Commands

name

Type

Description

- 32 bit counter

encountered by the channel


This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the near end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.

fecc

Parameter type: <Counter>


- 32 bit counter

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-up

rtx-uc-up

Parameter type: <Counter>


- 32 bit counter

rtx-tx-down

Parameter type: <Counter>


- 32 bit counter

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

1980

Released

validity of the corresponding PM


data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
near-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.22 xDSL Counters Near End Channel Previous


Day
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]

Command Parameters
Table 66.22-1 "xDSL Counters Near End Channel Previous Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber1day>
nbr identifying previous 1 day
Format:
intvl time, value 1 is the most
- a number identifying 1 day interval time
recently completed 1 day intvl
- range: [1...7]

interval-no

Description

Command Output
Table 66.22-2 "xDSL Counters Near End Channel Previous Day" Display parameters
Specific Information
name
cv

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of coding violations


encountered by the channel

Released

1981

66 xDSL Status Commands

name

Type

fecc

Parameter type: <Counter>


- 32 bit counter

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-up

Description
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the near end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

rtx-uc-up

Parameter type: <Counter>


- 32 bit counter

rtx-tx-down

Parameter type: <Counter>


- 32 bit counter

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

1982

Released

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
near-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.23 xDSL Counters Far End Line Current 15 Min


Command Description
This command displays xDSL counters far end line current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-interval [ (if-index) ]

Command Parameters
Table 66.23-1 "xDSL Counters Far End Line Current 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the xdsl port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.23-2 "xDSL Counters Far End Line Current 15 Min" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

lpr

Parameter type: <Counter>

number of occurences of an los


failure event
This element is always shown.
number of occurences of an lof
failure event
This element is always shown.
number of occurences of an lom
failure event
This element is always shown.
number of occurences of an lpr

3HH-04416-EBAA-TCZZA 01

Released

1983

66 xDSL Status Commands

name

Type

Description

- 32 bit counter

failure event
This element is always shown.
number of occurences of an lol
failure event
This element is always shown.
number of occurences of an ese
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.

lol

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

fecs

Parameter type: <Counter>


- 32 bit counter

in-valid-flag

1984

Released

validity of the corresponding PM


data
This element is always shown.

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
forward error correction second
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.24 xDSL Counters Far End Line Current Day


Command Description
This command displays xDSL counters far end line current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-1day [ (if-index) ]

Command Parameters
Table 66.24-1 "xDSL Counters Far End Line Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.24-2 "xDSL Counters Far End Line Current Day" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

lom

Parameter type: <Counter>


- 32 bit counter

lpr

Parameter type: <Counter>

number of occurences of an los


failure event
This element is always shown.
number of occurences of an lof
failure event
This element is always shown.
number of occurences of an lom
failure event
This element is always shown.
number of occurences of an lpr

3HH-04416-EBAA-TCZZA 01

Released

1985

66 xDSL Status Commands

name

Type

Description

- 32 bit counter

failure event
This element is always shown.
number of occurences of an lol
failure event
This element is always shown.
number of occurences of an ese
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

lol

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

fecs

Parameter type: <Counter>


- 32 bit counter

in-valid-flag

1986

Released

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
forward error correction second
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.25 xDSL Counters Far End Line Previous 15 Min


Command Description
This command displays xDSL counters far end line previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]

Command Parameters
Table 66.25-1 "xDSL Counters Far End Line Previous 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber15min>
nbr identifying previous 15 min
Format:
intvl time, value 1 is the most
- a number identifying 15 minutes interval time
recently completed 15 min intvl
- range: [1...192]

interval-no

Description

Command Output
Table 66.25-2 "xDSL Counters Far End Line Previous 15 Min" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

number of occurences of an los


failure event
This element is always shown.
number of occurences of an lof
failure event
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1987

66 xDSL Status Commands

name

Type

Description

lom

Parameter type: <Counter>


- 32 bit counter

lpr

Parameter type: <Counter>


- 32 bit counter

lol

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of occurences of an lom


failure event
This element is always shown.
number of occurences of an lpr
failure event
This element is always shown.
number of occurences of an lol
failure event
This element is always shown.
number of occurences of an ese
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)

in-valid-flag

interval-time

1988

Released

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
forward error correction second
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.26 xDSL Counters Far End Line Previous Day


Command Description
This command displays xDSL counters far end line previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]

Command Parameters
Table 66.26-1 "xDSL Counters Far End Line Previous Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber1day>
nbr identifying previous 1 day
Format:
intvl time, value 1 is the most
- a number identifying 1 day interval time
recently completed 1 day intvl
- range: [1...7]

interval-no

Description

Command Output
Table 66.26-2 "xDSL Counters Far End Line Previous Day" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

lof

Parameter type: <Counter>


- 32 bit counter

number of occurences of an los


failure event
This element is always shown.
number of occurences of an lof
failure event
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

1989

66 xDSL Status Commands

name

Type

Description

lom

Parameter type: <Counter>


- 32 bit counter

lpr

Parameter type: <Counter>


- 32 bit counter

lol

Parameter type: <Counter>


- 32 bit counter

ese

Parameter type: <Counter>


- 32 bit counter

es

Parameter type: <Counter>


- 32 bit counter

ses

Parameter type: <Counter>


- 32 bit counter

uas

Parameter type: <Counter>


- 32 bit counter

measured-time

ra-upshift
short name: rau

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of occurences of an lom


failure event
This element is always shown.
number of occurences of an lpr
failure event
This element is always shown.
number of occurences of an lol
failure event
This element is always shown.
number of occurences of an ese
failure event
This element is always shown.
number of errored seconds
encountered by the line
This element is always shown.
number of severely errored
seconds encountered by the line
This element is always shown.
number of unavailable seconds
encountered by the line
This element is always shown.
amt of time in sec that statistics
have been counted
This element is only shown in
detail mode.
validity of the corresponding PM
data
This element is only shown in
detail mode.

ra-downshift
short name: rad

Parameter type: <Counter>


- 32 bit counter

leftrs

Parameter type: <Counter>


- 32 bit counter

err-free-bits

Parameter type: <Counter>


- 32 bit counter

min-eftr

Parameter type: <SignedInteger>


- a signed integer

fecs

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)

in-valid-flag

interval-time

1990

Released

number of occurances of a
Upshift Rate Adaptation
This element is always shown.
number of occurances of a
Downshift Rate Adaptation
This element is always shown.
number
of
leftr
seconds
encountered by the line
This element is always shown.
count of the number of error
freebits divided by 2^16
This element is always shown.
count of the minimum of the
error free throughput observed
This element is always shown.
forward error correction second
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.27 xDSL Counters Far End Channel Current 15


Min
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-interval [ (if-index) ]

Command Parameters
Table 66.27-1 "xDSL Counters Far End Channel Current 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.27-2 "xDSL Counters Far End Channel Current 15 Min" Display parameters
Specific Information
name

Type

Description

cv

Parameter type: <Counter>


- 32 bit counter

fecc

Parameter type: <Counter>


- 32 bit counter

nbr
of
coding
violations
encountered by far end channel
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in

3HH-04416-EBAA-TCZZA 01

Released

1991

66 xDSL Status Commands

name

Type

Description

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-down

rtx-uc-down

Parameter type: <Counter>


- 32 bit counter

rtx-tx-up

Parameter type: <Counter>


- 32 bit counter

1992

Released

case of vdsl1 G.993.1


This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the far end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
far-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.28 xDSL Counters Far End Channel Current Day


Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-1day [ (if-index) ]

Command Parameters
Table 66.28-1 "xDSL Counters Far End Channel Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.28-2 "xDSL Counters Far End Channel Current Day" Display parameters
Specific Information
name

Type

Description

cv

Parameter type: <Counter>


- 32 bit counter

fecc

Parameter type: <Counter>


- 32 bit counter

cec

Parameter type: <Counter>

nbr
of
coding
violations
encountered by far end channel
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected

3HH-04416-EBAA-TCZZA 01

Released

1993

66 xDSL Status Commands

name

measured-time

Type

Description

- 32 bit counter

erroneous
codewords
encountered by the far end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-down

rtx-uc-down

Parameter type: <Counter>


- 32 bit counter

rtx-tx-up

Parameter type: <Counter>


- 32 bit counter

1994

Released

validity of the corresponding PM


data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
far-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.29 xDSL Counters Far End Channel Previous 15


Min
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-interval [ (if-index) [ interval-no <Xdsl::IntervalNumber15min> ] ]

Command Parameters
Table 66.29-1 "xDSL Counters Far End Channel Previous 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber15min>
nbr identifying previous 15 min
Format:
intvl time, value 1 is the most
- a number identifying 15 minutes interval time
recently completed 15 min intvl
- range: [1...192]

interval-no

Description

Command Output
Table 66.29-2 "xDSL Counters Far End Channel Previous 15 Min" Display parameters
Specific Information
name
cv

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of coding violations in


the previous 15 min

Released

1995

66 xDSL Status Commands

name

Type

fecc

Parameter type: <Counter>


- 32 bit counter

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::PrevCurIntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...900]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-down

Description

rtx-uc-down

Parameter type: <Counter>


- 32 bit counter

rtx-tx-up

Parameter type: <Counter>


- 32 bit counter

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

1996

Released

This element is always shown.


number of corrected codewords
encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the far end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
far-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.30 xDSL Counters Far End Channel Previous


Day
Command Description
CEC parameter only applies to VDSL2.
CEC:Number of uncorrected codewords encountered by near-end (or far-end) channel in VDSL2 mode.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-1day [ (if-index) [ interval-no <Xdsl::IntervalNumber1day> ] ]

Command Parameters
Table 66.30-1 "xDSL Counters Far End Channel Previous Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Xdsl::IntervalNumber1day>
nbr identifying previous 1 day
Format:
intvl time, value 1 is the most
- a number identifying 1 day interval time
recently completed 1 day intvl
- range: [1...7]

interval-no

Description

Command Output
Table 66.30-2 "xDSL Counters Far End Channel Previous Day" Display parameters
Specific Information
name
cv

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

number of coding violations in


the previous one day

Released

1997

66 xDSL Status Commands

name

Type

fecc

Parameter type: <Counter>


- 32 bit counter

cec

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <Xdsl::IntervalMeasureTime>


- the measured time interval
- unit: sec
- range: [0...86400]
Parameter type: <Xdsl::IntervalValidityFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

in-valid-flag

rtx-c-down

Description
This element is always shown.
number of corrected codewords
encountered by the channel,
respectively corrected octets in
case of vdsl1 G.993.1
This element is always shown.
the number of non-corrected
erroneous
codewords
encountered by the far end
channel
This element is always shown.
amt of time in sec that statistics
have been counted
This element is always shown.
validity of the corresponding PM
data
This element is always shown.

rtx-uc-down

Parameter type: <Counter>


- 32 bit counter

rtx-tx-up

Parameter type: <Counter>


- 32 bit counter

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

1998

Released

the total number of detected


errored DTUs which have been
successfully corrected by a
retransmission as seen by the
far-end receiver
This element is always shown.
the total number of detected
errored DTUs which have not
been corrected by one or more
retransmissions
This element is always shown.
the total number of retransmitted
DTUs by the transmitter
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.31 xDSL XTU-R Inventory Status Command


Command Description
This command displays the xDSL XTU-R inventory data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl cpe-inventory [ (if-index) ]

Command Parameters
Table 66.31-1 "xDSL XTU-R Inventory Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.31-2 "xDSL XTU-R Inventory Status Command" Display parameters
Specific Information
name
modem-vendor-id
sys-serial-no

sys-vendor-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::VendorID>


- an octet string defining vendor identification
- length: x<=16
Parameter type: <Xdsl::SystemSerialNumber>
- an octet string defining system serial number
- length: x<=32

vendor ID retrieved during


handshaking
This element is always shown.
serial number that identifies the
vendor equipment
This element is only shown in
detail mode.
vendor ID retrieved via the xdsl
EOC
This element is always shown.

Parameter type: <Xdsl::VendorID>


- an octet string defining vendor identification
- length: x<=16

Released

1999

66 xDSL Status Commands

name

Type

Description

sys-version-no

Parameter type: <Xdsl::XturSystemVersionNo>


- an octet string defining xtur system version number
- length: x<=34

self-test-result

Parameter type: <Xdsl::SelfTestResult>


- an octet string defining self test result
- length: x<=8

version number retrieved via the


the xdsl EOC
This element is only shown in
detail mode.
self test results value retrieved
via the the xdsl EOC
This element is always shown.

2000

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.32 xDSL XTU-C Inventory Status Command


Command Description
This command displays the xDSL XTU-C inventory data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl co-inventory [ (if-index) ]

Command Parameters
Table 66.32-1 "xDSL XTU-C Inventory Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.32-2 "xDSL XTU-C Inventory Status Command" Display parameters
Specific Information
name
modem-vendor-id
sys-serial-no

sys-vendor-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::VendorID>


- an octet string defining vendor identification
- length: x<=16
Parameter type: <Xdsl::SystemSerialNumber>
- an octet string defining system serial number
- length: x<=32

vendor ID retrieved during


handshaking
This element is always shown.
serial number that identifies the
vendor equipment
This element is only shown in
detail mode.
vendor ID
This element is always shown.

Parameter type: <Xdsl::VendorID>


- an octet string defining vendor identification
- length: x<=16

Released

2001

66 xDSL Status Commands

name

Type

Description

sys-version-no

Parameter type: <Xdsl::SystemVersionNo>


- an octet string defining system version number
- length: x<=32
Parameter type: <Xdsl::ModemSwVersionNo>
- display string of modem software version
- length: x<=32
Parameter type: <Xdsl::SelfTestResult>
- an octet string defining self test result
- length: x<=8

version number
This element is only shown in
detail mode.
modem sw version number
This element is only shown in
detail mode.
self test results value
This element is always shown.

modem-sw-ver-no
self-test-result

2002

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.33 xDSL Board Capability Status Command


Command Description
This command displays xDSL board capability.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl board [ (if-index) ]

Command Parameters
Table 66.33-1 "xDSL Board Capability Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.33-2 "xDSL Board Capability Status Command" Display parameters
Specific Information
name
capability

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::OpModeTypeLinePreDef>


( ansi-t1413
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2

operational mode supported by


the board
This element is always shown.

Released

2003

66 xDSL Status Commands

name

Type

Description

| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default
| <Xdsl::OpModeType> )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A
- default : default value
Field type <Xdsl::OpModeType>
- octet string bitmask defining operational mode
- length: 16

2004

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

Description

ansi-t1413

Parameter type: <Xdsl::T1413>


( dis-ansi-t1413
| ansi-t1413 )
Possible values:
- dis-ansi-t1413 : disable ANSI T1.413-1998
- ansi-t1413 : ANSI T1.413-1998
Parameter type: <Xdsl::Etsidts>
( dis-etsi-dts
| etsi-dts )
Possible values:
- dis-etsi-dts : disable ETSI DTS/TM06006
- etsi-dts : ETSI DTS/TM06006
Parameter type: <Xdsl::G21potsnos>
( dis-g992-1-a
| g992-1-a )
Possible values:
- dis-g992-1-a : disable G.992.1 POTS non-overlapped
spectrum
- g992-1-a : G.992.1 POTS non-overlapped spectrum
Parameter type: <Xdsl::G21isdnnos>
( dis-g992-1-b
| g992-1-b )
Possible values:
- dis-g992-1-b : disable G.992.1 ISDN non-overlapped
spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G22potsnos>
( dis-g992-2-a
| g992-2-a )
Possible values:
- dis-g992-2-a : disable G.992.2 POTS non-overlapped
spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23potsnos>
( dis-g992-3-a
| g992-3-a )
Possible values:
- dis-g992-3-a : disable G.992.3 POTS non-overlapped
spectrum
- g992-3-a : G.992.3 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23isdnnos>
( dis-g992-3-b
| g992-3-b )
Possible values:
- dis-g992-3-b : disable G.992.3 ISDN non-overlapped
spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G23AllDigNos>
( dis-g992-3-aj
| g992-3-aj )
Possible values:
- dis-g992-3-aj : disable G.992.3 all digital mode
non-overlapped spectrum
- g992-3-aj : G.992.3 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G23PotsnosUs1>
( dis-g992-3-l1

ANSI T1.413-1998
This element is only shown in
detail mode.

etsi-dts

g992-1-a

g992-1-b

g992-2-a

g992-3-a

g992-3-b

g992-3-aj

g992-3-l1

3HH-04416-EBAA-TCZZA 01

ETSI DTS/TM06006
This element is only shown in
detail mode.

G.992.1 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.1 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.2 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.3
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 1

Released

2005

66 xDSL Status Commands

name

g992-3-l2

g992-3-am

g992-5-a

g992-5-b

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

2006

Released

Type

Description

| g992-3-l1 )
Possible values:
- dis-g992-3-l1 : disable G.992.3 POTS non-overlapped
spectrum US mask 1
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
Parameter type: <Xdsl::G23PotsNosUs2>
( dis-g992-3-l2
| g992-3-l2 )
Possible values:
- dis-g992-3-l2 : disable G.992.3 POTS non-overlapped
spectrum US mask 2
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
Parameter type: <Xdsl::G23ExtPotsNos>
( dis-g992-3-am
| g992-3-am )
Possible values:
- dis-g992-3-am : disable G.992.3 extended POTS with
non-overlapped spectrum
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
Parameter type: <Xdsl::G25PotsNos>
( dis-g992-5-a
| g992-5-a )
Possible values:
- dis-g992-5-a : disable G.992.5 POTS non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
Parameter type: <Xdsl::G25IsdnNos>
( dis-g992-5-b
| g992-5-b )
Possible values:
- dis-g992-5-b : disable G.992.5 ISDN non-overlapped
spectrum
- g992-5-b : G.992.5 ISDN non-overlapped spectrum
Parameter type: <Xdsl::AnsiT1424>
( dis-ansi-t1.424
| ansi-t1.424 )
Possible values:
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
Parameter type: <Xdsl::EtsiTs>
( dis-etsi-ts
| etsi-ts )
Possible values:
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
Parameter type: <Xdsl::ItuG9931>
( dis-itu-g993-1
| itu-g993-1 )
Possible values:
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
Parameter type: <Xdsl::Ieee802.3Ah>
( dis-ieee-802.3ah
| ieee-802.3ah )

This element is only shown in


detail mode.

G.992.3 POTS non-overlapped


spectrum US mask 2
This element is only shown in
detail mode.

G.992.3 extended POTS with


non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5 POTS non-overlapped


spectrum
This element is only shown in
detail mode.

G.992.5 ISDN non-overlapped


spectrum
This element is only shown in
detail mode.

ansi T1.424
This element is only shown in
detail mode.

ETSI TS 101 270


This element is only shown in
detail mode.

ITU G993-1
This element is only shown in
detail mode.

IEEE 802.3ah
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

g992-5-aj

g992-5-am

g993-2-8a

g993-2-8b

g993-2-8c

g993-2-8d

g993-2-12a

g993-2-12b

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
Parameter type: <Xdsl::G25AllDigNos>
( dis-g992-5-aj
| g992-5-aj )
Possible values:
- dis-g992-5-aj : disable G.992.5 all digital mode
non-overlapped spectrum
- g992-5-aj : G.992.5 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G25ExtPotsNos>
( dis-g992-5-am
| g992-5-am )
Possible values:
- dis-g992-5-am : disable G.992.5 extended POTS
non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
Parameter type: <Xdsl::GProfile8A>
( dis-g993-2-8a
| g993-2-8a )
Possible values:
- dis-g993-2-8a : disable G.993.2_8A VDSL-2 with profile
8A
- g993-2-8a : G.993.2_8A VDSL-2 with profile 8A
Parameter type: <Xdsl::GProfile8B>
( dis-g993-2-8b
| g993-2-8b )
Possible values:
- dis-g993-2-8b : disable G.993.2_8B VDSL-2 with profile
8B
- g993-2-8b : G.993.2_8B VDSL-2 with profile 8B
Parameter type: <Xdsl::GProfile8C>
( dis-g993-2-8c
| g993-2-8c )
Possible values:
- dis-g993-2-8c : disable G.993.2_8C VDSL-2 with profile
8C
- g993-2-8c : G.993.2_8C VDSL-2 with profile 8C
Parameter type: <Xdsl::GProfile8D>
( dis-g993-2-8d
| g993-2-8d )
Possible values:
- dis-g993-2-8d : disable G.993.2_8D VDSL-2 with profile
8D
- g993-2-8d : G.993.2_8D VDSL-2 with profile 8D
Parameter type: <Xdsl::GProfile12A>
( dis-g993-2-12a
| g993-2-12a )
Possible values:
- dis-g993-2-12a : disable G.993.2_12A VDSL-2 with
profile 12A
- g993-2-12a : G.993.2_12A VDSL-2 with profile 12A
Parameter type: <Xdsl::GProfile12B>
( dis-g993-2-12b
| g993-2-12b )

G.992.5
all
digital
mode
non-overlapped spectrum
This element is only shown in
detail mode.

G.992.5
extended
POTS
non-overlapped spectrum
This element is only shown in
detail mode.

VDSL-2 with profile 8A


This element is only shown in
detail mode.

VDSL-2 with profile 8B


This element is only shown in
detail mode.

VDSL-2 with profile 8C


This element is only shown in
detail mode.

VDSL-2 with profile 8D


This element is only shown in
detail mode.

VDSL-2 with profile 12A


This element is only shown in
detail mode.

VDSL-2 with profile 12B


This element is only shown in
detail mode.

Released

2007

66 xDSL Status Commands

name

Type

g993-2-17a

g993-2-30a

2008

Description

Possible values:
- dis-g993-2-12b : disable G.993.2_12B VDSL-2 with
profile 12B
- g993-2-12b : G.993.2_12B VDSL-2 with profile 12B
Parameter type: <Xdsl::GProfile17A>
VDSL-2 with profile 17A
( dis-g993-2-17a
This element is only shown in
| g993-2-17a )
detail mode.
Possible values:
- dis-g993-2-17a : disable G.993.2_17A VDSL-2 with
profile 17A
- g993-2-17a : G.993.2_17A VDSL-2 with profile 17A
Parameter type: <Xdsl::GProfile30A>
VDSL-2 with profile 30A
( dis-g993-2-30a
This element is only shown in
| g993-2-30a )
detail mode.
Possible values:
- dis-g993-2-30a : disable G.993.2_30A VDSL-2 with
profile 30A
- g993-2-30a : G.993.2_30A VDSL-2 with profile 30A

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.34 xDSL Low Rate Alarm Timestamp Command


Command Description
This command displays the latest configured timestamp. This timestamp value will be used to build-up the
line-bitmap table.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl link-up-changes [ (linkup-timestamp) ]

Command Parameters
Table 66.34-1 "xDSL Low Rate Alarm Timestamp Command" Resource Parameters
Resource Identifier

Type

Description

(linkup-timestamp)

Format:
- Printable string

the latest link up timestamp

3HH-04416-EBAA-TCZZA 01

Released

2009

66 xDSL Status Commands

66.35 xDSL Low Rate Alarm Line Bitmap Status


Command
Command Description
This command displays in a bitmap all the lines (of the specified slot) which have changed state after the specified
timestamp. - to the Up-state and current bitrate is less than planned-bit-rate - to the Down-state.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl link-up-changes (linkup-timestamp) slot [ (slot) ]

Command Parameters
Table 66.35-1 "xDSL Low Rate Alarm Line Bitmap Status Command" Resource Parameters
Resource Identifier

Type

Description

(linkup-timestamp)

Format:
- Printable string
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

the latest link up timestamp

(slot)

the physical slot position

Command Output
Table 66.35-2 "xDSL Low Rate Alarm Line Bitmap Status Command" Display parameters
Specific Information
name
port

2010

Released

Type

Description

Parameter type: <Xdsl::PortList>


- Printable string

displays all the lines with state


change after specified time
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.36 xDSL Low Rate Alarm Linkup Record Data


Command
Command Description
This command displays the linkup record for the line.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl linkup-record [ (line) ]

Command Parameters
Table 66.36-1 "xDSL Low Rate Alarm Linkup Record Data Command" Resource Parameters
Resource Identifier

Type

(line)

Format:
the physical slot position
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.36-2 "xDSL Low Rate Alarm Linkup Record Data Command" Display parameters
Specific Information
name

Type

Description

link-timestamp-down

Parameter type: <Xdsl::timeInSecs>


- Printable string

link-timestamp-up

Parameter type: <Xdsl::timeInSecs>


- Printable string

act-bitrate-up

Parameter type: <Xdsl::BitRateKbps>

Displays the latest link down


timestamp
This element is always shown.
Displays the latest link up
timestamp
This element is always shown.
Displays the actual net data or

3HH-04416-EBAA-TCZZA 01

Released

2011

66 xDSL Status Commands

name

Type

Description

- Bitrate in kbps
- unit: kbps

expected throughput for the


upstream fast or interleaved
channel
This element is always shown.
Displays the actual net data or
expected throughput for the
downstream fast or interleaved
channel
This element is always shown.
Displays the realised noise
margin for the upstream direction
This element is always shown.
Displays the realised noise
margin for the downstream
direction
This element is always shown.
Displays the link up attenuation
on upstream
This element is always shown.
Displays the link up attenuation
on downstream
This element is always shown.
Displays maximum attainable net
data rate or expected throughtput
the modem can support in
upstream
This element is always shown.
Displays maximum attainable net
data rate or expected throughtput
the modem can support in
downstream
This element is always shown.
Displays
the
configured
maximum
bitrate
for
the
upstream
This element is always shown.
Displays
the
configured
maximum
bitrate
for
the
downstream
This element is always shown.
Displays the configured threshold
bitrate for upstream
This element is always shown.
Displays the configured threshold
bitrate for downstream
This element is always shown.
Displays
the
configured
maximum interleaving delay for
upstream
This element is always shown.
Displays
the
configured
maximum interleaving delay for
downstream
This element is always shown.
Displays the configured target
noise margin for upstream
This element is always shown.

act-bitrate-down

Parameter type: <Xdsl::BitRateKbps>


- Bitrate in kbps
- unit: kbps

act-noise-margin-up

Parameter type: <Xdsl::NoiseMargindB>


- Noise Margin in dB
- unit: 1/10 dB
Parameter type: <Xdsl::NoiseMargindB>
- Noise Margin in dB
- unit: 1/10 dB

act-noise-margin-down

attenuation-up

Parameter type: <Xdsl::AttenuationdB>


- an attenuation value
- unit: 1/10 dB
Parameter type: <Xdsl::AttenuationdB>
- an attenuation value
- unit: 1/10 dB
Parameter type: <Xdsl::BitRateKbps>
- Bitrate in kbps
- unit: kbps

attenuation-down
attained-bitrate-up

attained-bitrate-down

Parameter type: <Xdsl::BitRateKbps>


- Bitrate in kbps
- unit: kbps

max-bitrate-up

Parameter type: <Xdsl::BitRateKbps>


- Bitrate in kbps
- unit: kbps

max-bitrate-down

Parameter type: <Xdsl::BitRateKbps>


- Bitrate in kbps
- unit: kbps

threshold-bitrate-up

Parameter type: <Xdsl::BitRateKbps>


- Bitrate in kbps
- unit: kbps
Parameter type: <Xdsl::BitRateKbps>
- Bitrate in kbps
- unit: kbps
Parameter type: <Xdsl::Delay>
- Delay in kbps
- unit: msec

threshold-bitrate-down
max-delay-up

max-delay-down

Parameter type: <Xdsl::Delay>


- Delay in kbps
- unit: msec

tgt-noise-margin-up

Parameter type: <Xdsl::NoiseMargindB>


- Noise Margin in dB
- unit: 1/10 dB

2012

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

Type

Description

tgt-noise-margin-down

Parameter type: <Xdsl::NoiseMargindB>


- Noise Margin in dB
- unit: 1/10 dB

Displays the configured target


noise margin for downstream
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2013

66 xDSL Status Commands

66.37 xDSL INS Near End Operational Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end operational data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end oper-data [ (if-index) ]

Command Parameters
Table 66.37-1 "xDSL INS Near End Operational Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.37-2 "xDSL INS Near End Operational Data Status Command" Display parameters
Specific Information
name
sensitivity

equiv-inp-mode

2014

Released

Type

Description

Parameter type: <Xdsl::InsSensitivity>


- impulse noise sensitivity
- unit: dB / 10
- range: [-128...127]
Parameter type: <Xdsl::InmEquivInpMode>
( mode-0
| mode-1

impulse noise sensitivity


This element is always shown.
equivalent INP mode actually
used to construct the INM
equivalent INP histograms.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

| mode-2
| mode-3
| not-supported )
Possible values:
- mode-0 : impulse length
- mode-1 : cluster length
- mode-2 : sum of impulse length in cluster
- mode-3 : gap compensated impulse length in cluster
- not-supported : INM not supported by modem

This element is always shown.

Released

2015

66 xDSL Status Commands

66.38 xDSL INS Near End Current 15Min Data


Status Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end current 15Min data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-interval [ (if-index) ]

Command Parameters
Table 66.38-1 "xDSL INS Near End Current 15Min Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.38-2 "xDSL INS Near End Current 15Min Data Status Command" Display parameters
Specific Information
name
inm-data-symb-cnt

2016

Released

Type

Description

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

number of monitored data


symbols
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.39 xDSL INS Near End Current 15Min IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end current 15Min Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-interval (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.39-1 "xDSL INS Near End Current 15Min IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.39-2 "xDSL INS Near End Current 15Min IAT Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2017

66 xDSL Status Commands

66.40 xDSL INS Near End Current 15Min EINP


Histogram
Command Description
This
command
displays
the
xDSL
Equivalent-Impulse-Noise-Protection histogram.

Impulse-Noise-Sensor

near-end

current

15Min

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-interval (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.40-1 "xDSL INS Near End Current 15Min EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.40-2 "xDSL INS Near End Current 15Min EINP Histogram" Display parameters
Specific Information
name
counter

2018

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.41 xDSL INS Near End Current Day Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end current day data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-1day [ (if-index) ]

Command Parameters
Table 66.41-1 "xDSL INS Near End Current Day Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.41-2 "xDSL INS Near End Current Day Data Status Command" Display parameters
Specific Information
name
inm-data-symb-cnt

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

number of monitored data


symbols
This element is always shown.

Released

2019

66 xDSL Status Commands

66.42 xDSL INS Near End Current Day IAT


Histogram
Command Description
This command displays the xDSL impulse-Noise-Sensor near-end current day Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-1day (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.42-1 "xDSL INS Near End Current Day IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.42-2 "xDSL INS Near End Current Day IAT Histogram" Display parameters
Specific Information
name
counter

2020

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.43 xDSL INS Near End Current Day EINP


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end current day Equivalent-Impulse-Noise-Protection
histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end current-1day (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.43-1 "xDSL INS Near End Current Day EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.43-2 "xDSL INS Near End Current Day EINP Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2021

66 xDSL Status Commands

66.44 xDSL INS Near End Previous 15Min Data


Status Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end previous 15Min data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-interval [ (if-index) ]

Command Parameters
Table 66.44-1 "xDSL INS Near End Previous 15Min Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.44-2 "xDSL INS Near End Previous 15Min Data Status Command" Display parameters
Specific Information
name

Type

Description

inm-data-symb-cnt

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

number of monitored data


symbols
This element is always shown.
specifies the start time of interval
This element is always shown.

2022

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.45 xDSL INS Near End Previous 15Min IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end previous 15Min Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-interval (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.45-1 "xDSL INS Near End Previous 15Min IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.45-2 "xDSL INS Near End Previous 15Min IAT Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2023

66 xDSL Status Commands

66.46 xDSL INS Near End Previous 15Min EINP


Histogram
Command Description
This
command
displays
the
xDSL
Equivalent-Impulse-Noise-Protection histogram.

impulse-Noise-Sensor

near-end

previous

15Min

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-interval (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.46-1 "xDSL INS Near End Previous 15Min EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.46-2 "xDSL INS Near End Previous 15Min EINP Histogram" Display parameters
Specific Information
name
counter

2024

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.47 xDSL INS Near End Previous Day Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end previous day data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-1day [ (if-index) ]

Command Parameters
Table 66.47-1 "xDSL INS Near End Previous Day Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.47-2 "xDSL INS Near End Previous Day Data Status Command" Display parameters
Specific Information
name

Type

Description

inm-data-symb-cnt

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

number of monitored data


symbols
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2025

66 xDSL Status Commands

66.48 xDSL INS Near End Previous Day IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor near-end previous day Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-1day (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.48-1 "xDSL INS Near End Previous Day IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.48-2 "xDSL INS Near End Previous Day IAT Histogram" Display parameters
Specific Information
name
counter

2026

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.49 xDSL INS Near End Previous Day EINP


Histogram
Command Description
This
command
displays
the
xDSL
Equivalent-Impulse-Noise-Protection histogram.

Impulse-Noise-Sensor

near-end

previous

day

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor near-end previous-1day (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.49-1 "xDSL INS Near End Previous Day EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.49-2 "xDSL INS Near End Previous Day EINP Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2027

66 xDSL Status Commands

66.50 xDSL INS Far End Operational Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end operational data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end oper-data [ (if-index) ]

Command Parameters
Table 66.50-1 "xDSL INS Far End Operational Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.50-2 "xDSL INS Far End Operational Data Status Command" Display parameters
Specific Information
name
ins-sensitivity

equiv-inp-mode

2028

Released

Type

Description

Parameter type: <Xdsl::InsSensitivity>


- impulse noise sensitivity
- unit: dB / 10
- range: [-128...127]
Parameter type: <Xdsl::InmEquivInpMode>
( mode-0
| mode-1

impulse noise sensitivity


This element is always shown.
equivalent INP mode actually
used to construct the INM
equivalent INP histograms.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

| mode-2
| mode-3
| not-supported )
Possible values:
- mode-0 : impulse length
- mode-1 : cluster length
- mode-2 : sum of impulse length in cluster
- mode-3 : gap compensated impulse length in cluster
- not-supported : INM not supported by modem

This element is always shown.

Released

2029

66 xDSL Status Commands

66.51 xDSL INS Far End Current 15Min Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end current 15Min data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-interval [ (if-index) ]

Command Parameters
Table 66.51-1 "xDSL INS Far End Current 15Min Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.51-2 "xDSL INS Far End Current 15Min Data Status Command" Display parameters
Specific Information
name
inm-data-symb-cnt

2030

Released

Type

Description

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

number of monitored data


symbols
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.52 xDSL INS Far End Current 15Min IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end current 15Min Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-interval (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.52-1 "xDSL INS Far End Current 15Min IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.52-2 "xDSL INS Far End Current 15Min IAT Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2031

66 xDSL Status Commands

66.53 xDSL INS Far End Current 15Min EINP


Histogram
Command Description
This
command
displays
the
xDSL
Equivalent-Impulse-Noise-Protection histogram.

Impulse-Noise-Sensor

far-end

current

15Min

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-interval (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.53-1 "xDSL INS Far End Current 15Min EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.53-2 "xDSL INS Far End Current 15Min EINP Histogram" Display parameters
Specific Information
name
counter

2032

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.54 xDSL INS Far End Current Day Data Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end current day data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-1day [ (if-index) ]

Command Parameters
Table 66.54-1 "xDSL INS Far End Current Day Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.54-2 "xDSL INS Far End Current Day Data Status Command" Display parameters
Specific Information
name
inm-data-symb-cnt

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

number of monitored data


symbols
This element is always shown.

Released

2033

66 xDSL Status Commands

66.55 xDSL INS Far End Current Day IAT Histogram


Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end current day Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-1day (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.55-1 "xDSL INS Far End Current Day IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.55-2 "xDSL INS Far End Current Day IAT Histogram" Display parameters
Specific Information
name
counter

2034

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.56 xDSL INS Far End Current Day EINP


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end current day Equivalent-Impulse-Noise-Protection
histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end current-1day (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.56-1 "xDSL INS Far End Current Day EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.56-2 "xDSL INS Far End Current Day EINP Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2035

66 xDSL Status Commands

66.57 xDSL INS Far End Previous 15Min Data


Status Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end previous 15Min data. Note: Timestamp value will
be displayed only when actual Impulse-Noise counter values are retrieved.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-interval [ (if-index) ]

Command Parameters
Table 66.57-1 "xDSL INS Far End Previous 15Min Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.57-2 "xDSL INS Far End Previous 15Min Data Status Command" Display parameters
Specific Information
name

Type

Description

inm-data-symb-cnt

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

number of monitored data


symbols
This element is always shown.
specifies the start time of interval
This element is always shown.

2036

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.58 xDSL INS Far End Previous 15Min IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end previous 15Min Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-interval (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.58-1 "xDSL INS Far End Previous 15Min IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.58-2 "xDSL INS Far End Previous 15Min IAT Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2037

66 xDSL Status Commands

66.59 xDSL INS Far End Previous 15Min EINP


Histogram
Command Description
This
command
displays
the
xDSL
Equivalent-Impulse-Noise-Protection histogram.

Impulse-Noise-Sensor

far-end

previous

15Min

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-interval (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.59-1 "xDSL INS Far End Previous 15Min EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.59-2 "xDSL INS Far End Previous 15Min EINP Histogram" Display parameters
Specific Information
name
counter

2038

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.60 xDSL INS Far End Previous Day Status


Command
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end previous day data. Note: Timestamp value will be
displayed only when actual Impulse-Noise counter values are retrieved.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-1day [ (if-index) ]

Command Parameters
Table 66.60-1 "xDSL INS Far End Previous Day Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 66.60-2 "xDSL INS Far End Previous Day Status Command" Display parameters
Specific Information
name

Type

Description

inm-data-symb-cnt

Parameter type: <Xdsl::DataSymbolCounter>


- an unsigned integer

interval-time

Parameter type: <Xdsl::PmTimeStamp>


- Timestamp for Pm interval(yyyymmdd:hour:minutes)

number of monitored data


symbols
This element is always shown.
specifies the start time of interval
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2039

66 xDSL Status Commands

66.61 xDSL INS Far End Previous Day IAT


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end previous day Inter-Arrival-Time histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-1day (if-index) inm-iat-histo [ (class-interval) ]

Command Parameters
Table 66.61-1 "xDSL INS Far End Previous Day IAT Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring inter arrival time histogram
- range: [1...8]

(class-interval)

Description

Command Output
Table 66.61-2 "xDSL INS Far End Previous Day IAT Histogram" Display parameters
Specific Information
name
counter

2040

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.62 xDSL INS Far End Previous Day EINP


Histogram
Command Description
This command displays the xDSL Impulse-Noise-Sensor far-end previous day Equivalent-Impulse-Noise-Protection
histogram.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl imp-noise-sensor far-end previous-1day (if-index) inm-equiv-inp-histo [ (class-interval) ]

Command Parameters
Table 66.62-1 "xDSL INS Far End Previous Day EINP Histogram" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
class interval
- impulse noise monitoring equivalent INP histogram
- range: [1...17]

(class-interval)

Description

Command Output
Table 66.62-2 "xDSL INS Far End Previous Day EINP Histogram" Display parameters
Specific Information
name
counter

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SignedInteger>


- a signed integer

counter
This element is always shown.

Released

2041

66 xDSL Status Commands

66.63 xDSL Downstream Vectoring Disturberlist


Status Command
Command Description
Obsolete command, replaced by show xdsl vect-disturber-list downstream r/s/s/p.
This command displays the downstream disturber list for a specified victim line. The operator can also specify the
the maximum number of disturbers to be reported through the max-reported-dist parameter.
The disturber list will contain the following information per reported disturber:
disturber line identifier
Average Magnitude, range [-32768,-1400 -400], unit 0.1dBm/Hz
Special value -32768 indicates that the averaged xtalk magnitude could not be estimated.
cancelled line indicator [false,true]

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-disturbers [ (victim-line) ] [ no max-reported-dist | max-reported-dist <Xdsl::VectMaxNbrDist> ]
Obsolete command, replaced by show xdsl vect-disturber-list downstream r/s/s/p.

Command Parameters
Table 66.63-1 "xDSL Downstream Vectoring Disturberlist Status Command" Resource Parameters
Resource Identifier

Type

(victim-line)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 66.63-2 "xDSL Downstream Vectoring Disturberlist Status Command" Command


Parameters
Parameter

Type

Description

[no] max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>

optional parameter with default

2042

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

Parameter

Type

Description

Format:
- max number of vector disturbers to be reported
- range: [1...383]

value: 10
defines the maximum number of
disturbers to be reported

Command Output
Table 66.63-3 "xDSL Downstream Vectoring Disturberlist Status Command" Display parameters
Specific Information
name

Type

Description

max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>


- max number of vector disturbers to be reported
- range: [1...383]

disturber-list

Parameter type: <Xdsl::VectDistPrintableString>


- the vector disturber list

defines the maximum number of


disturbers to be reported
This element is only shown in
detail mode.
sorted list of disturber lines. The
strongest disturbers are listed
first. Data per reported disturber
in the list : disturber identifier,
average magnitude 0.1dBm/Hz,
cancelled line indicator.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2043

66 xDSL Status Commands

66.64 xDSL Upstream Vectoring Disturberlist


Status Command
Command Description
This command displays the upstream disturber list for a specified victim line. The operator can also specify the the
maximum number of disturbers to be reported through the max-reported-dist parameter.
The disturber list will contain the following information per reported disturber:
disturber line identifier
Average Magnitude, range [-32768,-1400 -400], unit 0.1dBm/Hz
Special value -32768 indicates that the averaged xtalk magnitude could not be estimated.
cancelled line indicator [false,true]

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-disturber-list upstream [ (victim-line) ] [ no max-reported-dist | max-reported-dist
<Xdsl::VectMaxNbrDist> ]

Command Parameters
Table 66.64-1 "xDSL Upstream Vectoring Disturberlist Status Command" Resource Parameters
Resource Identifier

Type

(victim-line)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 66.64-2 "xDSL Upstream Vectoring Disturberlist Status Command" Command Parameters
Parameter

Type

Description

[no] max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>


Format:
- max number of vector disturbers to be reported
- range: [1...383]

optional parameter with default


value: 10
defines the maximum number of
disturbers to be reported

2044

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

Command Output
Table 66.64-3 "xDSL Upstream Vectoring Disturberlist Status Command" Display parameters
Specific Information
name

Type

Description

max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>


- max number of vector disturbers to be reported
- range: [1...383]

disturber-list

Parameter type: <Xdsl::MultiVectDistPrintableString>


- the vector disturber list

defines the maximum number of


disturbers to be reported
This element is only shown in
detail mode.
sorted list of disturber lines. The
strongest disturbers are listed
first. Data per reported disturber
in the list : disturber identifier,
average magnitude 0.1dBm/Hz,
cancelled line indicator.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2045

66 xDSL Status Commands

66.65 xDSL Downstream Vectoring Disturberlist


Status Command
Command Description
This command displays the downstream disturber list for a specified victim line. The operator can also specify the
the maximum number of disturbers to be reported through the max-reported-dist parameter.
The disturber list will contain the following information per reported disturber:
disturber line identifier
Average Magnitude, range [-32768,-1400 -400], unit 0.1dBm/Hz
Special value -32768 indicates that the averaged xtalk magnitude could not be estimated.
cancelled line indicator [false,true]

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-disturber-list downstream [ (victim-line) ] [ no max-reported-dist | max-reported-dist
<Xdsl::VectMaxNbrDist> ]

Command Parameters
Table 66.65-1 "xDSL Downstream Vectoring Disturberlist Status Command" Resource Parameters
Resource Identifier

Type

(victim-line)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 66.65-2 "xDSL Downstream Vectoring Disturberlist Status Command" Command


Parameters
Parameter

Type

Description

[no] max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>


Format:
- max number of vector disturbers to be reported

optional parameter with default


value: 10
defines the maximum number of

2046

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

Parameter

Type

Description

- range: [1...383]

disturbers to be reported

Command Output
Table 66.65-3 "xDSL Downstream Vectoring Disturberlist Status Command" Display parameters
Specific Information
name

Type

Description

max-reported-dist

Parameter type: <Xdsl::VectMaxNbrDist>


- max number of vector disturbers to be reported
- range: [1...383]

disturber-list

Parameter type: <Xdsl::MultiVectDistPrintableString>


- the vector disturber list

defines the maximum number of


disturbers to be reported
This element is only shown in
detail mode.
sorted list of disturber lines. The
strongest disturbers are listed
first. Data per reported disturber
in the list : disturber identifier,
average magnitude 0.1dBm/Hz,
cancelled line indicator.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2047

66 xDSL Status Commands

66.66 xDSL Vectoring Carrier Data Near End Status


Command
Command Description
This command displays xDSL vectoring carrier data near end.
Carrier data is displayed in raw format so the actual data interpretation is described in this section.
The XDSL passband (downstream or upstream) is composed of one or more bands (max 5, including VDSL
optional band). Each carrier is coded as a bitmap. When the data are not available because the measurement is not
completed, not enabled or not supported, an empty string will be returned. Below is the definition of the carrier
specific bitmap.
Crosstalk Matrix : The carrier XLINs is coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, (1..512) contains the carrier group size. The value is defined as MSB-LSB
(big-endian)
OCTETS 2,3: INTEGER(0..65535), contains the scale factor to apply to the xlin values, over the upstream
band(s). The value is defined as MSB-LSB (big-endian).
OCTETS 4,5 : INTEGER (0..4096), index of the start carrier index of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6,7 : INTEGER (0..4096), index of the stop carrier index of the first upstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 8,9 : SIGNED INTEGER , contains the ai for the first carrier index of the band (start carrier index).
The value is defined as MSB-LSB (big-endian).
OCTETS 10,11: SIGNED INTEGER , contains the bi for the first carrier index of the band (start carrier index).
The value is defined as MSB-LSB (big-endian).
OCTETS 12..L: ai and bi for the next carrier index and so on until the last carrier index of the first upstream
band (stop carrier index).
OCTETS L+1..M: contain the start/stop carrier groups and the XLIN ai and bi of the second upstream band
when available.
OCTETS M+1..N: contain the start/stop carrier index and the XLIN ai and bi of the third upstream band when
available.
OCTETS N+1..P: contain the start/stop carrier index and the XLIN ai and bi of the fourth upstream band when
available.
OCTETS P+1..Q: contain the start/stop carrier index and the XLIN ai and bi of the fifth upstream band when
available.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-carrier-data near-end [ (line) ] disturber-line <Xdsl::MultiXdslLine> [ no vgr-link | vgr-link
<Xdsl::VectGrpLink> ] [ no group-sampling | group-sampling <Xdsl::ReqSamplingRate> ]

2048

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

Command Parameters
Table 66.66-1 "xDSL Vectoring Carrier Data Near End Status Command" Resource Parameters
Resource Identifier

Type

(line)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 66.66-2 "xDSL Vectoring Carrier Data Near End Status Command" Command Parameters
Parameter

Type

Description

disturber-line

Parameter type: <Xdsl::MultiXdslLine>


Format:
<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>
/
<Eqpt::MultiLtSlotId> / <Eqpt::MultiPortId>
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiLtSlotId>
- the LT board slot number
Field type <Eqpt::MultiPortId>
- the port number
Parameter type: <Xdsl::VectGrpLink>
Format:
( local
| <Xdsl::VectGrpLink> )
Possible values:
- local : vp-slv and disturber-line are managed by the local
isam
Field type <Xdsl::VectGrpLink>
- specifies the vectgroup link
- range: [1...8]
Parameter type: <Xdsl::ReqSamplingRate>
Format:
- the requested group sampling rate.Note that while values
less than 4 are accepted, the min actual group sampling rate
will be 4 if the crosstalk matrix is available.
- range: [1...50]

optional parameter
the interface identifier of the
disturber

[no] vgr-link

[no] group-sampling

optional parameter with default


value: "local"
the vector grouplink is mandatory
when the vp-slv and/or the
disturber-line are managed by a
remote isam

optional parameter with default


value: 1
the requested group sampling rate
of the reported xlin.

Command Output
Table 66.66-3 "xDSL Vectoring Carrier Data Near End Status Command" Display parameters
Specific Information
name
disturber

3HH-04416-EBAA-TCZZA 01

Type
Parameter type: <Xdsl::MultiXdslLine>
<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>

Description
the interface identifier of the
/ disturber

Released

2049

66 xDSL Status Commands

name

Type

vgr-link

group-sampling
xtalk-mat-complex

2050

Description

<Eqpt::MultiLtSlotId> / <Eqpt::MultiPortId>
This element is always shown.
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiLtSlotId>
- the LT board slot number
Field type <Eqpt::MultiPortId>
- the port number
Parameter type: <Xdsl::VectGrpLink>
the vectorgroup link identifier or
( local
local
| <Xdsl::VectGrpLink> )
This element is always shown.
Possible values:
- local : vp-slv and disturber-line are managed by the local
isam
Field type <Xdsl::VectGrpLink>
- specifies the vectgroup link
- range: [1...8]
Parameter type: <Xdsl::SamplingRate>
the actual selected group
- the group sampling rate of reported xlin
sampling rate of the reported xlin
- range: [1...50]
This element is always shown.
Parameter type: <Xdsl::OctetStingType>
provides the crosstalk matrix
- a binary string
values in linear scale for each
carrier group over the upstream
passband(xlin)
This element is always shown.

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

66.67 xDSL Vectoring Carrier Data Far End Status


Command
Command Description
This command displays xDSL vectoring carrier data far end.
Carrier data is displayed in raw format so the actual data interpretation is described in this section.
The XDSL passband (downstream or upstream) is composed of one or more bands (max 5, including VDSL
optional band). Each carrier is coded as a bitmap. When the data are not available because the measurement is not
completed, not enabled or not supported, an empty string will be returned. Below is the definition of the carrier
specific bitmap.
Crosstalk Matrix : The carrier XLINs is coded as a bitmap defined as follows:
OCTETS 0,1: INTEGER, (1..512) contains the carrier group size. The value is defined as MSB-LSB
(big-endian)
OCTETS 2,3: INTEGER(0..65535), contains the scale factor to apply to the xlin values, over the downstream
band(s). The value is defined as MSB-LSB (big-endian).
OCTETS 4,5 : INTEGER (0..4096), index of the start carrier index of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 6,7 : INTEGER (0..4096), index of the stop carrier index of the first downstream band. The value is
defined as MSB-LSB (big-endian).
OCTETS 8,9 : SIGNED INTEGER , contains the ai for the first carrier index of the band (start carrier index).
The value is defined as MSB-LSB (big-endian).
OCTETS 10,11: SIGNED INTEGER , contains the bi for the first carrier index of the band (start carrier index).
The value is defined as MSB-LSB (big-endian).
OCTETS 12..L: ai and bi for the next carrier index and so on until the last carrier index of the first downstream
band (stop carrier index).
OCTETS L+1..M: contain the start/stop carrier groups and the XLIN ai and bi of the second downstream band
when available.
OCTETS M+1..N: contain the start/stop carrier index and the XLIN ai and bi of the third downstream band
when available.
OCTETS N+1..P: contain the start/stop carrier index and the XLIN ai and bi of the fourth downstream band
when available.
OCTETS P+1..Q: contain the start/stop carrier index and the XLIN ai and bi of the fifth downstream band
when available.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-carrier-data far-end [ (line) ] disturber-line <Xdsl::MultiXdslLine> [ no vgr-link | vgr-link
<Xdsl::VectGrpLink> ] [ no group-sampling | group-sampling <Xdsl::ReqSamplingRate> ]

3HH-04416-EBAA-TCZZA 01

Released

2051

66 xDSL Status Commands

Command Parameters
Table 66.67-1 "xDSL Vectoring Carrier Data Far End Status Command" Resource Parameters
Resource Identifier

Type

(line)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 66.67-2 "xDSL Vectoring Carrier Data Far End Status Command" Command Parameters
Parameter

Type

Description

disturber-line

Parameter type: <Xdsl::MultiXdslLine>


Format:
<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>
/
<Eqpt::MultiLtSlotId> / <Eqpt::MultiPortId>
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiLtSlotId>
- the LT board slot number
Field type <Eqpt::MultiPortId>
- the port number
Parameter type: <Xdsl::VectGrpLink>
Format:
( local
| <Xdsl::VectGrpLink> )
Possible values:
- local : vp-slv and disturber-line are managed by the local
isam
Field type <Xdsl::VectGrpLink>
- specifies the vectgroup link
- range: [1...8]
Parameter type: <Xdsl::ReqSamplingRate>
Format:
- the requested group sampling rate.Note that while values
less than 4 are accepted, the min actual group sampling rate
will be 4 if the crosstalk matrix is available.
- range: [1...50]

optional parameter
the interface identifier of the
disturber

[no] vgr-link

[no] group-sampling

optional parameter with default


value: "local"
the vector grouplink is mandatory
when the vp-slv and/or the
disturber-line are managed by a
remote isam

optional parameter with default


value: 1
the requested group sampling rate
of the reported xlin.

Command Output
Table 66.67-3 "xDSL Vectoring Carrier Data Far End Status Command" Display parameters
Specific Information
name
disturber

2052

Type

Description

Parameter type: <Xdsl::MultiXdslLine>


<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>

Released

the interface identifier of the


/ disturber

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

vgr-link

group-sampling
xtalk-mat-complex

3HH-04416-EBAA-TCZZA 01

Type

Description

<Eqpt::MultiLtSlotId> / <Eqpt::MultiPortId>
This element is always shown.
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiLtSlotId>
- the LT board slot number
Field type <Eqpt::MultiPortId>
- the port number
Parameter type: <Xdsl::VectGrpLink>
the vectorgroup link identifier or
( local
local
| <Xdsl::VectGrpLink> )
This element is always shown.
Possible values:
- local : vp-slv and disturber-line are managed by the local
isam
Field type <Xdsl::VectGrpLink>
- specifies the vectgroup link
- range: [1...8]
Parameter type: <Xdsl::SamplingRate>
the actual selected group
- the group sampling rate of reported xlin
sampling rate of the reported xlin
- range: [1...50]
This element is always shown.
Parameter type: <Xdsl::OctetStingType>
provides the crosstalk matrix
- a binary string
values in linear scale for each
carrier group over the upstream
passband(xlin)
This element is always shown.

Released

2053

66 xDSL Status Commands

66.68 xDSL Vectoring Processing Board Status


Command
Command Description
This command allows the operator to show which LTs are actual connected to the vp-board. It also gives status
information on the cable connection and the related vectoring control entity.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vp-board [ (board-index) [ vp-link <Xdsl::VectVpLink> ] ]

Command Parameters
Table 66.68-1 "xDSL Vectoring Processing Board Status Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( ctrl : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Xdsl::VectVpLink>
Format:
- specifies the vp-link or the soft-link on the vp-board
- range: [1...8]

vp board index

vp-link

the (soft) link on the vp board

Command Output
Table 66.68-2 "xDSL Vectoring Processing Board Status Command" Display parameters
Specific Information
name
lt-detect

2054

Type

Description

Parameter type: <Xdsl::ActLsmBoardOrZero>


(
<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>

Released

actual detected lt board slot index


/ or value "none"

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

name

link-status

vce-status

qsfp-status

isam-ip
system-id

3HH-04416-EBAA-TCZZA 01

Type

Description

<Eqpt::MultiSlotId>
| none )
Possible values:
- none : lt board not specified
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiSlotId>
- the LT slot number
Parameter type: <Xdsl::VpLinkStatus>
( not-connected
| connected
| operational
| not-appl )
Possible values:
- not-connected : missing cable, invalid qsfp or connected lt
not active OR in case of a soft-link: no SLV-LT plugged in
- connected : vp-lt communication possible
- operational : vp-lt communication operational
- not-appl : the link status is not applicable
Parameter type: <Xdsl::VceStatus>
( not-operational
| operational
| not-appl )
Possible values:
- not-operational : link-status not operational or lt not
synchronized with vp-board
- operational : link-status operational and lt synchronized
with vp-board
- not-appl : not applicable
Parameter type: <Xdsl::QsfpStatus>
( not-present
| invalid
| valid
| not-appl )
Possible values:
- not-present : the hw does not detect a qsfp connector
- invalid : the detected qsfp does not contain a valid qsfp
string
- valid : the detected qsfp connector is valid and operational
- not-appl : the qsfp status is not applicable
Parameter type: <Xdsl::IpAddress>
- IPv4-address

This element is always shown.

Parameter type: <Sys::systemId>


- system ID
- range: printable string (no white-spaces)
- length: x<=64

the status of the cable connected


to the vp-link OR the soft-link
status
This element is always shown.

the status of the vectoring control


entity
This element is always shown.

the vp-qsfp connector status OR


not applicable in case of
soft-links
This element is always shown.

the ip address of the isam which


holds the detected lt board
This element is always shown.
a unique system identification
This element is only shown in
detail mode.

Released

2055

66 xDSL Status Commands

66.69 xDSL Vectoring Processing Group Status


Command
Command Description
This command allows the operator to retrieve, for a specified lt board (optional parameter), the vectoring group
information and its own info.
A vectoring group exists of a vp board and, per vgr-link, the detected lt's which passed their identification over the
vp-lt-link to the vp board.
Every update in the vectoring group e.g. new detected lt or vp has lost connectivity with an lt, is broadcasted by the
vp to all lt's within the group.
Therefore:
vectoring group info: contains the last retrieved data from the vp board when the vp-lt-link was operational!
- vp info: id of the vp board , the IP@ and system-id of the system which holds the vp board, vce status
- info per vgr-link:
the qsfp status of the connector on the vp board
id of the detected lt, the IP@ and system-id of the system which holds the detected lt, the link status and
vce status

own info: contains the actual status of its vp-lt-link, the qsfp status of the connector on the lt, the IP@ and
system-id of the system which holds the lt

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl vect-group [ (board-index) [ vgr-link <Xdsl::VectGroupLink> ] ]

Command Parameters
Table 66.69-1 "xDSL Vectoring Processing Group Status Command" Resource Parameters
Resource Identifier

Type

Description

(board-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

vp board index

2056

Released

3HH-04416-EBAA-TCZZA

01

66 xDSL Status Commands

Resource Identifier

Type

Description

vgr-link

Parameter type: <Xdsl::VectGroupLink>


Format:
( vp
| own
| <Xdsl::VectGroupLink> )
Possible values:
- vp : vp-board entry in the vectgroup table
- own : own lt entry in the vectgroup table
Field type <Xdsl::VectGroupLink>
- specifies the vp-link or the soft-link on the vp-board
- range: [1...8]

the vector group link

Command Output
Table 66.69-2 "xDSL Vectoring Processing Group Status Command" Display parameters
Specific Information
name
board-detect

link-status

vce-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Xdsl::VectGroupActLsmBoardOrZero>


( lt : <Eqpt::MultiRackId> / <Eqpt::MultiShelfId> /
<Eqpt::MultiLtSlotId>
| ctrl : <Eqpt::MultiRackId> / <Eqpt::MultiShelfId>
| acu : <Eqpt::MultiRackId> / <Eqpt::MultiShelfId>
|
<Eqpt::MultiRackId>
/
<Eqpt::MultiShelfId>
/
<Eqpt::MultiLtSlotId>
| none )
Possible values:
- none : lt board not specified
- lt : lt-slot
- ctrl : ctrl-slot
- acu : acu-slot
Field type <Eqpt::MultiRackId>
- the rack number
Field type <Eqpt::MultiShelfId>
- the shelf number
Field type <Eqpt::MultiLtSlotId>
- the LT board slot number
Parameter type: <Xdsl::VpLinkStatus>
( not-connected
| connected
| operational
| not-appl )
Possible values:
- not-connected : missing cable, invalid qsfp or connected lt
not active OR in case of a soft-link: no SLV-LT plugged in
- connected : vp-lt communication possible
- operational : vp-lt communication operational
- not-appl : the link status is not applicable
Parameter type: <Xdsl::VceStatus>
( not-operational
| operational
| not-appl )
Possible values:
- not-operational : link-status not operational or lt not
synchronized with vp-board
- operational : link-status operational and lt synchronized
with vp-board

a board slot index or value


"none"
This element is always shown.

the status of the cable connected


to the vp-link of the vp-board OR
the soft-link status. The vp-link
value is equal to the vgr-link.
This element is always shown.

the status of the vectoring control


entity
This element is always shown.

Released

2057

66 xDSL Status Commands

name

Type

qsfp-status

isam-ip
system-id

2058

Description

- not-appl : not applicable


Parameter type: <Xdsl::QsfpStatus>
( not-present
| invalid
| valid
| not-appl )
Possible values:
- not-present : the hw does not detect a qsfp connector
- invalid : the detected qsfp does not contain a valid qsfp
string
- valid : the detected qsfp connector is valid and operational
- not-appl : the qsfp status is not applicable
Parameter type: <Xdsl::IpAddress>
- IPv4-address
Parameter type: <Sys::systemId>
- system ID
- range: printable string (no white-spaces)
- length: x<=64

Released

the qsfp connector status OR not


applicable in case of soft-links
This element is always shown.

the ip address of the isam which


holds the detected board
This element is always shown.
a unique system identification
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

67- Configuration Data Status Commands

67.1 Configuration Data Status Command Tree


67.2 xDSL Port Configuration Status Command
67.3 xDSL Port ATM Configuration Status Command
67.4 xDSL Port ATM Interface Configuration Status
Command
67.5 xDSL Port Interface Configuration Status Command
67.6 xDSL IGMP Configuration Status Command
67.7 xDSL Security PAE Configuration Status Command
67.8 xDSL BridgePort Configuration Status Command
67.9 xDSL QoS Configuration Status Command
67.10 xDSL PPPoX Relay Configuration Status Command
67.11 xDSL Bonding Group Configuration Status
Command

3HH-04416-EBAA-TCZZA 01

67-2060
67-2062
67-2068
67-2070
67-2072
67-2074
67-2076
67-2079
67-2083
67-2085
67-2087

Released

2059

67 Configuration Data Status Commands

67.1 Configuration Data Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Configuration Data Status Commands".

Command Tree
----show
----xdsl
----config-data-port
- (if-index)
----xdsl
- [no] service-profile
- [no] spectrum-profile
- [no] dpbo-profile
- [no] ansi-t1413
- [no] etsi-dts
- [no] g992-1-a
- [no] g992-1-b
- [no] g992-2-a
- [no] g992-3-a
- [no] g992-3-b
- [no] g992-3-aj
- [no] g992-3-l1
- [no] g992-3-l2
- [no] g992-3-am
- [no] g992-5-a
- [no] g992-5-b
- [no] ansi-t1.424
- [no] etsi-ts
- [no] itu-g993-1
- [no] ieee-802.3ah
- [no] g992-5-aj
- [no] g992-5-am
- [no] g993-2-8a
- [no] g993-2-8b
- [no] g993-2-8c
- [no] g993-2-8d
- [no] g993-2-12a
- [no] g993-2-12b
- [no] g993-2-17a
- [no] g993-2-30a
- [no] carrier-data-mode
- admin-state
- [no] bonding-mode
- transfer-mode
- overrule-state
----atm-pvc
- (port-index)
- admin-state
- [no] aal5-encap-type
----interface-atm-pvc

2060

Released

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

- (pvc-index)
- [no] customer-id
----interface-port
- [no] admin-state
- [no] link-updown-trap
- [no] user
- [no] severity
----igmp
- (port)
- perm-pkg-bitmap
- max-num-group
----security-pae
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
- [no] initialize
----bridge-port
- (port)
- pvid
- default-priority
- mac-learn-off
- max-unicast-mac
- accept-frame-type
- prio-regen-prof
- prio-regen-name
- [no] qos-profile
----qos
- scheduler-profile
- cac-profile
----pppox-relay
- (port)
- vlan-id
- default-priority
- max-cc
- qos-profile
----bonding-group
- group-profile
- admin-state

3HH-04416-EBAA-TCZZA 01

Released

2061

67 Configuration Data Status Commands

67.2 xDSL Port Configuration Status Command


Command Description
This command displays the xDSL Port Configuration data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) xdsl [ no service-profile | service-profile <AsamProfilePointer> ] [ no
spectrum-profile | spectrum-profile <AsamProfilePointer> ] [ no dpbo-profile | dpbo-profile
<Xdsl::DpboProfilePointer> ] [ no ansi-t1413 | ansi-t1413 <Xdsl::T1413> ] [ no etsi-dts | etsi-dts <Xdsl::Etsidts> ]
[ no g992-1-a | g992-1-a <Xdsl::G21potsnos> ] [ no g992-1-b | g992-1-b <Xdsl::G21isdnnos> ] [ no g992-2-a |
g992-2-a <Xdsl::G22potsnos> ] [ no g992-3-a | g992-3-a <Xdsl::G23potsnos> ] [ no g992-3-b | g992-3-b
<Xdsl::G23isdnnos> ] [ no g992-3-aj | g992-3-aj <Xdsl::G23AllDigNos> ] [ no g992-3-l1 | g992-3-l1
<Xdsl::G23PotsnosUs1> ] [ no g992-3-l2 | g992-3-l2 <Xdsl::G23PotsNosUs2> ] [ no g992-3-am | g992-3-am
<Xdsl::G23ExtPotsNos> ] [ no g992-5-a | g992-5-a <Xdsl::G25PotsNos> ] [ no g992-5-b | g992-5-b
<Xdsl::G25IsdnNos> ] [ no ansi-t1.424 | ansi-t1.424 <Xdsl::AnsiT1424> ] [ no etsi-ts | etsi-ts <Xdsl::EtsiTs> ] [ no
itu-g993-1 | itu-g993-1 <Xdsl::ItuG9931> ] [ no ieee-802.3ah | ieee-802.3ah <Xdsl::Ieee802.3Ah> ] [ no g992-5-aj |
g992-5-aj <Xdsl::G25AllDigNos> ] [ no g992-5-am | g992-5-am <Xdsl::G25ExtPotsNos> ] [ no g993-2-8a |
g993-2-8a <Xdsl::GProfile8A> ] [ no g993-2-8b | g993-2-8b <Xdsl::GProfile8B> ] [ no g993-2-8c | g993-2-8c
<Xdsl::GProfile8C> ] [ no g993-2-8d | g993-2-8d <Xdsl::GProfile8D> ] [ no g993-2-12a | g993-2-12a
<Xdsl::GProfile12A> ] [ no g993-2-12b | g993-2-12b <Xdsl::GProfile12B> ] [ no g993-2-17a | g993-2-17a
<Xdsl::GProfile17A> ] [ no g993-2-30a | g993-2-30a <Xdsl::GProfile30A> ] [ no carrier-data-mode |
carrier-data-mode <Xdsl::CarrierDataMode> ] admin-state <Xdsl::XdslAdminStatus> [ no bonding-mode |
bonding-mode
<Xdsl::BondingMode>
]
transfer-mode
<Xdsl::ActualTpsTcMode>
overrule-state
<Xdsl::OverruleState>

Command Parameters
Table 67.2-1 "xDSL Port Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

2062

Released

Description

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Table 67.2-2 "xDSL Port Configuration Status Command" Command Parameters


Parameter

Type

Description

[no] service-profile

Parameter type: <AsamProfilePointer>


Format:
- a pointer to a profile or profile index
- range: [0...65535]
Parameter type: <AsamProfilePointer>
Format:
- a pointer to a profile or profile index
- range: [0...65535]
Parameter type: <Xdsl::DpboProfilePointer>
Format:
- profile index
- range: [0...50]
Parameter type: <Xdsl::T1413>
Format:
( dis-ansi-t1413
| ansi-t1413 )
Possible values:
- dis-ansi-t1413 : disable ANSI T1.413-1998
- ansi-t1413 : ANSI T1.413-1998
Parameter type: <Xdsl::Etsidts>
Format:
( dis-etsi-dts
| etsi-dts )
Possible values:
- dis-etsi-dts : disable ETSI DTS/TM06006
- etsi-dts : ETSI DTS/TM06006
Parameter type: <Xdsl::G21potsnos>
Format:
( dis-g992-1-a
| g992-1-a )
Possible values:
- dis-g992-1-a : disable G.992.1 POTS non-overlapped
spectrum
- g992-1-a : G.992.1 POTS non-overlapped spectrum
Parameter type: <Xdsl::G21isdnnos>
Format:
( dis-g992-1-b
| g992-1-b )
Possible values:
- dis-g992-1-b : disable G.992.1 ISDN non-overlapped
spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G22potsnos>
Format:
( dis-g992-2-a
| g992-2-a )
Possible values:
- dis-g992-2-a : disable G.992.2 POTS non-overlapped
spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23potsnos>
Format:
( dis-g992-3-a
| g992-3-a )
Possible values:

optional parameter with default


value: 0
service profile configured on this
port
optional parameter with default
value: 0
spectrum profile configured on
this port
optional parameter with default
value: 0
dpbo profile configured on this
port
optional parameter with default
value: "dis-ansi-t1413-1998"
ANSI T1.413-1998

[no] spectrum-profile

[no] dpbo-profile

[no] ansi-t1413

[no] etsi-dts

[no] g992-1-a

[no] g992-1-b

[no] g992-2-a

[no] g992-3-a

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: "dis-etsi-dts-tm06006"
ETSI DTS/TM06006

optional parameter with default


value: "dis-g992-1-a"
G.992.1 POTS non-overlapped
spectrum

optional parameter with default


value: "dis-g992-1-b"
G.992.1 ISDN non-overlapped
spectrum

optional parameter with default


value: "dis-g992-2-a"
G.992.2 POTS non-overlapped
spectrum

optional parameter with default


value: "dis-g992-3-a"
G.992.3 POTS non-overlapped
spectrum

Released

2063

67 Configuration Data Status Commands

Parameter

Type

[no] g992-3-b

[no] g992-3-aj

[no] g992-3-l1

[no] g992-3-l2

[no] g992-3-am

[no] g992-5-a

[no] g992-5-b

2064

Description

- dis-g992-3-a : disable G.992.3 POTS non-overlapped


spectrum
- g992-3-a : G.992.3 POTS non-overlapped spectrum
Parameter type: <Xdsl::G23isdnnos>
Format:
( dis-g992-3-b
| g992-3-b )
Possible values:
- dis-g992-3-b : disable G.992.3 ISDN non-overlapped
spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
Parameter type: <Xdsl::G23AllDigNos>
Format:
( dis-g992-3-aj
| g992-3-aj )
Possible values:
- dis-g992-3-aj : disable G.992.3 all digital mode
non-overlapped spectrum
- g992-3-aj : G.992.3 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G23PotsnosUs1>
Format:
( dis-g992-3-l1
| g992-3-l1 )
Possible values:
- dis-g992-3-l1 : disable G.992.3 POTS non-overlapped
spectrum US mask 1
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
Parameter type: <Xdsl::G23PotsNosUs2>
Format:
( dis-g992-3-l2
| g992-3-l2 )
Possible values:
- dis-g992-3-l2 : disable G.992.3 POTS non-overlapped
spectrum US mask 2
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
Parameter type: <Xdsl::G23ExtPotsNos>
Format:
( dis-g992-3-am
| g992-3-am )
Possible values:
- dis-g992-3-am : disable G.992.3 extended POTS with
non-overlapped spectrum
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum
Parameter type: <Xdsl::G25PotsNos>
Format:
( dis-g992-5-a
| g992-5-a )
Possible values:
- dis-g992-5-a : disable G.992.5 POTS non-overlapped
spectrum
- g992-5-a : G.992.5 POTS non-overlapped spectrum
Parameter type: <Xdsl::G25IsdnNos>
Format:

Released

optional parameter with default


value: "dis-g992-3-b"
G.992.3 ISDN non-overlapped
spectrum

optional parameter with default


value: "dis-g992-3-aj"
G.992.3
all
digital
mode
non-overlapped spectrum

optional parameter with default


value: "dis-g992-3-l1"
G.992.3 POTS non-overlapped
spectrum US mask 1

optional parameter with default


value: "dis-g992-3-l2"
G.992.3 POTS non-overlapped
spectrum US mask 2

optional parameter with default


value: "dis-g992-3-am"
G.992.3 extended POTS with
non-overlapped spectrum

optional parameter with default


value: "dis-g992-5-a"
G.992.5 POTS non-overlapped
spectrum

optional parameter with default


value: "dis-g992-5-b"

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter

[no] ansi-t1.424

[no] etsi-ts

[no] itu-g993-1

[no] ieee-802.3ah

[no] g992-5-aj

[no] g992-5-am

[no] g993-2-8a

3HH-04416-EBAA-TCZZA 01

Type

Description

( dis-g992-5-b
| g992-5-b )
Possible values:
- dis-g992-5-b : disable G.992.5 ISDN non-overlapped
spectrum
- g992-5-b : G.992.5 ISDN non-overlapped spectrum
Parameter type: <Xdsl::AnsiT1424>
Format:
( dis-ansi-t1.424
| ansi-t1.424 )
Possible values:
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
Parameter type: <Xdsl::EtsiTs>
Format:
( dis-etsi-ts
| etsi-ts )
Possible values:
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
Parameter type: <Xdsl::ItuG9931>
Format:
( dis-itu-g993-1
| itu-g993-1 )
Possible values:
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
Parameter type: <Xdsl::Ieee802.3Ah>
Format:
( dis-ieee-802.3ah
| ieee-802.3ah )
Possible values:
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
Parameter type: <Xdsl::G25AllDigNos>
Format:
( dis-g992-5-aj
| g992-5-aj )
Possible values:
- dis-g992-5-aj : disable G.992.5 all digital mode
non-overlapped spectrum
- g992-5-aj : G.992.5 all digital mode non-overlapped
spectrum
Parameter type: <Xdsl::G25ExtPotsNos>
Format:
( dis-g992-5-am
| g992-5-am )
Possible values:
- dis-g992-5-am : disable G.992.5 extended POTS
non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
Parameter type: <Xdsl::GProfile8A>
Format:
( dis-g993-2-8a
| g993-2-8a )
Possible values:

G.992.5 ISDN non-overlapped


spectrum

optional parameter with default


value: "dis-ansi-t1.424"
ansi T1.424

optional parameter with default


value: "dis-etsi-ts"
ETSI TS 101 270

optional parameter with default


value: "dis-itu-g993-1"
ITU G993-1

optional parameter with default


value: "dis-ieee-802.3ah"
IEEE 802.3ah

optional parameter with default


value: "dis-g992-5-aj"
G.992.5
all
digital
mode
non-overlapped spectrum

optional parameter with default


value: "dis-g992-5-am"
G.992.5
extended
POTS
non-overlapped spectrum

optional parameter with default


value: "dis-g993-2-8a"
VDSL-2 with profile 8A

Released

2065

67 Configuration Data Status Commands

Parameter

Type

[no] g993-2-8b

[no] g993-2-8c

[no] g993-2-8d

[no] g993-2-12a

[no] g993-2-12b

[no] g993-2-17a

[no] g993-2-30a

2066

Description

- dis-g993-2-8a : disable G.993.2_8A VDSL-2 with profile


8A
- g993-2-8a : G.993.2_8A VDSL-2 with profile 8A
Parameter type: <Xdsl::GProfile8B>
Format:
( dis-g993-2-8b
| g993-2-8b )
Possible values:
- dis-g993-2-8b : disable G.993.2_8B VDSL-2 with profile
8B
- g993-2-8b : G.993.2_8B VDSL-2 with profile 8B
Parameter type: <Xdsl::GProfile8C>
Format:
( dis-g993-2-8c
| g993-2-8c )
Possible values:
- dis-g993-2-8c : disable G.993.2_8C VDSL-2 with profile
8C
- g993-2-8c : G.993.2_8C VDSL-2 with profile 8C
Parameter type: <Xdsl::GProfile8D>
Format:
( dis-g993-2-8d
| g993-2-8d )
Possible values:
- dis-g993-2-8d : disable G.993.2_8D VDSL-2 with profile
8D
- g993-2-8d : G.993.2_8D VDSL-2 with profile 8D
Parameter type: <Xdsl::GProfile12A>
Format:
( dis-g993-2-12a
| g993-2-12a )
Possible values:
- dis-g993-2-12a : disable G.993.2_12A VDSL-2 with
profile 12A
- g993-2-12a : G.993.2_12A VDSL-2 with profile 12A
Parameter type: <Xdsl::GProfile12B>
Format:
( dis-g993-2-12b
| g993-2-12b )
Possible values:
- dis-g993-2-12b : disable G.993.2_12B VDSL-2 with
profile 12B
- g993-2-12b : G.993.2_12B VDSL-2 with profile 12B
Parameter type: <Xdsl::GProfile17A>
Format:
( dis-g993-2-17a
| g993-2-17a )
Possible values:
- dis-g993-2-17a : disable G.993.2_17A VDSL-2 with
profile 17A
- g993-2-17a : G.993.2_17A VDSL-2 with profile 17A
Parameter type: <Xdsl::GProfile30A>
Format:
( dis-g993-2-30a
| g993-2-30a )
Possible values:
- dis-g993-2-30a : disable G.993.2_30A VDSL-2 with

Released

optional parameter with default


value: "dis-g993-2-8b"
VDSL-2 with profile 8B

optional parameter with default


value: "dis-g993-2-8c"
VDSL-2 with profile 8C

optional parameter with default


value: "dis-g993-2-8d"
VDSL-2 with profile 8D

optional parameter with default


value: "dis-g993-2-12a"
VDSL-2 with profile 12A

optional parameter with default


value: "dis-g993-2-12b"
VDSL-2 with profile 12b

optional parameter with default


value: "dis-g993-2-17a"
VDSL-2 with profile 17A

optional parameter with default


value: "dis-g993-2-30a"
VDSL-2 with profile 30A

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter
[no] carrier-data-mode

admin-state

[no] bonding-mode

transfer-mode

overrule-state

3HH-04416-EBAA-TCZZA 01

Type

Description

profile 30A
- g993-2-30a : G.993.2_30A VDSL-2 with profile 30A
Parameter type: <Xdsl::CarrierDataMode>
Format:
( off
| on
| on-init )
Possible values:
- off : disable the collection
- on : enable the collection
- on-init : enable and re-initialize the line
Parameter type: <Xdsl::XdslAdminStatus>
Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Xdsl::BondingMode>
Format:
( native
| atm-bonding
| bonding )
Possible values:
- native : (deprecated)native mode for channel-1
- atm-bonding : (deprecated)atm bonding mode for
channel-1
obsolete alternative replaced by bonding
- bonding : (deprecated)bonding mode for channel-1
Parameter type: <Xdsl::ActualTpsTcMode>
Format:
( no-value
| atm
| ptm
| system-default )
Possible values:
- no-value : no value
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type
Parameter type: <Xdsl::OverruleState>
Format:
( not-created
| created-no-overrules
| created-overrules )
Possible values:
- not-created : not created
- created-no-overrules : created no overrules
- created-overrules : created overrules

optional parameter with default


value: "off"
carrier
data
measurement
collection

optional parameter
specifies state of the interface

optional parameter with default


value: "native-bonding"
channel-1 bonding mode

optional parameter
transfer mode which the node
will apply to the line

optional parameter
indicates whether an overrule
record is configured and not all
'no-overrules'

Released

2067

67 Configuration Data Status Commands

67.3 xDSL Port ATM Configuration Status


Command
Command Description
This command displays the xDSL port atm configuration data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) atm-pvc [ (port-index) ] admin-state <Xdsl::XdslAdminStatusAtm> [ no
aal5-encap-type | aal5-encap-type <Atm::VccEncapType> ]

Command Parameters
Table 67.3-1 "xDSL Port ATM Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
the ATM PVC
( dsl : <Eqpt::VpiMandatoryId> : <Eqpt::VciMandatoryId>
| dsl )
Possible values:
- dsl : ADSL/SHDSL board
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

(port-index)

Description

Table 67.3-2 "xDSL Port ATM Configuration Status Command" Command Parameters
Parameter

Type

Description

admin-state

Parameter type: <Xdsl::XdslAdminStatusAtm>


Format:

optional parameter
specifies the administrative state

2068

Released

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter

[no] aal5-encap-type

3HH-04416-EBAA-TCZZA 01

Type

Description

( up
| down )
Possible values:
- up : enable traffic flow
- down : disable traffic flow
Parameter type: <Atm::VccEncapType>
Format:
( llc-snap
| llc-snap-routed
| llc-nlpid
| vc-mux-bridged-8023
| vc-mux-routed
| vc-mux-pppoa
| none
| automatic : ip
| automatic : ppp
| automatic : pppoa
| automatic : ipoe-ppp )
Possible values:
- llc-snap : logical link control encapsulation bridged
protocol
- llc-snap-routed : logical link control encapsulation routed
protocol
- llc-nlpid : logical link control encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel multiplex bridged
protocol
- vc-mux-routed : virtual channel multiplex routed protocol
- vc-mux-pppoa : virtual channel multiplex pppoa protocol
- automatic : automatic detection of encapsulation type
- none : no encapsulation type
Possible values:
- ip : autodetection of the used ip encapsulation
- ppp : autodetection of the used ppp encapsulation
- pppoa : autodetection of the used pppoa encapsulation
- ipoe-ppp : autodetection of the used ip or ppp
encapsulation

of the VCL.

optional parameter with default


value: "llc-snap"
displays
the
encapsulations
method for carrying network
interconnect traffic over AAL
type 5 over ATM

Released

2069

67 Configuration Data Status Commands

67.4 xDSL Port ATM Interface Configuration Status


Command
Command Description
This command displays the xDSL port atm-interface configuration data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) interface-atm-pvc [ (pvc-index) ] [ no customer-id | customer-id
<Itf::asamIfExtCustomerId> ]

Command Parameters
Table 67.4-1 "xDSL Port ATM Interface Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
the ATM PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(pvc-index)

Description

Table 67.4-2 "xDSL Port ATM Interface Configuration Status Command" Command Parameters
Parameter

Type

Description

[no] customer-id

Parameter type: <Itf::asamIfExtCustomerId>


Format:

optional parameter with default


value: "available"

2070

Released

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

- a string identifying the customer or user


- length: x<=64

the customerId per PVC

Released

2071

67 Configuration Data Status Commands

67.5 xDSL Port Interface Configuration Status


Command
Command Description
This command displays the xDSL port interface configuration data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) interface-port [ no admin-state | admin-state <Xdsl::XdslAdminStatus> ] [
no link-updown-trap | link-updown-trap <Itf::ifLinkUpDownTrapEnable> ] [ no user | user
<Itf::asamIfExtCustomerId> ] [ no severity | severity <Itf::asamIfExtAlmReportingSeverity> ]

Command Parameters
Table 67.5-1 "xDSL Port Interface Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 67.5-2 "xDSL Port Interface Configuration Status Command" Command Parameters
Parameter

Type

Description

[no] admin-state

Parameter type: <Xdsl::XdslAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Itf::ifLinkUpDownTrapEnable>
Format:
( link-updown-trap

optional parameter with default


value: "admin-down"
the state of the interface

[no] link-updown-trap

2072

Released

optional parameter with default


value: "no-link-updown-trap"
indicates
whether

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter

[no] user

[no] severity

3HH-04416-EBAA-TCZZA 01

Type

Description

| no-link-updown-trap )
Possible values:
- link-updown-trap : enable link-up/link-down traps
- no-link-updown-trap : disable link-up/link-down traps
Parameter type: <Itf::asamIfExtCustomerId>
Format:
- a string identifying the customer or user
- length: x<=64
Parameter type: <Itf::asamIfExtAlmReportingSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical
| no-alarms
| default
| no-value )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
- no-alarms : do not report alarm
- default : take default as specified via Interface Alarm
Configuration command
- no-value : no entry in the table

link-up/link-down
generated

traps

are

optional parameter with default


value: "available"
description of the user connected
to this interface
optional parameter with default
value: "default"
severity for alarm to be reported

Released

2073

67 Configuration Data Status Commands

67.6 xDSL IGMP Configuration Status Command


Command Description
This command displays the xDSL IGMP configuration data.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) igmp [ (port) ] perm-pkg-bitmap <Igmp::PermPkgBitMap> max-num-group
<Igmp::ChannelMaxNumGroup>

Command Parameters
Table 67.6-1 "xDSL IGMP Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
virtual channel
| dsl
| vlan : dsl : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : dsl : <Eqpt::UnstackedVlan>
| vlan : dsl : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : dsl : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan : vlan port
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

2074

Released

Description

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Resource Identifier

Type

Description

Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 67.6-2 "xDSL IGMP Configuration Status Command" Command Parameters


Parameter

Type

Description

perm-pkg-bitmap

Parameter type: <Igmp::PermPkgBitMap>


Format:
- a binary string
- length: 128
Parameter type: <Igmp::ChannelMaxNumGroup>
Format:
- max group number this port can support
- range: [0...1024]

optional parameter
packages, the user is allowed to
join

max-num-group

3HH-04416-EBAA-TCZZA 01

optional parameter
max group number this port
(ADSL, PVC) can support

Released

2075

67 Configuration Data Status Commands

67.7 xDSL Security PAE Configuration Status


Command
Command Description
This command displays the xDSL security PAE configuration data.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) security-pae [ (port) ] [ no controlled-port | controlled-port
<Aaa::PaeControlledPortControl> ] [ no quiet-period | quiet-period <Aaa::paeQuitTime> ] [ no tx-period | tx-period
<Aaa::paeTime> ] [ no supp-timeout | supp-timeout <Aaa::paeTime> ] [ no server-timeout | server-timeout
<Aaa::paeTime> ] [ no max-req | max-req <Aaa::paeMaxReq> ] [ no authentication | authentication
<Aaa::PortAuthState> ] [ no init-authreq-off | init-authreq-off <Aaa::PortAuthReq> ] [ no handshake | handshake
<Aaa::PortHandShakeMode> ] [ no handshake-period | handshake-period <Aaa::PortHandShakePeriod> ] [ no
initialize | initialize <Aaa::InitCont> ]

Command Parameters
Table 67.7-1 "xDSL Security PAE Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

2076

Released

Description

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Table 67.7-2 "xDSL Security PAE Configuration Status Command" Command Parameters
Parameter

Type

[no] controlled-port

Parameter type: <Aaa::PaeControlledPortControl>


optional parameter with default
Format:
value: "auto"
( force-unauthorized
current value of the controlled
| auto
Port
| force-authorized )
Possible values:
- force-unauthorized : force unauthorized control
- auto : automatic control
- force-authorized : force authorized control
Parameter type: <Aaa::paeQuitTime>
optional parameter with default
Format:
value: 60
- quietPeriod
quietPeriod constant currently
- range: [0...65535]
used, value in seconds
Parameter type: <Aaa::paeTime>
optional parameter with default
Format:
value: 30
- authentication time
txPeriod constant currently used,
- range: [1...65535]
value in seconds
Parameter type: <Aaa::paeTime>
optional parameter with default
Format:
value: 30
- authentication time
suppTimeout constant currently
- range: [1...65535]
used, value in seconds
Parameter type: <Aaa::paeTime>
optional parameter with default
Format:
value: 30
- authentication time
serverTimeout constant currently
- range: [1...65535]
used, value in seconds
Parameter type: <Aaa::paeMaxReq>
optional parameter with default
Format:
value: 2
- max number of requests
maxReq constant currently used
- range: [1...10]
Parameter type: <Aaa::PortAuthState>
optional parameter with default
Format:
value: "no-authen"
( authentication
enable 802.1x authentication
| no-authen )
Possible values:
- authentication : enable 802.1x authentication
- no-authen : disable 802.1x aithentication
Parameter type: <Aaa::PortAuthReq>
optional parameter with default
Format:
value: "initiate-authreq"
( initiate-authreq
specify initiate authentication
| init-authreq-off )
request to supplicant
Possible values:
- initiate-authreq : enable initiate authentication request to
supplicant
- init-authreq-off : disable initiate authentication request to
supplicant
Parameter type: <Aaa::PortHandShakeMode>
optional parameter with default
Format:
value: "no-handshake"
( handshake
enable handshake for this port
| no-handshake )
Possible values:
- handshake : enable handshake for this port
- no-handshake : disable handshake for this port
Parameter type: <Aaa::PortHandShakePeriod>
optional parameter with default
Format:
value: 15
- handshake time interval
specify the handshake time

[no] quiet-period

[no] tx-period

[no] supp-timeout

[no] server-timeout

[no] max-req

[no] authentication

[no] init-authreq-off

[no] handshake

[no] handshake-period

3HH-04416-EBAA-TCZZA 01

Description

Released

2077

67 Configuration Data Status Commands

Parameter
[no] initialize

2078

Released

Type

Description

- range: [5...90]
Parameter type: <Aaa::InitCont>
Format:
( initialize
| no-initialize )
Possible values:
- initialize : initalize this port
- no-initialize : don't initialize this port

interval
optional parameter with default
value: "no-initialize"
initialization control for this port

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

67.8 xDSL BridgePort Configuration Status


Command
Command Description
This command displays the Bridge Port configured data.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority
<Vlan::Priority> mac-learn-off <Vlan::learnStatus> max-unicast-mac <Vlan::MaxMac> accept-frame-type
<Vlan::VlanFrameTypes>
prio-regen-prof
<Vlan::PrioRegenProfile>
prio-regen-name
<Vlan::PrioRegenProfileName> [ no qos-profile | qos-profile <Vlan::QosProfileName> ]

Command Parameters
Table 67.8-1 "xDSL BridgePort Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

Description

Table 67.8-2 "xDSL BridgePort Configuration Status Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

2079

67 Configuration Data Status Commands

Parameter

Type

Description

pvid

Parameter type: <Vlan::StackedVlan>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: <Vlan::learnStatus>
Format:
( mac-learning
| mac-learn-off )
Possible values:
- mac-learning : enable self learning of mac address
- mac-learn-off : disable self learning of mac address
Parameter type: <Vlan::MaxMac>
Format:
- number of unicast mac addresses
- range: [1...8192]
Parameter type: <Vlan::VlanFrameTypes>
Format:
( single-tagged
| untagged
| mixed-tagged )
Possible values:
- single-tagged : admit only vlan tagged
- untagged : admit only vlan untagged
- mixed-tagged : admit vlan tagged and vlan untagged
Parameter type: <Vlan::PrioRegenProfile>
Format:
( none
| trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3
| l2-vpn-4
| 11
| 12
| 13
| 14
| 15

optional parameter
default vlan id for untagged
frames

default-priority

mac-learn-off

max-unicast-mac

accept-frame-type

prio-regen-prof

2080

Released

optional parameter
priority to be set in upstream
frames
optional parameter
self learning of mac address

optional parameter
max unicast mac addresses
optional parameter
accept frame types

optional parameter
priority regeneration profile

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

Parameter

prio-regen-name

3HH-04416-EBAA-TCZZA 01

Type

Description

| 16
| 17
| 18
| 19
| 20
| 21
| 22
| 23
| 24
| 25
| 26
| 27
| 28
| 29
| 30
| 31
| 32 )
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Parameter type: <Vlan::PrioRegenProfileName>
optional parameter
Format:
priority regeneration profile name
( none
| name : <Vlan::IgnoredVlanProfileName> )
Possible values:

Released

2081

67 Configuration Data Status Commands

Parameter

Type

[no] qos-profile

2082

Description

- none : no profile name to associate


- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::QosProfileName>
optional parameter with default
Format:
value: "none"
( none
qos profile name
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

Released

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

67.9 xDSL QoS Configuration Status Command


Command Description
This command displays the xDSL QoS configuration data.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) qos scheduler-profile <Qos::QosSchedulerProfileName> cac-profile
<Qos::QosCacProfileName>

Command Parameters
Table 67.9-1 "xDSL QoS Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 67.9-2 "xDSL QoS Configuration Status Command" Command Parameters


Parameter

Type

Description

scheduler-profile

Parameter type: <Qos::QosSchedulerProfileName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>

optional parameter
the name of the scheduler profile
to be mapped on this dsl link

cac-profile

3HH-04416-EBAA-TCZZA 01

optional parameter
the name of the cac profile to be
mapped on this dsl link2

Released

2083

67 Configuration Data Status Commands

Parameter

Type

Description

| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

2084

Released

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

67.10 xDSL PPPoX Relay Configuration Status


Command
Command Description
This command displays the xDSL PPPoX relay client port configuration data.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) pppox-relay [ (port) ] vlan-id <Vlan::StackedVlanSigned> default-priority
<PPPoX::DefaultPriority> max-cc <PPPoX::MaxNumPppCc> qos-profile <PPPoX::QosProfileName>

Command Parameters
Table 67.10-1 "xDSL PPPoX Relay Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
client port identification
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl
| vlan : dsl : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : dsl : <Eqpt::UnstackedVlan>
| vlan : dsl : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : dsl : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan : vlan port
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>

(port)

3HH-04416-EBAA-TCZZA 01

Description

Released

2085

67 Configuration Data Status Commands

Resource Identifier

Type

Description

- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 67.10-2 "xDSL PPPoX Relay Configuration Status Command" Command Parameters
Parameter

Type

Description

vlan-id

Parameter type: <Vlan::StackedVlanSigned>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <PPPoX::DefaultPriority>
Format:
- indicates the p-bit for the client port
- range: [0...7]
Parameter type: <PPPoX::MaxNumPppCc>
Format:
- max no. of PPP cross connection on a port
- range: [1...64], [9...64] = 8 with MAC concentration.
Parameter type: <PPPoX::QosProfileName>
Format:
( none
| name : <PPPoX::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <PPPoX::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

optional parameter
client port associated to cc-engine

default-priority

max-cc

qos-profile

2086

Released

optional parameter
indicates the p-bit for the client
port
optional parameter
max no. of PPP cross connection
on a port
optional parameter
qos profile name associated with
client port

3HH-04416-EBAA-TCZZA

01

67 Configuration Data Status Commands

67.11 xDSL Bonding Group Configuration Status


Command
Command Description
This command displays the xDSL bonding group configuration data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl config-data-port (if-index) bonding-group group-profile <AsamProfileName> admin-state
<Xdsl::XdslAdminStatusGroup>

Command Parameters
Table 67.11-1 "xDSL Bonding Group Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 67.11-2 "xDSL Bonding Group Configuration Status Command" Command Parameters
Parameter

Type

Description

group-profile

Parameter type: <AsamProfileName>


Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Xdsl::XdslAdminStatusGroup>
Format:
( up
| down )
Possible values:
- up : admin-state of the group to up

optional parameter
name of the bonding group
profile

admin-state

3HH-04416-EBAA-TCZZA 01

optional parameter
the admin-state of the group

Released

2087

67 Configuration Data Status Commands

Parameter

Type

Description

- down : admin-state of the group to down

2088

Released

3HH-04416-EBAA-TCZZA

01

68- Operational Data Status Commands

68.1 Operational Data Status Command Tree


68.2 xDSL Port Operational Status Command
68.3 xDSL BridgePort Operational Status Command
68.4 xDSL Port ATM Operational Status Command
68.5 xDSL Port Interface Configuration Status Command
68.6 xDSL IGMP Operational Status Command
68.7 xDSL Port Ip Bridge Operational Status Command
68.8 xDSL QoS Opertaional Status Command

3HH-04416-EBAA-TCZZA 01

68-2090
68-2091
68-2095
68-2097
68-2099
68-2101
68-2104
68-2106

Released

2089

68 Operational Data Status Commands

68.1 Operational Data Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Operational Data Status Commands".

Command Tree
----show
----xdsl
----oper-data-port
- (if-index)
----xdsl
- admin-state
- opr-state/tx-rate-ds
- cur-op-mode
- tx-rate-us
- tx-rate-ds
- noise-margin-down
- noise-margin-up
- actual-tps-tc-mode
- overrule-state
----bridge-port
- (port)
- pvid
- default-priority
- [no] qos-profile
----atm-pvc
- (port-index)
- admin-state
- oper-state
- curr-encap-type
----interface-port
- [no] admin-state
- oper-state
----igmp
- (port)
- curr-num-group
- curr-preview-num
- curr-uncfg-num
----ip-bridge-port
- (ip-bridge-port)
- rx-pkts
- rx-drop-pkts
- tx-pkts
----qos
- frame-net-bw
- m-cast-avail-bw
- m-cast-used-bw

2090

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

68.2 xDSL Port Operational Status Command


Command Description
This command displays the xDSL Port Operational data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) xdsl admin-state <Itf::ifAdminStatus> opr-state/tx-rate-ds
<Xdsl::combinedCol> cur-op-mode <Xdsl::OneOpModeTypeLinePreDef> tx-rate-us <Xdsl::SignedIntegerKBPS>
tx-rate-ds
<Xdsl::SignedIntegerKBPS>
noise-margin-down
<Xdsl::NoiseValue>
noise-margin-up
<Xdsl::NoiseValue> actual-tps-tc-mode <Xdsl::ActualTpsTcMode> overrule-state <Xdsl::OverruleState>

Command Parameters
Table 68.2-1 "xDSL Port Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 68.2-2 "xDSL Port Operational Status Command" Command Parameters


Parameter

Type

Description

admin-state

Parameter type: <Itf::ifAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Xdsl::combinedCol>
Format:
( down
| testing
| unknown

optional parameter
specifies state of the interface

opr-state/tx-rate-ds

3HH-04416-EBAA-TCZZA 01

optional parameter
current operational state of the
interface.

Released

2091

68 Operational Data Status Commands

Parameter

Type

cur-op-mode

2092

Description

| dormant
| up : <Xdsl::bitrate> )
Possible values:
- up : up,traffic can pass
- down : down,no traffic is passing
- testing : testing,no traffic is passing
- unknown : unknown
- dormant : dormant,no traffic is passing
Field type <Xdsl::bitrate>
- bitrate
- unit: kbits/sec
Parameter type: <Xdsl::OneOpModeTypeLinePreDef>
optional parameter
Format:
operational mode allowed by this
( ansi-t1413
profile
| etsi-dts
| g992-1-a
| g992-1-b
| g992-2-a
| g992-3-a
| g992-3-b
| g992-3-aj
| g992-3-l1
| g992-3-l2
| g992-3-am
| g992-5-a
| g992-5-b
| ansi-t1.424
| etsi-ts
| itu-g993-1
| ieee-802.3ah
| g992-5-aj
| g992-5-am
| g993-2-8a
| g993-2-8b
| g993-2-8c
| g993-2-8d
| g993-2-12a
| g993-2-12b
| g993-2-17a
| g993-2-30a
| default )
Possible values:
- ansi-t1413 : ANSI T1.413-1998
- etsi-dts : ETSI DTS/TM06006
- g992-1-a : G.992.1 POTS non-overlapped spectrum
- g992-1-b : G.992.1 ISDN non-overlapped spectrum
- g992-2-a : G.992.2 POTS non-overlapped spectrum
- g992-3-a : G.992.2 POTS non-overlapped spectrum
- g992-3-b : G.992.3 ISDN non-overlapped spectrum
- g992-3-aj : G.992.3 All Digital Mode with non-overlapped
spectrum
- g992-3-l1 : G.992.3 POTS non-overlapped spectrum US
mask 1
- g992-3-l2 : G.992.3 POTS non-overlapped spectrum US
mask 2
- g992-3-am : G.992.3 extended POTS with non-overlapped
spectrum

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

Parameter

tx-rate-us

tx-rate-ds

noise-margin-down

noise-margin-up

actual-tps-tc-mode

overrule-state

3HH-04416-EBAA-TCZZA 01

Type

Description

- g992-5-a : G.992.5 POTS non-overlapped spectrum


- g992-5-b : G.992.5 POTS non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-aj : G.992.5 All Digital Mode with non-overlapped
spectrum
- g992-5-am : G.992.5 extended POTS non-overlapped
spectrum
- g993-2-8a : VDSL-2 with profile 8A
- g993-2-8b : VDSL-2 with profile 8B
- g993-2-8c : VDSL-2 with profile 8C
- g993-2-8d : VDSL-2 with profile 8D
- g993-2-12a : VDSL-2 with profile 12A
- g993-2-12b : VDSL-2 with profile 12B
- g993-2-17a : VDSL-2 with profile 17A
- g993-2-30a : VDSL-2 with profile 30A
- default : default value
Parameter type: <Xdsl::SignedIntegerKBPS>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Xdsl::SignedIntegerKBPS>
Format:
- bitrate
- unit: kbits/sec
Parameter type: <Xdsl::NoiseValue>
Format:
- a noise value
- unit: 1/10 dB
Parameter type: <Xdsl::NoiseValue>
Format:
- a noise value
- unit: 1/10 dB
Parameter type: <Xdsl::ActualTpsTcMode>
Format:
( no-value
| atm
| ptm
| system-default )
Possible values:
- no-value : no value
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type
Parameter type: <Xdsl::OverruleState>
Format:
( not-created
| created-no-overrules
| created-overrules )
Possible values:
- not-created : not created
- created-no-overrules : created no overrules
- created-overrules : created overrules

optional parameter
bitrate or expected throughput for
upstream fast or interleaved data
flow
optional parameter
bitrate or expected throughput for
downstream fast or interleaved
data flow
optional parameter
current noise margin for the
downstream direction
optional parameter
current noise margin for the
upstream direction
optional parameter
actual transfer mode

optional parameter
indicates whether an overrule
record is configured and not all
'no-overrules'

Released

2093

68 Operational Data Status Commands

Command Output
Table 68.2-3 "xDSL Port Operational Status Command" Display parameters
Specific Information
name
rtx-mode-up

rtx-mode-dn

2094

Released

Type

Description

Parameter type: <Xdsl::ActualRtxModeType>


( in-use
| forbidden
| no-xtuc
| no-xtur
| no-xtuc-xtur
| supported
| unknown )
Possible values:
- in-use : retransmission in use
- forbidden : retransmission not_in_use forbidden
- no-xtuc : retransmission not_in_use and not_supported for
xtuc
- no-xtur : retransmission not_in_use and not_supported for
xtur
- no-xtuc-xtur : retransmission not_in_use and
not_supported for xtuc and xtur
- supported : retransmission not selected but supported
- unknown : retransmission not supported
Parameter type: <Xdsl::ActualRtxModeType>
( in-use
| forbidden
| no-xtuc
| no-xtur
| no-xtuc-xtur
| supported
| unknown )
Possible values:
- in-use : retransmission in use
- forbidden : retransmission not_in_use forbidden
- no-xtuc : retransmission not_in_use and not_supported for
xtuc
- no-xtur : retransmission not_in_use and not_supported for
xtur
- no-xtuc-xtur : retransmission not_in_use and
not_supported for xtuc and xtur
- supported : retransmission not selected but supported
- unknown : retransmission not supported

actual retransmission mode in


upstream direction
This element is only shown in
detail mode.

actual retransmission mode in


downstream direction
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

68.3 xDSL BridgePort Operational Status


Command
Command Description
This command displays the Bridge Port Operational data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority
<Vlan::Priority> [ no qos-profile | qos-profile <Vlan::QosProfileName> ]

Command Parameters
Table 68.3-1 "xDSL BridgePort Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identity of the PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

Description

Table 68.3-2 "xDSL BridgePort Operational Status Command" Command Parameters


Parameter

Type

Description

pvid

Parameter type: <Vlan::StackedVlan>


Format:

optional parameter
default vlan id for untagged

3HH-04416-EBAA-TCZZA 01

Released

2095

68 Operational Data Status Commands

Parameter

Type

Description
frames

default-priority

( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: <Vlan::QosProfileName>
Format:
( none
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

[no] qos-profile

2096

Released

optional parameter
port dynamic or static (if no
dynamic) default priority
optional parameter with default
value: "none"
qos profile name

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

68.4 xDSL Port ATM Operational Status Command


Command Description
This command displays the xDSL port atm operational data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) atm-pvc [ (port-index) ] admin-state <Xdsl::XdslAdminStatusAtm>
oper-state <Atm::atmVclOperStatus> curr-encap-type <Atm::CurVccEncapType>

Command Parameters
Table 68.4-1 "xDSL Port ATM Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
the ATM PVC
( dsl : <Eqpt::VpiMandatoryId> : <Eqpt::VciMandatoryId>
| dsl )
Possible values:
- dsl : ADSL/SHDSL board
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

(port-index)

Description

Table 68.4-2 "xDSL Port ATM Operational Status Command" Command Parameters
Parameter

Type

Description

admin-state

Parameter type: <Xdsl::XdslAdminStatusAtm>


Format:
( up
| down )
Possible values:

optional parameter
specifies
the
desired
administrative state of the VCL.

3HH-04416-EBAA-TCZZA 01

Released

2097

68 Operational Data Status Commands

Parameter

Type

oper-state

curr-encap-type

2098

Description

- up : enable traffic flow


- down : disable traffic flow
Parameter type: <Atm::atmVclOperStatus>
Format:
( up
| down
| unknown )
Possible values:
- up : traffic flow is enabled in the virtual link
- down : traffic flow is disabled in the virtual link
- unknown : state is unknown
Parameter type: <Atm::CurVccEncapType>
Format:
( llc-snap
| llc-snap-routed
| llc-nlpid
| vc-mux-bridged-8023
| vc-mux-routed
| vc-mux-pppoa
| other
| unknown
| none )
Possible values:
- llc-snap : logical link control encapsulation bridged
protocol
- llc-snap-routed : logical link control encapsulation routed
protocol
- llc-nlpid : logical link control encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel multiplex bridged
protocol
- vc-mux-routed : virtual channel multiplex routed protocol
- vc-mux-pppoa : virtual channel multiplex pppoa protocol
- other : other encapsulation type
- unknown : unknown encapsulation type
- none : no encapsulation type

Released

optional parameter
indicates the current operational
status of the VCL.

optional parameter
the
current
encapsulation type.

3HH-04416-EBAA-TCZZA

established

01

68 Operational Data Status Commands

68.5 xDSL Port Interface Configuration Status


Command
Command Description
This command displays the xDSL port interface configuration data.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) interface-port [ no admin-state | admin-state <Xdsl::XdslAdminStatus> ]
oper-state <Itf::ifOperStatus>

Command Parameters
Table 68.5-1 "xDSL Port Interface Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 68.5-2 "xDSL Port Interface Configuration Status Command" Command Parameters
Parameter

Type

Description

[no] admin-state

Parameter type: <Xdsl::XdslAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Itf::ifOperStatus>
Format:
( up
| down

optional parameter with default


value: "admin-down"
the desired state of the interface

oper-state

3HH-04416-EBAA-TCZZA 01

optional parameter
the operational state
interface

Released

2099

of

the

68 Operational Data Status Commands

Parameter

Type

Description

| testing
| unknown
| dormant )
Possible values:
- up : permanent virtual circuit
- down : bridge port
- testing : l2 VLAN
- unknown : IPoE
- dormant : PPPoE

2100

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

68.6 xDSL IGMP Operational Status Command


Command Description
This command displays the xDSL IGMP operational data.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) igmp [ (port) ] curr-num-group <Gauge> curr-preview-num <Counter>
curr-uncfg-num <Counter>

Command Parameters
Table 68.6-1 "xDSL IGMP Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

(port)

3HH-04416-EBAA-TCZZA 01

Description

Released

2101

68 Operational Data Status Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>

2102

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

Resource Identifier

Type

Description

- the ONT PORT identifier


Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 68.6-2 "xDSL IGMP Operational Status Command" Command Parameters


Parameter

Type

Description

curr-num-group

Parameter type: <Gauge>


Format:
- gauge
Parameter type: <Counter>
Format:
- 32 bit counter

optional parameter
Indicates the current group
number in this port
optional parameter
Indicates the number of preview
multicast group that igmp
channel joins currently
optional parameter
Indicates the current unconfig
group number in this port

curr-preview-num

curr-uncfg-num

3HH-04416-EBAA-TCZZA 01

Parameter type: <Counter>


Format:
- 32 bit counter

Released

2103

68 Operational Data Status Commands

68.7 xDSL Port Ip Bridge Operational Status


Command
Command Description
This command displays the xDSL Port Ip Bridge Operational data.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) ip-bridge-port [ (ip-bridge-port) ] rx-pkts <Equipm::Octet-8> rx-drop-pkts
<Equipm::Octet-8> tx-pkts <Equipm::Octet-8>

Command Parameters
Table 68.7-1 "xDSL Port Ip Bridge Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(ip-bridge-port)

Description

Table 68.7-2 "xDSL Port Ip Bridge Operational Status Command" Command Parameters
Parameter

Type

Description

rx-pkts

Parameter type: <Equipm::Octet-8>


Format:

optional parameter
show the number of received

2104

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

Parameter
rx-drop-pkts

tx-pkts

3HH-04416-EBAA-TCZZA 01

Type

Description

- a binary string
- length: 8
Parameter type: <Equipm::Octet-8>
Format:
- a binary string
- length: 8
Parameter type: <Equipm::Octet-8>
Format:
- a binary string
- length: 8

packets
optional parameter
show the number of received
packets which are dropped
optional parameter
show the number of transmitted
packets

Released

2105

68 Operational Data Status Commands

68.8 xDSL QoS Opertaional Status Command


Command Description
This command displays the xDSL QoS operational data.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show xdsl oper-data-port (if-index) qos frame-net-bw <SignedInteger> m-cast-avail-bw <SignedInteger>
m-cast-used-bw <SignedInteger>

Command Parameters
Table 68.8-1 "xDSL QoS Opertaional Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 68.8-2 "xDSL QoS Opertaional Status Command" Command Parameters


Parameter

Type

Description

frame-net-bw

Parameter type: <SignedInteger>


Format:
- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


Format:
- a signed integer

optional parameter
Represents
the
approximate
bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
optional parameter
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting

2106

Released

3HH-04416-EBAA-TCZZA

01

68 Operational Data Status Commands

Parameter

m-cast-used-bw

3HH-04416-EBAA-TCZZA 01

Type

Parameter type: <SignedInteger>


Format:
- a signed integer

Description
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
optional parameter
Shows the bandwidth currently in
use by pre-configured multicast
streams.

Released

2107

69- xDSL Bonding Status Commands

69.1 xDSL Bonding Status Command Tree


69.2 xDSL Bonding Group Profiles Status Command
69.3 xDSL Bonding Group Rtx Profiles Status Command
69.4 xDSL Bonding Near End Operational Data Status
Command
69.5 xDSL Bonding Far End Operational Data Status
Command
69.6 xDSL Bonding Group Operational Data Command
69.7 xDSL Bonding Link Operational Data Command
69.8 xDSL Bonding Near End Failure Status Command
69.9 xDSL Bonding Far End Failure Status Command
69.10 xDSL Bonding Group Failure Status Command
69.11 xDSL Bonding Group Summary Info Command

2108

Released

69-2109
69-2110
69-2112
69-2114
69-2116
69-2118
69-2120
69-2122
69-2124
69-2126
69-2128

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

69.1 xDSL Bonding Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "xDSL Bonding Status Commands".

Command Tree
----show
----xdsl-bonding
----profiles
- (index)
----group-rtx-profiles
- (index)
----operational-data
----X near-end
- (if-index)
----X far-end
- (if-index)
----group
- (if-index)
----link
- (bonding-link-id)
----failure-status
----near-end
- (if-index)
----far-end
- (if-index)
----group
- (if-index)
----summary
- (index)

3HH-04416-EBAA-TCZZA 01

Released

2109

69 xDSL Bonding Status Commands

69.2 xDSL Bonding Group Profiles Status


Command
Command Description
This command displays the usage of the xDSL bonding group profiles.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding profiles [ (index) ]

Command Parameters
Table 69.2-1 "xDSL Bonding Group Profiles Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- bonding group profile index
- range: [1...100]

a unique interface index

Command Output
Table 69.2-2 "xDSL Bonding Group Profiles Status Command" Display parameters
Common Information:profile
name
Type
next-av-bond-pr
max-bond-pr

Specific Information
name
name

used-status

2110

Released

Description

Parameter type: <AsamNextProfileIndex>


- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]

next available index for the


bonding group profile
This element is always shown.
max number of bonding group
profile indices that can be created
This element is always shown.

Type

Description

Parameter type: <AsamProfileName>


- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Xdsl::UsedStatus>
- number of entities using this profile
- range: [0...65535]

name of the bonding group


profile
This element is always shown.
specifies the number of entities
using this profile.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2111

69 xDSL Bonding Status Commands

69.3 xDSL Bonding Group Rtx Profiles Status


Command
Command Description
This command displays the usage of the xDSL bonding group rtx profiles.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding group-rtx-profiles [ (index) ]

Command Parameters
Table 69.3-1 "xDSL Bonding Group Rtx Profiles Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a profile index value
- range: [1...128]

a unique interface index

Command Output
Table 69.3-2 "xDSL Bonding Group Rtx Profiles Status Command" Display parameters
Common Information:profile
name
Type
next-av-bond-rtx-pr
max-bond-rtx-pr

Specific Information
name
name

used-status

2112

Released

Description

Parameter type: <AsamNextProfileIndex>


- a profile index
- range: [0...65535]
Parameter type: <AsamMaxProfileIndex>
- a maximum value of a profile index
- range: [0...65535]

next available index for the


bonding group rtx profile
This element is always shown.
max number of bonding group rtx
profile indices that can be created
This element is always shown.

Type

Description

Parameter type: <AsamProfileName>


- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
Parameter type: <Xdsl::UsedStatus>
- number of entities using this profile
- range: [0...65535]

name of the bonding group rtx


profile
This element is always shown.
specifies the number of entities
using this profile.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2113

69 xDSL Bonding Status Commands

69.4 xDSL Bonding Near End Operational Data


Status Command
Command Description
Obsolete command, replaced by show xdsl-bonding operational-data group.
This command shows the operational data near end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data near-end [ (if-index) ]
Obsolete command, replaced by show xdsl-bonding operational-data group.

Command Parameters
Table 69.4-1 "xDSL Bonding Near End Operational Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.4-2 "xDSL Bonding Near End Operational Data Status Command" Display parameters
Specific Information
name
actual-bitrate-up

2114

Released

Type

Description

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

when the bonding group is in


service, this will give the actual
bitrate and 0 when not in service
also in case no data is available.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

Type

actaggr-ndr-up

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

3HH-04416-EBAA-TCZZA 01

Description
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in upstream
direction. Value 0 means bonding
group not in service or no data
available.
This element is always shown.

Released

2115

69 xDSL Bonding Status Commands

69.5 xDSL Bonding Far End Operational Data


Status Command
Command Description
Obsolete command, replaced by show xdsl-bonding operational-data group.
This command shows the operational data far end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data far-end [ (if-index) ]
Obsolete command, replaced by show xdsl-bonding operational-data group.

Command Parameters
Table 69.5-1 "xDSL Bonding Far End Operational Data Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.5-2 "xDSL Bonding Far End Operational Data Status Command" Display parameters
Specific Information
name
actual-bitrate-down

2116

Released

Type

Description

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

when the bonding group is in


service, this will give the actual
bitrate and 0 when not in service
also in case no data is available.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

Type

actaggr-ndr-dn

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

3HH-04416-EBAA-TCZZA 01

Description
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in downstream
direction. Value 0 means bonding
group not in service or no data
available.
This element is always shown.

Released

2117

69 xDSL Bonding Status Commands

69.6 xDSL Bonding Group Operational Data


Command
Command Description
This command displays the xDSL bonding oper-data group statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data group [ (if-index) ]

Command Parameters
Table 69.6-1 "xDSL Bonding Group Operational Data Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.6-2 "xDSL Bonding Group Operational Data Command" Display parameters
Specific Information
name

Type

Description

running-time

Parameter type: <SignedInteger>


- a signed integer

actual-bitrate-up

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

specifies accumulated time of


bonding group normal operation
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in upstream
direction or the expected

2118

Released

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

Type

Description

actual-bitrate-down

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

actaggr-ndr-up

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

actaggr-ndr-dn

Parameter type: <Xdsl::BondingBitRate>


- a bonding bit rate value
- unit: kbps
- range: [0...2147483647]

nbr-contributing-links

Parameter type: <SignedInteger>


- a signed integer

vect-fallback

Parameter type: <Xdsl::ActualVectFallbackState>


( normal-mode
| fallback-mode )
Possible values:
- normal-mode : line is operating using normal profiles
- fallback-mode : line is operating using vectoring fallback
configured profiles

3HH-04416-EBAA-TCZZA 01

throughput for the upstream


retransmission bonded data flow.
Value 0 means bonding group not
in service or no data available.
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in downstream
direction or the expected
throughput for the downstream
retransmission bonded data flow.
Value 0 means bonding group not
in service also or no data
available.
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in upstream
direction. Value 0 means bonding
group not in service or no data
available.
This element is always shown.
when the bonding group is in
service, this will give the actual
net data rate in downstream
direction. Value 0 means bonding
group not in service or no data
available.
This element is always shown.
the number of operational links,
selected by bandwidth split,
contributing to the overall
bonding group actual bitrate
This element is always shown.
actual vectoring fallback stateof
the group
This element is always shown.

Released

2119

69 xDSL Bonding Status Commands

69.7 xDSL Bonding Link Operational Data


Command
Command Description
This command displays the xDSL bonding oper-data link statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data link [ (bonding-link-id) ]

Command Parameters
Table 69.7-1 "xDSL Bonding Link Operational Data Command" Resource Parameters
Resource Identifier

Type

(bonding-link-id)

Format:
a bonding link interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.7-2 "xDSL Bonding Link Operational Data Command" Display parameters
Specific Information
name
link-status

2120

Released

Type

Description

Parameter type: <Xdsl::BondingGroupLinkStatus>


( not-training
| training
| not-selected
| up-no-traffic
| up-traffic )
Possible values:

the operational and selection


status of a bonding group link
This element is always shown.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

link-group-idx

3HH-04416-EBAA-TCZZA 01

Type

Description

- not-training : no training allowed


- training : training triggered
- not-selected : line not selected by BW-split algorithm
- up-no-traffic : selected by BW-split algorithm, not selected
for traffic(only for ATM lines)
- up-traffic : selected by BW-split algorithm, selected for
traffic
Parameter type: <Xdsl::BondingInterfaceIndex>
the bonding group index of which
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the link is a member
<Eqpt::PortId>
This element is always shown.
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Released

2121

69 xDSL Bonding Status Commands

69.8 xDSL Bonding Near End Failure Status


Command
Command Description
This command displays the xDSL bonding failure near end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding failure-status near-end [ (if-index) ]

Command Parameters
Table 69.8-1 "xDSL Bonding Near End Failure Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.8-2 "xDSL Bonding Near End Failure Status Command" Display parameters
Specific Information
name
defect

up-min-bitrate

2122

Released

Type

Description

Parameter type: <Xdsl::FailureStatusNEDefect>


( yes
| none )
Possible values:
- yes : defect in the near-end failure status
- none : no defect in the near-end failure status
Parameter type: <Xdsl::FailureStatusMinBitrate>

specifies the defect status in the


near-end
This element is always shown.

specifies the upstream minimum

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

up-config

up-plan-bitrate

defect-count
rxlos-count

3HH-04416-EBAA-TCZZA 01

Type

Description

( ok
| failure )
Possible values:
- ok : actual group bitrate is above the group minimum
bitrate
- failure : actual group bitrate is below the group minimum
bitrate
Parameter type: <Xdsl::FailureStatusConfig>
( feasible
| not-feasible )
Possible values:
- feasible : configuration feasible
- not-feasible : configuration not feasible e.g. actual group
bitrate is not high enough
Parameter type: <Xdsl::FailureStatusPlanBitrate>
( ok
| failure )
Possible values:
- ok : actual group bitrate is above the group planned bitrate
- failure : actual group bitrate is above the minimum bitrate
but below the group planned bitrate
Parameter type: <Counter>
- 32 bit counter

bitrate threshold alarm status


This element is always shown.

Parameter type: <Counter>


- 32 bit counter

specifies the upstream configured


alarm status
This element is always shown.

specifies the upstream planned


bitrate threshold alarm status
This element is always shown.

Indicates the number of failures


during the accumulation period
This element is always shown.
Indicates the number of lost
ATM cells or ETH fragments due
to sequence ID errors.
This element is only shown in
detail mode.

Released

2123

69 xDSL Bonding Status Commands

69.9 xDSL Bonding Far End Failure Status


Command
Command Description
This command displays the xDSL bonding failure far end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding failure-status far-end [ (if-index) ]

Command Parameters
Table 69.9-1 "xDSL Bonding Far End Failure Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.9-2 "xDSL Bonding Far End Failure Status Command" Display parameters
Specific Information
name
defect

down-min-bitrate

2124

Released

Type

Description

Parameter type: <Xdsl::FailureStatusFEDefect>


( yes
| none )
Possible values:
- yes : defect in the far-end failure status
- none : no defect in the far-end failure status
Parameter type: <Xdsl::FailureStatusMinBitrate>

specifies the defect status in the


far-end
This element is always shown.

specifies

3HH-04416-EBAA-TCZZA

the

downstream

01

69 xDSL Bonding Status Commands

name

down-config

down-plan-bitrate

peer-cpe

bond-cpe

bg-conn-cpes

bg-reg-fail

defect-count
rxlos-count

3HH-04416-EBAA-TCZZA 01

Type

Description

( ok
| failure )
Possible values:
- ok : actual group bitrate is above the group minimum
bitrate
- failure : actual group bitrate is below the group minimum
bitrate
Parameter type: <Xdsl::FailureStatusConfig>
( feasible
| not-feasible )
Possible values:
- feasible : configuration feasible
- not-feasible : configuration not feasible e.g. actual group
bitrate is not high enough
Parameter type: <Xdsl::FailureStatusPlanBitrate>
( ok
| failure )
Possible values:
- ok : actual group bitrate is above the group planned bitrate
- failure : actual group bitrate is above the minimum bitrate
but below the group planned bitrate
Parameter type: <Xdsl::FailureStatusFEPeerCpeConn>
( conn
| not-conn )
Possible values:
- conn : peer cpe is connected
- not-conn : peer cpe is not connected
Parameter type: <Xdsl::FailureStatusFEBondCpeConn>
( conn
| not-conn )
Possible values:
- conn : bonding capable cpe is connected
- not-conn : bonding capable cpe is not connected
Parameter type: <Xdsl::FailureStatusFEBondGrpConnCpe>
( one-cpe
| several-cpe )
Possible values:
- one-cpe : bonding group has one cpe connected
- several-cpe : bonding group has multiple cpe connected
Parameter type: <Xdsl::FailureStatusFEBondGrpRegFail>
( no
| yes )
Possible values:
- no : bonding group register failure not encountered
- yes : bonding group register failure encountered
Parameter type: <Counter>
- 32 bit counter

minimum bitrate threshold alarm


status
This element is always shown.

Parameter type: <Counter>


- 32 bit counter

specifies
the
downstream
configured alarm status
This element is always shown.

specifies the downstream planned


bitrate threshold alarm status
This element is always shown.

specifies the peer cpe connected


alarm status
This element is only shown in
detail mode.
specifies the bonding capable cpe
connected alarm status
This element is only shown in
detail mode.
specifies the bonding group
multiple cpe connected alarm
status
This element is only shown in
detail mode.
specifies the bonding group
discovery or aggregation register
failure alarm status
This element is only shown in
detail mode.
Indicates the number of failures
during the accumulation period
This element is always shown.
Indicates the number of lost
ATM cells or ETH fragments due
to sequence ID errors.
This element is only shown in
detail mode.

Released

2125

69 xDSL Bonding Status Commands

69.10 xDSL Bonding Group Failure Status


Command
Command Description
This command displays the xDSL bonding failure group statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding failure-status group [ (if-index) ]

Command Parameters
Table 69.10-1 "xDSL Bonding Group Failure Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
a unique interface index
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 69.10-2 "xDSL Bonding Group Failure Status Command" Display parameters
Specific Information
name
defect

2126

Released

Type

Description

Parameter type: <Xdsl::BondingGroupFailureStatusDefect>


( none
| not-feasible
| min-bitrate
| no-host
| diff-delay
| incomplete )

specifies the current failure


reason of a bonding group
This element is always shown.

3HH-04416-EBAA-TCZZA

01

69 xDSL Bonding Status Commands

name

failure-count

rx-error-count
unavailable-time

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- none : no defect on the bonding group failure status
- not-feasible : bonding group configuration not feasible
- min-bitrate : bonding group minimum data rate not met
- no-host : bonding group host not reachable
- diff-delay : bonding group differential delay tolerance
exceeded
- incomplete : bonding group incomplete
Parameter type: <Counter>
specifies the number of times a
- 32 bit counter
bonding group is declared
unavailable
This element is always shown.
Parameter type: <Counter>
specifies the number of errored
- 32 bit counter
cells received
This element is always shown.
Parameter type: <Xdsl::IntervalMeasureTime>
specifies accumulated time of
- the measured time interval
bonding group unavailability
- unit: sec
This element is always shown.
- range: [0...86400]

Released

2127

69 xDSL Bonding Status Commands

69.11 xDSL Bonding Group Summary Info


Command
Command Description
This command displays the xDSL bonding group summary information.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding summary [ (index) ]

Command Parameters
Table 69.11-1 "xDSL Bonding Group Summary Info Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

the physical number of the slot

Command Output
Table 69.11-2 "xDSL Bonding Group Summary Info Command" Display parameters
Specific Information
name
occupancy

2128

Released

Type

Description

Parameter type: <SignedInteger>


- a signed integer

indicates the occupancy per slot


of the bonding host function
This element is always shown.

3HH-04416-EBAA-TCZZA

01

70- PPPoE Status Commands

70.1 PPPoE Status Command Tree


70.2 PPPoE Client Emulation Status Command
70.3 PPPoE Interface Status Command

3HH-04416-EBAA-TCZZA 01

70-2130
70-2131
70-2134

Released

2129

70 PPPoE Status Commands

70.1 PPPoE Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoE Status Commands".

Command Tree
----show
----pppoe-client
----emulation
- (ifindex)
- client-id
----session
- (ifindex)

2130

Released

3HH-04416-EBAA-TCZZA

01

70 PPPoE Status Commands

70.2 PPPoE Client Emulation Status Command


Command Description
This command displays the PPPoE client emulation parameters, such as emulation state, and error code for failed
PPPoE emulation.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe-client emulation [ (ifindex) [ client-id <PPPoE::ClientId> ] ]

Command Parameters
Table 70.2-1 "PPPoE Client Emulation Status Command" Resource Parameters
Resource Identifier

Type

(ifindex)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>

3HH-04416-EBAA-TCZZA 01

Description
interface index of the PPPoE
/ client port
/
:
/
/
:

Released

2131

70 PPPoE Status Commands

Resource Identifier

Type

Description

- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <PPPoE::ClientId>
Format:
- the PPPoE client id
- range: [1]

client-id

the PPPoE client id

Command Output
Table 70.2-2 "PPPoE Client Emulation Status Command" Display parameters
Specific Information
name
state

error-code

2132

Released

Type

Description

Parameter type: <PPPoE::pppoeClientEmulationState>


( inited
| ongoing
| failed
| successed
| stopped )
Possible values:
- inited : PPPoE emulation has never been executed since
initialization
- ongoing : emulation is in progress
- failed : emulation failed
- successed : emulation successed and PPPoE session
established
- stopped : PPPoE session has been terminated
Parameter type: <PPPoE::pppoeClientEmulationErrorCode>
( none
| port-failure
| padi-timeout
| padr-timeout
| lcp-timeout
| auth-timeout
| auth-failure
| ncp-failure
| internal
| other
| onu-timeout
| onu-omci-failure )
Possible values:
- none : no errcode
- port-failure : port-failure
- padi-timeout : padi-timeout
- padr-timeout : padr-timeout
- lcp-timeout : lcp-timeout
- auth-timeout : auth-timeout
- auth-failure : auth-failure
- ncp-failure : ncp-failure
- internal : internal err
- other : other err
- onu-timeout : onu-timeout
- onu-omci-failure : onu-omci-failure

the state of the PPPoE client


emulation.
This element is always shown.

the failure reason for failed


PPPoE emulation.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

70 PPPoE Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2133

70 PPPoE Status Commands

70.3 PPPoE Interface Status Command


This command displays the PPPoE interface parameters.

Command Description
User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe-client session [ (ifindex) ]

Command Parameters
Table 70.3-1 "PPPoE Interface Status Command" Resource Parameters
Resource Identifier

Type

(ifindex)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id

2134

Released

Description
interface index of the PPP session
/
/
:
/
/
:

3HH-04416-EBAA-TCZZA

01

70 PPPoE Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SVlan>


- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 70.3-2 "PPPoE Interface Status Command" Display parameters
Specific Information
name

Type

Description

ipv4-addr

Parameter type: <Ip::V4Address>


- IPv4-address

ipv6-addr

Parameter type: <Ip::V6Prefix>


- IPv6-address

mru

Parameter type: <PPPoE::PppProfileMru>


- the MRU of PPP
- range: [0...65535]

IPv4 address of the system


which PPP connection
established.
This element is always shown.
IPv6 address of the system
which PPP connection
established.
This element is always shown.
The MRU of the system link,
which
PPPoE
session
established.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2135

on
is
on
is
on
is

71- Interface Status Commands

71.1 Interface Status Command Tree


71.2 Interface Alarm Status Command
71.3 Physical Interface Status Command
71.4 Interface Status Command
71.5 Interface Test Status Command
71.6 Interface Stack Status Command
71.7 SHub Interface Status Command
71.8 SHub Interface Port Control Status Command
71.9 SHub Interface Uplink Group Status Command
71.10 Interface Statistics Commands
71.11 Interface Shub Troubleshooting Statistics
Commands
71.12 Interface Shub Ethernet statistics Current 15 min
Status Command
71.13 Interface Shub Ethernet Statistics current one day
status command
71.14 Interface Shub Ethernet statistics Previous 15 min
Status Command
71.15 Interface Shub Ethernet Statistics current one day
status command
71.16 Interface Extensive Status Command
71.17 Interface Troubleshooting Ethernet Statistics
Commands

2136

Released

71-2137
71-2138
71-2140
71-2141
71-2151
71-2156
71-2164
71-2166
71-2169
71-2170
71-2173
71-2177
71-2180
71-2183
71-2186
71-2189
71-2191

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.1 Interface Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Interface Status Commands".

Command Tree
----show
----interface
----alarm
- (interface-type)
----phy-itf-status
- (shelf)
----port
- (port)
----test
- (port)
----stack
- (higher)
- lower
----shub
----vlan
- (vlan-id)
----port
- (port)
----group
- (group-id)
----statistics
- (port)
----trouble-shooting
----statistics
- (port)
----eth-frame
----statistics
----current-interval
- (port)
----current-1day
- (port)
----previous-interval
- (port)
- interval-no
----previous-1day
- (port)
- interval-no
----availability
- (port-type)
----trouble-shooting
----ethernet
----statistics
- (slot-id)

3HH-04416-EBAA-TCZZA 01

Released

2137

71 Interface Status Commands

71.2 Interface Alarm Status Command


Command Description
This command shows the alarm configured for the interface and the default minimal severity with which the alarm
is reported.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface alarm [ (interface-type) ]

Command Parameters
Table 71.2-1 "Interface Alarm Status Command" Resource Parameters
Resource Identifier

Type

Description

(interface-type)

Format:
( xdsl-line
| ethernet-line
| shdsl-line
| voicefxs
| pon
| ont
| uni
| epon
| eont
| euni
| ellid
| lag )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
- voicefxs : voicefxs
- pon : pon interface
- ont : ont interface
- uni : uni interface
- epon : epon interface
- eont : epon ont interface
- euni : epon uni interface
- ellid : epon llid interface
- lag : link aggregation group

type of the interface

2138

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Command Output
Table 71.2-2 "Interface Alarm Status Command" Display parameters
Specific Information
name
default-severity

3HH-04416-EBAA-TCZZA 01

Type
Parameter
<Itf::asamIfExtAlmReportingSeverityDefault>
( indeterminate
| warning
| minor
| major
| critical )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

Description
type: The default minimal severity for
an alarm to be reported that will
be used for interfaces.
This element is always shown.

Released

2139

71 Interface Status Commands

71.3 Physical Interface Status Command


Command Description
This command shows the summary of the physical interface, for example, the number of changes which occurred
for the physical interface.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface phy-itf-status [ (shelf) ]

Command Parameters
Table 71.3-1 "Physical Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(shelf)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number

the physical position of the shelf

Command Output
Table 71.3-2 "Physical Interface Status Command" Display parameters
Specific Information
name
no-of-change-occur

2140

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

Number of state changes of


physical lines, equipped on
boards within this shelf.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.4 Interface Status Command


Command Description
This command shows all the parameters related to the interface such as the type of interface, current bandwidth of
the interface, maximum size of the packet supported, and the connector present. All interfaces do not support each
of these parameters.
Ethernet port interfaces supports 14 ethernet ports.
Port 1 : Internal port used for management
Port 2 : External port used for management
Port 3 : Used for L2CP OAM traffic to BRAS
Ports 4-14 : Not used
Ethernet, loop, slip supports largest-pkt-size, current-bandwidth, phy-addr, admin-status, opr-status,
last-chg-opr-stat, in-octets, in-ucast-pkts, in-discard-pkts, in-err-pkts, out-err-pkts, pkts-unknown-proto, out-octets,
high-speed, connector-present and media.
ATM supports phy-addr, opr-status, last-chg-opr-stat, in-octets, in-err-pkts, out-err-pkts, pkts-unknown-proto and
out-octets.
Xdsl-Line and Bonding supports admin-status, opr-status and last-chg-opr-stat.
Bridge Port supports type and last-chg-opr-stat, the remaining interfaces supports opr-status and last-chg-opr-stat.
Shdsl-line supports info, name, admin-status, opr-status and last-chg-opr-stat.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface port [ (port) ]

Command Parameters
Table 71.4-1 "Interface Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
the interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description

Released

2141

71 Interface Status Commands

Resource Identifier

Type

Description

| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-ima : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /

2142

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| dist-router-interface : slot-stacked : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::SVlan> :
<Eqpt::CVlan>
| dist-router-interface : slot-vlan : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::UnstackedVlan>
| euni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::EontSlotId> /
<Eqpt::EontPortId>
| bundle : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::BundleId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface

3HH-04416-EBAA-TCZZA 01

Released

2143

71 Interface Status Commands

Resource Identifier

Type

Description

- atm-if : a static atm interface


- atm-pvc : an atm pvc interface
- bridge-port : a vlan bridge-port
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- sw-loopback : a software loopback interface
- slip : a slip interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a static shdsl line interface
- atm-ima : atm ima
- ethernet-line : an ethernet line interface
- vlan-port : vlan port
- pon : pon
- bundle : bundle
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- euni : euni
- la-group : link aggregation group
- dist-router-interface : dist router interface
Possible values:
- vlan : vlan port
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::BundleId>
- the BUNDLE identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>

2144

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

- the ONT PORT identifier


Field type <Eqpt::EontSlotId>
- Epon Ont Slot
Field type <Eqpt::EontPortId>
- Epon Ont Port
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id
Field type <Eqpt::LogicalId>
- logical id
Field type <Eqpt::VrfId>
- VRF id

Command Output
Table 71.4-2 "Interface Status Command" Display parameters
Specific Information
name

Type

Description

if-index

Parameter type: <SignedInteger>


- a signed integer

info

Parameter type: <PrintableString>


- printable string

type

Parameter type: <Itf::IANAifType>


( ethernet
| sw-loopback
| slip
| atm
| atm-bonding
| bonding
| xdsl-line
| xdsl-channel
| atm-vci-ep
| bridge-port
| l2-vlan
| ip-fwd
| efm
| atm-ima
| shdsl
| ip-gateway

Specifies a unique value for each


interface.
This element is only shown in
detail mode.
A textual string containing
information about the interface.
This string include the name of
the manufacturer, the product
name and the version of the
interface hardware/software.
This element is only shown in
detail mode.
Specifies the type of interface.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2145

71 Interface Status Commands

name

Type
| pon
| bundle
| ont
| uni
| epon
| eont
| euni
| ellid
| lag
| dist-router-interace )
Possible values:
- ethernet : ethernet csmacd
- sw-loopback : software loopback interface
- slip : generic SLIP interface
- atm : atm interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- xdsl-line : xdsl line
- xdsl-channel : xdsl channel
- atm-vci-ep : ATM VCI end point
- bridge-port : transparent bridge interface
- l2-vlan : layer 3 VLAN using IPX
- ip-fwd : IP forwarding interface
- efm : EFM interface
- atm-ima : atm-ima interface
- shdsl : shdsl interface
- ip-gateway : vrf interface
- pon : pon interface
- bundle : bundle interface
- ont : ont interface
- uni : uni interface
- epon : epon interface
- eont : epon ont interface
- euni : epon uni interface
- ellid : epon llid interface
- lag : link aggregation group
- dist-router-interace : dist router interface
Parameter type: <PrintableString>
- printable string

name

Description

Name of the interface.


This element is only shown in
detail mode.
Specifies
interface's
current
bandwidth.
This element is only shown in
detail mode.
Specifies the interface sublayer
has a physical connector or not.
This element is only shown in
detail mode.

high-speed

Parameter type: <Itf::ifHighSpeed>


- interface bandwidth
- unit: Mbit/sec

connector-present

Parameter type: <Itf::ifConnectorPresent>


( not-applicable
| has-connector
| no-connector )
Possible values:
- not-applicable : not-applicable
- has-connector : interface sublayer has a physical connector
- no-connector : interface sublayer doesn't have a physical
connector
Parameter type: <Object>
Specifies information about the
- an object identifier
particular media being used to
realize the interface.

media

2146

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

largest-pkt-size

Parameter type: <Itf::MtuSize>


- packet size
- unit: octets

current-bandwidth

Parameter type: <Itf::ifSpeed>


- interface bandwidth
- unit: bits/sec

phy-addr

Parameter type: <Itf::PhyAddress>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

admin-status

Parameter type: <Itf::ifAdminStatus>


( not-appl
| up
| down
| testing )
Possible values:
- not-appl : not-applicable
- up : admin status is up
- down : admin status is down
- testing : no operational packets can be passed
Parameter type: <Itf::ifOperStatus>
( up
| down
| testing
| unknown
| dormant
| no-value )
Possible values:
- up : permanent virtual circuit
- down : bridge port
- testing : l2 VLAN
- unknown : IPoE
- dormant : PPPoE
- no-value : no entry in the table
Parameter type: <Itf::ElapsedTime10Msec>
- the time elapsed since a certain event

opr-status

last-chg-opr-stat

pkts-unknown-proto

3HH-04416-EBAA-TCZZA 01

Parameter type: <Itf::Counter>


- 32 bit counter

Description
This element is only shown in
detail mode.
The size of the largest packet
which can be sent/received on the
interface, specified in octets. For
interfaces that are used for
transmitting network datagrams,
this is the size of the largest
network datagram that can be
sent on the interface.
This element is only shown in
detail mode.
Specifies the interface's current
bandwidth.
This element is only shown in
detail mode.
The interface's address at its
protocol sub-layer.
This element is only shown in
detail mode.
Specifies state of the interface.
This element is always shown.

The current operational state of


the interface.
This element is always shown.

The value of elapsed time since


the interface entered its current
operational state.
This element is only shown in
detail mode.
Number
of
packets(for
packet-oriented interfaces) or
transmission
units(for
character-oriented
interfaces)
received via the interface which
were discarded because of an
unknown
or
unsupported
protocol.

Released

2147

71 Interface Status Commands

name

Type

in-octets

Parameter type: <Itf::Counter>


- 32 bit counter

out-octets

Parameter type: <Itf::Counter>


- 32 bit counter

in-ucast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

out-ucast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

in-mcast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

out-mcast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

in-broadcast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

out-broadcast-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

in-discard-pkts

Parameter type: <Itf::Counter>

2148

Released

Description
This element is only shown in
detail mode.
The total number of octets
received on the interface,
including framing characters.
This element is only shown in
detail mode.
The total number of octets
transmitted out of the interface,
including framing characters.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The total number of packets that
higher-level protocols requested
be transmitted, and which were
not addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,tarnsmitted
by
this
sub-layer,which were addressed
to a multicast address at this
sub-layer.
This element is only shown in
detail mode.
The total number of packets that
higher-level protocols requested
be transmitted, and which were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The total number of packets that
higher-level protocols requested
be transmitted, and which were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The number of inbound packets

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

Description

- 32 bit counter

which were chosen to be


discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space.
This element is only shown in
detail mode.
The number of outbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space.
This element is only shown in
detail mode.
Number of inbound packets(for
packet-oriented interfaces) or
transmission
units(for
character-oriented interfaces) that
contained errors preventing them
from being deliverable to a
higher-layer protocol.
This element is only shown in
detail mode.
The number of outbound
packets(for
packet-oriented
interfaces)
or
transmission
units(for
character-oriented
interfaces) that could not be
transmitted because of errors.
This element is only shown in
detail mode.
The total number of octets
received on the interface,
including framing characters.
This element is only shown in
detail mode.
The total number of octets
transmitted out of the interface,
including framing characters.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,

out-discard-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

in-err-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

out-err-pkts

Parameter type: <Itf::Counter>


- 32 bit counter

in-octets-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

out-octets-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

in-ucast-pkts-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

out-ucast-pkts-hc

Parameter type: <Itf::Counter64>

3HH-04416-EBAA-TCZZA 01

Released

2149

71 Interface Status Commands

name

Type

Description

- 64 bit counter

tarnsmitted by this sub-layer,


which were not addressed to a
multicast or broadcast address at
this sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which were addressed to a
multicast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which wereaddressed to a
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.

in-mcast-pkts-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

out-mcast-pkts-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

in-broadcast-pkts-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

out-broadcast-pkts-hc

Parameter type: <Itf::Counter64>


- 64 bit counter

2150

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.5 Interface Test Status Command


Command Description
This command shows the parameters related to the testing of an interface.
Metallic Test Access is an example of an interface test. The result of the Metallic Test Access interface test is shown
with this command.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface test [ (port) ]

Command Parameters
Table 71.5-1 "Interface Test Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
index
(1/1/3/0..)
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> / rack/shelf/slot/port
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

2151

of

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId>
| atm-ima : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>

2152

Released

/
/
/
:
/
/
:
/
:
/
:
/
/
:
/
:
/
/
/
/
/
/
:
/
/
:
/
/
/
/
/
/
/
:
/

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :


stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| dist-router-interface : slot-stacked : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::SVlan> :
<Eqpt::CVlan>
| dist-router-interface : slot-vlan : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::UnstackedVlan>
| euni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::EontSlotId> /
<Eqpt::EontPortId>
| bundle : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::BundleId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface
- atm-if : a static atm interface
- atm-pvc : an atm pvc interface
- bridge-port : a vlan bridge-port
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- sw-loopback : a software loopback interface
- slip : a slip interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a static shdsl line interface
- atm-ima : atm ima
- ethernet-line : an ethernet line interface
- vlan-port : vlan port
- pon : pon

3HH-04416-EBAA-TCZZA 01

Released

2153

71 Interface Status Commands

Resource Identifier

Type

Description

- bundle : bundle
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- euni : euni
- la-group : link aggregation group
- dist-router-interface : dist router interface
Possible values:
- vlan : vlan port
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::BundleId>
- the BUNDLE identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::EontSlotId>
- Epon Ont Slot
Field type <Eqpt::EontPortId>
- Epon Ont Port
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id

2154

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::LogicalId>


- logical id
Field type <Eqpt::VrfId>
- VRF id

Command Output
Table 71.5-2 "Interface Test Status Command" Display parameters
Specific Information
name
id
result

code

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <TestAndIncr>


- TestAndIncr
- range: [0...2147483647]
Parameter type: <Itf::ifTestResult>
( none
| success
| in-progress
| not-supported
| unable-to-run
| aborted
| failed )
Possible values:
- none : no tests have been requested since the last reset
- success : test successfully completed
- in-progress : test is still in progress
- not-supported : test is not supported
- unable-to-run : test is unable to run
- aborted : test is aborted
- failed : test is failed
Parameter type: <Object>
- an object identifier

Specifies the current invocation


of the interface's test.
This element is always shown.
Specifies the result of the most
recently requested test
This element is always shown.

Specifies a code which contains


more specific information on the
test result
This element is always shown.

Released

2155

71 Interface Status Commands

71.6 Interface Stack Status Command


Command Description
This command shows the status of the stack.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface stack [ (higher) [ lower <Itf::InterfaceStack> ] ]

Command Parameters
Table 71.6-1 "Interface Stack Status Command" Resource Parameters
Resource Identifier

Type

(higher)

Format:
a higher layer interface index
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-ima : <Eqpt::RackId> / <Eqpt::ShelfId> /

2156

Released

Description

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| no-interface
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni

3HH-04416-EBAA-TCZZA 01

/
/
:
/
/
:
/
:
/
:
/
/
:
/
:
/
/
/
/
/
/
:
/
/
:
/
/
/
/
/
/
/
:
/
:

Released

2157

71 Interface Status Commands

Resource Identifier

Type

Description

stacked : <Eqpt::SVlan> : <Eqpt::CVlan>


| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| bundle : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::BundleId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface
- atm-if : a static atm interface
- atm-pvc : an atm pvc interface
- bridge-port : a vlan bridge-port
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- sw-loopback : a software loopback interface
- slip : a slip interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a static shdsl line interface
- atm-ima : atm ima
- ethernet-line : an ethernet line interface
- vlan-port : vlan port
- pon : pon
- bundle : bundle
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- la-group : link aggregation group
- no-interface : no interface

2158

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

lower

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::BundleId>
- the BUNDLE identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id
Field type <Eqpt::LogicalId>
- logical id
Field type <Eqpt::VrfId>
- VRF id
Parameter type: <Itf::InterfaceStack>
a lower layer interface index
Format:
( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :

Released

2159

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-ima : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| no-interface
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :

2160

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

<Eqpt::SVlan> : <Eqpt::CVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| bundle : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::BundleId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface
- atm-if : a static atm interface
- atm-pvc : an atm pvc interface
- bridge-port : a vlan bridge-port
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- sw-loopback : a software loopback interface
- slip : a slip interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding

3HH-04416-EBAA-TCZZA 01

Released

2161

71 Interface Status Commands

Resource Identifier

Type

Description

- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a static shdsl line interface
- atm-ima : atm ima
- ethernet-line : an ethernet line interface
- vlan-port : vlan port
- pon : pon
- bundle : bundle
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- la-group : link aggregation group
- no-interface : no interface
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::BundleId>
- the BUNDLE identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id

2162

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::LogicalId>


- logical id
Field type <Eqpt::VrfId>
- VRF id

3HH-04416-EBAA-TCZZA 01

Released

2163

71 Interface Status Commands

71.7 SHub Interface Status Command


Command Description
This command shows the current operational state of an interface.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub vlan [ (vlan-id) ]

Command Parameters
Table 71.7-1 "SHub Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

vlan id

Command Output
Table 71.7-2 "SHub Interface Status Command" Display parameters
Specific Information
name
admin-status

oper-status

2164

Released

Type

Description

Parameter type: <Shub::AdminStatus>


( up
| down
| testing
| auto-up )
Possible values:
- up : up
- down : down
- testing : testing
- auto-up : autoup
Parameter type: <Shub::OperStatus>
( up
| down
| testing
| unknown
| dormant
| not-present
| lower-layer-down )

The administrative state of the


vlan interface.
This element is always shown.

The current operational state of


the vlan interface.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

port

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- up : ready to pass packets
- down : down
- testing : in some test mode
- unknown : status can not be determined forsome reason
- dormant : dormant
- not-present : some component is missing
- lower-layer-down : down due to state of lower-layer
interface
Parameter type: <Shub::InterfaceIndex>
the local port.
- shub logical interface index
This element is only shown in
- range: [65536,65537,65538...66047,81920...81921]
detail mode.

Released

2165

71 Interface Status Commands

71.8 SHub Interface Port Control Status Command


Command Description
This command displays the port control status.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show interface shub port [ (port) ]

Command Parameters
Table 71.8-1 "SHub Interface Port Control Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

control index of the port

Command Output
Table 71.8-2 "SHub Interface Port Control Status Command" Display parameters
Specific Information

2166

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

Description

admin-status

Parameter type: <Shub::AdminStatus>


( up
| down
| testing
| auto-up )
Possible values:
- up : up
- down : down
- testing : testing
- auto-up : autoup
Parameter type: <Shub::AdminStatus>
( up
| down
| testing
| auto-up )
Possible values:
- up : up
- down : down
- testing : testing
- auto-up : autoup
Parameter type: <Sys::Speed>
( ten-mbps
| hundred-mbps
| one-gb
| ten-gb
| twodotfive-gb )
Possible values:
- ten-mbps : speed of 10MBPS
- hundred-mbps : speed of 100MBPS
- one-gb : speed of 1GB
- ten-gb : speed of 10GB
- twodotfive-gb : speed of 2.5GB
Parameter type: <Sys::Type>
( user
| subtending
| network
| data
| control
| unused
| outband-mngt )
Possible values:
- user : port to a directly connected user
- subtending : port to a subtended ISAM
- network : port to the service provider (ISP)
- data : port used internally for data traffic
- control : port used internally for control traffic
- unused : port is not in use
- outband-mngt : port is used for outband-management
Parameter type: <Sys::Duplex>
( unknown-trsf-mode
| full
| half )
Possible values:
- unknown-trsf-mode : transfer mode unknown
- full : data transfer in full duplex
- half : data transfer in half duplex
Parameter type: <Sys::PortCtrlMode>

Specifies
the
administrative
status of the interface
This element is always shown.

oper-status

speed

type

duplex

mode

3HH-04416-EBAA-TCZZA 01

Specifies the operational status of


the interface
This element is always shown.

Specifies the interface speed.


This element is always shown.

Specifies the type of port.


This element is always shown.

Specifies whether interface data


transfer mode is full-duplex or
half-duplex.
This element is always shown.

Speficies the mode in which the

Released

2167

71 Interface Status Commands

name

Type

max-mac-addr

mc-flood-mode

2168

Description

( automatic
speed, duplex modes and flow
| 10mbps : full
control of the interface is
| 10mbps : half
determined.
| 100mbps : full
This element is only shown in
| 100mbps : half
detail mode.
| 1gbps : full
| 1gbps : half
| 10gbps : full
| 2.5gbps : full )
Possible values:
- automatic : determine the parameters of interface
automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
- 10gbps : mode for interface is 10Gbps
- 2.5gbps : mode for interface is 2.5Gbps
Possible values:
- full : data transfer in full duplex
- half : data transfer in half duplex
Parameter type: <SignedInteger>
Specifies the maximum number
- a signed integer
of new MAC addresses that can
be learnt over the interface.
This element is only shown in
detail mode.
Parameter type: <Sys::FloodMode>
Specifies the multicast flooding
( mc-flooding
mode of the port is enabled or
| no-mc-flooding )
not.
Possible values:
This element is only shown in
- mc-flooding : enable multicast flooding
detail mode.
- no-mc-flooding : disable multicast flooding

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.9 SHub Interface Uplink Group Status Command


Command Description
This command allows the user to view the current state of an interface

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub group [ (group-id) ]

Command Parameters
Table 71.9-1 "SHub Interface Uplink Group Status Command" Resource Parameters
Resource Identifier

Type

Description

(group-id)

Format:
- the number of uplink group
- range: [1...7]

groupid number

Command Output
Table 71.9-2 "SHub Interface Uplink Group Status Command" Display parameters
Specific Information
name
group-status

threshold
up-links
port-list

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::GroupStatus>


( up
| down
| invalid )
Possible values:
- up : uplink group status up
- down : uplink group status down
- invalid : uplink group status invalid
Parameter type: <Itf::Threshold>
- the min nbr of links to be operational UP in grp
- range: [0...7]
Parameter type: <SignedInteger>
- a signed integer

the current uplink group status


This element is always shown.

Parameter type: <Shub::PortList>


- a list of ports (port 1 is the MSB of the first byte)
- length: 8

the min nbr of links to be


operational UP in grp
This element is always shown.
available number of links in the
group
This element is always shown.
The set of ports members of the
uplink group
This element is always shown.

Released

2169

71 Interface Status Commands

71.10 Interface Statistics Commands


Command Description
This command shows the interface statistics.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub statistics [ (port) ]

Command Parameters
Table 71.10-1 "Interface Statistics Commands" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

port number

Command Output
Table 71.10-2 "Interface Statistics Commands" Display parameters
Specific Information
name

Type

Description

in-octets

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-ucast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters

The total number of octets


received on the interface,
including framing characters.
This element is always shown.
The number of packets, delivered
by this sub-layer to a higher

2170

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

Description

- range: [1...18446744073709551615]

(sub-)layer, which were not


addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The number of inbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space.
This element is only shown in
detail mode.
Number of inbound packets(for
packet-oriented interfaces) or
transmission
units(for
character-oriented interfaces) that
contained errors preventing them
from being deliverable to a
higher-layer protocol.
This element is only shown in
detail mode.
Number
of
packets(for
packet-oriented interfaces) or
transmission
units(for
character-oriented
interfaces)
received via the interface which
were discarded because of an
unknown
or
unsupported
protocol.
This element is only shown in
detail mode.
The total number of octets
transmitted out of the interface,
including framing characters.
This element is always shown.
The
number
of
packets,
tarnsmitted by this sub-layer,
which were not addressed to a

in-mcast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-broadcast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-discard-pkts

Parameter type: <Counter>


- 32 bit counter

in-err-pkts

Parameter type: <Counter>


- 32 bit counter

pkts-unknown-proto

Parameter type: <Counter>


- 32 bit counter

out-octets

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-ucast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

3HH-04416-EBAA-TCZZA 01

Released

2171

71 Interface Status Commands

name

Type

out-mcast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-broadcast-pkts

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-discard-pkts

Parameter type: <Counter>


- 32 bit counter

out-err-pkts

Parameter type: <Counter>


- 32 bit counter

2172

Released

Description
multicast or broadcast address at
this sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which were addressed to a
multicast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which wereaddressed to a
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The number of outbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being transmitted. One possible
reason for discarding such a
packet could be to free up buffer
space.
This element is only shown in
detail mode.
The number of outbound
packets(for
packet-oriented
interfaces)
or
transmission
units(for
character-oriented
interfaces) that could not be
transmitted because of errors.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.11 Interface Shub Troubleshooting Statistics


Commands
Command Description
This command shows the interface statistics for trouble shooting counters on FD-REM(applicable to only
NANT-A). Statistics regarding frames received and transmitted on the shub port are displayed.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub trouble-shooting statistics [ (port) ]

Command Parameters
Table 71.11-1 "Interface Shub Troubleshooting Statistics Commands" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

port number

3HH-04416-EBAA-TCZZA 01

Released

2173

71 Interface Status Commands

Command Output
Table 71.11-2 "Interface Shub Troubleshooting Statistics Commands" Display parameters
Specific Information
name

Type

Description

in-octets-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-frames-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-ucast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-mcast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-broadcast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

in-discard-pkts

Parameter type: <Counter>


- 32 bit counter

fcs-err

Parameter type: <Counter>


- 32 bit counter

The total number of octets


received on the interface,
including framing characters.
This element is always shown.
64 bits counter holding the
number of frames that have been
received by this port from its
segment; only frames for a
protocol being processed by the
local bridging function are
counted
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The number of inbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space.
This element is only shown in
detail mode.
A count of frames received on a
particular interface that has frame
check error status is returned by
the MAC service to the LLC (or
other MAC user).

2174

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

align-err

Parameter type: <Counter>


- 32 bit counter

sym-err

Parameter type: <Counter>


- 32 bit counter

oversize-pkts

Parameter type: <Counter>


- 32 bit counter

undersize-pkts

Parameter type: <Counter>


- 32 bit counter

out-discard-pkts

Parameter type: <Counter>


- 32 bit counter

out-broadcast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-mcast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-ucast-pkts-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

out-frames-hc

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

3HH-04416-EBAA-TCZZA 01

Description
This element is always shown.
A count of frames received on a
particular interface that has
alignment error status returned by
MAC service to the LLC(or other
MAC user).
This element is always shown.
The number of times there was an
invalid data symbol.
This element is always shown.
The total number of packets
received that were longer than
1518 octets (excluding framing
bits,but including FCS octets).
This element is always shown.
The total number of packets
received that were less than 64
octets long (excluding framing
bits, but including FCS octets)
This element is always shown.
The number of outbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being transmitted. One possible
reason for discarding such a
packet could be to free up buffer
space.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which wereaddressed to a
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which were addressed to a
multicast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
tarnsmitted by this sub-layer,
which were not addressed to a
multicast or broadcast address at
this sub-layer.
This element is only shown in
detail mode.
64 bits counter holding the
number of frames that have been
transmitted by this port to its
segment; only frames for a
protocol being processed by the
local bridging function are

Released

2175

71 Interface Status Commands

name

Type

out-octets-hc

2176

Parameter type: <Shub::Counter64>


- Shub 64 bit counters
- range: [1...18446744073709551615]

Released

Description
counted
This element is only shown in
detail mode.
The total number of octets
transmitted out of the interface,
including framing characters.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.12 Interface Shub Ethernet statistics Current 15


min Status Command
Command Description
This command shows the interface statistics for Ethernet frame counters for the last 15 Minutes or lesser.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub eth-frame statistics current-interval [ (port) ]

Command Parameters
Table 71.12-1 "Interface Shub Ethernet statistics Current 15 min Status Command" Resource
Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

shub uplink port number

3HH-04416-EBAA-TCZZA 01

Released

2177

71 Interface Status Commands

Command Output
Table 71.12-2 "Interface Shub Ethernet statistics Current 15 min Status Command" Display
parameters
Specific Information
name
elapse-time

Description

Parameter type: <Shub::ElapsedTime>


Elapsed time (time from start of
- Time (measured or elapsed time) range of ethernet frame the interval to the get instance)
15min interval range from 0 to 900
This element is always shown.
- unit: sec
- range: [0...900]
Parameter type: <Shub::MeasuredTime>
The actual time for which the
- Time (measured or elapsed time) range of ethernet frame statistics collection was done
15min interval range from 0 to 900
successfully for the given interval
- unit: sec
This element is always shown.
- range: [0...900]
Parameter type: <Shub::InvalidFlag>
Validity of corresponding PM
( true
data
| false )
This element is always shown.
Possible values:
- true : counter is invalid
- false : counter is valid
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of octets
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of octets transmitted
- 64 bit counter
on the ethernet interface for the
given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of received frames
- 64 bit counter
that are discarded on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of frames discarded
- 64 bit counter
when transmitting on the ethernet
interface for the given interval.

measure-time

in-valid-flag

in-errors

out-errors

in-frames

out-frames

in-octets

out-octets

in-discards

out-discards

2178

Type

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

in-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is only shown in
detail mode.
The number of received frames
that are dropped on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
The number of frames dropped
when transmitting on the ethernet
interface for the given interval.
This element is only shown in
detail mode.

Released

2179

71 Interface Status Commands

71.13 Interface Shub Ethernet Statistics current


one day status command
Command Description
This command shows the statistics for Ethernet frame counters for the ports for every 24 Hrs. It contains statistics
for the last 24 Hours only.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub eth-frame statistics current-1day [ (port) ]

Command Parameters
Table 71.13-1 "Interface Shub Ethernet Statistics current one day status command" Resource
Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

shub uplink port number

2180

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Command Output
Table 71.13-2 "Interface Shub Ethernet Statistics current one day status command" Display
parameters
Specific Information
name
elapse-time

measure-time

in-valid-flag

in-errors

out-errors

in-frames

out-frames

in-octets

out-octets

in-discards

out-discards

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::ElapsedTime1d>


Elapsed time (time from start of
- Time (measured or elapsed time) range of ethernet frame the interval to the get instance)
1day interval range from 0 to 86400
This element is always shown.
- unit: sec
- range: [0...86400]
Parameter type: <Shub::MeasuredTime1d>
The actual time for which the
- Time (measured or elapsed time) range of ethernet frame statistics collection was done
1day interval range from 0 to 86400
successfully for the given interval
- unit: sec
This element is always shown.
- range: [0...86400]
Parameter type: <Shub::InvalidFlag>
Validity of corresponding PM
( true
data
| false )
This element is always shown.
Possible values:
- true : counter is invalid
- false : counter is valid
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of octets
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of octets transmitted
- 64 bit counter
on the ethernet interface for the
given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of received frames
- 64 bit counter
that are discarded on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of frames discarded
- 64 bit counter
when transmitting on the ethernet
interface for the given interval.

Released

2181

71 Interface Status Commands

name

Type

in-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

2182

Released

Description
This element is only shown in
detail mode.
The number of received frames
that are dropped on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
The number of frames dropped
when transmitting on the ethernet
interface for the given interval.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.14 Interface Shub Ethernet statistics Previous


15 min Status Command
Command Description
This command shows the interface statistics for Ethernet frame counters for the last 15 Minutes only.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub eth-frame statistics previous-interval [ (port) [ interval-no <ETHITF::IntervalNumber15min>
]]

Command Parameters
Table 71.14-1 "Interface Shub Ethernet statistics Previous 15 min Status Command" Resource
Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Parameter type: <ETHITF::IntervalNumber15min>

shub uplink port number

interval-no

3HH-04416-EBAA-TCZZA 01

the interval number

Released

2183

71 Interface Status Commands

Resource Identifier

Type

Description

Format:
- the specification of 15min-interval-number
- range: [1...96]

Command Output
Table 71.14-2 "Interface Shub Ethernet statistics Previous 15 min Status Command" Display
parameters
Specific Information
name
measure-time

Description

Parameter type: <Shub::MeasuredTime>


The actual time for which the
- Time (measured or elapsed time) range of ethernet frame statistics collection was done
15min interval range from 0 to 900
successfully for the given interval
- unit: sec
This element is always shown.
- range: [0...900]
Parameter type: <Shub::InvalidFlag>
Validity of corresponding PM
( true
data
| false )
This element is always shown.
Possible values:
- true : counter is invalid
- false : counter is valid
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of octets
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of octets transmitted
- 64 bit counter
on the ethernet interface for the
given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of received frames
- 64 bit counter
that are discarded on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of frames discarded
- 64 bit counter
when transmitting on the ethernet
interface for the given interval.
This element is only shown in

in-valid-flag

in-errors

out-errors

in-frames

out-frames

in-octets

out-octets

in-discards

out-discards

2184

Type

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

in-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
The number of received frames
that are dropped on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
The number of frames dropped
when transmitting on the ethernet
interface for the given interval.
This element is only shown in
detail mode.

Released

2185

71 Interface Status Commands

71.15 Interface Shub Ethernet Statistics current


one day status command
Command Description
This command shows the interface statistics for Ethernet frame counters for the ports for the past 7 days or lesser.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub eth-frame statistics previous-1day [ (port) [ interval-no <Shub::Valid1dPrevInt> ] ]

Command Parameters
Table 71.15-1 "Interface Shub Ethernet Statistics current one day status command" Resource
Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Parameter type: <Shub::Valid1dPrevInt>
Format:

shub uplink port number

interval-no

2186

Released

The interval number

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

Resource Identifier

Type

Description

- Range of the valid interval from 1 to 7


- range: [1...7]

Command Output
Table 71.15-2 "Interface Shub Ethernet Statistics current one day status command" Display
parameters
Specific Information
name
measure-time

in-valid-flag

in-errors

out-errors

in-frames

out-frames

in-octets

out-octets

in-discards

out-discards

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::MeasuredTime1d>


The actual time for which the
- Time (measured or elapsed time) range of ethernet frame statistics collection was done
1day interval range from 0 to 86400
successfully for the given interval
- unit: sec
This element is always shown.
- range: [0...86400]
Parameter type: <Shub::InvalidFlag>
Validity of corresponding PM
( true
data
| false )
This element is always shown.
Possible values:
- true : counter is invalid
- false : counter is valid
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of error frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of frames
- 64 bit counter
transmitted on the ethernet
interface for the given interval.
This element is always shown.
Parameter type: <Itf::IfXCounter64>
The total number of octets
- 64 bit counter
received on the ethernet interface
for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of octets transmitted
- 64 bit counter
on the ethernet interface for the
given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of received frames
- 64 bit counter
that are discarded on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
Parameter type: <Itf::IfXCounter64>
The number of frames discarded
- 64 bit counter
when transmitting on the ethernet
interface for the given interval.
This element is only shown in
detail mode.

Released

2187

71 Interface Status Commands

name

Type

Description

in-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-drops

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

The number of received frames


that are dropped on the ethernet
interface for the given interval.
This element is only shown in
detail mode.
The number of frames dropped
when transmitting on the ethernet
interface for the given interval.
This element is only shown in
detail mode.

2188

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.16 Interface Extensive Status Command


Command Description
This command shows the parameters related to an interface such as next avalable port type, counter indicating
number of state changes, and number of network interfaces.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface availability [ (port-type) ]

Command Parameters
Table 71.16-1 "Interface Extensive Status Command" Resource Parameters
Resource Identifier

Type

Description

(port-type)

Format:
( xdsl-line
| ethernet-line )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line

the port type

Command Output
Table 71.16-2 "Interface Extensive Status Command" Display parameters
Common Information:common
name
Type
change-count

Parameter type: <Counter>


- 32 bit counter

interface-cnt

Parameter type: <SignedInteger>


- a signed integer

Specific Information
name
next-available

3HH-04416-EBAA-TCZZA 01

Type

Description
Number of state changes of the
physical line.
This element is always shown.
The number of network interfaces
(regardless of their current state)
present on this system.
This element is always shown.

Description

Parameter type: <Itf::NextAvailable>


Specifies the next available
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / physical interface can be
<Eqpt::PortId>
retrieved.
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is always shown.
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

Released

2189

71 Interface Status Commands

name

Type

Description

<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

2190

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

71.17 Interface Troubleshooting Ethernet Statistics


Commands
Command Description
This command shows the interface statistics for trouble shooting counters on FD-REM at far-end side. Statistics
regarding frames received and transmitted at the remote LT side are displayed.All these counters are supported
only for NDLT-G and NELT-B LT card, "not-supported" will be displayed for other LT cards.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface trouble-shooting ethernet statistics [ (slot-id) ]

Command Parameters
Table 71.17-1 "Interface Troubleshooting Ethernet Statistics Commands" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

slot id

Command Output
Table 71.17-2 "Interface Troubleshooting Ethernet Statistics Commands" Display parameters
Specific Information
name
entry-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <ETHITF::CounterEntryStatus>


( valid
| invalid )
Possible values:
- valid : counters for this ifIndex are valid
- invalid : entry represents one of the device's addresses

The status of the entry. Valid


indicates the counters have actual
values, invalid means the
counters are unreliable.
This element is always shown.

Released

2191

71 Interface Status Commands

name

Type

Description

in-octets-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-octets-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

in-discard-pkts

Parameter type: <Itf::IfCounter32>


- 32 bit counter

fcs-err

Parameter type: <Itf::IfCounter32>


- 32 bit counter

align-err

Parameter type: <Itf::IfCounter32>


- 32 bit counter

oversize-pkts

Parameter type: <Itf::IfCounter32>


- 32 bit counter

undersize-pkts

Parameter type: <Itf::IfCounter32>


- 32 bit counter

in-ucast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

in-mcast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

in-broadcast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

The total number of octets


received on the LT interface.
This element is always shown.
The total number of octets
transmitted out of the interface,
including framing characters.
This element is always shown.
The number of inbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a
higher-layer
protocol.
One
possible reason for discarding
such a packet could be to free up
buffer space.
This element is only shown in
detail mode.
A count of frames received on a
particular interface that has frame
check error status is returned by
the MAC service to the LLC (or
other MAC user).
This element is always shown.
A count of frames received on a
particular interface that has
alignment error status returned by
MAC service to the LLC(or other
MAC user).
This element is always shown.
The total number of packets
received that were longer than
1518 octets (excluding framing
bits,but including FCS octets).
This element is always shown.
The total number of packets
received that were less than 64
octets long (excluding framing
bits, but including FCS octets)
This element is always shown.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
The number of packets, delivered
by this sub-layer to a higher

2192

Released

3HH-04416-EBAA-TCZZA

01

71 Interface Status Commands

name

Type

in-frames-hc

Parameter type: <Counter64>


- 64 bit counter

out-broadcast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-mcast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-ucast-pkts-hc

Parameter type: <Itf::IfXCounter64>


- 64 bit counter

out-frames-hc

Parameter type: <Counter64>


- 64 bit counter

3HH-04416-EBAA-TCZZA 01

Description
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
The total number of packets,
delivered by this sub-layer to a
higher (sub-)layer
This element is only shown in
detail mode.
The
number
of
packets,
transmitted by this sub-layer,
which were addressed to a
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
transmitted by this sub-layer,
which were addressed to a
multicast
address
at
this
sub-layer.
This element is only shown in
detail mode.
The
number
of
packets,
transmitted by this sub-layer,
which were not addressed to a
multicast or broadcast address at
this sub-layer.
This element is only shown in
detail mode.
The total number of packets,
delivered by this sub-layer to a
higher (sub-)layer
This element is only shown in
detail mode.

Released

2193

72- SNTP Status Commands

72.1 SNTP Status Command Tree


72.2 SNTP Status Command

2194

Released

72-2195
72-2196

3HH-04416-EBAA-TCZZA

01

72 SNTP Status Commands

72.1 SNTP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "SNTP Status Commands".

Command Tree
----show
----sntp

3HH-04416-EBAA-TCZZA 01

Released

2195

72 SNTP Status Commands

72.2 SNTP Status Command


Command Description
This command displays the information about the SNTP and its related parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show sntp

Command Output
Table 72.2-2 "SNTP Status Command" Display parameters
Specific Information
name
operating-mode

system-time
shub-time

2196

Released

Type

Description

Parameter type: <Sys::SNTPOperatingMode>


( unicast
| anycast
| multicast )
Possible values:
- unicast : operating mode unicast value 1
- anycast : operating mode anycast value 2
- multicast : operating mode multicast value 3
Parameter type: <Sys::GaugeTimeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
Parameter type: <Sys::GaugeTimeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)

specifies the operating mode for


the SNTP application at the
SNMP agent.
This element is always shown.

specifies the network time.


This element is always shown.
specifies shub network time.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

73- SNTP Server Commands

73.1 SNTP Server Command Tree


73.2 SNTP Server Status Command

3HH-04416-EBAA-TCZZA 01

73-2198
73-2199

Released

2197

73 SNTP Server Commands

73.1 SNTP Server Command Tree


Description
This chapter gives an overview of nodes that are handled by "SNTP Server Commands".

Command Tree
----show
----sntp
----server-table
- (server-ip-addr)

2198

Released

3HH-04416-EBAA-TCZZA

01

73 SNTP Server Commands

73.2 SNTP Server Status Command


Command Description
This command displays the information about the SNTP Servers and its related parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show sntp server-table [ (server-ip-addr) ]

Command Parameters
Table 73.2-1 "SNTP Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(server-ip-addr)

Format:
- IPv4-address

specifies the ip address of the


sntp server

Command Output
Table 73.2-2 "SNTP Server Status Command" Display parameters
Specific Information
name
port
priority
issyncsource

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::ServerPortNumber>


- port number
- range: [0...65535]
Parameter type: <Sys::priority>
- sntp server priority(1 - high)
- range: [1...3]
Parameter type: <Sys::issyncsrc>
( yes
| no )
Possible values:
- yes : this server is the current source of time
synchronization
- no : this server is not the current source of time
synchronization

specifies the port number of the


sntp server
This element is always shown.
specifies the priority number of
the sntp server
This element is always shown.
display whether this sntp server is
the current source of time
synchronization
This element is always shown.

Released

2199

74- System Status Commands

74.1 System Status Command Tree


74.2 SHub System Version Status Command
74.3 SHub System HTTP Status Command
74.4 SHub System Common Status Command
74.5 SHub System Control Status Command
74.6 SHub IP Filter Status Command
74.7 System Statistics Command
74.8 System Licenses Status Command
74.9 System Clock Status Command
74.10 Show syslog parameters
74.11 System Memory Usage Status Command
74.12 System CPU Load Status Command
74.13 System CDE Command
74.14 System Clock Management Status Command

2200

Released

74-2201
74-2202
74-2203
74-2204
74-2205
74-2207
74-2212
74-2213
74-2217
74-2219
74-2220
74-2222
74-2224
74-2225

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.1 System Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "System Status Commands".

Command Tree
----show
----system
----shub
----entry
----version
----status
----misc
----config-control
- (ctrl-index)
----filters
----ip
- (index-num)
----entry
----license
- (feature)
----clock-mgmt
----syslog
----memory-usage
- (slot)
----cpu-load
- (slot)
----cde-bitmap
----sync-if-timing
- (priority)

3HH-04416-EBAA-TCZZA 01

Released

2201

74 System Status Commands

74.2 SHub System Version Status Command


Command Description
This command displays the version of the SHub system parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry version

Command Output
Table 74.2-2 "SHub System Version Status Command" Display parameters
Specific Information
name
sw-release-num

2202

Released

Type

Description

Parameter type: <Sys::ReleaseNum>


- release number
- length: 1<=x<=7

specifies the software version


number.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.3 SHub System HTTP Status Command


Command Description
This command displays the last changed time of the status of the SHub HTTP access.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry status

Command Output
Table 74.3-2 "SHub System HTTP Status Command" Display parameters
Specific Information
name
last-chg-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <PrintableString>


- printable string

Specifies
whether
last
configuration change has been
saved in flash/remote and current
status of restore.
This element is always shown.

Released

2203

74 System Status Commands

74.4 SHub System Common Status Command


Command Description
This command displays the common system parameters of the SHub.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry misc

Command Output
Table 74.4-2 "SHub System Common Status Command" Display parameters
Specific Information
name

Type

Description

def-intf

Parameter type: <Sys::DefInterface>


- default interface name
- length: 1<=x<=16

base-bdg-addr

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

sys-mac-addr

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

Name of the default interface that


can be used for communicating
with the system for configuration
through SNMP.
This element is always shown.
Specifies the MAC address used
by the bridge when it must be
referred to in a unique fashion.
This element is always shown.
Specifies the system MAC
address used by this bridge when
it must be referred to in a unique
fashion.
This element is always shown.

2204

Released

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.5 SHub System Control Status Command


Command Description
This command displays the system control parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub config-control [ (ctrl-index) ]

Command Parameters
Table 74.5-1 "SHub System Control Status Command" Resource Parameters
Resource Identifier

Type

Description

(ctrl-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

control index of the config

Command Output
Table 74.5-2 "SHub System Control Status Command" Display parameters
Specific Information
name
egress

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::EgressStatus>


( egress-enabled
| egress-disabled )
Possible values:
- egress-enabled : enable this status
- egress-disabled : disable this status

Specifies the transmission of


egress traffic over this interface is
enabled or not.
This element is always shown.

Released

2205

74 System Status Commands

name

Type

Description

collection

Parameter type: <Sys::CollectionStatus>


( collection
| no-collection )
Possible values:
- collection : enable the collection of statistics
- no-collection : disable the collection of statistics
Parameter type: <Sys::ConfigCtrlStatus>
( enable
| disable )
Possible values:
- enable : makes the entry valid
- disable : makes the entry invalid

Specifies the statistics collection


for this interface is enabled or
not.
This element is always shown.

ctrl-status

2206

Released

Specifies the config control


status.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.6 SHub IP Filter Status Command


Command Description
This command displays IP filter related information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub filters ip [ (index-num) ]

Command Parameters
Table 74.6-1 "SHub IP Filter Status Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]

L3 Filter rule number

Command Output
Table 74.6-2 "SHub IP Filter Status Command" Display parameters
Specific Information
name
protocol
short name: proto

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::Protocol>


( icmp
| igmp
| ggp
| ip
| tcp
| egp
| igp
| nvp
| udp
| irtp
| idrp
| rsvp
| msrp
| igrp
| ospf
| any )
Possible values:
- icmp : check the packet for icmp

Specifies the type of protocol to


be checked against the packet.
This element is always shown.

Released

2207

74 System Status Commands

name

Type

msg-type
short name: msg/type

msg-code
short name: msg/code

2208

Released

- igmp : check the packet for igmp


- ggp : check the packet for ggp
- ip : check the packet for ip
- tcp : check the packet for tcp
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- udp : check the packet for udp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
Parameter type: <Sys::MsgType>
( echo-reply
| ( dest-unreach | dst-unr )
| src-quench
| redirect
| echo-request
| time-exceeded
| param-prob
| ( time-stamp-req | ts-req )
| ( time-stamp-reply | ts-rsp )
| ( infor-req | info-req )
| ( infor-reply | info-rsp )
| ( addr-mask-req | mask-req )
| ( addr-mask-reply | mask-rsp )
| ( no-icmp-type | no-icmp ) )
Possible values:
- echo-reply : echo reply
- dest-unreach : destination unreachable
- dst-unr : destination unreachable
- src-quench : source quench
- redirect : redirect
- echo-request : echo request
- time-exceeded : time exceeded message
- param-prob : parameter problem
- time-stamp-req : timestamp request message
- ts-req : timestamp request message
- time-stamp-reply : timestamp reply messages
- ts-rsp : timestamp reply messages
- infor-req : information request
- info-req : information request
- infor-reply : information reply
- info-rsp : information reply
- addr-mask-req : address mask request
- mask-req : address mask request
- addr-mask-reply : address mask reply
- mask-rsp : address mask reply
- no-icmp-type : message type is not icmp
- no-icmp : message type is not icmp
Parameter type: <Sys::MsgCode>
( ( network-unreach | nw-unreach )
| ( host-unreach | hst-unreach )
| ( protocol-unreach | proto-unreach )

Description

Specifies the message type to be


checked against the packet. If the
message type matches with the
packet, then the packet will be
dropped / allowed based on the
action set.
This element is only shown in
detail mode.

Specifies the message code to be


checked against the packet. If the
packet matches with the message
code, then the packet will be

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

name

dst-ip-addr

src-ip-addr

3HH-04416-EBAA-TCZZA 01

Type

Description

| ( port-unreach | prt-unreach )
| ( fragment-need | frag-need )
| ( src-route-fail | src-rt-fail )
| ( dest-nwk-unknown | dst-nw-unkn )
| ( dest-host-unknown | dst-hst-unkn )
| ( src-host-isolated | src-hst-iso )
| ( dest-nwk-prohibit | dst-nw-proh )
| ( dest-host-prohibit | dst-hst-proh )
| ( nwk-unreach-tos | nw-unr-tos )
| ( host-unreach-tos | hst-unr-tos )
| ( no-icmp-code | no-icmp ) )
Possible values:
- network-unreach : network unreachable
- nw-unreach : network unreachable
- host-unreach : host unreachable
- hst-unreach : host unreachable
- protocol-unreach : protocol unreachable
- proto-unreach : protocol unreachable
- port-unreach : port unreachable
- prt-unreach : port unreachable
- fragment-need : fragmentation needed
- frag-need : fragmentation needed
- src-route-fail : source route failed
- src-rt-fail : source route failed
- dest-nwk-unknown : destination network unknown
- dst-nw-unkn : destination network unknown
- dest-host-unknown : destination host unknown
- dst-hst-unkn : destination host unknown
- src-host-isolated : source host isolated
- src-hst-iso : source host isolated
- dest-nwk-prohibit : destination network administratively
prohibited
- dst-nw-proh : destination network administratively
prohibited
- dest-host-prohibit : destination host administratively
prohibited
- dst-hst-proh : destination host administratively prohibited
- nwk-unreach-tos : network unreachable for type of service
- nw-unr-tos : network unreachable for type of service
- host-unreach-tos : host unreachable for type of service
- hst-unr-tos : host unreachable for type of service
- no-icmp-code : message type is not icmp
- no-icmp : message type is not icmp
Parameter type: <Ip::AddressAndIpMaskFull>
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::AddressAndIpMaskFull>
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

dropped / allowed based on the


action set
This element is only shown in
detail mode.

the destination IP address and


mask to be matched with the
packet.
This element is always shown.

the source IP address and mask to


be matched with the packet.
This element is always shown.

Released

2209

74 System Status Commands

name

Type

Description

min-dst-port

Parameter type: <SignedInteger>


- a signed integer

max-dst-port

Parameter type: <SignedInteger>


- a signed integer

min-src-port

Parameter type: <SignedInteger>


- a signed integer

max-src-port

Parameter type: <SignedInteger>


- a signed integer

in-port-list

Parameter type: <Shub::PortList>


- a list of ports (port 1 is the MSB of the first byte)
- length: 8

out-port-list

Parameter type: <Shub::PortList>


- a list of ports (port 1 is the MSB of the first byte)
- length: 8

ack-bit

Parameter type: <Sys::AckBit>


( establish
| not-establish
| any )
Possible values:
- establish : establish the bit
- not-establish : not establish the bit
- any : default value
Parameter type: <Sys::RstBit>
( set
| not-set
| any )
Possible values:
- set : set the bit
- not-set : not set the bit
- any : default value
Parameter type: <Sys::TosDisplay>
( best-effort
| high-reliable
| high-throughput
| high-relia-thro
| low-delay
| low-delay-high-relai
| low-delay-high-thro
| best-tos

Specifies the minimum port in


the destination TCP/UDP port
range.
This element is only shown in
detail mode.
Specifies the maximum port in
the destination TCP/UDP port
range.
This element is only shown in
detail mode.
Specifies the minimum port in
the source TCP/UDP port range.
This element is only shown in
detail mode.
Specifies the maximum port in
the source TCP/UDP port range.
This element is only shown in
detail mode.
Specifies the complete set of
ports over which if the packet
arrives the filter rule will be
applicable. If the incoming port
list is '0', the filter rule is
applicable for all the incoming
ports.
This element is only shown in
detail mode.
Specifies the complete set of
ports over which the packet will
be sent.
This element is only shown in
detail mode.
Specifies whether TCP ACK bit
to be checked or not against the
packet.
This element is only shown in
detail mode.

rst-bit

tos

2210

Released

Specifies whether TCP RST bit


to be checked or not against the
packet.
This element is only shown in
detail mode.

Specifies whether IP TOS bit to


be checked or not against the
packet.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

name

direction

action

match-cnt
short name: cnt
vlan-id
short name: vlan

3HH-04416-EBAA-TCZZA 01

Type
| any )
Possible values:
- best-effort : best-effort
- high-reliable : high reliable
- high-throughput : high through put
- high-relia-thro : high reliable and through put
- low-delay : low delay
- low-delay-high-relai : low delay and high reliability
- low-delay-high-thro : low delay and high through put
- best-tos : low delay, high reliability and through put
- any : any tos value
Parameter type: <Sys::Direction>
( in
| out )
Possible values:
- in : incoming packets
- out : outgoing packets
Parameter type: <Sys::L3Action>
( action-allow
| action-drop )
Possible values:
- action-allow : the packet will be forwarded
- action-drop : the packet will be discarded
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Vlan::VlanFilterIndex>
( any
| <Vlan::VlanFilterIndex> )
Possible values:
- any : default vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4093]

Description

Specifies in which direction the


Filters are to be applied on the
packets, either to incoming or
outgoing packets.
This element is only shown in
detail mode.
Specifies the action to be taken
on the packet if the filter rule
matches.
This element is only shown in
detail mode.
Specifies the number of times
this filter is matched.
This element is always shown.
Displays Vlan Id
This element is always shown.

Released

2211

74 System Status Commands

74.7 System Statistics Command


Command Description
This command displays the status of the list commands.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system entry

Command Output
Table 74.7-2 "System Statistics Command" Display parameters
Specific Information
name
status-bit-map
mib-version
init-progress

2212

Released

Type

Description

Parameter type: <Sys::AsamSysStatusBitMap>


- status bitmap
Parameter type: <Sys::asamMibVersion>
- a printable string
- length: x<=21
Parameter type: <Sys::AsamSystemInitProgress>
- progress of system initialisation indicated as percent
- unit: percent
- range: [0...100]

Specifies the status bitmap.


This element is always shown.
Specifies the version of the
management interface.
This element is always shown.
Specifies the progress of the
system initialization indicated as
a percentage.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.8 System Licenses Status Command


Command Description
This command displays the routing-license indicating the status of the L3 routing protocols and displays also the
number of software licenses for the following features.
For ADSL2+, the counter indicates the number of XDSL lines for which an ADSL2+ operational mode (POTS
and/or ISDN) is enabled in its configuration, and supported by the LT board, and for which the XDSL board is
equipped.
For READSL2 operational mode (US mode 1 and/or US mode 2), the counter is enabled in its configuration, and
supported by the LT board, and for which the XDSL board is equipped.
For IGMP, the counter indicates the number of DSL subscriber lines for which an IGMP control channel has been
oonfigured.
For xDSL Annex-M, the counter indicates the number of DSL subscriber line which is configured for Annex-M.
For IP-Forwarding, the counter indicates the number of DSL subscriber lines configured.
For PPPoX Relay, the counter indicates the number of DSL subscriber lines configured.
For 802.1x, the counter indicates the number of DSL subscriber lines for which 802.1x has been configured as
'enabled'.
For IPoA-CC/RB, the counter indicates the number of DSL subscriber lines which are configured for IPoA cross
connect mode and enhanced i-bridge mode .In Release 3.6 IPOA-CC is replaced by IPOA-CC/RB
For UPBO Policing, the counter indicates the number of XDSL lines for which a VDSL2 opmode has been selected,
for which UPBO Policing pbo mode has been enabled in its configuration and supported by the LT board and for
which the XDSL board is equipped. The counter is decremented when one of these conditions is not met anymore.
For XDSL-Perline-Overrule, the counter indicates the number of XDSL lines for which the per-line overrule data
has been used in its configuration and for which the XDSL board is equipped.
For Impulse Noise Sensor, the counter indicates the number of XDSL lines for which the Impulse Noise Sensor is
enabled and for which the XDSL board is equipped.
For ADSL1/2 PSD Shaping, the counter indicates the number of XDSL line configured for which ADSL1 or ADSL2
opMode is enabled with DBPO shaping and supported by the LT board and for which the XDSL board is
equipped.The counter is decremented if the DPBO profile is unassigned or if the XDSL line is unconfigured.
For xDSL Annex-J, the counter indicates the number of DSL subscriber line which is configured for Annex-J.
For syncE clock source, the counter indicates the number of Synchronous Ethernet ports are configured as a clock
source.
For 2dot5gbps-lt, the counter indicates the number of LTs that operate at 2.5Gbps link speed.
For redcy, the counter indicates the number protection groups are enabled (unlocked).
Shdsl-ctc: this key isn't used, the counter remains zero.
For VDSL2, the counter indicates the number of xdsl lines for which Seamless Rate Adaptation and VDSL2 is
enabled.
For ARQ, the counter indicates the number of XDSL lines for which ARQ is enabled in the configuration,
supported by the LT board and for which the XDSL board is equipped.
For 10 Gbps enabled LT, the counter indicates the number of LTs that have an uplink that is running at 10 Gbps
speed.
For 20 Gbps enabled LT, the counter indicates the number of LTs that have an uplink that is running at 20 Gbps

3HH-04416-EBAA-TCZZA 01

Released

2213

74 System Status Commands

speed.
For ipv6 security,the coutner indicates the number of access lines (DSL, Ethernet or ONT UNI) where one or more
IPv6 security features are activated.
For Higig NT, the counter indicates whether lawful intercept is enabled (value 1) or Disabled (value 0).
For vectoring, the counter indicates the number of lines where a vectoring profile has been assigned to.
For Green DSL L2 mode,the counter indicates the number of xDSL lines which are equipped and configured with
L2 mode enabled.
For Ethernet OAM Advanced Monitoring Functions,the counter indicates the number of MEPS which can send
and/or receive CFM Continuity Check Messages.
For MPLS Advanced Resiliency, the counter indicates whether MPLS-FRR or MPLS LSR is being used (value 1) or
not used (value 0).
For 40 Gbps enabled LT, the counter indicates the number of LTs that have an uplink that is running at 40 Gbps
speed.
For Type-B protection, the counter indicates the number of protection groups in the system that are configured by
the operator. The counter is only valid on NANT-E and FANT-F boards. For other NTs, the value should always be
0, as protection group creation is not allowed. The value is between 0 (no protection group) and 62 (maximum
allowed by the system).
For vectoring legacy fext cancellation, the counter indicates the number of lines where a vectoring profile has been
assigned to in which the legacy fext cancellation feature is enabled.
For Vlan Translation resources extended usage vxlt-ext-usage, the counter indicates the number of line cards
making use of VLAN translation resources in an extended way.
For Ethernet OAM Y1731 Performance monitoring functions, the counter indicates the number of MEPs in the
system in which Y1731 performance monitoring functions have been enabled.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system license [ (feature) ]

Command Parameters
Table 74.8-1 "System Licenses Status Command" Resource Parameters
Resource Identifier

Type

Description

(feature)

Format:
( adsl2-plus
| readsl2
| igmp
| annex-m
| ip-forward
| pppox-relay
| 802dot1x
| ipoa-cc
| ipoa-cc/rb

table index

2214

Released

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

Resource Identifier

Type

Description

| upbo-policing
| xdslline-overrule
| xdsl-ins
| adsl-adsl2-dpbo
| annex-j
| synce-if-timing
| 2dot5gbps-lt
| redcy
| shdsl-ctc
| vdsl2
| arq
| 10gbps-lt
| 20gbps-lt
| ipv6-security
| lawful-intercept
| vectoring
| green-dsl-l2-mode
| eth-oam-adv-mon
| eth-y1731-pm-mon
| mpls-adv-resilien
| 40gbps-lt
| port-protection
| vectoring-legacy
| vxlt-ext-usage )
Possible values:
- adsl2-plus : number of xdsl lines for which ADSL2 is
enabled
- readsl2 : number of xdsl lines for which READSL2 is
enabled
- igmp : number of DSL subscribers configured for IGMP
- annex-m : number of DSL subscribers configured for
annex-m
- ip-forward : number of DSL subscribers configured for
Ip-forwarding
- pppox-relay : number of DSL subscribers configured for
PPPOX relay
- 802dot1x : number of DSL subscribers configured for
802.1x
- ipoa-cc : number of DSL subscribers configured for
IPoA-CC
obsolete alternative replaced by ipoa-cc/rb
- ipoa-cc/rb : number of DSL subscribers configured for
IPoA-CC/RB
- upbo-policing : number of lines configured with UPBO
policing
- xdslline-overrule : number of xdsl lines for which overrule
data is used
- xdsl-ins : number of lines for which impulse noise sensor is
enabled
- adsl-adsl2-dpbo : number of ADSL/ADSL2 lines for which
DPBO is enabled
- annex-j : number of DSL subscribers configured for
annex-j
- synce-if-timing : number of Synchronous Ethernet ports
are configured as a clock source
- 2dot5gbps-lt : number of LTs that operate at 2.5Gbps link
speed

3HH-04416-EBAA-TCZZA 01

Released

2215

74 System Status Commands

Resource Identifier

Type

Description

- redcy : number of protection groups enabled (unlocked)


- shdsl-ctc : number of equipped SHDSL lines configured
for which cross-talk cancellation (CTC) is enabled
- vdsl2 : number of xdsl lines for which Seamless Rate
Adaptation and VDSL2 is enabled
- arq : number of xdsl lines for which ARQ is enabled
- 10gbps-lt : number of LTs that operate at 10Gbps link
- 20gbps-lt : number of LTs that operate at 20Gbps link
- ipv6-security : the number of access lines (DSL, Ethernet
or ONT UNI) where one or more IPv6 security features are
activated
- lawful-intercept : indicates whether lawful intercept is
enabled or disabled
- vectoring : number of xdsl lines where a vectoring profile
has been associated to
- green-dsl-l2-mode : number of xdsl lines where
green-dsl-l2-mode is on
- eth-oam-adv-mon : number of MEPS where Ethernet
OAM Advanced Monitoring Functions are enabled
- eth-y1731-pm-mon : number of MEPS where Ethernet
y1731 performance monitoring functions are enabled
- mpls-adv-resilien : indicates whether MPLS-FRR or MPLS
LSR is being used (value 1) or not used (value 0)
- 40gbps-lt : number of LTs that operate at 40Gbps link
- port-protection : number of port-protection groups
- vectoring-legacy : number of xdsl lines where vectoring
legacy FEXT cancellation is enabled
- vxlt-ext-usage : indicates the number of line cards that are
extendedly using Vlan Translation Hardware Resources.

Command Output
Table 74.8-2 "System Licenses Status Command" Display parameters
Common Information:routing-licence
name
Type
routing-licence

Specific Information
name
number-license

2216

Released

Description

Parameter type: <Sys::RoutingLicStatus>


( not-active
| active )
Possible values:
- not-active : routing license unavailable
- active : routing license available

shows the status of the routing


license.
This element is always shown.

Type

Description

Parameter type: <SignedInteger>


- a signed integer

Specifies number of license.


This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.9 System Clock Status Command


Command Description
This command displays three display elements named actual-priority, clock-status, and clock-selection.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system clock-mgmt

Command Output
Table 74.9-2 "System Clock Status Command" Display parameters
Specific Information
name
actual-priority

selection

ext-source

external-nt-a

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::SysClkSrcPriorityScheme>


( autoselect
| local
| external-local )
Possible values:
- autoselect : select based on location
- local : always select local clock
- external-local : external clock > local clock
Parameter type: <Sys::asamSysClkSrcSelection>
( active-external
| active-local )
Possible values:
- active-external : external clock on active NT
- active-local : local clock on active NT
Parameter type: <Sys::SysClkExtSource>
( e1
| ds1
| khz2048
| autoselect )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source
- autoselect : autoselect Source
Parameter type: <Sys::clkSrcExtAFailure>
( failure
| available )
Possible values:

Shows the actual priority of clock


sources.
This element is always shown.

Shows the clock source selected


by system
This element is always shown.

Shows the clock source selected


by system E1/DS1/2048KHz
This element is always shown.

Shows the status of the External


clock on NT A
This element is always shown.

Released

2217

74 System Status Commands

name

Type

external-nt-b

local-nt-a

local-nt-b

2218

Description

- failure : failure of external clock on NT A


- available : availablity of external of clock on NT A
Parameter type: <Sys::clkSrcExtBFailure>
( failure
| available )
Possible values:
- failure : failure of external clock on NT B
- available : availablity of external of clock on NT B
Parameter type: <Sys::clkSrcLocAFailure>
( failure
| available )
Possible values:
- failure : failure of local of clock on NT A
- available : availablity of local of clock on NT A
Parameter type: <Sys::clkSrcLocBFailure>
( failure
| available )
Possible values:
- failure : faiulre of local of clock on NT B
- available : availablity of local of clock on NT B

Released

Shows the status of the External


clock on NT B
This element is always shown.

Shows the status of the Local


clock on NT A
This element is always shown.

Shows the status of the Local


clock on NT B
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.10 Show syslog parameters


Command Description
This command displays the system related parameters for syslog.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show system syslog

Command Output
Table 74.10-2 "Show syslog parameters" Display parameters
Specific Information
name
max-msg-size

available-on-disk

used-on-disk

reserved-on-disk

free-on-disk

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::MaxMsgSize>


maximum size of the syslog
- the maximum size of the syslog message
message
- unit: bytes
This element is always shown.
- range: [0...1024]
Parameter type: <Sys::MaxStorageSize>
total storage size available to
- total storage size available to store the messages
store the messages
- unit: bytes
This element is always shown.
- range: [0...2147483647]
Parameter type: <Sys::UsedSize>
indicates inuse storage size by the
- indicates inuse storage size by the messages
messages
- unit: bytes
This element is always shown.
- range: [0...2147483647]
Parameter type: <Sys::ReservedSize>
indicate the reserved storage size
- indicates inuse storage size by the messages
for the messages
- unit: bytes
This element is always shown.
- range: [0...2147483647]
Parameter type: <Sys::FreeSize>
total free memory available to
- free memory available for storing syslog messages from store syslog messages
total allocated memory
This element is always shown.
- unit: bytes
- range: [0...2147483647]

Released

2219

74 System Status Commands

74.11 System Memory Usage Status Command


Command Description
This command displays the various memory usage parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system memory-usage [ (slot) ]

Command Parameters
Table 74.11-1 "System Memory Usage Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

slot index

Command Output
Table 74.11-2 "System Memory Usage Status Command" Display parameters
Specific Information
name
total(mb)

2220

Released

Type

Description

Parameter type: <Sys::totalMem>


- memory size
- unit: Mbyte

the size of the total memory on


this board
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

name

Type

used(mb)

Parameter type: <Sys::memusageAbsolute>


the size of the memory actually in
- memory size
use
- unit: Mbyte
This element is always shown.
Parameter type: <Sys::memusagePrecent>
the size of the memory actually in
- the size of the memory actually in use, expressed as a use, expressed as a portion of the
portion of the total memory
total memory
- unit: percentage
This element is always shown.
- range: [0...100]

used-portion(%)

3HH-04416-EBAA-TCZZA 01

Description

Released

2221

74 System Status Commands

74.12 System CPU Load Status Command


Command Description
This command shows the various CPU load parameters, including the start time of monitoring, the average load
for the measurement period and the current condition of the CPU load monitoring activity. CPU Load monitoring
can be started and stopped using the command "admin system cpu-load".

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system cpu-load [ (slot) ]

Command Parameters
Table 74.12-1 "System CPU Load Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

slot index

Command Output
Table 74.12-2 "System CPU Load Status Command" Display parameters
Specific Information
name

Type

Description

monitor-start-time

Parameter type: <Sys::startMonitorTime>

the start time of last 3 minutes or

2222

Released

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

name
average(%)

oper-status

3HH-04416-EBAA-TCZZA 01

Type

Description

- the time (yyyy-mm-dd:hour:minutes:secs)


- unit: UTC
Parameter type: <Sys::cpuloadaverage>
- average load for the measurement period , expressed in
percentage
- unit: percentage
- range: [0...100]
Parameter type: <Sys::operateStatus>
( proceeding
| idle
| not-operational )
Possible values:
- proceeding : cpu load monitoring is ongoing
- idle : monitoring is either not started or already completed
- not-operational : monitoring cannot be performed as the
board is not operational

less monitoring
This element is always shown.
average load for the measurement
period , expressed in percentage
This element is always shown.
current condition of the cpu load
monitoring activity
This element is always shown.

Released

2223

74 System Status Commands

74.13 System CDE Command


Command Description
This command displays the activated Customer Dependent Engineering feature bitmap.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system cde-bitmap

Command Output
Table 74.13-2 "System CDE Command" Display parameters
Specific Information
name
cde-bitmap

2224

Released

Type

Description

Parameter type: <Sys::cdeBitMap>


<Sys::printableCdeBitMap>
Field type <Sys::printableCdeBitMap>
- printable cde bitmap

show activated cde feature


bitmap
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

74.14 System Clock Management Status Command


Command Description
This command shows the status of the clock sources configured for selection.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system sync-if-timing [ (priority) ]

Command Parameters
Table 74.14-1 "System Clock Management Status Command" Resource Parameters
Resource Identifier

Type

Description

(priority)

Format:
- priority index of the system clock source
- range: [1...3]

priority configured for the clock


source

Command Output
Table 74.14-2 "System Clock Management Status Command" Display parameters
Common Information:bits-mode
name
Type
bits-mode

Specific Information
name
clock-source

3HH-04416-EBAA-TCZZA 01

Description

Parameter type: <Sys::ActualSysClkExtSource>


( e1
| ds1
| khz2048 )
Possible values:
- e1 : select E1 Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source

external clock type E1 or DS1 or


2048Khz
This element is always shown.

Type

Description

Parameter type: <Sys::SysClkSrc>


( bits-a
| bits-b
| synce-1
| synce-2
| local
| ieee1588-a
| ieee1588-b

The clock source configured for


selection
This element is always shown.

Released

2225

74 System Status Commands

name

Type

ql

status

2226

Description

| none )
Possible values:
- bits-a : select BITS-A for this priority
- bits-b : select BITS-B for this priority
- synce-1 : select SyncE reference 1 for this priority
- synce-2 : select SyncE reference 2 for this priority
- local : holdover specified (always enable last priority)
- ieee1588-a : select IEEE 1588-A clock for this priority
- ieee1588-b : select IEEE 1588-B clock for this priority
- none : remove clock source for this priority
Parameter type: <Ntr::SysClkSrcQL>
( clk-ql-stu
| clk-ql-prs
| clk-ql-prc
| clk-ql-inv3
| clk-ql-ssu-a-tnc
| clk-ql-ssu-a
| clk-ql-tnc
| clk-ql-inv5
| clk-ql-inv6
| clk-ql-st2
| clk-ql-ssu-b
| clk-ql-inv9
| clk-ql-st3
| clk-ql-sec
| clk-ql-smc
| clk-ql-st3e
| clk-ql-prov
| clk-ql-dnu-dus
| clk-ql-dnu
| clk-ql-dus )
Possible values:
- clk-ql-stu : Synchronized-Traceability Unknown
- clk-ql-prs : Primary Reference Source
- clk-ql-prc : Primary Reference Clock
- clk-ql-inv3 : Quality Level unallocated
- clk-ql-ssu-a-tnc : Traced to Sync Supply Unit-A/Transmit
Node Clock
- clk-ql-ssu-a : Traced to Sync Supply Unit-A(ETSI)
- clk-ql-tnc : Traced to Transmit Node Clock(ANSI)
- clk-ql-inv5 : Quality Level unallocated
- clk-ql-inv6 : Quality Level unallocated
- clk-ql-st2 : Traceable to Stratum 2
- clk-ql-ssu-b : Traced to Sync Supply Unit-B
- clk-ql-inv9 : Quality Level unallocated
- clk-ql-st3 : Traceable to Stratum 3
- clk-ql-sec : Traceable to SDH Equipment Clock
- clk-ql-smc : Traceable to SONET Clock SelfTimed
- clk-ql-st3e : Traceable to Stratum 3E
- clk-ql-prov : Operator Provisionned
- clk-ql-dnu-dus : Signal should not be used for sync
- clk-ql-dnu : Signal should not be used for sync(ETSI)
- clk-ql-dus : Signal should not be used for sync(ANSI)
Parameter type: <Sys::SysClkStatusActual>
( reference
| valid
| fail

Released

Quality level of the clock


This element is always shown.

Operational
status
of
the
configured clock
This element is always shown.

3HH-04416-EBAA-TCZZA

01

74 System Status Commands

name

Type

Description

| donotuse
| unknown
| forced
| nosynceconfig
| nosyncesupport
| onnonreadypeernt
| syncenotavailable
| noieee1588config
| missing
| invalid )
Possible values:
- reference : clock is selected as the reference clock
- valid : clock is available for selection
- fail : clock is not available for selection
- donotuse : clock must not be used as indicated by SSM
- unknown : clock status unknown
- forced : clock is manually selected
- nosynceconfig : syncE clock (ref1/2) is not bound to a port
- nosyncesupport : SyncE clock (ref1/2) is bound to a port
that does not support syncE clock extraction
- onnonreadypeernt : clock configured on the face plate of
the peer NT is not eligible due to the state of the peer NT
- syncenotavailable : SyncE clock not available
- noieee1588config : ieee1588 is not configured
- missing : no SSM-QL received
- invalid : clock not available for selection

3HH-04416-EBAA-TCZZA 01

Released

2227

75- PCCP Status Commands

75.1 PCCP Status Command Tree


75.2 SHub PCCP Group Entry Status Command
75.3 SHub PCCP Group Port Entry Status Command

2228

Released

75-2229
75-2230
75-2231

3HH-04416-EBAA-TCZZA

01

75 PCCP Status Commands

75.1 PCCP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "PCCP Status Commands".

Command Tree
----show
----pccp
----group
- (groupid)
----port-entry
- (ctrl-index)

3HH-04416-EBAA-TCZZA 01

Released

2229

75 PCCP Status Commands

75.2 SHub PCCP Group Entry Status Command


Command Description
This command displays PCCP group related information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show pccp group [ (groupid) ]

Command Parameters
Table 75.2-1 "SHub PCCP Group Entry Status Command" Resource Parameters
Resource Identifier

Type

Description

(groupid)

Format:
- pccp identifier number
- range: [1...4]

pccp identifier

Command Output
Table 75.2-2 "SHub PCCP Group Entry Status Command" Display parameters
Specific Information
name
admin-state

Description

Parameter type: <Shub::AdminState>


group level of path connectivity
( enable
check protection group
| disable )
This element is always shown.
Possible values:
- enable : enable the path connectivity check protection at
group level
- disable : disable the path connectivity check protection at
group level
Parameter type: <Shub::OperState>
state of path connectivity check
( up
protection group
| down )
This element is always shown.
Possible values:
- up : pccp is up
- down : pccp is down
Parameter type: <Shub::TimeSwitchover>
time since last pccp swithover
- time since last pccp switchover occurred
occurred
- unit: 1/100 sec
This element is always shown.

oper-state

time-since-lastswo

2230

Type

Released

3HH-04416-EBAA-TCZZA

01

75 PCCP Status Commands

75.3 SHub PCCP Group Port Entry Status


Command
Command Description
This command displays PCCP group port related information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show pccp port-entry [ (ctrl-index) ]

Command Parameters
Table 75.3-1 "SHub PCCP Group Port Entry Status Command" Resource Parameters
Resource Identifier

Type

Description

(ctrl-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

control index of the configure

Command Output
Table 75.3-2 "SHub PCCP Group Port Entry Status Command" Display parameters
Specific Information
name
port-groupid

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::GroupId>


- pccp identifier number
- range: [1...4]

pccp identifier
This element is always shown.

Released

2231

75 PCCP Status Commands

name

Type

Description

forw-stats

Parameter type: <Shub::ForwState>


( discarding
| forwarding )
Possible values:
- discarding : state of the port is discarding
- forwarding : state of the port is forwarding

state of the port being involved in


pccp group
This element is always shown.

2232

Released

3HH-04416-EBAA-TCZZA

01

76- Transaction Status Commands

76.1 Transaction Status Command Tree


76.2 Transaction Log Status Command
76.3 Transaction Log Entry Status Command

3HH-04416-EBAA-TCZZA 01

76-2234
76-2235
76-2237

Released

2233

76 Transaction Status Commands

76.1 Transaction Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Transaction Status Commands".

Command Tree
----show
----transaction
----set-log-table
- (log-table-index)
----log-entry

2234

Released

3HH-04416-EBAA-TCZZA

01

76 Transaction Status Commands

76.2 Transaction Log Status Command


Command Description
This command displays the transaction set log parameters.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show transaction set-log-table [ (log-table-index) ]

Command Parameters
Table 76.2-1 "Transaction Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(log-table-index)

Format:
- a signed integer

the key in the set Log table

Command Output
Table 76.2-2 "Transaction Log Status Command" Display parameters
Specific Information
name

Type

Description

log-ipaddr

Parameter type: <Ip::V4Address>


- IPv4-address

changed-object-id

Parameter type: <Object>


- an object identifier

context

Parameter type: <Trans::context>


( nt
| shub
| dpoe
| xvps1
| xvps2
| xvps3
| xvps4
| xvps5
| xvps6
| xvps7
| xvps8 )
Possible values:

IP address of the Manager who


changed this object
This element is always shown.
the Object Identifier of an object
which has been changed.
This element is always shown.
The context, which the object
belongs to
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2235

76 Transaction Status Commands

name

Type

Description

- nt : nt: nt context
- shub : shub: shub context
- dpoe : dpoe: dpoe context
- xvps1 : xvps1: xvps1 context
- xvps2 : xvps2: xvps2 context
- xvps3 : xvps3: xvps3 context
- xvps4 : xvps4: xvps4 context
- xvps5 : xvps5: xvps5 context
- xvps6 : xvps6: xvps6 context
- xvps7 : xvps7: xvps7 context
- xvps8 : xvps8: xvps8 context

2236

Released

3HH-04416-EBAA-TCZZA

01

76 Transaction Status Commands

76.3 Transaction Log Entry Status Command


Command Description
This command displays the transaction log entry-related parameters.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show transaction log-entry

Command Output
Table 76.3-2 "Transaction Log Entry Status Command" Display parameters
Specific Information
name

Type

Description

set-log-lastentry

Parameter type: <SignedInteger>


- a signed integer

set-log-resettime

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Trans::overflowed>
( not-overflowed
| overflowed )
Possible values:
- not-overflowed : log buffer not overflowed is 1
- overflowed : log buffer overflowed is 2
Parameter type: <SignedInteger>
- a signed integer

index of the last entry that has


been added to the set log table.
This element is always shown.
time when set log has been reset
This element is always shown.

set-log-overflowed

set-log-buffersize
nbr-of-sets

3HH-04416-EBAA-TCZZA 01

Parameter type: <SignedInteger>


- a signed integer

specifies whether the set log


buffer is overflowed or not.
This element is always shown.

the size of the internal set log


buffer.
This element is always shown.
nbr of successfull sets since
system is up.
This element is always shown.

Released

2237

77- Error Status Command

77.1 Error Status Command Tree


77.2 Error Log Status Command

2238

Released

77-2239
77-2240

3HH-04416-EBAA-TCZZA

01

77 Error Status Command

77.1 Error Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Error Status Command".

Command Tree
----show
----error
- (id)

3HH-04416-EBAA-TCZZA 01

Released

2239

77 Error Status Command

77.2 Error Log Status Command


Command Description
This command displays the error log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show error (id)

Command Parameters
Table 77.2-1 "Error Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(id)

Format:
- a signed integer

error number

Command Output
Table 77.2-2 "Error Log Status Command" Display parameters
Common Information:error-log related information
name
Type
last-entry

Parameter type: <Error::ErrLogLastEntry>


- index of the last entry of error log table

reset-time

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <SignedInteger>
- a signed integer
Parameter type: <Error::LogOverFlow>
( no
| yes )
Possible values:
- no : when log buffer is reset
- yes : full action set to warp around

buffer-size
overflowed

Specific Information
name
timestamp

2240

Released

Description
index of the last entry that is
added to the error log table.
This element is always shown.
time value when the error log is
resetted
This element is always shown.
size of the internal log buffer.
This element is always shown.
specifies whether log buffer is
overflowed or not.
This element is always shown.

Type

Description

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

network time when the error is


generated.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

77 Error Status Command

name

Type

Description

originator

Parameter type: <Alarm::ReqIdAndIPAddress>


<SignedInteger> @ <Ip::V4Address>
Field type <SignedInteger>
- a signed integer
Field type <Ip::V4Address>
- IPv4-address
Parameter type: <Description-127>
- description to help the operator to identify the object
- length: x<=127
Parameter type: <PrintableString>
- printable string

request-id and IP address that


generated the error
This element is only shown in
detail mode.

description
info

obj-id

Parameter type: <Alarm::MibName>


- representation of the mib name

obj-value

Parameter type: <PrintableString>


- printable string

3HH-04416-EBAA-TCZZA 01

description of the error.


This element is always shown.
additional information to guide to
correct the error
This element is only shown in
detail mode.
object identifier in the request
that caused the error.
This element is always shown.
value received from the manager
for the object that generated the
error.
This element is only shown in
detail mode.

Released

2241

78- Software Status Commands

78.1 Software Status Command Tree


78.2 Database Status Command
78.3 Disk Status Command
78.4 Overall Software Package Status Command
78.5 Software Package Status Command
78.6 File Status Command
78.7 Upload/Download Status Command
78.8 Software Version For ANSI Status Command
78.9 Software Version For ETSI Status Command

2242

Released

78-2243
78-2244
78-2246
78-2248
78-2251
78-2253
78-2255
78-2258
78-2259

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

78.1 Software Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Software Status Commands".

Command Tree
----show
----software-mngt
----database
- (db-container)
- oswp-number
----descriptor-files
- (index)
----oswp
- (index)
----swp
- (name)
----swp-disk-file
- (name)
- file-name
- file-board-type
----upload-download
----version
----ansi
----etsi

3HH-04416-EBAA-TCZZA 01

Released

2243

78 Software Status Commands

78.2 Database Status Command


Command Description
This command displays the various database parameters.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt database [ (db-container) [ oswp-number <SwMngt::DbmOswpIndex> ] ]

Command Parameters
Table 78.2-1 "Database Status Command" Resource Parameters
Resource Identifier

Type

Description

(db-container)

Format:
( first
| second
| third )
Possible values:
- first : first container
- second : second container
- third : third container
Parameter type: <SwMngt::DbmOswpIndex>
Format:
- index in the database table
- range: [1...2]

the database container ID

oswp-number

index in the database table

Command Output
Table 78.2-2 "Database Status Command" Display parameters
Specific Information
name

Type

Description

name

Parameter type: <SwMngt::dbmDatabaseName>


- a printable string
- length: x<=32

oper-status

Parameter type: <SwMngt::dBaseOperStatus>


( actual
| preferable
| previous

A string representing the


database. The value 'NO-NAME'
will be used by the system for the
default databases.
This element is always shown.
The operational status of the
database.
This element is always shown.

2244

Released

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

name

version

3HH-04416-EBAA-TCZZA 01

Type
| failed
| not-useful )
Possible values:
- actual : actual oper status
- preferable : preferable oper status
- previous : previous oper status
- failed : failed oper status
- not-useful : not useful oper status
Parameter type: <SwMngt::dbmDatabaseVersion>
- a printable string
- length: x<=32

Description

The version of the database.


This element is always shown.

Released

2245

78 Software Status Commands

78.3 Disk Status Command


Command Description
This command displays the values of the various attributes of the SWM disk file.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt descriptor-files [ (index) ]

Command Parameters
Table 78.3-1 "Disk Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./:]
- length: 1<=x<=255

index to the swm disk file table

Command Output
Table 78.3-2 "Disk Status Command" Display parameters
Specific Information
name
type

2246

Released

Type

Description

Parameter type: <SwMngt::diskFileType>


( overall-descriptor
| descriptor
| file-type-a
| file-type-b
| not-specified
| file-type-c
| file-type-d
| file-type-e
| file-type-f
| file-type-g
| file-type-h
| file-type-i
| file-type-j
| file-type-k
| file-type-l
| file-type-m
| file-type-n

Specifies the type of the file.


This element is always shown.

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

name

file-size

3HH-04416-EBAA-TCZZA 01

Type
| file-type-p )
Possible values:
- overall-descriptor : over all descriptor file
- descriptor : descriptor file
- file-type-a : file type a
- file-type-b : file type b
- not-specified : file type not specified
- file-type-c : file type c
- file-type-d : file type d
- file-type-e : file type e
- file-type-f : file type f
- file-type-g : file type g
- file-type-h : file type h
- file-type-i : file type i
- file-type-j : file type j
- file-type-k : file type k
- file-type-l : file type l
- file-type-m : file type m
- file-type-n : file type n
- file-type-p : file type p
Parameter type: <SwMngt::DiskFileSize>
- specifies the size of the file
- unit: bytes

Description

Specifies the size of the file.


This element is always shown.

Released

2247

78 Software Status Commands

78.4 Overall Software Package Status Command


Command Description
This command displays various OSWP states and attributes.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt oswp [ (index) ]

Command Parameters
Table 78.4-1 "Overall Software Package Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- id of one of the two oswps
- range: [1...2]

index to the swm oswp table

Command Output
Table 78.4-2 "Overall Software Package Status Command" Display parameters
Specific Information
name

Type

Description

name

Parameter type: <SwMngt::oswpName>


- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./:]
- length: 1<=x<=255

availability

Parameter type: <SwMngt::operAvailStatus>


( empty
| enabled
| disabled
| downloading
| aborting )
Possible values:
- empty : no OSWP is related to the index
- enabled : related OSWP is valid
- disabled : download of related OSWP failed
- downloading : download of related OSWP is ongoing
- aborting : files of the related OSWP are removed
Parameter type: <SwMngt::operActStatus>

Name of the OSWP. The name of


an OSWP corresponds to the path
name:
/path_to_OSWP/file_name.
This element is always shown.
Specifies the availability status of
the OSWP.
This element is always shown.

act-status

2248

Released

Specifies the related OSWP is

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

name

commit-status

download-error

err-file-name

3HH-04416-EBAA-TCZZA 01

Type

Description

( active
| not-active
| act-act-nt
| act-stb-nt )
Possible values:
- active : related OSWP is active
- not-active : related OSWP is not active
- act-act-nt : related OSWP is being activated on the active
NT
- act-stb-nt : related OSWP is being activated on the standby
NT
Parameter type: <SwMngt::operCommitStatus>
( committed
| un-committed
| committing )
Possible values:
- committed : Committed
- un-committed : Un committed
- committing : OSWP is committing
Parameter type: <SwMngt::oswpDldErr>
( invalidftpdaemon
| invalidtftpdaemon
| invalidsftpdaemon
| not-defined
| file-not-found
| access-violation
| diskfull-alloc-exced
| illegal-tftp-operation
| unknown-transfer-id
| file-exists
| no-such-user
| syntax-error
| lack-of-storage
| system-restart
| no-error
| synchronization-failed )
Possible values:
- invalidftpdaemon : trying to download using ftp when sftp
is enabled
- invalidtftpdaemon : trying to download using tftp when
sftp is enabled
- invalidsftpdaemon : trying to download using sftp when
tftp is enabled
- not-defined : the error is not defined
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation: illegal TFTP operation
- unknown-transfer-id : transfer id is unknown
- file-exists : file is already existing
- no-such-user : no such user
- syntax-error : Syntax error
- lack-of-storage : Lack of storage resource
- system-restart : system restart
- no-error : no error in download
- synchronization-failed: synchronization failed
Parameter type: <SwMngt::oswpName>

currently active, not active or


being activated on active or
standby NT.
This element is always shown.

Specifies the OSWP is committed


or uncommitted or whether the
commit-operation is still ongoing.
This element is always shown.

Specifies for what reason the


download of the OSWP failed for
the requested set of files.
This element is only shown in
detail mode.

The name of the file that caused

Released

2249

78 Software Status Commands

name

err-file-server

auto-activate-error

2250

Type

Description

- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./:]
- length: 1<=x<=255
Parameter type: <Ip::V4Address>
- IPv4-address

the error.
This element is only shown in
detail mode.
Specifies the IP address of the
file server where the file can be
found.
This element is only shown in
detail mode.
the
reason
the
automatic
activation of the OSWP failed
This element is only shown in
detail mode.

Parameter type: <SwMngt::OswpAutoActErr>


( not-defined
| no-error
| another-swdb-on
| no-compatible-db
| unknown-err )
Possible values:
- not-defined : the error is not defined
- no-error : no error in download
- another-swdb-on : another swdb process ongoing
- no-compatible-db : no compatible database
- unknown-err : unknown error during activation

Released

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

78.5 Software Package Status Command


Command Description
This command displays the parameters of the dynamic SWP table, which represent the SWPs that belong to at least
one of the OSWPs available in the system.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt swp [ (name) ]

Command Parameters
Table 78.5-1 "Software Package Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a printable string
- length: x<=32

index to the swm-swp table

Command Output
Table 78.5-2 "Software Package Status Command" Display parameters
Specific Information
name
type

dbase-ver-no

Type

Description

Parameter type: <SwMngt::swmSwpType>


( asam-core
| voice-gateway
| ip-server )
Possible values:
- asam-core : asam core
- voice-gateway : voice gateway
- ip-server : ip server
Parameter type: <SwMngt::dBVersionNumber>
- a printable string
- length: x<=32

Specifies the type of the software


package.
This element is always shown.

primary-file-id

Parameter type: <Ip::V4Address>


- IPv4-address

secondary-file-id

Parameter type: <Ip::V4Address>

3HH-04416-EBAA-TCZZA 01

Specifies the version number of


the database that is compatible
with the software package.
This element is always shown.
Specifies the IP address of the
TFTP/SFTP server where the
software package can be found.
This element is always shown.
Specifies the IP address of a

Released

2251

78 Software Status Commands

name

2252

Released

Type

Description

- IPv4-address

possible second TFTP/SFTP


server where the software
package can be found.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

78.6 File Status Command


Command Description
This command displays information about the relationships between the files known by the system and the available
OSWPs.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt swp-disk-file [ (name) [ file-name <SwMngt::swpContainsFileName> ] [ file-board-type
<SwMngt::swpBoardType> ] ]

Command Parameters
Table 78.6-1 "File Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a printable string
- length: x<=32
Parameter type: <SwMngt::swpContainsFileName>
Format:
- a printable string
- length: x<=32
Parameter type: <SwMngt::swpBoardType>
Format:
- a printable string
- length: x<=21

index to the Swm_Contains_File


table

file-name

file-board-type

index to the Swm_Contains_File


table
index to the Swm_Contains_File
table

Command Output
Table 78.6-2 "File Status Command" Display parameters
Specific Information
name
file-format

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SwMngt::fileFormat>


( tar
| lz77
| ascii
| exe
| coff )
Possible values:
- tar : file format is tar

Specifies the format of the file.


This element is always shown.

Released

2253

78 Software Status Commands

name

Type

available-status

file-priority

file-size
file-type

file-decompression

2254

Description

- lz77 : file format is lz77


- ascii : file format is ascii
- exe : file format is exe
- coff : file format is coff
Parameter type: <SwMngt::availableStatus>
( available
| not-available )
Possible values:
- available : the file is avilable
- not-available : the file is not avilable
Parameter type: <SwMngt::filePriority>
( part-min-set
| no-part-min-set )
Possible values:
- part-min-set : part min set
- no-part-min-set : no part min set
Parameter type: <SwMngt::SwmFileSize>
- specifies the size of the file
- unit: bytes
Parameter type: <SwMngt::SwmFileType>
( special-file
| file-type-a
| file-type-b )
Possible values:
- special-file : special file type
- file-type-a : file type A
- file-type-b : file type B
Parameter type: <SwMngt::swmFileDecompression>
( decompressed
| no-decompressed )
Possible values:
- decompressed : file is decompressed
- no-decompressed : file is compressed

Released

Specifies whether the file is


available on the file disk or not.
This element is always shown.

Specifies whether the file belongs


to the minimum set of the related
OSWPs.
This element is only shown in
detail mode.
Specifies the size of the file.
This element is only shown in
detail mode.
Specifies the type of the file.
This element is only shown in
detail mode.

Specifies whether the file must be


decompressed or not before being
sent to the applicable boards.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

78.7 Upload/Download Status Command


Command Description
This command displays the upload and download parameters.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt upload-download

Command Output
Table 78.7-2 "Upload/Download Status Command" Display parameters
Specific Information
name

Type

Description

disk-space

Parameter type: <SwMngt::TotalSpaceOnDisk>


- total space on file disk that is reserved for storage
- unit: bytes

free-space

Parameter type: <SwMngt::FreeSpaceOnDisk>


- total space on the file disk that is still available
- unit: bytes

download-progress

Parameter type: <SwMngt::downloadProgress>


( download-ongoing
| download-success
| download-fail )
Possible values:
- download-ongoing : download ongoing
- download-success : download finished and successfull
- download-fail : download finished but failed
Parameter type: <SwMngt::downloadError>
( not-defined
| file-not-found
| access-violation
| diskfull-alloc-exced
| illegal-tftp-operation
| unknown-transfer-id
| file-exists
| no-such-user
| corrupted-database
| system-restart
| no-error

The total space on the file disk


that is reserved for the storage of
files.
This element is always shown.
Specifies the space on the file
disk that is still available for the
storage of files.
This element is always shown.
Specifies the current status of the
database download process.
This element is always shown.

download-error

3HH-04416-EBAA-TCZZA 01

Specifies the reason in case of a


database download failure.
This element is always shown.

Released

2255

78 Software Status Commands

name

Type

upload-progress

upload-error

auto-activate-error

2256

Description

| iss-cksm-fail
| issprot-cksm-fail )
Possible values:
- not-defined : the error is not defined
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation: illegal TFTP operation
- unknown-transfer-id : transfer id is unknown
- file-exists : file is already existing
- no-such-user : no such user
- corrupted-database : corrupted/incompleted database
- system-restart : system restart
- no-error : no error in download
- iss-cksm-fail : checksum-failed for iss.conf
- issprot-cksm-fail : checksum-failed for issprot.conf
Parameter type: <SwMngt::uploadProgress>
( upload-ongoing
| upload-success
| upload-fail )
Possible values:
- upload-ongoing : upload ongoing
- upload-success : upload finished and successfull
- upload-fail : upload finished but failed
Parameter type: <SwMngt::uploadError>
( not-defined
| file-not-found
| access-violation
| diskfull-alloc-exced
| illegal-tftp-operation
| unknown-transfer-id
| file-exists
| no-such-user
| database-not-avail
| system-restart
| no-error
| another-swdb-on )
Possible values:
- not-defined : the error is not defined
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation: illegal TFTP operation
- unknown-transfer-id : transfer id is unknown
- file-exists : file is already existing
- no-such-user : no such user
- database-not-avail : selected database not available
- system-restart : system restart
- no-error : no error in download
- another-swdb-on : another swdb progress ongoing
Parameter type: <SwMngt::DbAutoActErr>
( not-defined
| no-error
| another-swdb-on
| no-compat-oswp
| unknown-err )
Possible values:

Released

Specifies the current status of the


database upload process.
This element is always shown.

Specifies the reason in case of a


database upload failure.
This element is always shown.

the
reason
the
automatic
activation of the Database failed
This element is always shown.

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

name

Type

Description

- not-defined : the error is not defined


- no-error : no error in download
- another-swdb-on : another swdb process ongoing
- no-compat-oswp : no compatible OSWP
- unknown-err : unknown error during activation

3HH-04416-EBAA-TCZZA 01

Released

2257

78 Software Status Commands

78.8 Software Version For ANSI Status Command


Command Description
This command shows the Software version for ANSI market.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt version ansi

Command Output
Table 78.8-2 " Software Version For ANSI Status Command " Display parameters
Specific Information
name
isam-feature-group

2258

Released

Type

Description

Parameter type: <SwMngt::swAnsiVersion>


- the ANSI market version
- length: x<=50

the ansi market version


This element is always shown.

3HH-04416-EBAA-TCZZA

01

78 Software Status Commands

78.9 Software Version For ETSI Status Command


Command Description
This command shows the Software version for ETSI market.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt version etsi

Command Output
Table 78.9-2 "Software Version For ETSI Status Command" Display parameters
Specific Information
name
isam-release

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SwMngt::swEtsiVersion>


- the ETSI market version
- length: x<=50

the ETSI market version


This element is always shown.

Released

2259

79- SHub Software Management Status Command

79.1 SHub Software Management Status Command Tree


79.2 SHub Configuration File Status Command
79.3 Status of the SHub Boot ROM Update Command

2260

Released

79-2261
79-2262
79-2264

3HH-04416-EBAA-TCZZA

01

79 SHub Software Management Status Command

79.1 SHub Software Management Status Command


Tree
Description
This chapter gives an overview of nodes that are handled by "SHub Software Management Status Command".

Command Tree
----show
----software-mngt
----shub
----config-file
----boot-rom-status

3HH-04416-EBAA-TCZZA 01

Released

2261

79 SHub Software Management Status Command

79.2 SHub Configuration File Status Command


Command Description
This command shows the status of SHub configuration files.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt shub config-file

Command Output
Table 79.2-2 "SHub Configuration File Status Command" Display parameters
Specific Information
name
db-save-status

sw-download-status

downloaded-sw

current-osp

2262

Released

Type

Description

Parameter type: <Sys::SaveStatus>


( inprogress
| successful
| failed
| notinitiated )
Possible values:
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
- notinitiated : not initiated
Parameter type: <Sys::DownloadStatus>
( inprogress
| successful
| failed )
Possible values:
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
Parameter type: <SwMngt::ShubSoftwareImage>
<Ip::V4Address> : <Sys::FileName>
Field type <Ip::V4Address>
- IPv4-address
Field type <Sys::FileName>
- name
- length: 1<=x<=256
Parameter type: <SwMngt::CurrOSPVersion>
( other than config/tftp
| config-1

the status of the database save


operation
This element is always shown.

the status of the software


download operation
This element is always shown.

the
specification
of
the
downloaded software package
This element is only shown in
detail mode.

the current osp version


This element is always shown.

3HH-04416-EBAA-TCZZA

01

79 SHub Software Management Status Command

name

Type

Description

| config-2
| tftp )
Possible values:
- other than config/tftp: version not defined
- config-1 : sets config1 version in BSP
- config-2 : sets config2 version in BSP
- tftp : sets tftp version in BSP

3HH-04416-EBAA-TCZZA 01

Released

2263

79 SHub Software Management Status Command

79.3 Status of the SHub Boot ROM Update


Command
Command Description
This command displays the status of the SHub boot ROM update.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt shub boot-rom-status

Command Output
Table 79.3-2 "Status of the SHub Boot ROM Update Command" Display parameters
Specific Information
name
boot-rom-status

2264

Released

Type

Description

Parameter type: <SwMngt::ShubBootRomStatus>


( in-progress
| successful
| failed )
Possible values:
- in-progress : update operation in progress
- successful : update operation successful
- failed : update operation failed

the status of the boot ROM image


update operation
This element is always shown.

3HH-04416-EBAA-TCZZA

01

80- CDE Status Commands

80.1 CDE Status Command Tree


80.2 CDE download Status Command

3HH-04416-EBAA-TCZZA 01

80-2266
80-2267

Released

2265

80 CDE Status Commands

80.1 CDE Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "CDE Status Commands".

Command Tree
----show
----software-mngt
----cdeprof
----dldstatus

2266

Released

3HH-04416-EBAA-TCZZA

01

80 CDE Status Commands

80.2 CDE download Status Command


Command Description
This command displays the CDE profile and download status.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt cdeprof dldstatus

Command Output
Table 80.2-2 "CDE download Status Command" Display parameters
Specific Information
name
server-ip
path

download-progress

download-error

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SwMngt::serverId>


- IPv4-address
Parameter type: <SwMngt::cdePath>
path
for
the
db
or
cde(example:
/path_to_db_or_cde/file_name)
- range: [a-zA-Z0-9-_./():]
- length: 1<=x<=128
Parameter type: <SwMngt::CDETarDldProgress>
( download-ongoing
| download-success
| download-fail )
Possible values:
- download-ongoing : download ongoing
- download-success : download finished and successfull
- download-fail : download finished but failed
Parameter type: <SwMngt::CDETarDldError>
( not-defined
| file-not-found
| access-violation
| diskfull-alloc-exced
| illegal-tftp-operation
| no-such-user
| file-name-error
| corrupted-cde
| server-ip-error
| cde-file-error
| no-error )
Possible values:

show file server Ip address


This element is always shown.
show the cde file downloading
path
This element is always shown.
show the cde file download
progress
This element is always shown.

specifies the reason in case of a


cde download failure
This element is always shown.

Released

2267

80 CDE Status Commands

name

Type

Description

- not-defined : the error is not defined


- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation: illegal TFTP operation
- no-such-user : no such user
- file-name-error : the CDE profile name error
- corrupted-cde : corrupted/incompleted CDE profile
- server-ip-error : input the server ip address
- cde-file-error : CDE file error
- no-error : no error in download

2268

Released

3HH-04416-EBAA-TCZZA

01

81- IGMP Status Commands

81.1 IGMP Status Command Tree


81.2 IGMP System Status Command
81.3 IGMP Channel Sources Status Command
81.4 IGMP Channel Miscellaneous Status Command
81.5 IGMP Channel Protocol Status Command
81.6 IGMP package to multicast source Command
81.7 IGMP Group to Package Status Command
81.8 Show Multicast Source Statistics Command
81.9 Show Multicast Channel Statistics Command
81.10 IGMP Module Counter Status Command
81.11 IGMP Module Time Status Command
81.12 IGMP Module Miscellaneous Status Command
81.13 IGMP System Status Command
81.14 SHub IGMP VLAN Router Port Status Command
81.15 Shub IGMP System Status Command
81.16 Shub IGMP CAC System Status Command
81.17 Shub IGMP CAC Multicast Sources Status Command
81.18 Shub IGMP CAC Bundle Status Command
81.19 Shub IGMP CAC Bundle to Source Command

3HH-04416-EBAA-TCZZA 01

81-2270
81-2272
81-2274
81-2277
81-2280
81-2284
81-2285
81-2286
81-2288
81-2290
81-2293
81-2295
81-2297
81-2298
81-2300
81-2302
81-2304
81-2306
81-2308

Released

2269

81 IGMP Status Commands

81.1 IGMP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IGMP Status Commands".

Command Tree
----show
----igmp
----system
----channel
----counter
- (port)
----miscellaneous
- (port)
----protocol
- (port)
----package-to-src
- (package-id)
----grp-to-package
- (grp-ip-addr)
- src-ip-addr
- vlan-id
----X module-mcast-src
- (slot)
- mcast-addr
----module-mcast-channel
- (slot)
- grp-ip-addr
- src-ip-addr
- vlan-id
----module
----counter
- (slot-index)
----time
- (slot-index)
----miscellaneous
- (slot-index)
----mcast-svc-context
----shub
----vlan-router-port
- (vlan-id)
- network-port
----igs-stats
- (vlan-id)
----system-stats
----mcast-stats
- (src)
- vlan-id
- ip-addr
----bundle-stats
- (bundle-name)
----bundle-to-src

2270

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

- (bundle-name)
- class-d-addr
- vlan-id

3HH-04416-EBAA-TCZZA 01

Released

2271

81 IGMP Status Commands

81.2 IGMP System Status Command


Command Description
This command displays the IGMP system-related parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp system

Command Output
Table 81.2-2 "IGMP System Status Command" Display parameters
Specific Information
name
startup-query-intvl

startup-query-count

Type

Description

Parameter type: <Igmp::SysStartUpQueryInt>


- interval at which general membership queries transmitted
- unit: sec
- range: [1...3175]
Parameter type: <Igmp::SystemStartupQueryCount>
- queries sent out on startup separated by query interval
- range: [1...10]

The interval between general


membership queries sent on
startup.
This element is always shown.
The number of queries sent out
on startup separated by the query
interval.
This element is always shown.
This statistics indicates the
network time of when the
system-wide statistics were last
reset.
This element is always shown.
This object specifies the source
IP address which is contained in
every multicast IP datagrams
transmitted on all IGMP control
channels.
This element is always shown.
When the system acts as host on
the network side of the IGMP
proxy, this value is the time how
long the system shall wait after
hearing a Version 1 Query before
it shall send any IGMPv2
messages.
This element is always shown.
The interval that must pass before

stats-intvl

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

src-ipaddr

Parameter type: <Ip::V4Address>


- IPv4-address

router-present-timeout

Parameter type: <SignedInteger>


- a signed integer

grp-memb-intvl

Parameter type: <SignedInteger>

2272

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

- a signed integer

the system decides there are no


more members of a group on a
network.
This element is always shown.

Released

2273

81 IGMP Status Commands

81.3 IGMP Channel Sources Status Command


Command Description
This command displays the IGMP channel source.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp channel counter [ (port) ]

Command Parameters
Table 81.3-1 "IGMP Channel Sources Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

2274

Released

Description

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

2275

81 IGMP Status Commands

Command Output
Table 81.3-2 "IGMP Channel Sources Status Command" Display parameters
Specific Information
name

Type

Description

noperm-join

Parameter type: <Counter>


- 32 bit counter

bitrate-fail

Parameter type: <Counter>


- 32 bit counter

inval-classd

Parameter type: <Counter>


- 32 bit counter

numsec-ovld-protappl

Parameter type: <Counter>


- 32 bit counter

num-fail

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

no of times perm bitmap failure


has occurred.
This element is always shown.
no of times IGMP join message
failed
This element is always shown.
indicates the count of IP address
states
This element is always shown.
no of 1sec int for overload
protection has been applied
This element is always shown.
Indicates the count of failure join
This element is always shown.
Indicates the count of failure
IGMP join
This element is always shown.
Indicates the count of failure
IGMP join because of low
Bandwidth
This element is always shown.

sysnum-fail
sysrate-fail

2276

Parameter type: <Counter>


- 32 bit counter

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

81.4 IGMP Channel Miscellaneous Status


Command
Command Description
This command displays the IGMP channel source.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp channel miscellaneous [ (port) ]

Command Parameters
Table 81.4-1 "IGMP Channel Miscellaneous Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

2277

81 IGMP Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id

2278

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::CVlan>


- customer vlan id

Command Output
Table 81.4-2 "IGMP Channel Miscellaneous Status Command" Display parameters
Specific Information
name

Type

Description

curr-num-group

Parameter type: <Gauge>


- gauge

curr-preview-num

Parameter type: <Counter>


- 32 bit counter

curr-uncfg-num

Parameter type: <Counter>


- 32 bit counter

current group number in this


port(ADSL,PVC)
This element is always shown.
count of prev mcast grp that igmp
channel joins currently
This element is always shown.
current unconfig group number in
this port(ADSL,PVC)
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2279

81 IGMP Status Commands

81.5 IGMP Channel Protocol Status Command


Command Description
This command shows the IGMP protocol statistics for an IGMP channel

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp channel protocol [ (port) ]

Command Parameters
Table 81.5-1 "IGMP Channel Protocol Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

2280

Released

Description

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

2281

81 IGMP Status Commands

Command Output
Table 81.5-2 "IGMP Channel Protocol Status Command" Display parameters
Specific Information
name

Type

Description

tx-gmq
short name: tx/gmq

Parameter type: <Counter>


- 32 bit counter

tx-gsq
short name: tx/gsq

Parameter type: <Counter>


- 32 bit counter

tx-gssq
short name: tx/gssq

Parameter type: <Counter>


- 32 bit counter

rx-v1-req
short name: rx-req/v1

Parameter type: <Counter>


- 32 bit counter

rx-v2-req
short name: rx-req/v2

Parameter type: <Counter>


- 32 bit counter

rx-v3-req
short name: rx-req/v3

Parameter type: <Counter>


- 32 bit counter

rx-v2-leaves

Parameter type: <Counter>


- 32 bit counter

rx-valid-message
short name: rx-msg/ok

Parameter type: <Counter>


- 32 bit counter

rx-invalid-message
short name: rx-msg/nok

Parameter type: <Counter>


- 32 bit counter

rx-unknown-message
short name:
rx-msg/unknown
rx-bad-length

Parameter type: <Counter>


- 32 bit counter

rx-bad-ip-checksum

Parameter type: <Counter>


- 32 bit counter

rx-bad-igmp-checksum

Parameter type: <Counter>


- 32 bit counter

rx-wrong-src-ip-addr

Parameter type: <Counter>


- 32 bit counter

number of general queries


transmitted on user interface
This element is always shown.
number of group specific queries
transmitted
This element is always shown.
number of group-source specific
queries transmitted
This element is always shown.
number of V1 membership report
received
This element is always shown.
number of V2 membership report
received
This element is always shown.
number of V3 membership report
received
This element is always shown.
number of leave messages report
received
This element is only shown in
detail mode.
number of valid IGMP packets
received
This element is always shown.
number of invalid IGMP packets
received
This element is always shown.
number of unknown IGMP
packets received
This element is always shown.
number of bad length IGMP
packet received/dropped
This element is only shown in
detail mode.
number of wrong IP checksum
IGMP packet received/dropped
This element is only shown in
detail mode.
number
of
wrong
IGMP
checksum
IGMP
packets
received/dropped
This element is only shown in
detail mode.
number of IGMP signals received
where the src-ip-addr of the
multicast channel violates the
ASM/SSM rules
This element is only shown in
detail mode.

2282

Released

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2283

81 IGMP Status Commands

81.6 IGMP package to multicast source Command


Command Description
This command shows the IGMP package to multicast source parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp package-to-src [ (package-id) ]

Command Parameters
Table 81.6-1 "IGMP package to multicast source Command" Resource Parameters
Resource Identifier

Type

Description

(package-id)

Format:
- index of the package
- range: [1...1024]

name used
packages

to

identify

the

Command Output
Table 81.6-2 "IGMP package to multicast source Command" Display parameters
Specific Information
name
group-address
source-address
vlan-id

2284

Type

Description

Parameter type: <Ip::V4Address>


- IPv4-address
Parameter type: <Ip::V4Address>
- IPv4-address

the multicast group address


This element is always shown.
the multicast group source
address
This element is always shown.
the multicast vlan id
This element is always shown.

Parameter type: <Igmp::SrcVlanId>


- the multicast vlan id
- range: [1...4094]

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

81.7 IGMP Group to Package Status Command


Command Description
This command shows the IGMP group to package parameters

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp grp-to-package [ (grp-ip-addr) [ src-ip-addr <Ip::V4Address> ] [ vlan-id <Igmp::SrcVlanId> ] ]

Command Parameters
Table 81.7-1 "IGMP Group to Package Status Command" Resource Parameters
Resource Identifier

Type

Description

(grp-ip-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address identifying the


multicast group
ip address of the multicast server
originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr)
identifies a particular vlan id

src-ip-addr

vlan-id

Parameter type: <Igmp::SrcVlanId>


Format:
- the multicast vlan id
- range: [1...4094]

Command Output
Table 81.7-2 "IGMP Group to Package Status Command" Display parameters
Specific Information
name
index

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Igmp::PackageIndex>


- index of the package
- range: [1...1024]

index used to identify the


packages
This element is always shown.

Released

2285

81 IGMP Status Commands

81.8 Show Multicast Source Statistics Command


Command Description
Obsolete command.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module-mcast-src [ (slot) [ mcast-addr <Igmp::MulticastAddress> ] ]
Obsolete command.

Command Parameters
Table 81.8-1 "Show Multicast Source Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)

identifies an IGMP module by


the logical SlotId

mcast-addr

mcast src address in network-byte


order(big-endian)

Command Output
Table 81.8-2 "Show Multicast Source Statistics Command" Display parameters
Specific Information
name

Type

Description

peak-nbr-subs-channels
short name:
pk-nr-sub-chan

Parameter type: <Counter>


- 32 bit counter

peak-time

Parameter type: <Igmp::McastSrcPeakTime>

The peak number of subscribed


IGMP channels which have
members connected to the source
since the last statistics reset. It is
only for those groups configured
in multicast source table.
This element is always shown.
The network time indicating

2286

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description

- the time (yyyy-mm-dd:hour:minutes:secs)


- unit: UTC

when the peak number of


subscribed IGMP channels for
the source occurred. It is only for
those groups configured in
Multicast Source Table.
This element is always shown.
Indicates the current number of
subscribed IGMP channels for
the source.
This element is only shown in
detail mode.
Indicates the number of times
that an attempt to create a
multicast connection fails.
This element is always shown.
indicates the number of times that
users successfully joined a group.
This element is always shown.

curr-subs-channels

Parameter type: <Gauge>


- gauge

nbr-connect-fail
short name: nr-con-fail

Parameter type: <Counter>


- 32 bit counter

user-success-join

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2287

81 IGMP Status Commands

81.9 Show Multicast Channel Statistics Command


Command Description
This command shows the distribution of statistics information maintained by IGMP channels. The operator should
know the slot index(the range is 1/1/0 to 1/1/18) ,the class D address (the range is 224.0.0.3 to 239.255.255.255)
and the source-ip-addr of the mcast server. The following statistics objects measure the popularity of a multicast
channel (when and how much the multicast channel is being watched by end users). The term "subscribe" in this
context means how many IGMP channels have a group member connected to this multicast source.
peak-nbr-subs-channels: This statistic indicates the peak number of subscribed IGMP channels for which leaf
multicast VCLs have connected to the source since the last statistics reset.
peak-time: This statistic indicates the network time, in seconds, when the peak number of subscribed IGMP
channels for the source occurred.
curr-subs-channels: This statistic indicates the current number of subscribed IGMP channels for the source.
connect-fail-counter: This statistic indicates the number of times that an attempt to create a multicast
connection has failed and the number of times that a multicast connection failure has occurred. The reason for
failure is likely because there is insufficient bandwidth in the internal backplane of the Alcatel-Lucent 7302 or
7330 ISAM FTTN to transport the data traffic from the root endpoint of the network interface to the leaf
endpoint of the access interface.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module-mcast-channel [ (slot) [ grp-ip-addr <Igmp::MulticastAddress> ] [ src-ip-addr
<Ip::V4Address> ] [ vlan-id <Igmp::McastChannelVlan> ] ]

Command Parameters
Table 81.9-1 "Show Multicast Channel Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(slot)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:

identifies an IGMP module by


the logical SlotId

grp-ip-addr
src-ip-addr

2288

Released

ip address identifying
multicast group

the

ip address of the multicast server


originating
the
multicast

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

Resource Identifier
vlan-id

Type

Description

- IPv4-address

channel,value 0.0.0.0 means


ASM(any-src-ip-addr)
vlanid of the multicast channel
which is configured in it

Parameter type: <Igmp::McastChannelVlan>


Format:
- vlan id for multicast
- range: [1...4093]

Command Output
Table 81.9-2 "Show Multicast Channel Statistics Command" Display parameters
Specific Information
name

Type

Description

peak-nbr-subs-channels
short name: pk-nr-sub-ch

Parameter type: <Counter>


- 32 bit counter

peak-time

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

curr-subs-channels

Parameter type: <Gauge>


- gauge

nbr-connect-fail
short name: nr-con-nok

Parameter type: <Counter>


- 32 bit counter

user-success-join

Parameter type: <Counter>


- 32 bit counter

The peak number of subscribed


IGMP channels which have
members connected to the source
since the last statistics reset. It is
only for those groups configured
in Multicast Channel table.
This element is always shown.
The network time indicating
when the peak number of
subscribed IGMP channels for
the source occurred. It is only for
those groups configured in
Multicast Channel Table.
This element is always shown.
Indicates the current number of
subscribed IGMP channels for
the multicast stream/channel.
This element is only shown in
detail mode.
Indicates the number of times
that an attempt to create a
multicast connection fails.
This element is always shown.
indicates the number of times that
users successfully joined a group.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2289

81 IGMP Status Commands

81.10 IGMP Module Counter Status Command


Command Description
This command displays the IGMP module counters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module counter [ (slot-index) ]

Command Parameters
Table 81.10-1 "IGMP Module Counter Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identifies an IGMP module by


the logical slot id

Command Output
Table 81.10-2 "IGMP Module Counter Status Command" Display parameters
Specific Information
name

Type

Description

total-msg

Parameter type: <Counter>


- 32 bit counter

total-igmp-msg

Parameter type: <Counter>


- 32 bit counter

total-req

Parameter type: <Counter>

The total number of messages


received from users, including
IGMP messages and invalid
messages.
This element is always shown.
The total number of IGMP
messages, which includes join
and leave requests from users,
(both
successful
and
unsuccessful).
This element is always shown.
The total number of join requests

2290

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description

- 32 bit counter

from users, which includes


successful and unsuccessful
attempts.
This element is always shown.
The total number of successful
join requests from users which
includes new joins (which make a
new connection) and re-joins
(which
already
have
a
connection).
This element is always shown.
The total number of unsuccessful
new join requests from users. The
failures could be due to the
following reasons: permission
bitmap failure, bitrate failure,
lack of resource or invalid group
address.
This element is only shown in
detail mode.
The total number of leave
requests from users.
This element is only shown in
detail mode.
The total number of invalid
messages from users. These
messages could be invalid for the
following reasons: invalid IGMP
message type, invalid IGMP
message CRC, invalid IGMP
message size, non-IGMP frame
received, unexpected IGMP
Query (GSQ or GMQ) received,
RFC 1483 errors, MAC layer
errors, or IP layer errors.
This element is only shown in
detail mode.
The total number of connects due
to successful new IGMP join
requests from users.
This element is always shown.
The total number of disconnects
to users. They can be due to GSQ
or GMQ timer expiry or the
triggering of fast channel
changes.
This element is only shown in
detail mode.
The peak number of multicast
branch connections performed
per second since the statistics
were last cleared.
This element is only shown in
detail mode.
The peak number of disconnects
to users performed per second.
This element is only shown in

success-req

Parameter type: <Counter>


- 32 bit counter

unsuccess-req

Parameter type: <Counter>


- 32 bit counter

total-leave-req

Parameter type: <Counter>


- 32 bit counter

total-inval-msg

Parameter type: <Counter>


- 32 bit counter

num-connects

Parameter type: <Counter>


- 32 bit counter

num-disconnects

Parameter type: <Counter>


- 32 bit counter

peak-connects-sec

Parameter type: <Counter>


- 32 bit counter

peak-disconnects-sec

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2291

81 IGMP Status Commands

name

Type

peak-msg-sec

Parameter type: <Counter>


- 32 bit counter

gmq

Parameter type: <Counter>


- 32 bit counter

gsq

Parameter type: <Counter>


- 32 bit counter

gssq

Parameter type: <Counter>


- 32 bit counter

ovrld-app

Parameter type: <Counter>


- 32 bit counter

2292

Released

Description
detail mode.
The peak number of messages
received from users per second.
This element is only shown in
detail mode.
The total number of GMQ
requests from network.
This element is only shown in
detail mode.
The total number of GSQ
requests from network.
This element is only shown in
detail mode.
The total number of GSSQ
requests from network.
This element is only shown in
detail mode.
The number of seconds during
which
module
overload
protection has been applied
affecting all IGMP channels
which are terminated at the
IGMP module.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

81.11 IGMP Module Time Status Command


Command Description
This command displays the IGMP module time-related parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module time [ (slot-index) ]

Command Parameters
Table 81.11-1 "IGMP Module Time Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identifies an IGMP module by


the logical slot id

Command Output
Table 81.11-2 "IGMP Module Time Status Command" Display parameters
Specific Information
name

Type

Description

peak-connects

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

peak-disconnects

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

peak-msg

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)

This statistic is the network time


indicating when the peak number
of connects performed per second
occurred.
This element is always shown.
The network time of when the
peak number of disconnects to
users performed per second
occurred.
This element is always shown.
The network time of when the
peak number of messages

3HH-04416-EBAA-TCZZA 01

Released

2293

81 IGMP Status Commands

name

stats-intval

2294

Type

Description

- unit: UTC

received from users per second


occurred.
This element is always shown.
The network time, when the
module-wide statistics were last
reset.
This element is only shown in
detail mode.

Parameter type: <Igmp::McastSrcPeakTime>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

81.12 IGMP Module Miscellaneous Status


Command
Command Description
This command displays the IGMP module parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module miscellaneous [ (slot-index) ]

Command Parameters
Table 81.12-1 "IGMP Module Miscellaneous Status Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identifies an IGMP module by


the logical slot id

Command Output
Table 81.12-2 "IGMP Module Miscellaneous Status Command" Display parameters
Specific Information
name

Type

Description

curr-root-conn

Parameter type: <Gauge>


- gauge

con-cfgd

Parameter type: <Gauge>


- gauge

con-un-cfgd

Parameter type: <Gauge>


- gauge

The number of the connected


groups.
This element is always shown.
The number of the connected
groups who are configured in
multicast source table.
This element is always shown.
The number of the connected
groups who aren't configured in

3HH-04416-EBAA-TCZZA 01

Released

2295

81 IGMP Status Commands

name
con-no-memb

2296

Released

Type

Description

Parameter type: <Gauge>


- gauge

multicast source table.


This element is always shown.
The number of the connected
groups who is in reserve state(no
member).
This element is always shown.

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

81.13 IGMP System Status Command


Command Description
This command displays the next Multicast Service Context Profile Index available.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp mcast-svc-context

Command Output
Table 81.13-2 "IGMP System Status Command" Display parameters
Specific Information
name
next

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Igmp::McastSvcCtxtNextPointer>


- mcast service context profile index
- range: [0...64]

The next available id for


multicast service context profile.
This element is always shown.

Released

2297

81 IGMP Status Commands

81.14 SHub IGMP VLAN Router Port Status


Command
Command Description
This command displays the status of the IGMP VLAN router ports.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub vlan-router-port [ (vlan-id) [ network-port <Shub::NetworkPort> ] ]

Command Parameters
Table 81.14-1 "SHub IGMP VLAN Router Port Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Shub::NetworkPort>
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

the id of a vlan for which a


network port is reachable

network-port

the network port that is reachable

Command Output
Table 81.14-2 "SHub IGMP VLAN Router Port Status Command" Display parameters
Specific Information

2298

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description

config-status

Parameter type: <Vlan::VlanRouterConfigStatus>


( static
| dynamic
| static-dynamic )
Possible values:
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry

status of the router port


This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2299

81 IGMP Status Commands

81.15 Shub IGMP System Status Command


Command Description
This command shows IGMP protocol statistics for the shub

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub igs-stats [ (vlan-id) ]

Command Parameters
Table 81.15-1 "Shub IGMP System Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]

for which IGMP snooping


statistics are displayed

Command Output
Table 81.15-2 "Shub IGMP System Status Command" Display parameters
Specific Information
name

Type

Description

rx-gmq
short name: rx/gmq

Parameter type: <SignedInteger>


- a signed integer

rx-gsq
short name: rx/gsq

Parameter type: <SignedInteger>


- a signed integer

rx-gssq
short name: rx/gssq

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-reports
short name:
igmp-reports/rx
rx-igmp-v3-reports
short name:
igmp-reports/rx-v3
rx-igmp-v3-is-in-msgs

Parameter type: <SignedInteger>


- a signed integer

number of queries received by


the snooping switch
This element is always shown.
number of group queries received
by the snoop switch
This element is always shown.
number of group,source queries
received by switch
This element is always shown.
number of IGMPv1/IGMPv2
membership reports received
This element is always shown.
number of IGMPv3 mem-reports
received by snoop switch
This element is always shown.
number of IGMPv3 mem-reports
of type IS_IN received
This element is only shown in

2300

Released

Parameter type: <SignedInteger>


- a signed integer
Parameter type: <SignedInteger>
- a signed integer

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

rx-igmp-v3-is-ex-msgs

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-v3-to-in-msgs

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-v3-to-ex-msgs

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-v3-allow-msgs

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-v3-block-msgs

Parameter type: <SignedInteger>


- a signed integer

rx-igmp-leaves
short name:
igmp-leaves/rx
tx-igmp-leaves
short name:
igmp-leaves/tx
tx-gmq
short name: tx/gmq

Parameter type: <SignedInteger>


- a signed integer

tx-gsq
short name: tx/gsq

Parameter type: <SignedInteger>


- a signed integer

tx-gssq
short name: tx/gssq

Parameter type: <SignedInteger>


- a signed integer

tx-igmp-reports
short name:
igmp-reports/tx
tx-igmp-v3-reports
short name:
igmp-reports/tx-v3
rx-igmp-drop-pkts

Parameter type: <SignedInteger>


- a signed integer

rx-wrong-src-ip-addr

Parameter type: <SignedInteger>


- a signed integer

3HH-04416-EBAA-TCZZA 01

Parameter type: <SignedInteger>


- a signed integer
Parameter type: <SignedInteger>
- a signed integer

Parameter type: <SignedInteger>


- a signed integer
Parameter type: <SignedInteger>
- a signed integer

Description
detail mode.
number of IGMPv3 mem-reports
of type IS_EX received
This element is only shown in
detail mode.
number of IGMPv3 mem-reports
of type TO_IN received
This element is only shown in
detail mode.
number of IGMPv3 mem-reports
of type TO_EX received
This element is only shown in
detail mode.
number of IGMPv3 mem-reports
of type ALLOW received
This element is only shown in
detail mode.
number of IGMPv3 mem-reports
of type BLOCK received
This element is only shown in
detail mode.
number of IGMPv2 leave
messages received by switch
This element is always shown.
number of IGMPv2 leave
messages
This element is always shown.
gen query transmitted by the
switch when it is a querier
This element is always shown.
number of group specific queries
transmitted
This element is always shown.
number of group source specific
queries transmitted
This element is always shown.
number of IGMPv1/IGMPv2
membership reports
This element is always shown.
number of IGMPV3 membership
reports
This element is always shown.
number of erroneous IGMP
packets dropped
This element is only shown in
detail mode.
number of IGMP signals received
where the src-ip-addr of the
multicast channel violates the
ASM/SSM rules
This element is only shown in
detail mode.

Released

2301

81 IGMP Status Commands

81.16 Shub IGMP CAC System Status Command


Command Description
This command shows the CAC system-related parameters and statistics.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub system-stats

Command Output
Table 81.16-2 "Shub IGMP CAC System Status Command" Display parameters
Specific Information
name
used-bw-grt
short name: bw-grt
used-chan-grt
short name: chan-grt
used-bw-no-grt
short name: bw-no-grt
used-chan-no-grt
short name: chan-no-grt

Type

Description

Parameter type: <Igmp::OccupyBWGuranteed>


- bandwidth occupied by all active guaranteed channels
- unit: kbps
Parameter type: <Igmp::OccupyGuaranteedChannel>
- a signed integer

bandwidth occupied by the all


active guaranteed channels
This element is always shown.
number of active guaranteed
channels connected to lanx
This element is always shown.
bandwidth occupied by the all
active non-guaranteed channels
This element is always shown.
number of active non-guaranteed
channels connected to lanx
This element is always shown.
the number of joins rejected for
non-guaranteed channels
This element is only shown in
detail mode.
number of multicast joins
rejected
for
the
non-guaranteed/non-configured
channels
This element is only shown in
detail mode.
count of joins rejected for
non-configured multicast source
This element is only shown in
detail mode.
number of active non configured
multicast
entries,
include

Parameter type: <Igmp::OccupyBWNonGuranteed>


- bandwidth occupied by all active non-guaranteed channels
- unit: kbps
Parameter type: <Igmp::OccupyNonGuaranteedChannel>
- a signed integer

jn-reject-bw

Parameter type: <Counter>


- 32 bit counter

jn-reject-chan

Parameter type: <Counter>


- 32 bit counter

jn-reject-uncfg

Parameter type: <Counter>


- 32 bit counter

active-non-rate-based

Parameter type: <Igmp::ActiveNonConfMulticastEntries>


- a signed integer

2302

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description
dynamic and static mc stream
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2303

81 IGMP Status Commands

81.17 Shub IGMP CAC Multicast Sources Status


Command
Command Description
Show the Multicast channel statistics maintained by SHub for CAC functionality.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub mcast-stats [ (src) [ vlan-id <Igmp::McastSrcVLANID> ] [ ip-addr <Ip::V4Address> ] ]

Command Parameters
Table 81.17-1 "Shub IGMP CAC Multicast Sources Status Command" Resource Parameters
Resource Identifier

Type

Description

(src)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Igmp::McastSrcVLANID>
Format:
- VLAN for this multicast source
- range: [1...4093]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

mcast src address in network-byte


order(big-endian)
vlan for this multicast source

vlan-id

ip-addr

ip address of the multicast server


in
network-byte
order
(big-enaian)

Command Output
Table 81.17-2 "Shub IGMP CAC Multicast Sources Status Command" Display parameters
Specific Information
name

Type

Description

fail-join

Parameter type: <Counter>


- 32 bit counter

fail-sys-bw

Parameter type: <Counter>


- 32 bit counter

fail-bundle-bw

Parameter type: <Counter>

number of multicast joins


rejected of all un-configured and
un-guaranteed
This element is always shown.
number of multicast joins
rejected since bandwidth is not
available at the system
This element is always shown.
number of multicast joins

2304

Released

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description

- 32 bit counter

rejected since bandwidth is not


available in the bundle
This element is always shown.
number of multicast joins
rejected since system max
connections has reached
This element is always shown.
number of multicast joins
rejected since bundle max
connections has reached
This element is always shown.

fail-sys-chan

Parameter type: <Counter>


- 32 bit counter

fail-bundle-chan

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2305

81 IGMP Status Commands

81.18 Shub IGMP CAC Bundle Status Command


Command Description
Show the Multicast Bundle statistics maintained by LANX for CAC functionality.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub bundle-stats [ (bundle-name) ]

Command Parameters
Table 81.18-1 "Shub IGMP CAC Bundle Status Command" Resource Parameters
Resource Identifier

Type

Description

(bundle-name)

Format:
- the name of the bundle
- length: x<=32

name of this bundle

Command Output
Table 81.18-2 "Shub IGMP CAC Bundle Status Command" Display parameters
Specific Information
name

Type

jn-reject-bw
short name: reject-bw

Parameter type: <Counter>


- 32 bit counter

jn-reject-chan
short name: reject-chan
used-bw-grt
short name: bw-grt
used-chan-grt
short name: chan-grt
used-bw-no-grt
short name: bw-no-grt

2306

Released

Description

number of multicast joins


rejected since bandwidth is not
available in the bundle
This element is always shown.
Parameter type: <Counter>
number of multicast joins
- 32 bit counter
rejected since bundle max
connections has reached
This element is always shown.
Parameter type: <Igmp::bundleOccupiedBWGuranteed>
total
bandwidth
currently
- bandwidth occupied by all active guaranteed channels
occupied by guaranteed channels
- unit: kbps
This element is always shown.
Parameter type: <Igmp::bundleOccupiedGuaranteed>
number of guaranteed channels
- a signed integer
that are active in that bundle
This element is always shown.
Parameter type: <Igmp::bundleOccupiedBWNonGuranteed> total
bandwidth
currently
- bandwidth occupied by all active non-guaranteed channels occupied
by
unguaranteed
- unit: kbps
channels
This element is always shown.

3HH-04416-EBAA-TCZZA

01

81 IGMP Status Commands

name

Type

Description

used-chan-no-grt
short name: chan-no-grt

Parameter type: <Igmp::bundleOccupiedNonGuaranteed>


- a signed integer

chan-associate

Parameter type: <Igmp::bundleChannelAssociatedCount>


- a signed integer

number of unguaranteed channels


that are active in that bundle
This element is always shown.
number of multicast channels that
are configured in the bundle
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2307

81 IGMP Status Commands

81.19 Shub IGMP CAC Bundle to Source Command


Command Description
This command shows the CAC Bundle to multicast source parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub bundle-to-src [ (bundle-name) [ class-d-addr <Igmp::MulticastAddress> ] [ vlan-id
<Igmp::McastSrcVLANID> ] ]

Command Parameters
Table 81.19-1 "Shub IGMP CAC Bundle to Source Command" Resource Parameters
Resource Identifier

Type

Description

(bundle-name)

Format:
- the name of the bundle
- length: x<=32
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Igmp::McastSrcVLANID>
Format:
- VLAN for this multicast source
- range: [1...4093]

name of this bundle

class-d-addr
vlan-id

mcast src address in network-byte


order(big-endian)
vlan for this multicast source

Command Output
Table 81.19-2 "Shub IGMP CAC Bundle to Source Command" Display parameters
Specific Information
name
ip-addr

2308

Released

Type

Description

Parameter type: <Ip::V4Address>


- IPv4-address

ip address of the multicast server


in
network-byte
order
(big-endian)
This element is always shown.

3HH-04416-EBAA-TCZZA

01

82- Transport Status Commands

82.1 Transport Status Command Tree


82.2 ICMP Status Command
82.3 IP Address Status Command
82.4 IP Statistics
82.5 IP Route Status Command
82.6 IP Net-to-media Status Command
82.7 SNMP Protocol Statistics Command
82.8 SNMP Engine Status Command
82.9 System Status Command
82.10 UDP Status Command
82.11 UDP Listener Status Command
82.12 SHub Ethernet Dot3 Status Command
82.13 SHub Dot3 Control Status Command
82.14 SHub Dot3 Pause Status Command
82.15 SHub Ethernet Dot3 Status Command
82.16 SHub L2 Filter Status Command
82.17 SHub Rate Status Command
82.18 SFP status commands
82.19 Interface MAU Status Command
82.20 Ethernet Lt Dot3 Status Command

3HH-04416-EBAA-TCZZA 01

82-2310
82-2311
82-2314
82-2316
82-2319
82-2321
82-2322
82-2325
82-2326
82-2327
82-2328
82-2329
82-2330
82-2332
82-2334
82-2338
82-2340
82-2342
82-2344
82-2349

Released

2309

82 Transport Status Commands

82.1 Transport Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Transport Status Commands".

Command Tree
----show
----transport
----icmp
----ip-address
- (address)
----ip-parameters
----ip-route
- (destination)
----ip-net-to-media
- (interface-name)
- network-addr
----snmp
----protocol-stats
----engine
----system-parameters
----udp-parameters
----udp
- (local-address)
- local-port
----shub
----dot3-coll
- (if-index)
- coll-count
----dot3-control
- (stats-index)
----dot3-pause
- (stats-index)
----dot3-status
- (stats-index)
----mac
- (index-num)
- port
----rate
- (port)
----X ether-ifsfplt
- (if-index)
- index
----X ether-ifmault
- (if-index)
- index
----X ether-dot3lt
- (stats-index)

2310

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.2 ICMP Status Command


Command Description
This command displays the ICMP parameter, which gives a count of how many ICMP messages an entity
receives(including errors also).This errors determine the number of ICMP specific errors in the ICMP messages.
The ICMP parameter uses a list for the numbers of messages that did not reach the destination, time exceeded
messages,parameter problem messages received, source quench messages, redirect messages, echo request and
reply messages, time stamp request and reply messages, address mask request and reply messages, messages which
the entity attempted to send including the error messages and messages which the entity did not send due to the
problems like lack of buffer.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport icmp

Command Output
Table 82.2-2 "ICMP Status Command" Display parameters
Specific Information
name

Type

Description

rx-total-msgs

Parameter type: <Counter>


- 32 bit counter

rx-err-msgs

Parameter type: <Counter>


- 32 bit counter

rx-dest-unreach-msgs

Parameter type: <Counter>


- 32 bit counter

rx-time-exceed-msgs

Parameter type: <Counter>


- 32 bit counter

rx-param-problem-msgs

Parameter type: <Counter>


- 32 bit counter

rx-src-quench-msgs

Parameter type: <Counter>


- 32 bit counter

rx-redirect-msgs

Parameter type: <Counter>

The total number of ICMP


messages which the entity
received(includes errors also).
This element is always shown.
The number of ICMP messages
which the entity received but
determined
as
having
ICMP-specific errors.
This element is always shown.
The number of ICMP destination
unreachable messages received.
This element is always shown.
The number of ICMP time
exceeded messages received.
This element is always shown.
The number of ICMP parameter
problem messages received.
This element is always shown.
The number of ICMP source
quench messages received.
This element is always shown.
The number of ICMP Redirect

3HH-04416-EBAA-TCZZA 01

Released

2311

82 Transport Status Commands

name

Type

Description

- 32 bit counter

messages received.
This element is always shown.
The number of ICMP echo
(request) messages received.
This element is always shown.
The number of ICMP Echo Reply
messages received.
This element is always shown.
The number of ICMP time stamp
(request) messages received.
This element is always shown.
The number of ICMP timestamp
reply messages received.
This element is always shown.
The number of ICMP address
mask request messages received.
This element is always shown.
The number of ICMP address
mask reply messages received.
This element is always shown.
The total number of ICMP
messages which was attempted to
send.
This element is always shown.
The number of ICMP messages
which this entity did not send due
to problems discovered within
ICMP such as a lack of buffers.
This element is always shown.
The number of ICMP Destination
Unreachable messages sent.
This element is always shown.
The number of ICMP Time
Exceeded messages sent.
This element is always shown.
The number of ICMP Parameter
Problem messages sent.
This element is always shown.
The number of ICMP source
quench messages sent.
This element is always shown.
The number of ICMP Redirect
messages sent. For a host, this
object will always be zero, since
hosts do not send redirects.
This element is always shown.
The number of ICMP echo
request messages sent.
This element is always shown.
The number of ICMP Echo Reply
messages sent.
This element is always shown.
The number of ICMP timestamp
request messages sent.
This element is always shown.
The number of ICMP timestamp
reply messages sent.

rx-echo-req-msgs

Parameter type: <Counter>


- 32 bit counter

rx-echo-reply-msgs

Parameter type: <Counter>


- 32 bit counter

rx-timestamp-req-msgs

Parameter type: <Counter>


- 32 bit counter

rx-timestamp-reply

Parameter type: <Counter>


- 32 bit counter

rx-addr-mask-req-msgs

Parameter type: <Counter>


- 32 bit counter

rx-addr-mask-reply

Parameter type: <Counter>


- 32 bit counter

tx-total-msgs

Parameter type: <Counter>


- 32 bit counter

not-tx-err-msgs

Parameter type: <Counter>


- 32 bit counter

tx-dest-unreach-msgs

Parameter type: <Counter>


- 32 bit counter

tx-time-exceed-msgs

Parameter type: <Counter>


- 32 bit counter

tx-param-problem-msgs

Parameter type: <Counter>


- 32 bit counter

tx-src-quench-msgs

Parameter type: <Counter>


- 32 bit counter

tx-redirect-msgs

Parameter type: <Counter>


- 32 bit counter

tx-echo-req-msgs

Parameter type: <Counter>


- 32 bit counter

tx-echo-reply-msgs

Parameter type: <Counter>


- 32 bit counter

tx-timestamp-req-msgs

Parameter type: <Counter>


- 32 bit counter

tx-timestamp-reply

Parameter type: <Counter>


- 32 bit counter

2312

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

tx-addr-mask-req-msgs

Parameter type: <Counter>


- 32 bit counter

tx-addr-mask-reply

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is always shown.
The number of ICMP Address
Mask Request messages sent.
This element is always shown.
The number of ICMP Address
Mask Reply messages sent.
This element is always shown.

Released

2313

82 Transport Status Commands

82.3 IP Address Status Command


Command Description
This command displays the IP address parameter that holds the addressing information for one of this entity's IP
addresses.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-address [ (address) ]

Command Parameters
Table 82.3-1 "IP Address Status Command" Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
- IPv4-address

ip address where
information pertains

addressing

Command Output
Table 82.3-2 "IP Address Status Command" Display parameters
Specific Information
name

Type

Description

ifindex

Parameter type: <SignedInteger>


- a signed integer

subnet-mask

Parameter type: <Ip::V4Address>


- IPv4-address

bcast-addr

Parameter type: <SignedInteger>


- a signed integer

reas-max-size

Parameter type: <Transport::IpAdEntReasmMaxSize>


- size of the largest reassembled IP datagram
- range: [0...65535]

Uniquely identifies the interface


to which this is applicable.
This element is always shown.
The subnet mask associated with
the IP address.
This element is always shown.
The broadcast address used for
sending datagrams on the
(logical) interface associated with
the IP address
This element is only shown in
detail mode.
The size of the largest IP
datagram which this entity can
re-assemble from incoming IP
fragmented datagrams received
on this interface.
This element is only shown in

2314

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

Description
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2315

82 Transport Status Commands

82.4 IP Statistics
Command Description
This command displays the IP statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-parameters

Command Output
Table 82.4-2 "IP Statistics" Display parameters
Specific Information
name

Type

Description

rx-total-datagrams

Parameter type: <Counter>


- 32 bit counter

in-hdr-err-data

Parameter type: <Counter>


- 32 bit counter

in-addr-err-data

Parameter type: <Counter>


- 32 bit counter

forwarded-datagrams

Parameter type: <Counter>


- 32 bit counter

rx-unknown-proto-data

Parameter type: <Counter>

The total number of input


datagrams
received
from
interfaces,
including
those
received in error.
This element is always shown.
The number of input datagrams
discarded due to errors in their IP
headers,
including
bad
checksums, version number
mismatch, other format errors,
time-to-live exceeded, errors
discovered in processing their IP
options, etc.
This element is always shown.
The number of input datagrams
discarded because the IP address
in their IP header's destination
field was not a valid address to be
received at this entity.
This element is always shown.
The number of input datagrams
for which this entity was not their
final IP destination, as a result of
which an attempt was made to
find a route to forward them to
that final destination.
This element is always shown.
The number of locally-addressed

2316

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

Description

- 32 bit counter

datagrams received successfully


but discarded because of an
unknown
or
unsupported
protocol.
This element is always shown.
The number of input IP
datagrams for which no problems
were encountered to prevent their
continued processing, but which
were discarded (e.g., for lack of
buffer space).
This element is always shown.
The total number of input
datagrams successfully delivered
to IP user-protocols (including
ICMP).
This element is always shown.
The total number of IP datagrams
which local IP user-protocols
(including ICMP) supplied to IP
in requests for transmission.
This element is always shown.
The number of output IP
datagrams for which no problem
was encountered to prevent their
transmission to their destination,
but which were discarded (e.g.,
for lack of buffer space).
This element is always shown.
The number of IP datagrams
discarded because no route could
be found to transmit them to their
destination.
This element is always shown.
The maximum number of
seconds
which
received
fragments are held while they are
awaiting reassembly at this
entity.
This element is always shown.
The number of IP fragments
received which needed to be
reassembled at this entity.
This element is always shown.
The number of IP datagrams
successfully re-assembled.
This element is always shown.
The number of failures detected
by the IP re-assembly algorithm
This element is always shown.
The number of IP datagrams that
have
been
successfully
fragmented at this entity.
This element is always shown.
The number of IP datagrams that
have been discarded because they
needed to be fragmented at this

discard-in-data

Parameter type: <Counter>


- 32 bit counter

tot-deliv-in-data

Parameter type: <Counter>


- 32 bit counter

tot-out-req-data

Parameter type: <Counter>


- 32 bit counter

discard-out-data

Parameter type: <Counter>


- 32 bit counter

out-no-route-datagrams

Parameter type: <Counter>


- 32 bit counter

timeout-reassem

Parameter type: <SignedInteger>


- a signed integer

reassem-req-data

Parameter type: <Counter>


- 32 bit counter

reassem-success-data

Parameter type: <Counter>


- 32 bit counter

reassem-fail-data

Parameter type: <Counter>


- 32 bit counter

frag-success-data

Parameter type: <Counter>


- 32 bit counter

frag-fail-data

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2317

82 Transport Status Commands

name

Type

gener-frag-data

Parameter type: <Counter>


- 32 bit counter

discard-rout-entrs

Parameter type: <Counter>


- 32 bit counter

2318

Released

Description
entity but could not be, e.g.,
because their Don't Fragment flag
was set.
This element is always shown.
The number of IP datagram
fragments that have been
generated as a result of
fragmentation at this entity.
This element is always shown.
The number of routing entries
which were chosen to be
discarded even though they are
valid.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.5 IP Route Status Command


Command Description
This command displays the IP routing statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-route [ (destination) ]

Command Parameters
Table 82.5-1 "IP Route Status Command" Resource Parameters
Resource Identifier

Type

Description

(destination)

Format:
- IPv4-address

destination IP address of this


route

Command Output
Table 82.5-2 "IP Route Status Command" Display parameters
Specific Information
name
routing-mechanism

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Transport::ipRouteProto>


( other
| local
| netmgmt
| icmp
| egp
| ggp
| hello
| rip
| is-is
| es-is
| cisco-igrp
| bbn-spf-igp
| ospf
| bgp )
Possible values:
- other : entry is created via the BOOTP protocol
- local : manually configured
- netmgmt : entry is created via the SNMP protocol
- icmp : obtained via ICMP

The routing mechanism via


which this route was learned.
This element is always shown.

Released

2319

82 Transport Status Commands

name

Type
- egp : egp protocol
- ggp : ggp protocol
- hello : hello protocol
- rip : rip protocol
- is-is : is-is protocol
- es-is : es-is protocol
- cisco-igrp : ciscoIgrp protocol
- bbn-spf-igp : bbnSpfIgp protocol
- ospf : ospf protocol
- bgp : bgp protocol
Parameter type: <SymbolicObject>
- an object identifier

info

2320

Released

Description

A reference to MIB definitions


specific to the particular routing
protocol which is responsible for
this route.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.6 IP Net-to-media Status Command


Command Description
This command displays the status of net-to-media.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-net-to-media [ (interface-name) [ network-addr <Ip::V4AddressHex> ] ]

Command Parameters
Table 82.6-1 "IP Net-to-media Status Command" Resource Parameters
Resource Identifier

Type

Description

(interface-name)

Format:
eth1
Possible values:
- eth1 : control interface
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address

name of the interface

network-addr

ip
addr
corresponding
to
media-dependent physical addr

Command Output
Table 82.6-2 "IP Net-to-media Status Command" Display parameters
Specific Information
name
phy-addr
type

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sys::MacAddr>


- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Parameter type: <Transport::ipNetToMediaType>
( other
| invalid
| dynamic
| static )
Possible values:
- other : none of the following
- invalid : invalidating the corresponding entry
- dynamic : dynamic mapping
- static : static mapping

media-dependent physical addr


This element is always shown.
type of mapping
This element is always shown.

Released

2321

82 Transport Status Commands

82.7 SNMP Protocol Statistics Command


Command Description
This command displays the statistics related to the SNMP protocol.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport snmp protocol-stats

Command Output
Table 82.7-2 "SNMP Protocol Statistics Command" Display parameters
Specific Information
name

Type

Description

in-pkts

Parameter type: <Counter>


- 32 bit counter

out-pkts

Parameter type: <Counter>


- 32 bit counter

in-get-requests

Parameter type: <Counter>


- 32 bit counter

out-get-requests

Parameter type: <Counter>


- 32 bit counter

in-get-next-requests

Parameter type: <Counter>


- 32 bit counter

out-get-next-requests

Parameter type: <Counter>


- 32 bit counter

in-set-requests

Parameter type: <Counter>


- 32 bit counter

out-set-requests

Parameter type: <Counter>


- 32 bit counter

in-get-responses

Parameter type: <Counter>


- 32 bit counter

out-get-responses

Parameter type: <Counter>

The total number of received


SNMP packets.
This element is always shown.
The total number of transmitted
SNMP packets.
This element is always shown.
The total number of received
SNMP get requests.
This element is always shown.
The total number of transmitted
SNMP get requests.
This element is always shown.
The total number of received
SNMP get-next requests.
This element is always shown.
The total number of transmitted
get-next requests .
This element is always shown.
The total number of received
SNMP set requests.
This element is always shown.
The total number of transmitted
SNMP set requests.
This element is always shown.
The total number of received
SNMP get responses.
This element is always shown.
The total number of transmitted

2322

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

Description

- 32 bit counter

SNMP get responsesG.


This element is always shown.
The total number of received
SNMP traps.
This element is always shown.
The total number of tranmitted
SNMP traps.
This element is always shown.
The total number of successfully
read SNMP objects.
This element is always shown.
The total number of successfully
altered objects.
This element is always shown.
The total number of received
SNMP packets with tooBig
error-status.
This element is always shown.
The total number of transmitted
SNMP packets with tooBig
error-status.
This element is always shown.
The total number of received
SNMP
packets
with
noSuchName error-status.
This element is always shown.
The total number of transmitted
SNMP
packets
with
noSuchName error-status.
This element is always shown.
The total number of received
SNMP packets with badValue
error-status.
This element is always shown.
The total number of transmitted
SNMP packets with badValue
error-status.
This element is always shown.
The total number received SNMP
packts with genErr error-status.
This element is always shown.
The total number of transmitted
SNMP packets with genErr
error-status.
This element is always shown.
The total number received SNMP
packets
with
readOnly
error-status.
This element is always shown.
The total number of received
SNMP packets with a bad SNMP
version.
This element is always shown.
The total number of received
SNMP packets with an unknown
community name.
This element is always shown.

in-traps

Parameter type: <Counter>


- 32 bit counter

out-traps

Parameter type: <Counter>


- 32 bit counter

success-get-objects

Parameter type: <Counter>


- 32 bit counter

success-set-objects

Parameter type: <Counter>


- 32 bit counter

in-too-bigs

Parameter type: <Counter>


- 32 bit counter

out-too-bigs

Parameter type: <Counter>


- 32 bit counter

in-no-such-names

Parameter type: <Counter>


- 32 bit counter

out-no-such-names

Parameter type: <Counter>


- 32 bit counter

in-bad-values

Parameter type: <Counter>


- 32 bit counter

out-bad-values

Parameter type: <Counter>


- 32 bit counter

in-gen-errors

Parameter type: <Counter>


- 32 bit counter

out-gen-errors

Parameter type: <Counter>


- 32 bit counter

in-read-only-s

Parameter type: <Counter>


- 32 bit counter

in-bad-versions

Parameter type: <Counter>


- 32 bit counter

in-unknown-communities

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2323

82 Transport Status Commands

name

Type

Description

in-bad-communities

Parameter type: <Counter>


- 32 bit counter

in-asn1-errors

Parameter type: <Counter>


- 32 bit counter

in-unknown-contexts

Parameter type: <Counter>


- 32 bit counter

in-bad-security-levels

Parameter type: <Counter>


- 32 bit counter

in-not-in-time-windows

Parameter type: <Counter>


- 32 bit counter

in-unknown-users

Parameter type: <Counter>


- 32 bit counter

in-unknown-engines

Parameter type: <Counter>


- 32 bit counter

in-wrong-digests

Parameter type: <Counter>


- 32 bit counter

in-decrypt-errors

Parameter type: <Counter>


- 32 bit counter

in-unknown-models

Parameter type: <Counter>


- 32 bit counter

in-invalids

Parameter type: <Counter>


- 32 bit counter

in-unknown-pdu-types

Parameter type: <Counter>


- 32 bit counter

The total number of received


SNMP packets with an operation
not allowed for the specified
community..
This element is always shown.
The total number of received
SNMP packets with ASN.1
coding errors.
This element is always shown.
The total number of received
SNMP packets targetted to a
wrong context.
This element is always shown.
The total number of received
SNMP packets with an invalid
security-level.
This element is always shown.
The total number of received
SNMP packets outside the
allowed time-window.
This element is always shown.
The total number of received
SNMP packets with an unknown
user name.
This element is always shown.
The total number of received
SNMP packets with an unknown
engine-id.
This element is always shown.
The total number of received
SNMP packets with a wrong
authentication digest.
This element is always shown.
The total number of received
SNMP packets that could not be
decrypted.
This element is always shown.
nbr of pkts rx which referred an
unknown model
This element is always shown.
The number of received invalid
SNMP messages.
This element is always shown.
The number of received SNMP
packets with an unknown PDU
type.
This element is always shown.

2324

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.8 SNMP Engine Status Command


Command Description
This command displays the status of the SNMP engine.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport snmp engine

Command Output
Table 82.8-2 "SNMP Engine Status Command" Display parameters
Specific Information
name
engine-id
boot-cnt
up-time
max-message-size

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Snmp::EngineID>


- SNMP Engine Identifier
- length: 5<=x<=32
Parameter type: <Snmp::EngineBoots>
- SNMP Engine Boots
- range: [1...2147483647]
Parameter type: <Snmp::EngineTime>
- SNMP Engine Time
- range: [1...2147483647]
Parameter type: <Snmp::MessageSize>
- SNMP Message Size
- range: [484...2147483647]

the unique identifier for the


SNMP engine
This element is always shown.
the number of times the SNMP
engine booted.
This element is always shown.
the number of seconds since the
last boot
This element is always shown.
the maximum length for an
SNMP message for this engine
This element is always shown.

Released

2325

82 Transport Status Commands

82.9 System Status Command


Command Description
This command displays the system statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport system-parameters

Command Output
Table 82.9-2 "System Status Command" Display parameters
Specific Information
name

Type

Description

description

Parameter type: <Transport::sysDescr>


- a printable string
- length: x<=255

object-id

Parameter type: <Object>


- an object identifier

up-time

Parameter type: <Transport::TimeTicks>


- a timeout value
- unit: hundredths of a second

services

Parameter type: <Transport::SysServices>


- set of services
- unit: milisec
- range: [0...127]

A textual description which


include's the full name and
version identification of the
system's hardware type, software
operating-system,
and
networking software.
This element is always shown.
The
vendor's
authoritative
identification of the network
management
subsystem
contained in the entity. This value
is allocated within the SMI
enterprises subtree (1.3.6.1.4.1)
and provides an easy and
unambiguous
means
for
determining `what kind of box' is
being managed.
This element is always shown.
The time since the network
management portion of the
system was last re-initialized.
This element is always shown.
A value which indicates the set of
services that this entity primarily
offers.
This element is always shown.

2326

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.10 UDP Status Command


Command Description
This command displays the parameters that keep track of the number of UDP datagrams delivered to the UDP user
and also the number of errors that occurred. Implementation of the UDP group is mandatory for all systems that
implement the UDP.
The total number of UDP datagrams delivered to UDP users is given by the total-delivered-datagrams parameter.
The no-port parameter gives the total number of received UDP datagrams for which there was no application at
the destination port. The err-datagrams parameter gives the number of received UDP datagrams that could not be
delivered for reasons other than the lack of an application at the destination port. The total-datagrams parameter
gives the total number of UDP datagrams sent from this entity.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport udp-parameters

Command Output
Table 82.10-2 "UDP Status Command" Display parameters
Specific Information
name

Type

Description

tot-deliv-data

Parameter type: <Counter>


- 32 bit counter

rx-tot-no-port-data

Parameter type: <Counter>


- 32 bit counter

rx-err-datagrams

Parameter type: <Counter>


- 32 bit counter

tx-total-datagrams

Parameter type: <Counter>


- 32 bit counter

The total number of UDP


datagrams delivered to UDP
users.
This element is always shown.
The total number of received
UDP datagrams for which there
was no application at the
destination port.
This element is always shown.
The number of received UDP
datagrams that could not be
delivered for reasons other than
the lack of an application at the
destination port.
This element is always shown.
The total number of UDP
datagrams sent from this entity.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2327

82 Transport Status Commands

82.11 UDP Listener Status Command


Command Description
This command displays the UDP listener table that contains information about this entity's UDP end-points on
which a local application is currently accepting datagrams.
The local IP address for this UDP listener is given by the local-address parameter. In the case of a UDP listener
which is willing to accept datagrams for any IP interface associated with the node, the value 0.0.0.0 is used. The
local port number for this UDP listener is given by local-port parameter.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport udp [ (local-address) [ local-port <Transport::UdpLocalPort> ] ]

Command Parameters
Table 82.11-1 "UDP Listener Status Command" Resource Parameters
Resource Identifier

Type

Description

(local-address)

Format:
- IPv4-address
Parameter type: <Transport::UdpLocalPort>
Format:
- udp local port number
- range: [0...65535]

local IP address for this UDP


listener
local port number for this UDP
listener

local-port

2328

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.12 SHub Ethernet Dot3 Status Command


Command Description
This command displays the related Dot3 collision status For SHub.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-coll [ (if-index) [ coll-count <Transport::CollisionCount> ] ]

Command Parameters
Table 82.12-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier

Type

Description

(if-index)

Format:
- index of the collision interface
- range: [0...2147483647]
Parameter type: <Transport::CollisionCount>
Format:
- count of per-frame media collisions
- range: [0...16]

index of the collision interface

coll-count

count of
collisions

per-frame

media

Command Output
Table 82.12-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name
frequencies

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

A count of individual MAC


frames for which the transmission
(successful or otherwise) on a
particular interface occurs after
the frame has experienced exactly
the number of collisions as in
coll-count
This element is always shown.

Released

2329

82 Transport Status Commands

82.13 SHub Dot3 Control Status Command


Command Description
This command displays the Dot3 control status.
The functions-supported parameter give a list of the possible MAC Control functions implemented for this
interface. The rx-unknown-opcodes parameter gives a count of MAC Control frames received on this interface that
contain an opcode that is not supported by this device.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-control [ (stats-index) ]

Command Parameters
Table 82.13-1 "SHub Dot3 Control Status Command" Resource Parameters
Resource Identifier

Type

Description

(stats-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

index of the interface to an


ethernet-like medium

Command Output
Table 82.13-2 "SHub Dot3 Control Status Command" Display parameters
Specific Information
name
functions-supported

2330

Released

Type

Description

Parameter type: <Ether::Dot3ControlFuncSupport>


- printable string

A list of the possible MAC


Control functions implemented
for this interface.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

rx-unknown-opcodes

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is always shown.
A count of MAC Control frames
received on this interface that
contain an opcode that is not
supported by this device.
This element is always shown.

Released

2331

82 Transport Status Commands

82.14 SHub Dot3 Pause Status Command


Command Description
This command displays the Dot3 pause parameters.
The stats-index parameter gives a value that uniquely identifies an interface to an Ethernet-like medium. The
operator-mode parameter reflects the PAUSE mode in mandatory in use on this interface, as determined by either
(1) the result of the auto-negotiation function or (2) if auto-negotiation is not enabled or is not implemented for the
active MAU attached to this interface, by the value of pause admin mode.
The in-frames parameter gives a count of MAC Control frames received on this interface with an opcode indicating
the PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode. The
out-frames parameter gives a count of MAC Control frames transmitted on this interface with an opcode indicating
the PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-pause [ (stats-index) ]

Command Parameters
Table 82.14-1 "SHub Dot3 Pause Status Command" Resource Parameters
Resource Identifier

Type

Description

(stats-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

index of the interface to an


ethernet-like medium

Command Output
Table 82.14-2 "SHub Dot3 Pause Status Command" Display parameters

2332

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

Specific Information
name
operator-mode

in-frames

out-frames

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ether::Dot3PauseOperatorMode>


( disabled
| enable-xmit
| enable-rcv
| enable-xmit-rcv )
Possible values:
- disabled : disabled
- enable-xmit : enabled only in transmit direction
- enable-rcv : enabled only in receipt
- enable-xmit-rcv : enabled both transmit and receipt
Parameter type: <Counter>
- 32 bit counter

specifies pause mode in use on


this interface
This element is always shown.

Parameter type: <Counter>


- 32 bit counter

A count of MAC control frames


received on this interface with an
opcode indicating the pause
operation.
This element is always shown.
A count of MAC control frames
transmitted on this interface with
an opcode indicating the pause
operation.
This element is always shown.

Released

2333

82 Transport Status Commands

82.15 SHub Ethernet Dot3 Status Command


Command Description
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The stats-index parameter gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The single-collision-frame parameter gives a count of successfully transmitted frames on a particular interface for
which transmission is inhibited by exactly one collision. This counter does not increment when the interface is
operating in full-duplex mode. The multiple-collision-frame parameter gives a count of successfully transmitted
frames on a particular interface for which transmission is inhibited by more than one collision. This counter also
does not increment when the interface is operating in full-duplex mode.
The deferred-transmission parameter gives a count of frames for which the first transmission attempt on a
particular interface is delayed because the medium is busy. The count represented by an instance of this object
does not include frames involved in collisions. This counter does not increment when the interface is operating in
full-duplex mode.
The late-collision parameter gives the number of times that a collision is detected on a particular interface later
than one slotTime into the transmission of a packet. A (late) collision included in a count represented by an
instance of this object is also considered as a (generic) collision for purposes of other collision-related statistics.
This counter does not increment when the interface is operating in full-duplex mode.
The excessive-collision parameter gives a count of frames for which transmission on a particular interface fails due
to excessive collisions. This counter does not increment when the interface is operating in full-duplex mode.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the dot3StatsLateCollisions object, the
dot3StatsExcessiveCollisions object, or the dot3StatsCarrierSenseErrors object. The precise meaning of the count
represented by an instance of this object is implementation-specific. In particular, an instance of this object may
represent a count of transmission errors on a particular interface that are not otherwise counted.
The frame-too-long parameter gives a count of frames received on a particular interface that exceed the maximum
permitted frame size. The count represented by an instance of this object is incremented when the frameTooLong
status is returned by the MAC service to the LLC.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame too longs, the alignment errors, or the FCS errors object. The
precise meaning of the count represented by an instance of this object is implementation-specific. In particular, an
instance of this object may represent a count of receive errors on a particular interface that are not otherwise
counted.
The duplex-status parameter is the mandatory mode of operation of the MAC entity. "unknown" indicates that the
mandatory duplex mode could not be determined. Management control of the duplex mode is accomplished through
the MAU MIB. When an interface does not support auto-negotiation, or when auto-negotiation is not enabled, the
duplex mode is controlled using MAU default type. When auto-negotiation is supported and enabled, duplex mode

2334

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

is controlled using MAU auto-negotiation advertised bits. In either case, the mandatory operating duplex mode is
reflected both in this object and in its MAU type.
The carrier-sense-error parameter gives the number of times that the carrier sense condition was lost or never
asserted when attempting to transmit a frame on a particular interface. The count represented by an instance of
this object is incremented at most once per transmission attempt, even if the carrier sense condition fluctuates
during a transmission attempt. This counter does not increment when the interface is operating in full-duplex mode.
The symbol-error parameter of an interface operating at 100 Mb/s gives the number of times there is an invalid
data symbol when a valid carrier is present. For an interface operating in half-duplex mode at 1000 Mb/s it is the
number of times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than
slotTime, and during which there is at least one occurrence of an event that causes the PHY to indicate 'Data
reception error' or 'carrier extend error' on the GMII. For an interface operating in full-duplex mode at 1000 Mb/s
it gives the number of times the receiving media is non-idle a carrier event) for a period of time equal to or greater
than minimum frame size, and during which there is at least one occurrence of an event that causes the PHY to
indicate 'Data reception error' on the GMII. The count represented by an instance of this object is incremented at
most once per carrier event, even if multiple symbol errors occur during the carrier event. This count does not
increment if a collision is present.
The sqe-test-error parameter gives a count of times that the SQE TEST ERROR message is generated by the PLS
sublayer for a particular interface. This counter does not increment on interfaces operating at speeds greater than
10 Mb/s, or on interfaces operating in full-duplex mode.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-status [ (stats-index) ]

Command Parameters
Table 82.15-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier

Type

Description

(stats-index)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

index of the interface to an


ethernet-like medium

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2335

82 Transport Status Commands

Table 82.15-2 "SHub Ethernet Dot3 Status Command" Display parameters


Specific Information
name

Type

Description

align-err

Parameter type: <Counter>


- 32 bit counter

fcs-err

Parameter type: <Counter>


- 32 bit counter

single-coll-frame

Parameter type: <Counter>


- 32 bit counter

multiple-coll-frame

Parameter type: <Counter>


- 32 bit counter

deferred-trans

Parameter type: <Counter>


- 32 bit counter

late-coll

Parameter type: <Counter>


- 32 bit counter

excessive-coll

Parameter type: <Counter>


- 32 bit counter

internal-mac-tx-err

Parameter type: <Counter>


- 32 bit counter

frame-too-long

Parameter type: <Counter>


- 32 bit counter

A count of frames received on a


particular interface that has
alignment error status returned by
MAC service to the LLC(or other
MAC user).
This element is always shown.
A count of frames received on a
particular interface that has frame
check error status is returned by
the MAC service to the LLC (or
other MAC user).
This element is always shown.
A
count
of
successfully
transmitted frames on a particular
interface for which transmission
is inhibited by exactly one
collision.
This element is always shown.
A
count
of
successfully
transmitted frames on a particular
interface for which transmission
is inhibited by more than one
collision.
This element is always shown.
A count of frames for which the
first transmission attempt on a
particular interface is delayed
because the medium is busy, this
does not include frames involved
in collisions.
This element is only shown in
detail mode.
The number of times that a
collision is detected on a
particular interface later than one
slotTime into the transmission of
a packet.
This element is only shown in
detail mode.
A count of frames for which
transmission on a particular
interface fails due to excessive
collisions.
This element is only shown in
detail mode.
A count of frames for which
transmission on a particular
interface fails due to an internal
MAC sublayer transmit error.
This element is only shown in
detail mode.
A count of frames received on a
particular interface that exceed
the maximum permitted frame

2336

Released

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

internal-mac-rx-err

Parameter type: <Counter>


- 32 bit counter

duplex-status

Parameter type: <Ether::Dot3DuplexStatus>


( unknown
| half-duplex
| full-duplex )
Possible values:
- unknown : Unknown type
- half-duplex : half duples mode
- full-duplex : full duplex mode
Parameter type: <Counter>
- 32 bit counter

carrier-sense-err

ether-chipset

Parameter type: <SymbolicObject>


- an object identifier

sym-err

Parameter type: <Counter>


- 32 bit counter

sqe-test-err

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
size.
This element is only shown in
detail mode.
A count of frames for which
reception on a particular interface
fails due to an internal MAC
sublayer receive error.
This element is only shown in
detail mode.
specifies the mode of operation
of the MAC.
This element is only shown in
detail mode.

The number of times that the


carrier sense condition was lost
or
never
asserted
when
attempting to transmit a frame on
a particular interface.
This element is only shown in
detail mode.
Identifies the chipset used to
realize the interface. Ethernet-like
interfaces are typically built out
of several different chips.
This element is only shown in
detail mode.
The number of times there was an
invalid data symbol.
This element is always shown.
A count of times that the SQE
test error message is generated by
the PLS sublayer for a particular
interface.
This element is only shown in
detail mode.

Released

2337

82 Transport Status Commands

82.16 SHub L2 Filter Status Command


Command Description
This command displays the L2 filter information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show transport shub mac [ (index-num) [ port <Shub::InDataPort> ] ]

Command Parameters
Table 82.16-1 "SHub L2 Filter Status Command" Resource Parameters
Resource Identifier

Type

Description

(index-num)

Format:
- Filter rule number
- range: [1...65535]
Parameter type: <Shub::InDataPort>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| all
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- lt : line board
- network : network port
- all : apply to all ports
- nt : active nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>

L2 Filter rule number

port

2338

Released

Specifies the complete set of


ports over which if the packet
arrives the filter rule will be
applicable. If the incoming port
list is '0', the filter rule is
applicable for all the incoming
ports.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

Resource Identifier

Type

Description

- the faceplate port number

Command Output
Table 82.16-2 "SHub L2 Filter Status Command" Display parameters
Specific Information
name
protocol-type
short name: proto
dst-mac-addr

Type

Description

Parameter type: <Sys::ProtocolType>


- message protocol type
- range: [0,1536...65535]
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

Specifies the non IP protocol type


to be filtered.
This element is always shown.
Specifies the destination MAC
address to be matched with the
packet.
This element is always shown.
Specifies the source MAC
address to be matched with the
packet.
This element is always shown.
Specifies the vlan id to be
filtered.
This element is always shown.
Specifies the action to be taken
on the packet.
This element is always shown.

src-mac-addr

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

vlan-id

Parameter type: <Sys::FilterVlanId>


- vlan id
- range: [0...4094]
Parameter type: <Sys::L2Action>
( ( action-allow | allow )
| ( action-drop | drop ) )
Possible values:
- action-allow : the packet will be forwarded
- allow : the packet will be forwarded
- action-drop : the packet will be discarded
- drop : the packet will be discarded
Parameter type: <CounterWithDefaultValue>
Number of times mac filter is
( ( not-available | na )
matched.
| <CounterWithDefaultValue> )
This element is always shown.
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]

action

match-cnt
short name: cnt

3HH-04416-EBAA-TCZZA 01

Released

2339

82 Transport Status Commands

82.17 SHub Rate Status Command


Command Description
This command displays the SHub rate information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show transport shub rate [ (port) ]

Command Parameters
Table 82.17-1 "SHub Rate Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

port for which the rate parameters


are displayed

Command Output
Table 82.17-2 "SHub Rate Status Command" Display parameters
Specific Information
name
dlf-limit

2340

Released

Type

Description

Parameter type: <Sys::DlfStatus>


( lookup-enabled
| lookup-disabled )
Possible values:
- lookup-enabled : enable this status
- lookup-disabled : disable this status

Specifies destination lookup


failure
packet
transmission
control over the interface is
enabled or not.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

Type

Description

bcast-limit

Parameter type: <Sys::BcastStatus>


( bcast-pkt-enabled
| bcast-pkt-disabled )
Possible values:
- bcast-pkt-enabled : enable this status
- bcast-pkt-disabled : disable this status
Parameter type: <Sys::McastStatus>
( mcast-pkt-enabled
| mcast-pkt-disabled )
Possible values:
- mcast-pkt-enabled : enable this status
- mcast-pkt-disabled : disable this status
Parameter type: <Sys::RateCtrlLimit>
- max nbr of packets transmitted on this interface
- range: [0...33554431]

Specifies
broadcast
packet
transmission control over the
interface is enabled or not.
This element is always shown.

mcast-limit

max-nbr-pkts

validity

3HH-04416-EBAA-TCZZA 01

Parameter type: <Sys::RateCtrlStatus>


( valid
| invalid )
Possible values:
- valid : status is valid
- invalid : status is invalid

Specifies
multicast
packet
transmission control over the
interface is enabled or not.
This element is always shown.
Specifies the maximum number
of packets that can be transmitted
over this interface.
This element is always shown.
Specifies whether this entry is
valid or not.
This element is always shown.

Released

2341

82 Transport Status Commands

82.18 SFP status commands


Command Description
Obsolete command, replaced by show ethernet sfp.
This command displays the Ethernet SFP parameters

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ether-ifsfplt [ (if-index) [ index <Transport::Index> ] ]
Obsolete command, replaced by show ethernet sfp.

Command Parameters
Table 82.18-1 "SFP status commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the sfp
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Transport::Index>
identify sfp, among others
Format:
connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]

index

Description

Command Output
Table 82.18-2 "SFP status commands" Display parameters
Specific Information
name
sfp-status

2342

Released

Type

Description

Parameter type: <Transport::SFPstatus>


( operational-up
| interface-down

identifies the status of the sfp


This element is always shown.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

sfp-inventory

3HH-04416-EBAA-TCZZA 01

Type

Description

| no-alcatel-label
| als
| type-mismatch
| local-power-off
| brother-power-off
| active-power-off )
Possible values:
- operational-up : SFP is operational up
- interface-down : SFP is not plugged in, interface is down
- no-alcatel-label : SFP is plugged in but in power down
because no Alcatel-Lucent label
- als : SFP is plugged in but in power down because of ALS
- type-mismatch : SFP real type mismatch with configured
type
- local-power-off : local SFP power off since temperature
over
- brother-power-off : brother SFP power off since
temperature over
- active-power-off : SFP power down actively by operator
Parameter type: <Transport::SFPinventory>
indicates the information of the
- specification of Sfp inventory.
sfp vendor
- length: 1<=x<=128
This element is only shown in
detail mode.

Released

2343

82 Transport Status Commands

82.19 Interface MAU Status Command


Command Description
Obsolete command, replaced by show ethernet mau.
This command displays the Ethernet MAU parameters.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ether-ifmault [ (if-index) [ index <Transport::Index> ] ]
Obsolete command, replaced by show ethernet mau.

Command Parameters
Table 82.19-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the mau
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Transport::Index>
identify MAU, among others
Format:
connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]

index

Description

Command Output
Table 82.19-2 "Interface MAU Status Command" Display parameters
Specific Information
name
type

2344

Released

Type

Description

Parameter type: <Ether::MAUType>


( 10baset
| 100basetxhd

Specifies the MAU type. If the


MAU type is unknown, then
unknown Mac type will be

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

media-available

3HH-04416-EBAA-TCZZA 01

Type

Description

| 100basetxfd
| 100basefxhd
| 100basefxfd
| 1000basexhd
| 1000basexfd
| 1000baselxhd
| 1000baselxfd
| 1000basesxhd
| 1000basesxfd
| 1000basethd
| 1000basetfd
| 10gbaser
| 10gbaseer
| 10gbaselr
| 100basebx10d
| 100basebx10u
| 100baselx10
| 1000basebx10d
| 1000basebx10u
| 1000baselx10
| unknown )
Possible values:
- 10baset : UTP 10M
- 100basetxhd : UTP 100M half duplex
- 100basetxfd : UTP 100M full duplex
- 100basefxhd : X fiber over PMT half duplex
- 100basefxfd : X fiber over PMT full duplex
- 1000basexhd : PCS/PMA,unknown PMD, half duplex
- 1000basexfd : PCS/PMA,unknown PMD, full duplex
- 1000baselxhd : fiber over long-wavelength laser half
duplex
- 1000baselxfd : fiber over long-wavelength laser full duplex
- 1000basesxhd : fiber over short-wavelength laser half
duplex
- 1000basesxfd : fiber over short-wavelength laser full
duplex
- 1000basethd : UTP 1G half duplex
- 1000basetfd : UTP 1G full duplex
- 10gbaser : fiber 1OG ethernet
- 10gbaseer : fiber 1OG ethernet extended reach, 30km
- 10gbaselr : fiber 1OG ethernet long reach, 10km
- 100basebx10d : one single-mode fiber OLT long
wavelength, 10km, 100 base
- 100basebx10u : one single-mode fiber ONU, long
wavelength, 10km, 100 base
- 100baselx10 : two single-mode fibers over long
wavelength, 10km, 100 base
- 1000basebx10d : one single-mode fiber OLT over long
wavelength, 10km, 1000 base
- 1000basebx10u : one single-mode fiber ONU over long
wavelength, 10km, 1000 base
- 1000baselx10 : two single-mode fibers over long
wavelength, 10km, 1000 base
- unknown : unknown type
Parameter type: <Transport::MauAvailable>
( other
| unknown

returned. If the MAU is a link or


fiber type then media-available is
equivalent to the link test fail
state/low light function. For an
AUI or a coax (including
broadband) MAU this indicates
whether or not loopback is
detected on the DI circuit. The
value of this attribute persists
between packets for MAU types
AUI, 10BASE5, 10BASE2,
10BROAD36, and 10BASE-FP.
This element is always shown.

Specifies whether the media is


availble for the MAU or not.
This element is always shown.

Released

2345

82 Transport Status Commands

name

Type
| available
| not-available
| remote-fault
| invalid-signal
| remote-jabber
| remote-link-loss
| remote-test
| off-line
| auto-neg-error )
Possible values:
- other : MAU in other state
- unknown : MAU's true state is unknown
- available :
- not-available : MAU is fully functional
- remote-fault : power down
- invalid-signal : reset the MAU
- remote-jabber : power down
- remote-link-loss : power down
- remote-test : power down
- off-line : power down
- auto-neg-error : power down
Parameter type: <Transport::MauJabber>
( other
| unknown
| no-jabber
| jabbering )
Possible values:
- other : if not in any state
- unknown : MAU's true state is unknown
- no-jabber : MAU not jabbering
- jabbering : MAU is jabbering
Parameter type: <Ether::B100BaseFXFD>
( yes
| no )
Possible values:
- yes : 100basefxfd supported
- no : 100basefxfd not supported
Parameter type: <Ether::B100BaseLX10>
( yes
| no )
Possible values:
- yes : 100baselx10 supported
- no : 100baselx10 not supported
Parameter type: <Ether::B100BaseBX10D>
( yes
| no )
Possible values:
- yes : 100basebx10d supported
- no : 100basebx10d not supported
Parameter type: <Ether::B100BaseBX10U>
( yes
| no )
Possible values:
- yes : 100basebx10u supported
- no : 100basebx10u supported
Parameter type: <Ether::B100BaseTXFD>
( yes

jabber-state

b100basefxfd

b100baselx10

b100basebx10d

b100basebx10u

b100basetxfd

2346

Released

Description

The
jabber-state
indicates
whether this entity is jabbering,
not jabbering, unknown or other
state.
This element is always shown.

X fiber over PMT full duplex


This element is only shown in
detail mode.

two single-mode fibers over long


wavelength, 10km, 100 base
This element is only shown in
detail mode.
one single-mode fiber OLT long
wavelength, 10km, 100 base
This element is only shown in
detail mode.
one single-mode fiber ONU, long
wavelength, 10km, 100 base
This element is only shown in
detail mode.
UTP 100M full duplex
This element is only shown in

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

name

b1000basetfd

b1000basesxfd

b1000baselx10

b1000baselxfd

b1000basebx10u

b1000basebx10d

auto-neg-supported

auto-neg-status

3HH-04416-EBAA-TCZZA 01

Type

Description

| no )
Possible values:
- yes : 100basetxfd supported
- no : 100basetxfd not supported
Parameter type: <Ether::B1000BaseTFD>
( yes
| no )
Possible values:
- yes : 1000basetfd supported
- no : 1000basetfd not supported
Parameter type: <Ether::B1000BaseSXFD>
( yes
| no )
Possible values:
- yes : 1000basesxfd supported
- no : 1000basesxfd not supported
Parameter type: <Ether::B1000BaseLX10>
( yes
| no )
Possible values:
- yes : 1000baselx10 supported
- no : 1000baselx10 not supported
Parameter type: <Ether::B1000BaseLXFD>
( yes
| no )
Possible values:
- yes : 1000baselxfd supported
- no : 1000baselxfd not supported
Parameter type: <Ether::B1000BaseBX10U>
( yes
| no )
Possible values:
- yes : 1000basebx10u supported
- no : 1000basebx10u not supported
Parameter type: <Ether::B1000BaseBX10D>
( yes
| no )
Possible values:
- yes : 1000basebx10d supported
- no : 1000basebx10d not supported
Parameter type: <Ether::TruthValue>
( true
| false )
Possible values:
- true : autonegotiation is supported
- false : autonegotiation is not supported
Parameter type: <Ether::AutoNegStatus>
( other
| configuring
| complete
| disabled
| paralleldetectfail )
Possible values:
- other : unknown auto-negotiation status
- configuring : auto-negotiation still ongoing
- complete : auto-negotiation completed
- disabled : auto-negotiation disabled

detail mode.

UTP 1G full duplex


This element is only shown in
detail mode.

fiber over short-wavelength laser


full duplex
This element is only shown in
detail mode.
two single-mode fibers over long
wavelength, 10km, 1000 base
This element is only shown in
detail mode.
fiber over long-wavelength laser
full duplex
This element is only shown in
detail mode.
one single-mode fiber ONU over
long wavelength, 10km, 1000
base
This element is only shown in
detail mode.
one single-mode fiber OLT over
long wavelength, 10km, 1000
base
This element is only shown in
detail mode.
Specifies
whether
or
not
auto-negotiation is supported on
this MAU.
This element is always shown.
Displays the auto-negotiation
status of this MAU.
This element is always shown.

Released

2347

82 Transport Status Commands

name

Type

cap1000base-xfd

cap1000base-tfd

2348

Description

- paralleldetectfail : parallel detection failed


Parameter type: <Ether::ACAP_1000BaseXFD>
( yes
| no )
Possible values:
- yes : 1000BaseXFD supported
- no : 1000BaseXFD not supported
Parameter type: <Ether::ACAP_1000BaseTFD>
( yes
| no )
Possible values:
- yes : 1000BaseTFD supported
- no : 1000BaseTFD not supported

Released

optical
1G
full
duplex
autonegotiation capable
This element is only shown in
detail mode.
electrical
1G
full
duplex
autonegotiation capable
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

82 Transport Status Commands

82.20 Ethernet Lt Dot3 Status Command


Command Description
Obsolete command, replaced by show ethernet dot3stats.
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The parameter stats-index gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the late collisions object, the excessive collisions object, or the
carrier sense errors object. The precise meaning of the count represented by an instance of this object is
implementation-specific. In particular, an instance of this object may represent a count of transmission errors on a
particular interface that are not otherwise counted.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame toolongs object, the alignment errors object, or the FCS errors
object. The precise meaning of the count represented by an instance of this object is implementation-specific. In
particular, an instance of this object may represent a count of receive errors on a particular interface that are not
otherwise counted.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ether-dot3lt [ (stats-index) ]
Obsolete command, replaced by show ethernet dot3stats.

Command Parameters
Table 82.20-1 "Ethernet Lt Dot3 Status Command" Resource Parameters
Resource Identifier

Type

(stats-index)

Format:
index of the interface to an
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / ethernet-like medium

3HH-04416-EBAA-TCZZA 01

Description

Released

2349

82 Transport Status Commands

Resource Identifier

Type

Description

<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Command Output
Table 82.20-2 "Ethernet Lt Dot3 Status Command" Display parameters
Specific Information
name

Type

Description

align-err

Parameter type: <Counter>


- 32 bit counter

fcs-err

Parameter type: <Counter>


- 32 bit counter

internal-mac-tx-err

Parameter type: <Counter>


- 32 bit counter

internal-mac-rx-err

Parameter type: <Counter>


- 32 bit counter

A count of frames received on a


particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
A count of frames received on a
particular interface that are not an
integral number of octets in
length and do not pass the FCS
check.
This element is always shown.
A count of frames for which
transmission on a particular
interface fails due to an internal
MAC sublayer transmit error.
This element is only shown in
detail mode.
A count of frames for which
reception on a particular interface
fails due to an internal MAC
sublayer receive error.
This element is only shown in
detail mode.

2350

Released

3HH-04416-EBAA-TCZZA

01

83- Efm Oam Status Commands

83.1 Efm Oam Status Command Tree


83.2 Efm Oam Mac Statistics Command
83.3 Efm Oam Pme Statistics Command
83.4 Efm Oam Local Information Status Command
83.5 Efm Oam Peer Information Status Command
83.6 Efm Oam statistics Status Command
83.7 Efm Oam loopback Status Command
83.8 Efm Oam Internal Traffic generator Status Command

3HH-04416-EBAA-TCZZA 01

83-2352
83-2353
83-2356
83-2358
83-2360
83-2362
83-2364
83-2366

Released

2351

83 Efm Oam Status Commands

83.1 Efm Oam Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Efm Oam Status Commands".

Command Tree
----show
----efm-oam
----mac-stats
- (interface)
----pme-stats
- (group)
----local-oam-info
- (interface)
----peer-oam-info
- (interface)
----oam-stats
- (interface)
----loopback-info
- (interface)
----int-traff-gen
- (interface)

2352

Released

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

83.2 Efm Oam Mac Statistics Command


Command Description
This command triggers a request to retrieve MAC information from the CPE and displays the result if and when
available.
The output of this command is always in detailed format.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam mac-stats [ (interface) ]

Command Parameters
Table 83.2-1 "Efm Oam Mac Statistics Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.2-2 "Efm Oam Mac Statistics Command" Display parameters
Specific Information
name
frames-tx-ok

frames-rx-ok

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Ether::FramesTxOkCounter>


( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::FramesRxOkCounter>

the number of frames that are


successfully transmitted (by
CPE).
This element is only shown in
detail mode.
the number of frames that are

Released

2353

83 Efm Oam Status Commands

name

Type

Description
successfully received (by CPE).
This element is only shown in
detail mode.

fcs-errors

( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::FcsErrorsCounter>
( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter

alignment-errors

Parameter type: <Ether::AlignmentErrorsCounter>


( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter

frames-lost-mac-tx

Parameter type: <Ether::FramesLostMacTxCounter>


( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter

frames-lost-mac-rx

Parameter type: <Ether::FramesLostMacRxCounter>


( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::McastFramesRxOkCounter>
( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::BcastFramesRxOkCounter>
( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::InRangeLenErrCounter>
( not-available
| <Counter> )
Possible values:

mcast-frames-rx-ok

bcast-frames-rx-ok

in-range-len-err

2354

Released

the number of receive frames (in


CPE) that are an integral number
of octets in length and do not
pass the FCS check. This does
not include frames with frame
fragment
error.
The
ReceiveStatus is reported as
frameCheckError
This element is only shown in
detail mode.
the number of frames (in CPE)
that are not an integral number of
octets in length and do not pass
the
FCS
check.
The
ReceiveStatus is reported as
alignmentError.
This element is only shown in
detail mode.
the number of frames (in CPE)
that
would
otherwise
be
transmitted by the station, but
could not be sent due to an
internal MAC sublayer transmit
error.
This element is only shown in
detail mode.
the number of frames (in CPE)
that would otherwise be received
by the station, but could not be
accepted due to an internal MAC
sublayer receive error.
This element is only shown in
detail mode.
the number of frames that are
successfully received (by CPE)
and are directed to an active
nonbroadcast group address.
This element is only shown in
detail mode.
the number of frames that are
successfully received (by CPE)
and are directed to the broadcast
group address.
This element is only shown in
detail mode.
the number of frames that are
successfully received (by CPE)
and are directed to the broadcast
group address. This does not

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

len-out-of-range

frame-too-long-err

3HH-04416-EBAA-TCZZA 01

Type

Description

- not-available : counter not available


Field type <Counter>
- 32 bit counter

include frames received with


frame-too-long, FCS, length or
alignment errors, or frames lost
due to internal MAC sublayer
error.
This element is only shown in
detail mode.
the number of frames (in CPE)
with a length field value greater
than the maximum allowed LLC
data size.
This element is only shown in
detail mode.

Parameter type: <Ether::LenOutOfRangeCounter>


( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::FrameTooLongErrorsCounter>
( not-available
| <Counter> )
Possible values:
- not-available : counter not available
Field type <Counter>
- 32 bit counter

the number of of frames received


(by CPE) that exceed the
maximum permitted frame size.
This element is only shown in
detail mode.

Released

2355

83 Efm Oam Status Commands

83.3 Efm Oam Pme Statistics Command


Command Description
This command triggers a request to retrieve PME information from the CPE and displays the result if and when
available. This commands allows retrieval of PME information for an individual dsl link or for all links in an EFM
bonding group.
The output of this command is always in detailed format.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam pme-stats [ (group) ]

Command Parameters
Table 83.3-1 "Efm Oam Pme Statistics Command" Resource Parameters
Resource Identifier

Type

(group)

Format:
identification of the EFM or
( link : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / XDSL port
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Possible values:
- link : xdsl-line
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.3-2 "Efm Oam Pme Statistics Command" Display parameters
Specific Information
name
link

2356

Type

Description

Parameter type: <Itf::LinkPmeEthernetIndex>


identification of the xdsl port
( xdsl : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId>
detail mode.

Released

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

tc-cod-violations

fec-corrected-blk

fec-uncorrect-blk

tc-crc-errors

3HH-04416-EBAA-TCZZA 01

Type

Description

| eth : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PortId> )
Possible values:
- xdsl : xdsl-line
- eth : eth-line
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ether::CodingViolationsCounter>
a
number
of
64/65-octet
( not-available
encapsulation error (in CPE).
| <Counter> )
This element is only shown in
Possible values:
detail mode.
- not-available : counter not available
Field type <Counter>
- 32 bit counter
Parameter type: <Ether::FecCorrectedBlkCounter>
For a 10PASS-TS PME, a
( not-available
number of corrected FEC blocks
| <Counter> )
(in CPE). This counter will not
Possible values:
increment for other PHY types.
- not-available : counter not available
This element is only shown in
Field type <Counter>
detail mode.
- 32 bit counter
Parameter type: <Ether::FecUncorrectBlkCounter>
For a 10PASS-TS PME, a
( not-available
number of uncorrectable FEC
| <Counter> )
blocks (in CPE). This counter
Possible values:
will not increment for other PME
- not-available : counter not available
types.
Field type <Counter>
This element is only shown in
- 32 bit counter
detail mode.
Parameter type: <Ether::CrcErrorsCounter>
number of TC-CRC errors
( not-available
recorded on the CPE.
| <Counter> )
This element is only shown in
Possible values:
detail mode.
- not-available : counter not available
Field type <Counter>
- 32 bit counter

Released

2357

83 Efm Oam Status Commands

83.4 Efm Oam Local Information Status Command


Command Description
This command displays the local EFM OAM data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam local-oam-info [ (interface) ]

Command Parameters
Table 83.4-1 "Efm Oam Local Information Status Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.4-2 "Efm Oam Local Information Status Command" Display parameters
Specific Information
name
oper-status

2358

Released

Type

Description

Parameter type: <Ether::OperStatus>


( disabled
| link-fault
| passive-wait
| active-snd-local
| snd-local-rem
| snd-local-rem-ok
| peer-local-rej
| peer-remote-rej
| operational )
Possible values:

operational status of the OAM


entity
This element is always shown.

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

max-oam-pdu-size
short name: max-pdu/size
config-revision
short name: cfg/rev

Type
- disabled : efm oam not enabled
- link-fault : interface operational down
- passive-wait : passive mode
- active-snd-local : send local config
- snd-local-rem : send local remote tlv
- snd-local-rem-ok : remote config ok
- peer-local-rej : remote config locally rejected
- peer-remote-rej : local config remotely rejected
- operational : fully operational
Parameter type: <Ether::PduSize>
- an integer value
- unit: bytes
- range: [0,64...1518]
Parameter type: <Ether::ConfigRevision>
- an unsigned short value
- range: [0...65535]

version
short name: vers

Parameter type: <Ether::Version>


- the version of the local OAM entity

support-unidirect
short name: support/uni

Parameter type: <Ether::unidirection>


( yes
| no )
Possible values:
- yes : unidirection supported
- no : unidirection not supported
Parameter type: <Ether::loopback>
( yes
| no )
Possible values:
- yes : loopback supported
- no : loopback not supported
Parameter type: <Ether::event>
( yes
| no )
Possible values:
- yes : event supported
- no : event not supported
Parameter type: <Ether::variable>
( yes
| no )
Possible values:
- yes : variable functions supported
- no : variable functions supported

support-loopback
short name: support/lpbck

support-event
short name: support/evnt

support-variable
short name: support/var

3HH-04416-EBAA-TCZZA 01

Description

the maximum size of the


OAMPDU supported by the CPE.
This element is always shown.
the configuration revision of the
OAM peer as reflected in the
latest OAMPDU.
This element is always shown.
the version of the local OAM
entity
This element is always shown.
unidirection support function
This element is always shown.

loopback support function


This element is always shown.

event support function


This element is always shown.

variable support function


This element is always shown.

Released

2359

83 Efm Oam Status Commands

83.5 Efm Oam Peer Information Status Command


Command Description
This command displays the peer (CPE) EFM OAM configuration data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam peer-oam-info [ (interface) ]

Command Parameters
Table 83.5-1 "Efm Oam Peer Information Status Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.5-2 "Efm Oam Peer Information Status Command" Display parameters
Specific Information
name
mac-address
vendor-oui
short name: vendor/oui
vendor-info
short name: vendor/info

2360

Released

Type

Description

Parameter type: <Ether::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Ether::VendorOui>
- an octet string bitmask
- length: 3
Parameter type: <Ether::VendorInfo>
<Ether::PrintableVendorInfo>
Field type <Ether::PrintableVendorInfo>
- description to help the operator to identify the object

the mac address of the peer OAM


entity.
This element is always shown.
The oui of the CPE.
This element is always shown.
the vendor info of the CPE.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name
mode

max-oam-pdu-size
short name: max-pdu/size
config-revision
short name: cfg/rev
support-unidirect
short name: support/uni

support-loopback
short name: support/lpbck

support-event
short name: support/evnt

support-variable
short name: support/var

3HH-04416-EBAA-TCZZA 01

Type
- length: 4
Parameter type: <Ether::Mode>
( ( passive | pas )
| ( active | act )
| ( unknown | unkn ) )
Possible values:
- passive : passive mode
- pas : passive mode
- active : active mode
- act : active mode
- unknown : unknown mode
- unkn : unknown mode
Parameter type: <Ether::PduSize>
- an integer value
- unit: bytes
- range: [0,64...1518]
Parameter type: <Ether::ConfigRevision>
- an unsigned short value
- range: [0...65535]
Parameter type: <Ether::unidirection>
( yes
| no )
Possible values:
- yes : unidirection supported
- no : unidirection not supported
Parameter type: <Ether::loopback>
( yes
| no )
Possible values:
- yes : loopback supported
- no : loopback not supported
Parameter type: <Ether::event>
( yes
| no )
Possible values:
- yes : event supported
- no : event not supported
Parameter type: <Ether::variable>
( yes
| no )
Possible values:
- yes : variable functions supported
- no : variable functions supported

Description
the mode of the OAM peer as
reflected in the latest information
OAMPDU received with a local
information tlv.
This element is always shown.

the maximum size of the


OAMPDU supported by the CPE.
This element is always shown.
the configuration revision of the
OAM peer as reflected in the
latest OAMPDU.
This element is always shown.
unidirection support function
This element is always shown.

loopback support function


This element is always shown.

event support function


This element is always shown.

variable support function


This element is always shown.

Released

2361

83 Efm Oam Status Commands

83.6 Efm Oam statistics Status Command


Command Description
This command displays the EFM OAM statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam oam-stats [ (interface) ]

Command Parameters
Table 83.6-1 "Efm Oam statistics Status Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.6-2 "Efm Oam statistics Status Command" Display parameters
Specific Information
name

Type

information-tx
Parameter type: <Counter>
short name: information/tx - 32 bit counter
information-rx
short name:
information/rx
variable-rqst-tx
short name:
variable/rqst-tx
variable-rsp-rx

2362

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>

Released

Description
number
of
information
OAMPDUs transmitted.
This element is always shown.
number
of
information
OAMPDUs received.
This element is always shown.
number of variable request
OAMPDUs transmitted.
This element is always shown.
number of variable response

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

Type

Description

short name:
variable/rsp-rx
loopback-control-tx
short name:
loopback-ctrl/tx

- 32 bit counter

unsup-codes-rx
short name:
unsup-codes/rx

Parameter type: <Counter>


- 32 bit counter

OAMPDUs received.
This element is always shown.
number of Loopback Control
OAMPDUs transmitted on this
interface.
This element is always shown.
number of OAMPDUs received
with an unsupported op-code.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Parameter type: <Counter>


- 32 bit counter

Released

2363

83 Efm Oam Status Commands

83.7 Efm Oam loopback Status Command


Command Description
This command displays the EFM OAM loopback status.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam loopback-info [ (interface) ]

Command Parameters
Table 83.7-1 "Efm Oam loopback Status Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.7-2 "Efm Oam loopback Status Command" Display parameters
Specific Information
name
loopback-status

2364

Type

Description

Parameter type: <Ether::LoopbackStatus>


loopback status of the OAM
( no-loopback
entity
| initiating-loopback
This element is always shown.
| terminating-loopback
| remote-loopback
| unknown )
Possible values:
- no-loopback : no loopback
- initiating-loopback : remote loopback is initiated
- terminating-loopback : termination of remote loopback
ongoing

Released

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

Type

Description

- remote-loopback : peer device on this interface is in remote


loopback.
- unknown : unknown

3HH-04416-EBAA-TCZZA 01

Released

2365

83 Efm Oam Status Commands

83.8 Efm Oam Internal Traffic generator Status


Command
Command Description
This command displays the status of the internal traffic generator.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show efm-oam int-traff-gen [ (interface) ]

Command Parameters
Table 83.8-1 "Efm Oam Internal Traffic generator Status Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of the EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 83.8-2 "Efm Oam Internal Traffic generator Status Command" Display parameters
Specific Information
name
state

2366

Released

Type

Description

Parameter type: <Ether::TraffGenState>


( active
| not-active )
Possible values:
- active : Internal traffic generator on specified itf is active
- not-active : Internal traffic generator on specified itf is not
active

State of the internal traffic


generator for the specified
interface.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

83 Efm Oam Status Commands

name

Type

Description

data-length

Parameter type: <Ether::TraffGenDataLengthType>


- A value of 1 up to 1500. Indicates length in bytes.
- unit: byte
- range: [1...1500]
Parameter type: <Ether::TraffGenBitRateType>
( 100k
| 1m
| 10m
| 100m
| 1g )
Possible values:
- 100k : bitrate = 100K bit/sec
- 1m : bitrate = 1M bit/sec
- 10m : bitrate = 10M bit/sec
- 100m : bitrate = 100M bit/sec
- 1g : bitrate = 1G bit/sec
Parameter type: <Ether::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

Length of data field, in bytes, of


the generated test traffic.
This element is always shown.

bitrate

smac

dmac

3HH-04416-EBAA-TCZZA 01

Parameter type: <Ether::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

Requested
bitrate
for
the
generated test traffic.
This element is always shown.

Source MAC address of the


generated test traffic.
This element is only shown in
detail mode.
Destination MAC address of the
generated test traffic.
This element is only shown in
detail mode.

Released

2367

84- DHCP Relay Status Commands

84.1 DHCP Relay Status Command Tree


84.2 DHCP Relay Port Statistics
84.3 DHCP Relay Port Statistics Related To Untagged
Frames
84.4 DHCP Relay Port Summary Statistics Related To
Untagged Frames
84.5 DHCP Relay Port Detailed Statistics Related To
Untagged Frames
84.6 DHCP Relay Port Statistics Related To Vlan Ports
84.7 DHCP Relay Port Summary Statistics Related To Vlan
Ports
84.8 DHCP Relay Port Detailed Statistics Related To Vlan
Ports
84.9 DHCP v6 Relay Port Statistics
84.10 DHCP v6 Relay Port Statistics Related To Vlan Ports
84.11 DHCP v6 Relay Port Summary Statistics Related To
Vlan Ports
84.12 DHCP v6 Relay Port Detailed Statistics Related To
Vlan Ports
84.13 SHub DHCP Relay Statistics
84.14 DHCP Relay Session Status Command

2368

Released

84-2369
84-2370
84-2372
84-2374
84-2376
84-2383
84-2385
84-2387
84-2394
84-2396
84-2398
84-2400
84-2404
84-2407

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

84.1 DHCP Relay Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "DHCP Relay Status Commands".

Command Tree
----show
----dhcp-relay
----port-stats
- (port-interface)
----untagged-ip
----summary
----extensive
----vlan
- (subscr-vlan)
----summary
----extensive
----v6-port-stats
- (port-interface)
----vlan
- (subscr-vlan)
----v6summary
----v6extensive
----shub
----vrf-agent-stats
- (vrf)
----session
- (client)
- ip-addr

3HH-04416-EBAA-TCZZA 01

Released

2369

84 DHCP Relay Status Commands

84.2 DHCP Relay Port Statistics


Command Description
This command allows the operator to view the DHCP relay port counters. When this show command is invoked, all
commands in underlying nodes are automatically executed.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats [ (port-interface) ]

Command Parameters
Table 84.2-1 "DHCP Relay Port Statistics" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier

2370

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntId>


- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

3HH-04416-EBAA-TCZZA 01

Released

2371

84 DHCP Relay Status Commands

84.3 DHCP Relay Port Statistics Related To


Untagged Frames
Command Description
This command allows the operator to view the DHCP relay port counters. The command will show all counters
related to untagged frames.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) untagged-ip

Command Parameters
Table 84.3-1 "DHCP Relay Port Statistics Related To Untagged Frames" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

2372

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

3HH-04416-EBAA-TCZZA 01

Released

2373

84 DHCP Relay Status Commands

84.4 DHCP Relay Port Summary Statistics Related


To Untagged Frames
Command Description
This command allows the operator to view the DHCP relay port summary counters. The command will show all
counters related to untagged frames. These summary counters are always available.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) untagged-ip summary

Command Parameters
Table 84.4-1 "DHCP Relay Port Summary Statistics Related To Untagged Frames" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI

2374

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::VciId>


- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 84.4-2 "DHCP Relay Port Summary Statistics Related To Untagged Frames" Display
parameters
Specific Information
name
error-summary

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

show the total of DHCP packets


that have been dropped because
of errors
This element is only shown in
detail mode.

Released

2375

84 DHCP Relay Status Commands

84.5 DHCP Relay Port Detailed Statistics Related


To Untagged Frames
Command Description
This command allows the operator to view the DHCP relay port counters. The command will show all counters
related to untagged frames.
The detailed counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) untagged-ip extensive

Command Parameters
Table 84.5-1 "DHCP Relay Port Detailed Statistics Related To Untagged Frames" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

2376

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::VpiId>


- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 84.5-2 "DHCP Relay Port Detailed Statistics Related To Untagged Frames" Display
parameters
Specific Information
name
internal-ctxt-err

up-corrupt-pkt

up-invalid-l2-proto

up-unsupp-l3-proto

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <CounterWithDefaultValue>


( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>

show the number of ARP packets


dropped due to internal context
errors
This element is only shown in
detail mode.

show the number of upstream


DHCP packets classified as
corrupt and discarded
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
invalid
Layer
2
protocol
configuration
This element is only shown in
detail mode.

show the number of upstream

Released

2377

84 DHCP Relay Status Commands

name

up-large-pkt-discard

up-frag-pkt-discard

up-malformed-option

up-invalid-hops

up-invalid-op-code

2378

Released

Type

Description

( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>

DHCP packets discarded due to


unsupported protocol version
This element is only shown in
detail mode.

show the humber of upstream


DHCP packets discarded due to
packet size exceeds the MTU
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
received fragmented packet
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
malformed 'options' field
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
inconsistency between 'giaddr'
field and 'hops' field
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
invalid opcode in packet header
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name
up-not-allowed-pkt

up-opt82-too-long

up-not-trusted

up-invalid-chaddr

up-dup-chaddr

up-invalid-giaddr

3HH-04416-EBAA-TCZZA 01

Type

Description

- Number of times mac filter is matched


- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type

show the number of upstream


DHCP packets discarded due to
invalid packet type
This element is only shown in
detail mode.

show the number of received


packets that exceed the MTU
after Option 82 insertion
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
unexpected presence of Option
82
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
client invalid hardware address
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
duplicate clietn hardware address
ico snooping
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
IP anti-spoofing failure for
'giaddr' field
This element is only shown in

Released

2379

84 DHCP Relay Status Commands

name

up-invalid-ciaddr

up-no-free-context

up-no-assoc-context

up-relay-agent-unsupp

up-no-broadcast-vlan

dn-not-trusted

2380

Released

Type

Description

of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )

detail mode.

show the number of upstream


DHCP packets discarded due to
IP anti-spoofing failure for
'ciaddr' field
This element is only shown in
detail mode.

show number of upstream DHCP


packets discarded due to free
session context is unavailable ico
snooping
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded for
which no session context could
be associated ico snooping
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
already been relayed by another
relay agent
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
no Upstream broadcast Vlan
configured
This element is only shown in
detail mode.

show the number of downstream


DHCP packets discarded due to

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name

dn-invalid-yiaddr

dn-invalid-server-resp

dn-no-free-context

option82-inserted

option82-removed

3HH-04416-EBAA-TCZZA 01

Type

Description

| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched

unexpected presence of Option


82
This element is only shown in
detail mode.

show the number of downstream


DHCP packets discarded due to
invalid client IP address ico
snooping
This element is only shown in
detail mode.

show the number of downstream


DHCP packets discarded due to
invalid DHCP Server response
received ico snooping
This element is only shown in
detail mode.

show number of downstream


DHCP packets discarded due to
free
session
context
is
unavailable ico snooping
This element is only shown in
detail mode.

show the number of all DHCP


packets received in the upstream
and successfully inserted with
option 82
This element is only shown in
detail mode.

show the number of all DHCP


packets
received
in
the
downstream from which option
82 has been successfully removed
This element is only shown in
detail mode.

Released

2381

84 DHCP Relay Status Commands

name

Type

active-snooped-session

total-snooped-session

2382

Released

Description

- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]

show the number of all the DHCP


sessions
that
have
been
established and are currently
being snooped
This element is only shown in
detail mode.

show the number of all the DHCP


sessions
that
have
been
established and are being or have
been snooped
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

84.6 DHCP Relay Port Statistics Related To Vlan


Ports
Command Description
This command allows the operator to view the DHCP relay port counters. The command will show all counters
related to the specified vlan tagged frames.
Both the summary and detailed counters are shown through the underlying nodes.
The detailed counters are only available when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) vlan [ (subscr-vlan) ]

Command Parameters
Table 84.6-1 "DHCP Relay Port Statistics Related To Vlan Ports" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

3HH-04416-EBAA-TCZZA 01

Description
user port interface
/
/
/
/
/
/
/

Released

2383

84 DHCP Relay Status Commands

Resource Identifier

Description

Field type <Eqpt::VpiId>


- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

2384

Type

Released

the subscriber vlan id

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

84.7 DHCP Relay Port Summary Statistics Related


To Vlan Ports
Command Description
This command allows the operator to view the DHCP relay port counters. The command will show all counters
related to the specified vlan tagged frames. These summary counters are always available.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) vlan (subscr-vlan) summary

Command Parameters
Table 84.7-1 "DHCP Relay Port Summary Statistics Related To Vlan Ports" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description
user port interface
/
/
/
/
/
/
/

Released

2385

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

the subscriber vlan id

Command Output
Table 84.7-2 "DHCP Relay Port Summary Statistics Related To Vlan Ports" Display parameters
Specific Information
name

Type

Description

error-summary

Parameter type: <Counter>


- 32 bit counter

total-in

Parameter type: <Counter>


- 32 bit counter

total-out

Parameter type: <Counter>


- 32 bit counter

show the total of DHCP packets


that have been dropped because
of errors
This element is only shown in
detail mode.
show count of all DHCP packets
that have been received
This element is only shown in
detail mode.
show count of all DHCP packets
that have been sent
This element is only shown in
detail mode.

2386

Released

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

84.8 DHCP Relay Port Detailed Statistics Related


To Vlan Ports
Command Description
This command allows the operator to view the DHCP relay port counters. The command will show all counters
related to the specified vlan tagged frames.
The detailed counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port-stats (port-interface) vlan (subscr-vlan) extensive

Command Parameters
Table 84.8-1 "DHCP Relay Port Detailed Statistics Related To Vlan Ports" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>

3HH-04416-EBAA-TCZZA 01

Description
user port interface
/
/
/
/
/
/
/

Released

2387

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(subscr-vlan)

the subscriber vlan id

Command Output
Table 84.8-2 "DHCP Relay Port Detailed Statistics Related To Vlan Ports" Display parameters
Specific Information
name
internal-ctxt-err

up-corrupt-pkt

2388

Released

Type

Description

Parameter type: <CounterWithDefaultValue>


( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched

show the number of ARP packets


dropped due to internal context
errors
This element is only shown in
detail mode.

show the number of upstream


DHCP packets classified as
corrupt and discarded
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name
up-invalid-l2-proto

up-unsupp-l3-proto

up-large-pkt-discard

up-frag-pkt-discard

up-malformed-option

up-invalid-hops

3HH-04416-EBAA-TCZZA 01

Type

Description

- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board

show the number of upstream


DHCP packets discarded due to
invalid
Layer
2
protocol
configuration
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
unsupported protocol version
This element is only shown in
detail mode.

show the humber of upstream


DHCP packets discarded due to
packet size exceeds the MTU
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
received fragmented packet
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
malformed 'options' field
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
inconsistency between 'giaddr'
field and 'hops' field
This element is only shown in
detail mode.

Released

2389

84 DHCP Relay Status Commands

name

Type

up-invalid-op-code

up-not-allowed-pkt

up-opt82-too-long

up-not-trusted

up-invalid-chaddr

up-dup-chaddr

2390

Description

- na : counter value is not applicable for this type of board


Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )

Released

show the number of upstream


DHCP packets discarded due to
invalid opcode in packet header
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
invalid packet type
This element is only shown in
detail mode.

show the number of received


packets that exceed the MTU
after Option 82 insertion
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
unexpected presence of Option
82
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
client invalid hardware address
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
duplicate client hardware address

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name

up-invalid-giaddr

up-invalid-ciaddr

up-no-free-context

up-no-assoc-context

up-relay-agent-unsupp

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]

This element is only shown in


detail mode.

show the number of upstream


DHCP packets discarded due to
IP anti-spoofing failure for
'giaddr' field
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
IP anti-spoofing failure for
'ciaddr' field
This element is only shown in
detail mode.

show number of upstream DHCP


packets discarded due to free
session context is unavailable
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded for
which no session context could
be associated
This element is only shown in
detail mode.

show the number of upstream


DHCP packets discarded due to
already been relayed by another
relay agent
This element is only shown in
detail mode.

Released

2391

84 DHCP Relay Status Commands

name

Type

Description

up-no-broadcast-vlan

Parameter type: <CounterWithDefaultValue>


( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board

show the number of upstream


DHCP packets discarded due to
no Upstream broadcast Vlan
configured
This element is only shown in
detail mode.

dn-not-trusted

dn-invalid-yiaddr

dn-invalid-server-resp

dn-no-free-context

option82-inserted

2392

Released

show the number of downstream


DHCP packets discarded due to
unexpected presence of Option
82
This element is only shown in
detail mode.

show the number of downstream


DHCP packets discarded due to
invalid client IP address
This element is only shown in
detail mode.

show the number of downstream


DHCP packets discarded due to
invalid DHCP Server response
received
This element is only shown in
detail mode.

show number of downstream


DHCP packets discarded due to
free
session
context
is
unavailable
This element is only shown in
detail mode.

show the number of all DHCP


packets received in the upstream
and successfully inserted with
option 82
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name

option82-removed

active-snooped-session

total-snooped-session

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <CounterWithDefaultValue>


- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]

show the number of all DHCP


packets
received
in
the
downstream from which option
82 has been successfully removed
This element is only shown in
detail mode.

show the number of all the DHCP


sessions
that
have
been
established and are currently
being snooped
This element is only shown in
detail mode.

show the number of all the DHCP


sessions
that
have
been
established and are being or have
been snooped
This element is only shown in
detail mode.

Released

2393

84 DHCP Relay Status Commands

84.9 DHCP v6 Relay Port Statistics


Command Description
This command allows the operator to view the DHCP v6 relay port counters. When this show command is invoked,
all commands in underlying nodes are automatically executed.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay v6-port-stats [ (port-interface) ]

Command Parameters
Table 84.9-1 "DHCP v6 Relay Port Statistics" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier

2394

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntId>


- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

3HH-04416-EBAA-TCZZA 01

Released

2395

84 DHCP Relay Status Commands

84.10 DHCP v6 Relay Port Statistics Related To


Vlan Ports
Command Description
This command allows the operator to view the DHCP v6 relay port counters. The command will show all counters
related to the specified vlan tagged frames.
Both the summary and detailed counters are shown through the underlying nodes.
The detailed counters are only available when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay v6-port-stats (port-interface) vlan [ (subscr-vlan) ]

Command Parameters
Table 84.10-1 "DHCP v6 Relay Port Statistics Related To Vlan Ports" Resource Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

2396

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

(subscr-vlan)

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Eqpt::VpiId>


- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

the subscriber vlan id

Released

2397

84 DHCP Relay Status Commands

84.11 DHCP v6 Relay Port Summary Statistics


Related To Vlan Ports
Command Description
This command allows the operator to view the DHCP v6 relay port counters. The command will show all counters
related to the specified vlan tagged frames. These summary counters are always available.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay v6-port-stats (port-interface) vlan (subscr-vlan) v6summary

Command Parameters
Table 84.11-1 "DHCP v6 Relay Port Summary Statistics Related To Vlan Ports" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI

2398

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

(subscr-vlan)

Type

Description

Field type <Eqpt::VciId>


- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

the subscriber vlan id

Command Output
Table 84.11-2 "DHCP v6 Relay Port Summary Statistics Related To Vlan Ports" Display
parameters
Specific Information
name
dhcpv6-error-summary

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Counter>


- 32 bit counter

show the total of DHCP v6


packets that have been dropped
because of errors
This element is only shown in
detail mode.

Released

2399

84 DHCP Relay Status Commands

84.12 DHCP v6 Relay Port Detailed Statistics


Related To Vlan Ports
Command Description
This command allows the operator to view the DHCP v6 relay port counters. The command will show all counters
related to the specified vlan tagged frames.
The detailed counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay v6-port-stats (port-interface) vlan (subscr-vlan) v6extensive

Command Parameters
Table 84.12-1 "DHCP v6 Relay Port Detailed Statistics Related To Vlan Ports" Resource
Parameters
Resource Identifier

Type

(port-interface)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

2400

Released

Description
user port interface
/
/
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

(subscr-vlan)

Type

Description

Field type <Eqpt::VpiId>


- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

the subscriber vlan id

Command Output
Table 84.12-2 "DHCP v6 Relay Port Detailed Statistics Related To Vlan Ports" Display parameters
Specific Information
name

Type

Description

dhcpv6-up-corrupt-pkt

Parameter type: <Counter>


- 32 bit counter

dhcpv6-up-lg-pkt-discd

Parameter type: <Counter>


- 32 bit counter

dhcpv6-up-not-allowed

Parameter type: <Counter>


- 32 bit counter

dhcpv6-up-untrusted

Parameter type: <Counter>


- 32 bit counter

show the number of upstream


DHCP v6 packets classified as
corrupt and discarded
This element is only shown in
detail mode.
show the number of upstream
DHCPv6 packets discarded due
to packet size exceeds the MTU
This element is only shown in
detail mode.
show the number of upstream
DHCPv6 packets discarded due
to invalid packet type
This element is only shown in
detail mode.
show
the
number
of
Relay-Forward
messages
received from the untrusted client

3HH-04416-EBAA-TCZZA 01

Released

2401

84 DHCP Relay Status Commands

name

Type

dhcpv6-up-opt18-too-lg

Parameter type: <Counter>


- 32 bit counter

dhcpv6-up-opt37-too-lg

Parameter type: <Counter>


- 32 bit counter

dhcpv6-dn-not-allowed

Parameter type: <Counter>


- 32 bit counter

dhcpv6-opt18-inserted

Parameter type: <Counter>


- 32 bit counter

dhcpv6-opt37-inserted

Parameter type: <Counter>


- 32 bit counter

dhcpv6-opt18-removed

Parameter type: <Counter>


- 32 bit counter

dhcpv6-opt37-removed

Parameter type: <Counter>


- 32 bit counter

dhcpv6-dn-corrupt-pkt

Parameter type: <Counter>


- 32 bit counter

dhcpv6dn-no-free-ctxt

Parameter type: <Counter>


- 32 bit counter

dhcpv6-up-opt17-too-lg

Parameter type: <CounterWithDefaultValue>


( ( not-available | na )

2402

Released

Description
port
This element is only shown in
detail mode.
show the number of received
packets that exceed the MTU
after option-18 insertion
This element is only shown in
detail mode.
show the number of received
packets that exceed the MTU
after option-37 insertion
This element is only shown in
detail mode.
show the number of downstream
DHCPv6 packets discarded due
to invalid packet type
This element is only shown in
detail mode.
show the number of all DHCPv6
packets received in the upstream
and successfully inserted with
option-18
This element is only shown in
detail mode.
show the number of all DHCPv6
packets received in the upstream
and successfully inserted with
option-37
This element is only shown in
detail mode.
show the number of all DHCPv6
packets
received
in
the
downstream
from
which
option-18 has been successfully
removed
This element is only shown in
detail mode.
show the number of all DHCPv6
packets
received
in
the
downstream
from
which
option-37 has been successfully
removed
This element is only shown in
detail mode.
show the number of downstream
DHCP v6 packets classified as
corrupt and discarded
This element is only shown in
detail mode.
show the number of DHCPv6
packets which were discarded in
the downstream due to exceed
max dimension
This element is only shown in
detail mode.
show the number of received
packets that exceed the MTU

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name

dhcpv6-opt17-inserted

dhcpv6-opt17-removed

3HH-04416-EBAA-TCZZA 01

Type

Description

| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]
Parameter type: <CounterWithDefaultValue>
( ( not-available | na )
| <CounterWithDefaultValue> )
Possible values:
- not-available : counter value is not applicable for this type
of board
- na : counter value is not applicable for this type of board
Field type <CounterWithDefaultValue>
- Number of times mac filter is matched
- range: [0...4294967294]

after option-17 insertion


This element is only shown in
detail mode.

show the number of all DHCPv6


packets received in the upstream
and successfully inserted with
option-17
This element is only shown in
detail mode.

show the number of all DHCPv6


packets
received
in
the
downstream
from
which
option-17 has been successfully
removed
This element is only shown in
detail mode.

Released

2403

84 DHCP Relay Status Commands

84.13 SHub DHCP Relay Statistics


Command Description
This command displays DHCP relay agent statistics for each VRF in the Shub.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay shub vrf-agent-stats [ (vrf) ]

Command Parameters
Table 84.13-1 "SHub DHCP Relay Statistics" Resource Parameters
Resource Identifier

Type

Description

(vrf)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

vrf for which the agent is running

Command Output
Table 84.13-2 "SHub DHCP Relay Statistics" Display parameters
Specific Information
name

Type

Description

fwd-upstream
short name: fwd/up

Parameter type: <Counter>


- 32 bit counter

fwd-downstream
short name: fwd/down

Parameter type: <Counter>


- 32 bit counter

rx-upstream
short name: rx/up

Parameter type: <Counter>


- 32 bit counter

rx-downstream
short name: rx/down

Parameter type: <Counter>


- 32 bit counter

errors
short name: err

Parameter type: <Counter>


- 32 bit counter

internal-ctxt-err

Parameter type: <Counter>

number of forwarded upstream


dhcp packets
This element is always shown.
number
of
forwarded
downstream dhcp packets
This element is always shown.
number of received upstream
dhcp packets
This element is always shown.
number of received downstream
dhcp packets
This element is always shown.
number
of
dhcp
packets
discarded.
This
counter
summarizes all cases where
packets are dropped.
This element is always shown.
number of packets dropped

2404

Released

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

name

Type

Description

short name: int-ctxt/err

- 32 bit counter

packet-expired
short name: pkt/exp

Parameter type: <Counter>


- 32 bit counter

malformed-packets
short name: pkt/malf

Parameter type: <Counter>


- 32 bit counter

too-many-hops
short name:
too-many/hops

Parameter type: <Counter>


- 32 bit counter

dup-client-hw-addr
short name:
dup-client/hw-addr

Parameter type: <Counter>


- 32 bit counter

no-free-context
short name: no-free/ctxt

Parameter type: <Counter>


- 32 bit counter

upstr-invalid-giaddr
short name: inv-giaddr/up

Parameter type: <Counter>


- 32 bit counter

downstr-invalid-giaddr
short name:
inv-giaddr/down

Parameter type: <Counter>


- 32 bit counter

no-route-to-server
short name:
no-server/route

Parameter type: <Counter>


- 32 bit counter

downstr-no-ctxt-found
short name:
down-no/ctxt-found

Parameter type: <Counter>


- 32 bit counter

because of invalid internal


contexts
This element is only shown in
detail mode.
number of request packets
dropped because the time stamp
in the packet exceeded the
threshold time
This element is only shown in
detail mode.
number of packets dropped
because of packet corruption.
Packet corruption occurs when
the magic cookie verification
fails.
This element is only shown in
detail mode.
number of request packets
dropped because the packet hops
exceeded the maximum number
of hops configured. This check is
only done in case giaddr of
incoming packet is not zero.
This element is only shown in
detail mode.
number of packets dropped
because the client hardware
address is already existing on a
different port.
This element is only shown in
detail mode.
number of packets dropped
because of failure to add a new
context for an incoming packet
This element is only shown in
detail mode.
number of request packets
dropped because the GiAddr
doesnot matches one of the
interfaces' addresses in the VRF
This element is only shown in
detail mode.
number of response packets
dropped because the DHCP reply
does not contain interface address
as GiAddr
This element is only shown in
detail mode.
number of packets dropped
because the route to server cannot
be found
This element is only shown in
detail mode.
number of response packets
dropped because the DHCP reply
does not refer to a valid context.
This element is only shown in

3HH-04416-EBAA-TCZZA 01

Released

2405

84 DHCP Relay Status Commands

name

Type

invalid-packet-type
short name: inv-pkt/type

Parameter type: <Counter>


- 32 bit counter

invalid-hops
short name: inv/hops

Parameter type: <Counter>


- 32 bit counter

invalid-client-hw-addr
short name: inv/ch-addr

Parameter type: <Counter>


- 32 bit counter

interface-down
short name: itf/down

Parameter type: <Counter>


- 32 bit counter

2406

Released

Description
detail mode.
number of response packets
dropped because the DHCP
packet
type
is
not
a
BootReq/BootReply.
This element is only shown in
detail mode.
number of request packets
dropped when the Giaddr equals
zero and received hops count in
the packet is bigger than zero.
This element is only shown in
detail mode.
number of packets dropped
because the 'htype' and 'hlen'
fields of the received packet do
not correspond to Ethernet type
and Ethernet mac length or when
the chaddr field in the packet
equals zero
This element is only shown in
detail mode.
number of requests packets
dropped
because
the
itf
corresponding to GiAddr is
operationally down
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

84.14 DHCP Relay Session Status Command


Command Description
This command displays the dhcp-sessions information.
Note: Once the remaining-lease timer has expired, there will be a delay of 30 seconds for the removal of the
session. Until then, the traffic will be forwarded to the corresponding user interface.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay session [ (client) [ ip-addr <Ip::V4Address> ] ]

Command Parameters
Table 84.14-1 "DHCP Relay Session Status Command" Resource Parameters
Resource Identifier

Type

(client)

Format:
specifies the if-index uniquely
( ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / indentifying each interface
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>

3HH-04416-EBAA-TCZZA 01

Description

Released

2407

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan> )
Possible values:
- ipox : ip line interface
- vlanport : vlan port
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>

2408

Released

3HH-04416-EBAA-TCZZA

01

84 DHCP Relay Status Commands

Resource Identifier

Type

Description

- the ONT identifier


Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip-addr

client ip address assigned by


dhcp server

Command Output
Table 84.14-2 "DHCP Relay Session Status Command" Display parameters
Specific Information
name
subnet
lease-time

Type

Description

Parameter type: <Ip::PrefixLength>


- IP address prefix length
- range: [0...30]
Parameter type: <Ip::LeaseTimeInSec>
- the lease time

the subnet mask of the client ip


address
This element is always shown.
time period for which DHCP
server leases ip address to a client
This element is always shown.
the gateway ip address
This element is only shown in
detail mode.
ip address of dhcp server
This element is only shown in
detail mode.
the forwarder type to which this
session belongs
This element is always shown.

gateway-ip-addr

Parameter type: <Ip::V4Address>


- IPv4-address

dhcp-ip-addr

Parameter type: <Ip::V4Address>


- IPv4-address

forwarder-type

Parameter type: <Dhcp::ForwarderType>


( layer2
| layer3 )
Possible values:
- layer2 : the session belongs to l2forwarder
- layer3 : the session belongs to l3forwarder
Parameter type: <Dhcp::ForwarderId>
( <DHCP::Layer>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex>
| vrf : <Vrf::UnsignedVrfIndex> )
Possible values:
- vrf : vrf identity
- stacked : stacked vlan identity
Field type <DHCP::Layer>
- unstacked vlan identity
- range: [1...4093]

forwarder-id

3HH-04416-EBAA-TCZZA 01

the id of the forwarder to which


this session belongs
This element is always shown.

Released

2409

84 DHCP Relay Status Commands

name

Type

remaining-lease

2410

Description

Field type <Vrf::UnsignedVrfIndex>


- the VRF ID which uniquely identify a VRF
- range: [1...127]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Ip::RemainingLeaseTimeInSec>
( ( session-being-deleted | ses-deleting )
| <Ip::LeaseTimeInSec> )
Possible values:
- session-being-deleted : session being deleted
- ses-deleting : session being deleted
Field type <Ip::LeaseTimeInSec>
- the lease time

Released

remaining time period for which


DHCP server leases ip address to
a client
This element is always shown.

3HH-04416-EBAA-TCZZA

01

85- IPv6 Users Status Commands

85.1 IPv6 Users Status Command Tree


85.2 IPv6 Users Status Command

3HH-04416-EBAA-TCZZA 01

85-2412
85-2413

Released

2411

85 IPv6 Users Status Commands

85.1 IPv6 Users Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IPv6 Users Status Commands".

Command Tree
----show
----ipv6
----users
- (client)
- ip-prefix
- prefix-length

2412

Released

3HH-04416-EBAA-TCZZA

01

85 IPv6 Users Status Commands

85.2 IPv6 Users Status Command


Command Description
This command displays the ipv6 users information.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show ipv6 users [ (client) [ ip-prefix <Ip::V6Prefix> ] [ prefix-length <Ip::V6PrefixLength> ] ]

Command Parameters
Table 85.2-1 "IPv6 Users Status Command" Resource Parameters
Resource Identifier

Type

(client)

Format:
specifies the if-index uniquely
( ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / indentifying each interface
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

2413

85 IPv6 Users Status Commands

Resource Identifier

Type

Description

<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| ipox : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| ipox : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlanport : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan> )
Possible values:
- ipox : ip line interface
- vlanport : vlan port
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:

2414

Released

3HH-04416-EBAA-TCZZA

01

85 IPv6 Users Status Commands

Resource Identifier

ip-prefix
prefix-length

Type

Description

- voip : virtual uni identifier


obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Ip::V6Prefix>
Format:
- IPv6-address
Parameter type: <Ip::V6PrefixLength>
Format:
- length of IPv6-address
- range: [0...128]

client ipv6 prefix assigned by


dhcp server
client ipv6 prefix length

Command Output
Table 85.2-2 "IPv6 Users Status Command" Display parameters
Specific Information
name
forwarder-id

remaining-lease

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Dhcp::ForwarderId>


( <DHCP::Layer>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex>
| vrf : <Vrf::UnsignedVrfIndex> )
Possible values:
- vrf : vrf identity
- stacked : stacked vlan identity
Field type <DHCP::Layer>
- unstacked vlan identity
- range: [1...4093]
Field type <Vrf::UnsignedVrfIndex>
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Ip::LeaseTimeInSec>
- the lease time

the id of the forwarder to which


this session belongs
This element is always shown.

remaining time period for which


DHCP server leases ip address to
a client
This element is always shown.

Released

2415

86- Multicast Status Commands

86.1 Multicast Status Command Tree


86.2 Multicast Active Groups Status Command
86.3 Multicast PON Active Groups Status Command
86.4 Multicast ONT Active Groups Status Command
86.5 Multicast Group Membership Status Command
86.6 Dynamic and Static-Dynamic Multicast VLAN FWD
Port Status Command
86.7 SHub Multicast Status Command

2416

Released

86-2417
86-2418
86-2421
86-2424
86-2427
86-2430
86-2432

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

86.1 Multicast Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Multicast Status Commands".

Command Tree
----show
----mcast
----active-groups
- (port)
- vlan-id
- mcast-grp-addr
- mcast-src-addr
----pon-active-groups
- (pon-idx)
- port
- vlan-id
- mcast-grp-addr
- mcast-src-addr
----ont-active-groups
- (ont-idx)
- port
- vlan-id
- mcast-grp-addr
- mcast-src-addr
----grp-membership
- (mcast-grp-addr)
- vlan-id
- mcast-src-addr
- port
----shub
----igs-vlan-grp
- (vlan-id)
- mcast-addr
- port
----active-streams

3HH-04416-EBAA-TCZZA 01

Released

2417

86 Multicast Status Commands

86.2 Multicast Active Groups Status Command


Command Description
This command shows per user interface the list of active multicast streams.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast active-groups [ (port) [ vlan-id <Vlan::VlanId> ] [ mcast-grp-addr <Igmp::MulticastAddress> ] [
mcast-src-addr <Ip::V4Address> ] ]

Command Parameters
Table 86.2-1 "Multicast Active Groups Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>

2418

Released

Description

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

Resource Identifier

Type

Description

| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

3HH-04416-EBAA-TCZZA 01

Released

2419

86 Multicast Status Commands

Resource Identifier

Type

Description

vlan-id

Parameter type: <Vlan::VlanId>


Format:
- vlan id
- range: [1...4093]
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

vlan Id

mcast-grp-addr
mcast-src-addr

class D address of the multicast


stream
the multicast
address

group

source

Command Output
Table 86.2-2 "Multicast Active Groups Status Command" Display parameters
Specific Information
name
state

curr-previewed-nbr
short name: prev-nbr
status

2420

Type

Description

Parameter type: <Igmp::ActualState>


( full-view
| pre-view
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
Parameter type: <Igmp::PreviewNumber>
- number of pre-view sessions already been viewed
- range: [0...1000]

The actual state of the multicast


stream
This element is always shown.

Parameter type: <Igmp::McastStatus>


( static
| static-dynamic
| dynamic )
Possible values:
- static : static entry
- static-dynamic : static dynamic entry
- dynamic : dynamic entry

Released

number of pre-view sessions that


have already been viewed
This element is only shown in
detail mode.
the current type of multicast
group
This element is always shown.

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

86.3 Multicast PON Active Groups Status


Command
Command Description
This command shows per user interface on a particular PON the list of active multicast streams.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast pon-active-groups [ (pon-idx) [ port <Igmp::IgmpIfIndex> ] [ vlan-id <Vlan::VlanId> ] [
mcast-grp-addr <Igmp::MulticastAddress> ] [ mcast-src-addr <Ip::V4Address> ] ]

Command Parameters
Table 86.3-1 "Multicast PON Active Groups Status Command" Resource Parameters
Resource Identifier

Type

(pon-idx)

Format:
identification of the PON
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Parameter type: <Igmp::IgmpIfIndex>
identification of the vlanport
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>

port

3HH-04416-EBAA-TCZZA 01

Description

Released

2421

86 Multicast Status Commands

Resource Identifier

Type

Description

| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni

2422

Released

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

Resource Identifier

vlan-id

mcast-grp-addr
mcast-src-addr

Type

Description

- vuni : virtual uni identifier


Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::VlanId>
Format:
- vlan id
- range: [1...4093]
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

vlan id

class D address of the multicast


stream
the multicast
address

group

source

Command Output
Table 86.3-2 "Multicast PON Active Groups Status Command" Display parameters
Specific Information
name
state

curr-previewed-nbr
short name: prev-nbr
status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Igmp::ActualState>


( full-view
| pre-view
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
Parameter type: <Igmp::PreviewNumber>
- number of pre-view sessions already been viewed
- range: [0...1000]

The actual state of the multicast


stream
This element is always shown.

Parameter type: <Igmp::McastStatus>


( static
| static-dynamic
| dynamic )
Possible values:
- static : static entry
- static-dynamic : static dynamic entry
- dynamic : dynamic entry

number of pre-view sessions that


have already been viewed
This element is only shown in
detail mode.
the current type of multicast
group
This element is always shown.

Released

2423

86 Multicast Status Commands

86.4 Multicast ONT Active Groups Status


Command
Command Description
This command shows per user interface on a particular ONT the list of active multicast streams.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast ont-active-groups [ (ont-idx) [ port <Igmp::IgmpIfIndex> ] [ vlan-id <Vlan::VlanId> ] [
mcast-grp-addr <Igmp::MulticastAddress> ] [ mcast-src-addr <Ip::V4Address> ] ]

Command Parameters
Table 86.4-1 "Multicast ONT Active Groups Status Command" Resource Parameters
Resource Identifier

Type

(ont-idx)

Format:
identification of the ONT
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Parameter type: <Igmp::IgmpIfIndex>
identification of the vlanport
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

port

2424

Released

Description

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

Resource Identifier

Type

Description

<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:

3HH-04416-EBAA-TCZZA 01

Released

2425

86 Multicast Status Commands

Resource Identifier

Type

Description

- voip : virtual uni identifier


obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::VlanId>
Format:
- vlan id
- range: [1...4093]
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

vlan-id

mcast-grp-addr
mcast-src-addr

vlan Id

class D address of the multicast


stream
the multicast
address

group

source

Command Output
Table 86.4-2 "Multicast ONT Active Groups Status Command" Display parameters
Specific Information
name
state

curr-previewed-nbr
short name: prev-nbr
status

2426

Type

Description

Parameter type: <Igmp::ActualState>


( full-view
| pre-view
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
Parameter type: <Igmp::PreviewNumber>
- number of pre-view sessions already been viewed
- range: [0...1000]

The actual state of the multicast


stream
This element is always shown.

Parameter type: <Igmp::McastStatus>


( static
| static-dynamic
| dynamic )
Possible values:
- static : static entry
- static-dynamic : static dynamic entry
- dynamic : dynamic entry

Released

number of pre-view sessions that


have already been viewed
This element is only shown in
detail mode.
the current type of multicast
group
This element is always shown.

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

86.5 Multicast Group Membership Status


Command
Command Description
This command shows per multicast stream the list of user interfaces to which the system is currently requested to
forward this stream.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast grp-membership [ (mcast-grp-addr) [ vlan-id <Vlan::VlanId> ] [ mcast-src-addr <Ip::V4Address> ] [
port <Igmp::IgmpIfIndex> ] ]

Command Parameters
Table 86.5-1 "Multicast Group Membership Status Command" Resource Parameters
Resource Identifier

Type

Description

(mcast-grp-addr)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Vlan::VlanId>
Format:
- vlan id
- range: [1...4093]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Igmp::IgmpIfIndex>
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

multicast group address

vlan-id

mcast-src-addr
port

3HH-04416-EBAA-TCZZA 01

vlan id

the multicast
address

group

source

identifies a user interface


receiving a multicast stream

Released

2427

86 Multicast Status Commands

Resource Identifier

Type

Description

<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>


| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier

2428

Released

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntSlotId>


- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 86.5-2 "Multicast Group Membership Status Command" Display parameters
Specific Information
name
state

status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Igmp::GroupAddr2UserItfActualstate>


( full-view
| pre-view
| black-out )
Possible values:
- full-view : full view of the stream
- pre-view : preview of the stream
- black-out : no stream is viewed
Parameter type: <Igmp::McastStatus>
( static
| static-dynamic
| dynamic )
Possible values:
- static : static entry
- static-dynamic : static dynamic entry
- dynamic : dynamic entry

the actual state of the multicast


stream
This element is always shown.

the current status of the static


multicast branch
This element is always shown.

Released

2429

86 Multicast Status Commands

86.6 Dynamic and Static-Dynamic Multicast VLAN


FWD Port Status Command
Command Description
This command displays the VLAN list for the MAC multicast group.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast shub igs-vlan-grp [ (vlan-id) [ mcast-addr <Igmp::MulticastAddress> ] [ port <Shub::DataPort> ] ]

Command Parameters
Table 86.6-1 "Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command"
Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
- vlan id
- range: [1...4093]
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Shub::DataPort>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : line board
- network : network port
- nt : active nt slot
- unassigned-link : unassigned external link
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::RackId>
- the rack number

vlan id

mcast-addr
port

2430

Released

multicast address
outbound port

3HH-04416-EBAA-TCZZA

01

86 Multicast Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Shub::SlotId>
- the egress lt slot
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NoExtLink>
- unassigned external SFP port

Command Output
Table 86.6-2 "Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command" Display
parameters
Specific Information
name

Type

Description

src-ip-addr

Parameter type: <Ip::V4Address>


- IPv4-address

status

Parameter type: <Vlan::VlanMcastConfigStatus>


( dynamic
| static-dynamic )
Possible values:
- dynamic : dynamic entry
- static-dynamic : static dynamic entry

ip addr of the mcast server in


network byte order(big endian)
This element is always shown.
The status of the igs-vlan
multicast group
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2431

86 Multicast Status Commands

86.7 SHub Multicast Status Command


Command Description
This command displays the data for SHub multicast.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast shub active-streams

Command Output
Table 86.7-2 "SHub Multicast Status Command" Display parameters
Specific Information
name
count

2432

Released

Type

Description

Parameter type: <Vlan::ActiveNrMcastEntries>


- a signed integer

number of active multicast


entries.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

87- CPE Management Status Commands

87.1 CPE Management Status Command Tree


87.2 CPE Management Show Command

3HH-04416-EBAA-TCZZA 01

87-2434
87-2435

Released

2433

87 CPE Management Status Commands

87.1 CPE Management Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "CPE Management Status Commands".

Command Tree
----show
----cpe-management
----snmpproxy-statistics
- (address)

2434

Released

3HH-04416-EBAA-TCZZA

01

87 CPE Management Status Commands

87.2 CPE Management Show Command


Command Description
This chapter shows the global statistics and the statistics per CPE manager

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cpe-management snmpproxy-statistics [ (address) ]

Command Parameters
Table 87.2-1 "CPE Management Show Command" Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
- IP address of CPE Management Station

the IP address of a CPE manager

Command Output
Table 87.2-2 "CPE Management Show Command" Display parameters
Common Information:cpeproxy
name
Type
rx-drop-msgs-cpe

Specific Information
name

Description

Parameter type: <Counter>


- 32 bit counter

the number of discarded msgs


received from CPEs
This element is only shown in
detail mode.

Type

Description

rx-msgs

Parameter type: <Counter>


- 32 bit counter

tx-msgs

Parameter type: <Counter>


- 32 bit counter

rx-drop-msgs

Parameter type: <Counter>


- 32 bit counter

the number of received msgs


from a CPE manager
This element is always shown.
the number of msgs sent to a CPE
manager
This element is always shown.
the number of discarded msgs
received from a CPE manager
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2435

88- Session Status Commands

88.1 Session Status Command Tree


88.2 Session Status Command

2436

Released

88-2437
88-2438

3HH-04416-EBAA-TCZZA

01

88 Session Status Commands

88.1 Session Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Session Status Commands".

Command Tree
----show
----session
- (id)

3HH-04416-EBAA-TCZZA 01

Released

2437

88 Session Status Commands

88.2 Session Status Command


Command Description
This command displays the status of all sessions.

User Level
The command can be accessed and executed by an operator with admin privilege.

Command Syntax
The command has the following syntax:
> show session (id)

Command Parameters
Table 88.2-1 "Session Status Command" Resource Parameters
Resource Identifier

Type

Description

(id)

Format:
- the session number
- range: [1...13]

the session number

Command Output
Table 88.2-2 "Session Status Command" Display parameters
Specific Information
name
operator
from
type

2438

Released

Type

Description

Parameter type: <Sec::SessionOperatorName>


- the name of an operator
- length: 1<=x<=11
Parameter type: <Sec::LoginAddress>
- the address from where the operator logged in
- length: x<=21
Parameter type: <Sec::TerminalType>
( craft
| telnet
| unused
| test
| ssh
| sftp )
Possible values:
- craft : craft terminal
- telnet : telnet terminal
- unused : unused terminal
- test : test terminal

the name of the operator that is


actually using the session
This element is always shown.
the ip-address from where the
user is logged in
This element is always shown.
the type of connection use.
Network
means
that
any
supported connection type over ip
is possible.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

88 Session Status Commands

name
status
short name: stat

login-time

Type

Description

- ssh : ssh terminal


- sftp : sftp terminal
Parameter type: <Sec::SessionStatus>
( init
| free
| ( reserved | res )
| name
| ( passwd | pwd )
| ( active | act )
| ( logout | end ) )
Possible values:
- init : initialisation ongoing
- free : free
- reserved : reserved
- res : reserved
- name : asking the operator name
- passwd : asking the password
- pwd : asking the password
- active : active
- act : active
- logout : the operator is logging out
- end : the operator is logging out
Parameter type: <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

the status of the session. Special


values are : initializing=session is
not yet ready to be used,
free=session
is
not
used,
selected=session is reserved,
stopping=the user is logging out,
invalid=the
session
is
out-of-service
This element is always shown.

idle-time

Parameter type: <ElapsedTime>


- the time elapsed since a certain event
- unit: sec

numbering-scheme
short name: num

Parameter type: <Sec::SlotDesc>


( ( type-based | typ )
| ( position-based | pos )
| ( legacy-based | leg ) )
Possible values:
- type-based : flat-numbering per slot-type (tl1-like)
- typ : flat-numbering per slot-type (tl1-like)
- position-based : flat-numbering independent of slot-type
- pos : flat-numbering independent of slot-type
- legacy-based : numbering used since the early days
(position-based-like)
- leg : numbering used since the early days
(position-based-like)

3HH-04416-EBAA-TCZZA 01

the time when the user connected


to the terminal. Never if no user
is connected.
This element is always shown.
the time that this terminal is idle
(the operator did not type any
character and did not modify its
window size
This element is always shown.
the numbering scheme for this
session
This element is always shown.

Released

2439

89- PPPoX-Relay Status Commands

89.1 PPPoX-Relay Status Command Tree


89.2 PPPoX CC Engine Statistics
89.3 PPPoX CC Client Port Statistics
89.4 PPPoX CC Engine Monitor Statistics
89.5 PPPoX CC Client Port Monitor Statistics
89.6 PPPoX CC Session Engine Status Command
89.7 PPPoX CC Session Client Port Status Command
89.8 PPPCC Engine Current 15Minute Statistics Command
89.9 PPPCC Engine Current 1day Statistics Command
89.10 PPPCC Engine Previous 15Minute Statistics
Command
89.11 PPPCC Engine Previous 1day Statistics Command

2440

Released

89-2441
89-2442
89-2444
89-2447
89-2449
89-2452
89-2455
89-2458
89-2460
89-2462
89-2464

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

89.1 PPPoX-Relay Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoX-Relay Status Commands".

Command Tree
----show
----pppox-relay
----cross-connect
----statistics
----engine
- (vlan-id)
----client-port
- (client-port)
----monitor-statistics
----engine
- (vlan-id)
----client-port
- (client-port)
----session
----engine
- (vlan-id)
----client-port
- (client-port)
----trouble-shooting-cntrs
----engine
----curr-15min-stats
- (vlan-id)
----curr-1day-stats
- (vlan-id)
----prev-15min-stats
- (vlan-id)
- interval-num
----prev-1day-stats
- (vlan-id)
- interval-num

3HH-04416-EBAA-TCZZA 01

Released

2441

89 PPPoX-Relay Status Commands

89.2 PPPoX CC Engine Statistics


Command Description
This command displays the statistics for a particular VLAN ID.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect statistics engine [ (vlan-id) ]

Command Parameters
Table 89.2-1 "PPPoX CC Engine Statistics" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

engine identification

Command Output
Table 89.2-2 "PPPoX CC Engine Statistics" Display parameters
Specific Information
name
engine-name
in-ctrl-frm
out-ctrl-frm

2442

Type

Description

Parameter type: <PPPoX::EngineName>


- Engine Name
- length: 1<=x<=32
Parameter type: <Counter>
- 32 bit counter

name
to
identify
the
engine/service
This element is always shown.
number of ingress control
messages
This element is always shown.
number of egress control

Parameter type: <Counter>

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

name

Type

Description

- 32 bit counter

messages
This element is always shown.
nbr of errored upstream and
downstream control msgs
This element is only shown in
detail mode.
nbr of PPP cross-connections
currently in use
This element is always shown.

err-ctrl-frm

Parameter type: <Counter>


- 32 bit counter

ppp-cc

Parameter type: <SignedInteger>


- a signed integer

3HH-04416-EBAA-TCZZA 01

Released

2443

89 PPPoX-Relay Status Commands

89.3 PPPoX CC Client Port Statistics


Command Description
This command displays the statistics of a client port.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect statistics client-port [ (client-port) ]

Command Parameters
Table 89.3-1 "PPPoX CC Client Port Statistics" Resource Parameters
Resource Identifier

Type

(client-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip

2444

Released

Description
client port identification
/
/
/
:
/
/
:
/
:
/
/
:
/
/
:
/
/
/
:

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

stacked : <Eqpt::SVlan> : <Eqpt::CVlan>


| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>

3HH-04416-EBAA-TCZZA 01

Released

2445

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

- customer vlan id

Command Output
Table 89.3-2 "PPPoX CC Client Port Statistics" Display parameters
Specific Information
name

Type

Description

in-ctrl-frm

Parameter type: <Counter>


- 32 bit counter

out-ctrl-frm

Parameter type: <Counter>


- 32 bit counter

err-ctrl-frm

Parameter type: <Counter>


- 32 bit counter

curr-num-session

Parameter type: <SignedInteger>


- a signed integer

fwd-frames-up

Parameter type: <Counter>


- 32 bit counter

fwd-frames-down

Parameter type: <Counter>


- 32 bit counter

disc-frames-up

Parameter type: <Counter>


- 32 bit counter

disc-frames-down

Parameter type: <Counter>


- 32 bit counter

number of ingress control


messages
This element is always shown.
number of egress control
messages
This element is always shown.
number of errored control
messages
This element is always shown.
number of active PPP sessions on
the client port
This element is always shown.
number of upstream forwarded
frames
This element is only shown in
detail mode.
number
of
downstream
forwarded frames
This element is only shown in
detail mode.
number of upstream discarded
frames
This element is only shown in
detail mode.
number of downstream discarded
frames
This element is only shown in
detail mode.

2446

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

89.4 PPPoX CC Engine Monitor Statistics


Command Description
This command displays the engine monitor statistics for a particular VLAN ID and lists the statistics of a
configured engine with a monitor enabled.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect monitor-statistics engine [ (vlan-id) ]

Command Parameters
Table 89.4-1 "PPPoX CC Engine Monitor Statistics" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

engine identification

Command Output
Table 89.4-2 "PPPoX CC Engine Monitor Statistics" Display parameters
Specific Information
name

Type

Description

generic-err-cnt

Parameter type: <Counter>


- 32 bit counter

inv-serv-name

Parameter type: <Counter>


- 32 bit counter

nbr of discovery msgs that


carried the Generic Error tag
This element is always shown.
nbr of PAD-S msgs containing
Service-Name-Error tag
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2447

89 PPPoX-Relay Status Commands

2448

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

89.5 PPPoX CC Client Port Monitor Statistics


Command Description
This command shows the client port monitor statistics and lists the statistics of a configured client port with a
monitor enabled.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect monitor-statistics client-port [ (client-port) ]

Command Parameters
Table 89.5-1 "PPPoX CC Client Port Monitor Statistics" Resource Parameters
Resource Identifier

Type

(client-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>

3HH-04416-EBAA-TCZZA 01

Description
client port identification
/
/
/
:
/
/
:
/
:
/
/
:
/
/
:
/
/
/

Released

2449

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :


stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id

2450

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::CVlan>


- customer vlan id

Command Output
Table 89.5-2 "PPPoX CC Client Port Monitor Statistics" Display parameters
Specific Information
name

Type

Description

unexp-ctrl-msg

Parameter type: <Counter>


- 32 bit counter

unexp-data-pkts

Parameter type: <Counter>


- 32 bit counter

prt-mru-err-cnt

Parameter type: <Counter>


- 32 bit counter

trans-age-out

Parameter type: <Counter>


- 32 bit counter

session-age-out

Parameter type: <Counter>


- 32 bit counter

cc-port-max-exceeded

Parameter type: <Counter>


- 32 bit counter

cc-line-max-exceeded

Parameter type: <Counter>


- 32 bit counter

cc-board-max-exceeded

Parameter type: <Counter>


- 32 bit counter

number of unexpected control


messages discarded
This element is always shown.
number of discarded data packets
on this port
This element is always shown.
number of long messages
discarded on this port
This element is only shown in
detail mode.
nbr of events cleared because the
transaction timed out
This element is always shown.
nbr of events timed out for this
port
This element is always shown.
number of times a ppp cc set-up
process is aborted due to max nbr
ppp cc allowed on a port
This element is only shown in
detail mode.
number of times a ppp cc set-up
process is aborted due to max nbr
ppp cc allowed on a line
This element is only shown in
detail mode.
number of times a ppp cc set-up
process is aborted due to max nbr
ppp cc allowed on a board
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2451

89 PPPoX-Relay Status Commands

89.6 PPPoX CC Session Engine Status Command


Command Description
This command displays session data for the engine.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session engine [ (vlan-id) ]

Command Parameters
Table 89.6-1 "PPPoX CC Session Engine Status Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

engine identification

Command Output
Table 89.6-2 "PPPoX CC Session Engine Status Command" Display parameters
Specific Information
name
server-mac-addr
ext-session-id
client-port

2452

Type

Description

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <SignedInteger>
- a signed integer

mac-addr of the PPPoE Server


for this PPP cross-connection
This element is always shown.
PPPoE session id of this PPP
cross-connection
This element is always shown.
Index to which the PPPoE client

Parameter type: <Itf::PppoxClientPortInterface>

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

name

Type

Description

( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>


<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>

3HH-04416-EBAA-TCZZA 01

/ is directly associated
This element is always shown.
/
/
:
/
/
:
/
:
/
/
:
/
/
:
/
/
/
:
/
:
/
:
/
:
/
/
/
/
/
/
/

Released

2453

89 PPPoX-Relay Status Commands

name

Type

int-session-id
client-mac-addr

2454

Description

- the LT slot number


Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <SignedInteger>
- a signed integer
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

Released

index that uniquely indicate a


PPP cross-connection
This element is always shown.
mac-addr of the PPPoE Client for
this PPP cross-connection
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

89.7 PPPoX CC Session Client Port Status


Command
Command Description
This command displays session data for the client port.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session client-port [ (client-port) ]

Command Parameters
Table 89.7-1 "PPPoX CC Session Client Port Status Command" Resource Parameters
Resource Identifier

Type

(client-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>

3HH-04416-EBAA-TCZZA 01

Description
client port identification
/
/
/
:
/
/
:
/
:
/
/
:
/
/
:
/
/

Released

2455

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id

2456

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::SVlan>


- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Command Output
Table 89.7-2 "PPPoX CC Session Client Port Status Command" Display parameters
Specific Information
name
vlan-id

server-mac-addr
ext-session-id

Type

Description

Parameter type: <Vlan::StackedVlanSigned>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <SignedInteger>
- a signed integer

vlan id
This element is always shown.

int-session-id

Parameter type: <SignedInteger>


- a signed integer

client-mac-addr

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

3HH-04416-EBAA-TCZZA 01

mac-addr of the PPPoE server for


this PPP cross-connection
This element is always shown.
PPPoE session id of this PPP
cross-connection
This element is always shown.
index that uniquely indicate a
PPP cross-connection
This element is always shown.
mac-addr of the PPPoE client for
this PPP cross-connection
This element is only shown in
detail mode.

Released

2457

89 PPPoX-Relay Status Commands

89.8 PPPCC Engine Current 15Minute Statistics


Command
Command Description
This command displays the statistics of the transaction ageout and session ageout counters per engine for the
Current 15Minute interval.
The counters are updated once in every 3 minute interval.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect trouble-shooting-cntrs engine curr-15min-stats [ (vlan-id) ]

Command Parameters
Table 89.8-1 "PPPCC Engine Current 15Minute Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan-id

Command Output
Table 89.8-2 "PPPCC Engine Current 15Minute Statistics Command" Display parameters
Specific Information
name
engine-name

2458

Released

Type

Description

Parameter type: <PPPoX::EngineName>


- Engine Name

engine name
This element is always shown.

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

name

Type

trans-age-out-cnt

- length: 1<=x<=32
Parameter type: <Counter>
- 32 bit counter

Description

sess-age-out-cnt

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <PPPoX::IntervalMeasureTime15Min>


- the measured time interval
- unit: sec

valid-flag

Parameter type: <PPPoX::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is valid
- false : data is not valid

3HH-04416-EBAA-TCZZA 01

number of transaction age out


counters in current 15 min
interval
This element is always shown.
number of session age out
counters in current 15 min
interval
This element is always shown.
amount of time in seconds that
statistics for this entry has been
counted in the current 15 min
interval
This element is always shown.
validity of the counters collected
This element is always shown.

Released

2459

89 PPPoX-Relay Status Commands

89.9 PPPCC Engine Current 1day Statistics


Command
Command Description
This command displays the statistics of the transaction ageout and session ageout counters per engine for the
current 1day interval.
The counters are updated once in every 3 minute interval.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect trouble-shooting-cntrs engine curr-1day-stats [ (vlan-id) ]

Command Parameters
Table 89.9-1 "PPPCC Engine Current 1day Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan-id

Command Output
Table 89.9-2 "PPPCC Engine Current 1day Statistics Command" Display parameters
Specific Information
name
engine-name

2460

Released

Type

Description

Parameter type: <PPPoX::EngineName>


- Engine Name

engine name
This element is always shown.

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

name

Type

trans-age-out-cnt

- length: 1<=x<=32
Parameter type: <Counter>
- 32 bit counter

sess-age-out-cnt

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <PPPoX::IntervalMeasureTime1Day>


- the measured time interval
- unit: sec

valid-flag

Parameter type: <PPPoX::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is valid
- false : data is not valid

3HH-04416-EBAA-TCZZA 01

Description
number of transaction age out
counters in current 1 day interval
This element is always shown.
number of session age out
counters in current 1 dayinterval
This element is always shown.
amount of time in seconds that
statistics for this entry has been
counted in the current 1 day
interval
This element is always shown.
validity of the counters collected
This element is always shown.

Released

2461

89 PPPoX-Relay Status Commands

89.10 PPPCC Engine Previous 15Minute Statistics


Command
Command Description
This command displays the statistics of the transaction ageout and session ageout counters per engine for the
previous 15Minute interval.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect trouble-shooting-cntrs engine prev-15min-stats [ (vlan-id) [ interval-num
<PPPoX::IntervalNumber15min> ] ]

Command Parameters
Table 89.10-1 "PPPCC Engine Previous 15Minute Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <PPPoX::IntervalNumber15min>
Format:
- a number identifying 15 minutes interval time
- range: [1...32]

vlan-id

interval-num

previous 15 min interval number

Command Output
Table 89.10-2 "PPPCC Engine Previous 15Minute Statistics Command" Display parameters

2462

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

Specific Information
name
engine-name
trans-age-out-cnt

Type

Description

Parameter type: <PPPoX::EngineName>


- Engine Name
- length: 1<=x<=32
Parameter type: <Counter>
- 32 bit counter

engine identification
This element is always shown.

sess-age-out-cnt

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <PPPoX::IntervalMeasureTime15Min>


- the measured time interval
- unit: sec

valid-flag

Parameter type: <PPPoX::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is valid
- false : data is not valid

3HH-04416-EBAA-TCZZA 01

number of transaction age out in


previous 15 min interval
This element is always shown.
number of session age out in
previous 15 min interval
This element is always shown.
amount of time in seconds that
statistics for this entry has been
counted in the previous 15 min
interval
This element is always shown.
validity of the counters collected
This element is always shown.

Released

2463

89 PPPoX-Relay Status Commands

89.11 PPPCC Engine Previous 1day Statistics


Command
Command Description
This command displays the statistics of the transaction ageout and session ageout counters per engine for the
previous 1day interval.

User Level
The command can be accessed by operators with pppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect trouble-shooting-cntrs engine prev-1day-stats [ (vlan-id) [ interval-num
<PPPoX::IntervalNumber1day> ] ]

Command Parameters
Table 89.11-1 "PPPCC Engine Previous 1day Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <PPPoX::IntervalNumber1day>
Format:
- a number identifying 1 day interval time
- range: [1...7]

vlan-id

interval-num

previous 1 day interval number

Command Output
Table 89.11-2 "PPPCC Engine Previous 1day Statistics Command" Display parameters

2464

Released

3HH-04416-EBAA-TCZZA

01

89 PPPoX-Relay Status Commands

Specific Information
name
engine-name
trans-age-out-cnt

Type

Description

Parameter type: <PPPoX::EngineName>


- Engine Name
- length: 1<=x<=32
Parameter type: <Counter>
- 32 bit counter

engine name
This element is always shown.

sess-age-out-cnt

Parameter type: <Counter>


- 32 bit counter

measured-time

Parameter type: <PPPoX::IntervalMeasureTime1Day>


- the measured time interval
- unit: sec

valid-flag

Parameter type: <PPPoX::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is valid
- false : data is not valid

3HH-04416-EBAA-TCZZA 01

number of transaction age out


previous 1 day interval
This element is always shown.
number of session age out
counters in previous 1 day
interval
This element is always shown.
amount of time in seconds that
statistics for this entry has been
counted in the previous 1 day
interval
This element is always shown.
validity of the counters collected
This element is always shown.

Released

2465

90- OSPF Status Commands

90.1 OSPF Status Command Tree


90.2 OSPF Area Status Command
90.3 OSPF LSA Status Command
90.4 OSPF External Link State Status Command
90.5 OSPF Interface Status Command
90.6 OSPF Neighbor Status Command
90.7 OSPF Routing Status Command
90.8 OSPF Redistributed Routing Status Command
90.9 OSPF Statistics
90.10 OSPF Parameter Status Command

2466

Released

90-2467
90-2468
90-2470
90-2472
90-2474
90-2477
90-2479
90-2481
90-2483
90-2484

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

90.1 OSPF Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "OSPF Status Commands".

Command Tree
----show
----ospf
----area
- (area-id)
----link-state-adv
----link-type
- (link-type)
- area-id
- router-id
- itf-ip-addr
----asbr-external
- (itf-ip-addr)
- router-id
----interface
- (ip-addr)
----neighbour
- (ip-address)
----routing-table
- (destination)
- mask
- peer
----redistributed-route
- (destination)
----statistics
----status

3HH-04416-EBAA-TCZZA 01

Released

2467

90 OSPF Status Commands

90.2 OSPF Area Status Command


Command Description
This command displays the values of the area identifier, spf-runs, number of link state advertisements in the
link-state database, and link-state-checksum.
This command also displays the number of border routers in the area, number of the AS border router, number of
OSPF interfaces in the area, total number of interfaces in the area, total number of networks in the area, and
number of NSSA translator events in the area.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf area [ (area-id) ]

Command Parameters
Table 90.2-1 "OSPF Area Status Command" Resource Parameters
Resource Identifier

Type

Description

(area-id)

Format:
- IPv4-address

ospf area identifier

Command Output
Table 90.2-2 "OSPF Area Status Command" Display parameters
Specific Information
name

Type

Description

spf-runs

Parameter type: <Counter>


- 32 bit counter

num-lsa

Parameter type: <Gauge>


- gauge

lsa-checksum

Parameter type: <SignedInteger>


- a signed integer

area-bdr-rtrs

Parameter type: <Gauge>


- gauge

as-bdr-rtrs

Parameter type: <Gauge>


- gauge

nbr of times the intra-area route


table has been calculated
This element is always shown.
nbr of lsa in this area's link-state
database
This element is always shown.
checksums contained in this
area's link-state database
This element is always shown.
nbr of area border routers in this
area
This element is only shown in
detail mode.
nbr of autonomous sys border
routers in this area

2468

Released

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

name

Type

num-interfaces

Parameter type: <Gauge>


- gauge

num-area-nw

Parameter type: <Gauge>


- gauge

nssa-events

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is only shown in
detail mode.
total number of Interfaces in the
area
This element is only shown in
detail mode.
total number of networks in the
area
This element is only shown in
detail mode.
nbr of translator state changes
since the last boot-up
This element is only shown in
detail mode.

Released

2469

90 OSPF Status Commands

90.3 OSPF LSA Status Command


Command Description
This command displays the general information of OSPF link state advertisements based on the interface type.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf link-state-adv link-type [ (link-type) [ area-id <Ip::V4Address> ] [ router-id <Ip::V4Address> ] [
itf-ip-addr <Ip::V4Address> ] ]

Command Parameters
Table 90.3-1 "OSPF LSA Status Command" Resource Parameters
Resource Identifier

Type

Description

(link-type)

Format:
( router
| network
| summary
| asbr-summary
| nssa )
Possible values:
- router : router link
- network : network link
- summary : summary link
- asbr-summary : assummary link
- nssa : nssa external link
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

filter for the ospf database

area-id
router-id
itf-ip-addr

ospf area identifier


originating router identifier
link state identifier(is router ID or
IP
address
depending
on
link-type)

Command Output
Table 90.3-2 "OSPF LSA Status Command" Display parameters
Specific Information

2470

Released

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

name

Type

Description

age

Parameter type: <Ospf::LsAge>


- age of the link state advertisement
- unit: sec
- range: [0...3600]
Parameter type: <SignedInteger>
- a signed integer

age
of
the
link
state
advertisement in seconds
This element is always shown.

sequence

checksum

Parameter type: <SignedInteger>


- a signed integer

advertisement

Parameter type: <Ospf::Advtsmnt>


- entire link state advertisement
- length: 1<=x<=65535

3HH-04416-EBAA-TCZZA 01

identifies the old and recent


advertisements
This element is only shown in
detail mode.
checksum of the complete
contents of the advertisement
This element is only shown in
detail mode.
entire link state advertisement,
including its header
This element is only shown in
detail mode.

Released

2471

90 OSPF Status Commands

90.4 OSPF External Link State Status Command


Command Description
This command displays the values of the link state database of the OSPF process.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf link-state-adv asbr-external [ (itf-ip-addr) [ router-id <Ip::V4Address> ] ]

Command Parameters
Table 90.4-1 "OSPF External Link State Status Command" Resource Parameters
Resource Identifier

Type

Description

(itf-ip-addr)

Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

external link state identifier

router-id

originating router identifier, a 32


bit number

Command Output
Table 90.4-2 "OSPF External Link State Status Command" Display parameters
Specific Information
name
age

sequence

Type

Description

Parameter type: <Ospf::LsAge>


- age of the link state advertisement
- unit: sec
- range: [0...3600]
Parameter type: <SignedInteger>
- a signed integer

age
of
the
link
state
advertisement in seconds
This element is always shown.

checksum

Parameter type: <SignedInteger>


- a signed integer

advertisement

Parameter type: <Ospf::ExtAdvtsmnt>


- entire link state advertisement of external links
- length: 1<=x<=36

2472

Released

identifies the old and recent


advertisements
This element is only shown in
detail mode.
checksum of the complete
contents of the advertisement
This element is only shown in
detail mode.
entire link state advertisement,
including its header
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2473

90 OSPF Status Commands

90.5 OSPF Interface Status Command


Command Description
This command displays the values of the OSPF interface.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf interface [ (ip-addr) ]

Command Parameters
Table 90.5-1 "OSPF Interface Status Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

ip address of the interface

Command Output
Table 90.5-2 "OSPF Interface Status Command" Display parameters
Specific Information
name
oper-status

designated-router

Type

Description

Parameter type: <Ospf::OperStatus>


( operup
| operdown
| loopback
| unloop )
Possible values:
- operup : operational status up
- operdown : operational status down
- loopback : operational status loopback
- unloop : operational status unloop
Parameter type: <Ip::V4Address>
- IPv4-address

operational status of the interface


This element is always shown.

bkp-designated-router

Parameter type: <Ip::V4Address>


- IPv4-address

events

Parameter type: <Counter>


- 32 bit counter

2474

Released

ip address of the designated


router
This element is always shown.
ip address of the backup
designated router
This element is only shown in
detail mode.
nbr of times this OSPF interface
has changed its state

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

name

Type

num-neighbors

Parameter type: <Gauge>


- gauge

num-adjacencies

Parameter type: <Gauge>


- gauge

rx-hello

Parameter type: <Counter>


- 32 bit counter

tx-hello

Parameter type: <Counter>


- 32 bit counter

discard-hello

Parameter type: <Counter>


- 32 bit counter

rx-ddp

Parameter type: <Counter>


- 32 bit counter

tx-ddp

Parameter type: <Counter>


- 32 bit counter

discard-ddp

Parameter type: <Counter>


- 32 bit counter

discard-lrq

Parameter type: <Counter>


- 32 bit counter

rx-lrq

Parameter type: <Counter>


- 32 bit counter

tx-lrq

Parameter type: <Counter>


- 32 bit counter

rx-lsus

Parameter type: <Counter>


- 32 bit counter

tx-lsus

Parameter type: <Counter>


- 32 bit counter

discard-lsus

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
This element is only shown in
detail mode.
total nbr of neighbour's through
that Itf
This element is only shown in
detail mode.
total nbr of adjacencies through
that Itf
This element is only shown in
detail mode.
total nbr of Hello pkts received
through that Itf
This element is only shown in
detail mode.
total nbr of hello pkts transmitted
through that Itf
This element is only shown in
detail mode.
total nbr of Hello pkts discarded
through that Itf
This element is only shown in
detail mode.
total nbr of Ddp pkts received
through that Itf
This element is only shown in
detail mode.
total nbr of Ddp pkts transmitted
through that Itf
This element is only shown in
detail mode.
total nbr of Ddp pkts discarded
through that Itf
This element is only shown in
detail mode.
total nbr of Lrq pkts discarded
through that Itf
This element is only shown in
detail mode.
total nbr of Lrq pkts received
through that Itf
This element is only shown in
detail mode.
total nbr of Lrq pkts transmitted
through that Itf
This element is only shown in
detail mode.
total nbr of Lsu pkts received
through that Itf
This element is only shown in
detail mode.
total nbr of Lsu pkts transmitted
through that Itf
This element is only shown in
detail mode.
total nbr of Lsu pkts discarded
through that Itf
This element is only shown in

Released

2475

90 OSPF Status Commands

name

Type

discard-lak

Parameter type: <Counter>


- 32 bit counter

rx-lak

Parameter type: <Counter>


- 32 bit counter

tx-lak

Parameter type: <Counter>


- 32 bit counter

2476

Released

Description
detail mode.
total nbr of Lak pkts discarded on
that Itf
This element is only shown in
detail mode.
total nbr of Lak pkts received
through that Itf
This element is only shown in
detail mode.
total nbr of Lak pkts transmitted
through that Itf
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

90.6 OSPF Neighbor Status Command


Command Description
This command displays OSPF neighbor information.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf neighbour [ (ip-address) ]

Command Parameters
Table 90.6-1 "OSPF Neighbor Status Command" Resource Parameters
Resource Identifier

Type

Description

(ip-address)

Format:
- IPv4-address

neighbour ip

Command Output
Table 90.6-2 "OSPF Neighbor Status Command" Display parameters
Specific Information
name

Type

Description

router-id

Parameter type: <Ip::V4Address>


- IPv4-address

state

Parameter type: <Ospf::NbrState>


( down
| attempt
| init
| two-way
| exchange-start
| exchange
| loading
| full )
Possible values:
- down : down
- attempt : attempt
- init : init
- two-way : two-way
- exchange-start : exchange-start
- exchange : exchange

a 32-bit integer identifying the


neighboring router
This element is always shown.
state of the relationship with this
neighbor
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2477

90 OSPF Status Commands

name

Type

Description

- loading : loading
- full : full
Parameter type: <Ospf::NbrPriority>
- priority of the neighbour
- length: x<=255
Parameter type: <Gauge>
- gauge

priority
retrans-q-len

options

Parameter type: <SignedInteger>


- a signed integer

events

Parameter type: <Counter>


- 32 bit counter

nbma-permanence

Parameter type: <Ospf::NbrPermanence>


( dynamic
| permanent )
Possible values:
- dynamic : dynamic
- permanent : permanent
Parameter type: <Ospf::HelloSuppress>
( hello-suppressed
| no-hello-suppressed )
Possible values:
- hello-suppressed : set hello-suppressed value true
- no-hello-suppressed : set hello-suppressed false
Parameter type: <Gauge>
- gauge

hello-suppressed

db-summary-q-len

ls-req-q-len

2478

Parameter type: <Gauge>


- gauge

Released

priority of neighbor in designated


router election algorithm
This element is always shown.
current
length
of
the
retransmission queue
This element is only shown in
detail mode.
bit mask corresponding to the
neighbor
This element is only shown in
detail mode.
nbr of times this neighbor has
changed state
This element is only shown in
detail mode.
status of how the neighbor
became known
This element is only shown in
detail mode.
indicates whether hellos are being
suppressed to the neighbor
This element is only shown in
detail mode.
que length of the database
summary list
This element is only shown in
detail mode.
length of link state request que
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

90.7 OSPF Routing Status Command


Command Description
This command displays information about a single route.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf routing-table [ (destination) [ mask <Ip::V4Address> ] [ peer <Ip::V4Address> ] ]

Command Parameters
Table 90.7-1 "OSPF Routing Status Command" Resource Parameters
Resource Identifier

Type

Description

(destination)

Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

ip address of the route

mask
peer

ip address mask of the route


ip next hop of the route

Command Output
Table 90.7-2 "OSPF Routing Status Command" Display parameters
Specific Information
name

Type

Description

interface
short name: itf

Parameter type: <SignedInteger>


- a signed integer

area-id

Parameter type: <Ip::V4Address>


- IPv4-address
Parameter type: <Ospf::RouteCost>
- Type 1 external metrics
- length: x<=16777215
Parameter type: <Ospf::RouteType>
( intraarea
| interarea
| type1-external
| type2-external )

interface index associated with


the route
This element is always shown.
area id associated with the route
This element is always shown.
type 1 metrics expressed in the
same units as OSPF itf cost
This element is always shown.
type of the route
This element is only shown in
detail mode.

metric
route-type

3HH-04416-EBAA-TCZZA 01

Released

2479

90 OSPF Status Commands

name

Type
Possible values:
- intraarea : intraarea
- interarea : interarea
- type1-external : type1-external
- type2-external : type2-external
Parameter type: <Ospf::RouteCost>
- Type 1 external metrics
- length: x<=16777215

type2-metric

2480

Released

Description

routing between AS is the major


cost of routing a pkt
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

90.8 OSPF Redistributed Routing Status Command


Command Description
This command displays information about redistributed routes.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf redistributed-route [ (destination) ]

Command Parameters
Table 90.8-1 "OSPF Redistributed Routing Status Command" Resource Parameters
Resource Identifier

Type

Description

(destination)

Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

the destination ip address and


mask of this route

Command Output
Table 90.8-2 "OSPF Redistributed Routing Status Command" Display parameters
Specific Information
name
interface
fwd-addr

Type

Description

Parameter type: <Itf::ShubVlanAlias>


- an alias for a vlan
Parameter type: <Ip::V4Address>
- IPv4-address

interface to reach the destination


This element is always shown.
ip address to which packets
should be forwarded
This element is always shown.
route tag applied at the indicated
TOS
This element is always shown.
variable used to get the route
origin
This element is always shown.
ip address of next hop to reach
the destination
This element is always shown.

tag

Parameter type: <SignedInteger>


- a signed integer

origin

Parameter type: <SignedInteger>


- a signed integer

next-hop

Parameter type: <Ip::V4Address>


- IPv4-address

3HH-04416-EBAA-TCZZA 01

Released

2481

90 OSPF Status Commands

name

Type

Description

metric

Parameter type: <Ospf::RouteCost>


- Type 1 external metrics
- length: x<=16777215

metric-type

Parameter type: <SignedInteger>


- a signed integer

metric value applied at the


indicated type of service
This element is only shown in
detail mode.
metric Type applied at the
indicated type of service
This element is only shown in
detail mode.

2482

Released

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

90.9 OSPF Statistics


Command Description
This command displays various statistics, counts, and external link-state advertisement counts.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf statistics

Command Output
Table 90.9-2 "OSPF Statistics" Display parameters
Specific Information
name

Type

Description

num-external-lsa

Parameter type: <Gauge>


- gauge

tx-new-lsas

Parameter type: <Counter>


- 32 bit counter

rx-new-lsas

Parameter type: <Counter>


- 32 bit counter

tx-pkts

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

nbr
of
ext
link-state
advertisements in the link-state
database
This element is always shown.
nbr
of
new
link-state
advertisements that have been
originated
This element is always shown.
nbr of link-state advertisements
received to be new instantiations
This element is always shown.
total no. of packets transmitted
This element is always shown.
total no. of packets received
This element is always shown.
total no. of packets discarded
This element is always shown.

rx-pkts
discard-pkts

3HH-04416-EBAA-TCZZA 01

Released

2483

90 OSPF Status Commands

90.10 OSPF Parameter Status Command


Command Description
This command displays the OSPF parameter status.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf status

Command Output
Table 90.10-2 "OSPF Parameter Status Command" Display parameters
Specific Information
name

Type

Description

router-id

Parameter type: <Ip::V4Address>


- IPv4-address

version
short name: vers

Parameter type: <Ospf::Version>


( version2 | 2 )
Possible values:
- version2 : version number
- 2 : version number
Parameter type: <Ospf::AreaRtrStat>
( ( area-bdr-rtr-stat | y )
| ( no-area-bdr-rtr-stat | n ) )
Possible values:
- area-bdr-rtr-stat : set area-bdr-rtr-stat value true
- y : set area-bdr-rtr-stat value true
- no-area-bdr-rtr-stat : set area-bdr-rtr-stat value false
- n : set area-bdr-rtr-stat value false
Parameter type: <Ospf::AsRtrStat>
( ( as-bdr-rtr-stat | y )
| ( no-as-bdr-rtr-stat | n ) )
Possible values:
- as-bdr-rtr-stat : set as-bdr-rtr-stat value true
- y : set as-bdr-rtr-stat value true
- no-as-bdr-rtr-stat : set as-bdr-rtr-stat value false
- n : set as-bdr-rtr-stat value false
Parameter type: <SignedInteger>
- a signed integer

a 32-bit integer identifying the


router in the Autonomous Sys
This element is always shown.
current version number of the
OSPF protocol is 2
This element is always shown.

area-bdr-rtr-stat
short name: abr

as-bdr-rtr-stat
short name: asbr

ext-lsa-chcksm
overflow-state

2484

Parameter type: <Ospf::OvflwState>

Released

indicates whether the router is an


area border router
This element is always shown.

indicates whether the router is an


Autonomous Sys border router
This element is always shown.

a 32-bit LS checksums of the


external link-state advertisements
This element is always shown.
indicates the router overflow state

3HH-04416-EBAA-TCZZA

01

90 OSPF Status Commands

name

Type

Description

short name: overflow

( ( overflow-state | y )
| ( no-overflow-state | n ) )
Possible values:
- overflow-state : set overflow-state value true
- y : set overflow-state value true
- no-overflow-state : set overflow-state value false
- n : set overflow-state value false
Parameter type: <Ospf::IntLsaCount>
( not-applicable
| <Ospf::IntLsaCount> )
Possible values:
- not-applicable : the counter is not supported
Field type <Ospf::IntLsaCount>
- ospf lsa counter values
- range: [0...2147483647]
Parameter type: <SignedInteger>
- a signed integer

This element is always shown.

num-internal-lsa
short name: num-int-lsa

num-redist-routes

3HH-04416-EBAA-TCZZA 01

current number of internal lsas


This element is always shown.

current number of redistributed


routes
This element is always shown.

Released

2485

91- RIP Status Commands

91.1 RIP Status Command Tree


91.2 RIP Statistics Command
91.3 RIP Peer Status Command
91.4 RIP Routing Status Command
91.5 RIP Global Status Command

2486

Released

91-2487
91-2488
91-2489
91-2490
91-2492

3HH-04416-EBAA-TCZZA

01

91 RIP Status Commands

91.1 RIP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "RIP Status Commands".

Command Tree
----show
----rip
----statistics
- (ip-addr)
----peer
- (ip-addr)
----routing-table
- (destination)
- peer
----global

3HH-04416-EBAA-TCZZA 01

Released

2487

91 RIP Status Commands

91.2 RIP Statistics Command


Command Description
This command displays the RIP interface status.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip statistics [ (ip-addr) ]

Command Parameters
Table 91.2-1 "RIP Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

show statistics of a specific IP


interface

Command Output
Table 91.2-2 "RIP Statistics Command" Display parameters
Specific Information
name

Type

Description

periodical-update

Parameter type: <Counter>


- 32 bit counter

rx-bad-pkts

Parameter type: <Counter>


- 32 bit counter

rx-bad-routes

Parameter type: <Counter>


- 32 bit counter

updates-sent

Parameter type: <Counter>


- 32 bit counter

total nbr of periodic RIP updates


sent on this interface
This element is always shown.
number of RIP response pkts
which were discarded
This element is always shown.
number of routes in valid RIP
packets which were ignored
This element is always shown.
number of triggered RIP updates
sent on this interface
This element is only shown in
detail mode.

2488

Released

3HH-04416-EBAA-TCZZA

01

91 RIP Status Commands

91.3 RIP Peer Status Command


Command Description
This command displays information about a single routing peer.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip peer [ (ip-addr) ]

Command Parameters
Table 91.3-1 "RIP Peer Status Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

IP identifying the remote peer

Command Output
Table 91.3-2 "RIP Peer Status Command" Display parameters
Specific Information
name

Type

Description

peer-version

Parameter type: <SignedInteger>


- a signed integer

last-updt-rx

Parameter type: <TimeTicks>


- a timeout value
- unit: msec
Parameter type: <Counter>
- 32 bit counter

version number in the header of


the last RIP packet
This element is always shown.
most recent RIP update received
from the system
This element is always shown.
number of RIP response pkts
discarded as invalid
This element is always shown.
number of routes that were
ignored
This element is always shown.

rx-bad-pkts
rx-bad-routes

3HH-04416-EBAA-TCZZA 01

Parameter type: <Counter>


- 32 bit counter

Released

2489

91 RIP Status Commands

91.4 RIP Routing Status Command


Command Description
This command displays a list of routes in the local routing table.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip routing-table [ (destination) [ peer <Ip::V4Address> ] ]

Command Parameters
Table 91.4-1 "RIP Routing Status Command" Resource Parameters
Resource Identifier

Type

Description

(destination)

Format:
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

the destination ip address and


mask of this route

peer

nexthop address where datagrams


are to be forwarded

Command Output
Table 91.4-2 "RIP Routing Status Command" Display parameters
Specific Information
name

Type

Description

gateway

Parameter type: <Ip::V4Address>


- IPv4-address

vlan-id
short name: vlan

Parameter type: <Itf::ShubVlanAlias>


- an alias for a vlan

metric

Parameter type: <SignedInteger>


- a signed integer

change-time

Parameter type: <SignedInteger>


- a signed integer

gateway
address
where
datagrams are to be forwarded
This element is always shown.
vlan through which the route is
learnt
This element is always shown.
reachability
cost
for
the
destination
This element is always shown.
time when the route is installed
This element is only shown in

2490

Released

3HH-04416-EBAA-TCZZA

01

91 RIP Status Commands

name

Type

valid

Parameter type: <SignedInteger>


- a signed integer

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
row status for particular route
entry
This element is only shown in
detail mode.

Released

2491

91 RIP Status Commands

91.5 RIP Global Status Command


Command Description
This command displays information regarding the sum of all the interface-related counters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip global

Command Output
Table 91.5-2 "RIP Global Status Command" Display parameters
Specific Information
name

Type

Description

periodic-updates

Parameter type: <Counter>


- 32 bit counter

dropped-pkts

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

total nbr of periodic RIP updates


sent from this router
This element is always shown.
number of packets dropped
This element is always shown.
number of routes changed
This element is always shown.
number of responses sent to RIP
queries
This element is always shown.
current number of rip routes
This element is always shown.

route-change
global-queries
num-routes
short name:
num-routes/all
num-redist-routes
short name:
num-routes/redist
num-discarded-routes
short name:
num-routes/discard
next-route-map-index
short name:
next-rtmap/index

2492

Released

Parameter type: <SignedInteger>


- a signed integer
Parameter type: <SignedInteger>
- a signed integer

current number of redistributed


routes
This element is always shown.
number of discarded routes
This element is always shown.

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Rip::NewGlobalRouteMapIndex>
( no-free-entry
| <Rip::NewRouteMapIndex> )
Possible values:
- no-free-entry : no free route map entry for rip global show
Field type <Rip::NewRouteMapIndex>
- identifies the route map index
- range: [1...400]

next free value for the route-map


index
This element is always shown.

3HH-04416-EBAA-TCZZA

01

91 RIP Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2493

92- Cluster Status Commands

92.1 Cluster Status Command Tree


92.2 Cluster Port Counter Status Command
92.3 Neighbor Device Status Command
92.4 Topology Device Status Command
92.5 Topology Connect Status Command

2494

Released

92-2495
92-2496
92-2498
92-2500
92-2502

3HH-04416-EBAA-TCZZA

01

92 Cluster Status Commands

92.1 Cluster Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Cluster Status Commands".

Command Tree
----show
----cluster
----counter
- (counter)
----neighbour
- (port-id)
----device
- (device)
----connect
- (device-id)
- port-id

3HH-04416-EBAA-TCZZA 01

Released

2495

92 Cluster Status Commands

92.2 Cluster Port Counter Status Command


Command Description
This command shows the counter of the port.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show cluster counter [ (counter) ]

Command Parameters
Table 92.2-1 "Cluster Port Counter Status Command" Resource Parameters
Resource Identifier

Type

Description

(counter)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

the interface index

Command Output
Table 92.2-2 "Cluster Port Counter Status Command" Display parameters
Specific Information
name

Type

Description

disc-in

Parameter type: <Counter>


- 32 bit counter

disc-out

Parameter type: <Counter>


- 32 bit counter

The
number
of
received
neighbour discovery packets on
the port
This element is always shown.
The number of transmitted
neighbour discovery packets on

2496

Released

3HH-04416-EBAA-TCZZA

01

92 Cluster Status Commands

name

Type

disc-discard

Parameter type: <Counter>


- 32 bit counter

top-req-in

Parameter type: <Counter>


- 32 bit counter

top-req-out

Parameter type: <Counter>


- 32 bit counter

top-req-loop-discard
short name: loop

Parameter type: <Counter>


- 32 bit counter

top-req-index-discard
short name: index

Parameter type: <Counter>


- 32 bit counter

top-req-other-discard
short name: other

Parameter type: <Counter>


- 32 bit counter

top-resp-in

Parameter type: <Counter>


- 32 bit counter

top-resp-out

Parameter type: <Counter>


- 32 bit counter

top-resp-discard
short name: response

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
the port.
This element is always shown.
The number of discard neighbour
discovery packets due to invalid
packets on the port.
This element is always shown.
The number of received topology
request packets on the port.
This element is always shown.
The number of transmitted
topology request packets on the
port.
This element is always shown.
The number of discarded
topology request packets due to
loop on the port.
This element is always shown.
The number of discarded
duplicate
topology
request
packets on the port.
This element is always shown.
The number of discarded
topology request packets due to
error checksum, version etc. on
the port.
This element is always shown.
The number of received topology
response packets on the port.
This element is always shown.
The number of transmitted
topology response packets on the
port.
This element is always shown.
The number of discarded
topology response packets on the
port.
This element is always shown.

Released

2497

92 Cluster Status Commands

92.3 Neighbor Device Status Command


Command Description
This command shows the neighbor info.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show cluster neighbour [ (port-id) ]

Command Parameters
Table 92.3-1 "Neighbor Device Status Command" Resource Parameters
Resource Identifier

Type

Description

(port-id)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

interface index

Command Output
Table 92.3-2 "Neighbor Device Status Command" Display parameters
Specific Information
name
device
port

2498

Released

Type

Description

Parameter type: <Cluster::MacAddr>


- binary string of 06 bytes
- length: 6
Parameter type: <Cluster::PortID>
- a signed integer

The neighbor device MAC


address on the port.
This element is always shown.
The port id of neighbor node
connected on the port.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

92 Cluster Status Commands

name

Type

Description

host

Parameter type: <Cluster::HostName>


- the cluster name
- length: x<=255

description

Parameter type: <Cluster::neighbourSystemDescription>


- a printable string
- length: x<=255

stp

Parameter type: <Cluster::neighbourPortSTPState>


( disabled
| blocking
| listening
| learning
| forwarding
| broken )
Possible values:
- disabled : the STP in the port is disabled
- blocking : the STP in the port is blocking
- listening : the STP in the port is listening
- learning : the STP in the port is learning
- forwarding : the STP in the port is forwarding
- broken : the STP in the port is broken

The host name of neighbour node


on the port.
This element is only shown in
detail mode.
The system description of
neighbor node on the port.
This element is only shown in
detail mode.
The stp state of the current port.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2499

92 Cluster Status Commands

92.4 Topology Device Status Command


Command Description
This command shows the information of nodes within the connected environment.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show cluster device [ (device) ]

Command Parameters
Table 92.4-1 "Topology Device Status Command" Resource Parameters
Resource Identifier

Type

Description

(device)

Format:
- binary string of 06 bytes
- length: 6

device id

Command Output
Table 92.4-2 "Topology Device Status Command" Display parameters
Specific Information
name

Type

Description

host

Parameter type: <Cluster::topologyHostName>


- a printable string
- length: x<=255

description

Parameter type: <Cluster::topoloygSystemDescription>


- a printable string
- length: x<=255

cluster-name

Parameter type: <Cluster::topologyClusterName>


- a printable string
- length: x<=255

cluster-role

Parameter type: <Cluster::topologyClusterRole>


( command
| member
| backup
| candidate )
Possible values:

The host name of connected


node.
This element is only shown in
detail mode.
The ystem description of
connected node.
This element is only shown in
detail mode.
The cluster name of connected
node.
This element is only shown in
detail mode.
The role of connected node.
This element is always shown.

2500

Released

3HH-04416-EBAA-TCZZA

01

92 Cluster Status Commands

name

Type

Description

- command : the connected node is a command node


- member : the connected node is a member node
- backup : the connected node is a backup node
- candidate : the connected node is a candidate node

3HH-04416-EBAA-TCZZA 01

Released

2501

92 Cluster Status Commands

92.5 Topology Connect Status Command


Command Description
This command shows the connected information of nodes within the connected environment in which the command
node is.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show cluster connect [ (device-id) [ port-id <Shub::NetworkPort> ] ]

Command Parameters
Table 92.5-1 "Topology Connect Status Command" Resource Parameters
Resource Identifier

Type

Description

(device-id)

Format:
- binary string of 06 bytes
- length: 6
Parameter type: <Shub::NetworkPort>
Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

native device id

port-id

native port id

Command Output
Table 92.5-2 "Topology Connect Status Command" Display parameters
Specific Information
name
peer-device

2502

Released

Type

Description

Parameter type: <Cluster::peerDeviceID>


- binary string of 06 bytes

The device MAC address of


connected node with the native

3HH-04416-EBAA-TCZZA

01

92 Cluster Status Commands

name
peer-port

stp-state

3HH-04416-EBAA-TCZZA 01

Type

Description

- length: 6

node.
This element is always shown.
The device MAC address of
connected node with the native
node.
This element is always shown.

Parameter type: <Shub::NetworkPort>


( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Parameter type: <Cluster::portSTPstate>
( disabled
| blocking
| listening
| learning
| forwarding
| broken )
Possible values:
- disabled : the STP state is disabled
- blocking : the STP state is blocking
- listening : the STP state is listening
- learning : the STP state is learning
- forwarding : the STP state is forwarding
- broken : the STP state is broken

The STP state of port.


This element is always shown.

Released

2503

93- SHDSL Status Commands

93.1 SHDSL Status Command Tree


93.2 SHDSL Inventory Status Command
93.3 SHDSL Span Status Command
93.4 SHDSL Unit Status Command
93.5 SHDSL Segment Status Command
93.6 SHDSL Segment Counters Current Interval Status
Command
93.7 SHDSL Segment Counters Current Day Status
Command
93.8 SHDSL Segment Counters Previous Interval Status
Command
93.9 SHDSL Segment Counters Previous Day Status
Command
93.10 SHDSL Span Current Interval Performance Data
Status Command
93.11 SHDSL Span Current Day Performance Data Status
Command
93.12 SHDSL Span Previous Interval Performance Data
Status Command
93.13 SHDSL Span Previous Day Performance Data Status
Command

2504

Released

93-2505
93-2507
93-2509
93-2516
93-2518
93-2523
93-2526
93-2529
93-2532
93-2535
93-2537
93-2539
93-2541

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.1 SHDSL Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "SHDSL Status Commands".

Command Tree
----show
----shdsl
----inventory
- (if-index)
- unit-id
----span-status
- (if-index)
----unit-status
- (if-index)
- unit-id
----segment-status
- (if-index)
- unit-id
- side
- wire-pair
----segment-counters
----current-15min
- (if-index)
- unit-id
- side
- wire-pair
----current-1day
- (if-index)
- unit-id
- side
- wire-pair
----previous-15min
- (if-index)
- unit-id
- side
- wire-pair
- int-no
----previous-1day
- (if-index)
- unit-id
- side
- wire-pair
- int-no
----span-counters
----current-15min
- (if-index)
----current-1day
- (if-index)
----previous-15min
- (if-index)
- interval-number

3HH-04416-EBAA-TCZZA 01

Released

2505

93 SHDSL Status Commands

----previous-1day
- (if-index)
- interval-number

2506

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.2 SHDSL Inventory Status Command


Command Description
This command displays the SHDSL inventory status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl inventory [ (if-index) [ unit-id <Shdsl::UnitId> ] ]

Command Parameters
Table 93.2-1 "SHDSL Inventory Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3

unit-id

3HH-04416-EBAA-TCZZA 01

Description

Released

2507

93 SHDSL Status Commands

Resource Identifier

Type

Description

- sru-4 : the SHDSL unit is SRU-4


- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8

Command Output
Table 93.2-2 "SHDSL Inventory Status Command" Display parameters
Specific Information
name
version
list-no
issue-no
sw-version
clei-code

vendor-id
model-no

Type

Description

Parameter type: <Shdsl::UnitShdslStdVersion>


- an SHDSL unit standard version
- range: [0...255]
Parameter type: <Shdsl::UnitVendorListNumber>
- string indicates an SHDSL unit's vendor list number
- length: x<=3
Parameter type: <Shdsl::UnitVendorIssueNumber>
- string indicates SHDSL unit's vendor issue number
- length: x<=2
Parameter type: <Shdsl::UnitVendorSwVersion>
- string indicates SHDSL unit's vendor softwr version nbr
- length: x<=32
Parameter type: <Shdsl::UnitCleiCode>
- string indicates SHDSL unit's Common Language
Equipment Identifier code
- length: x<=10
Parameter type: <Shdsl::UnitVendorID>
- a string indicates an SHDSL unit's vendor ID
- length: x<=8
Parameter type: <Shdsl::UnitVendorModelNumber>
- a string indicates an SHDSL unit's vendor model number
- length: x<=12

the SHDSL standard version for


this unit
This element is always shown.
the vendor list number for this
SHDSL unit
This element is always shown.
the vendor issue number for this
SHDSL unit
This element is always shown.
the vendor software version
number for this SHDSL unit
This element is always shown.
the
Common
Language
Equipment Identifier code for this
SHDSL unit
This element is always shown.
the vendor id for this SHDSL unit
This element is only shown in
detail mode.
the vendor model number for this
SHDSL unit
This element is only shown in
detail mode.
the vendor serial number for this
SHDSL unit
This element is only shown in
detail mode.
the vendor other specific
information for this SHDSL unit
This element is only shown in
detail mode.
the regional capablities that can
be supported by this unit
This element is only shown in
detail mode.

serial-no

Parameter type: <Shdsl::UnitVendorSerialNumber>


- a string indicates an SHDSL unit's vendor serial number
- length: x<=12

other-info

Parameter type: <Shdsl::UnitVendorOtherInfo>


- a string indicates an SHDSL unit's vendor specific info
- length: x<=12

region-cap

Parameter type: <Shdsl::SpanRegionalSetting>


( annex-a/f
| annex-b/g )
Possible values:
- annex-a/f : Annex A/F Region 1
- annex-b/g : Annex B/G Region 2

2508

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.3 SHDSL Span Status Command


Command Description
This command displays the SHDSL span status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl span-status [ (if-index) ]

Command Parameters
Table 93.3-1 "SHDSL Span Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 93.3-2 "SHDSL Span Status Command" Display parameters
Specific Information
name
state

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::SpanState>


( unknown
| unequipped
| faulty
| idle
| startup
| active
| testing
| fwdownloading )
Possible values:
- unknown : the state is unknown

the overall state of this SHDSL


span
This element is always shown.

Released

2509

93 SHDSL Status Commands

name

Type

det-stu-c

det-stu-r

det-sru-1

det-sru-2

det-sru-3

det-sru-4

det-sru-5

det-sru-6

det-sru-7

2510

Description

- unequipped : the state is unequipped


- faulty : the state is faulty
- idle : the state is idle
- startup : the state is startup
- active : the state is active
- testing : the state is testing
- fwdownloading : the state is firmware downloading
Parameter type: <Shdsl::STUC>
( no-stu-c
| stu-c )
Possible values:
- no-stu-c : STU-C isn't on this span
- stu-c : STU-C is on this span
Parameter type: <Shdsl::STUR>
( no-stu-r
| stu-r )
Possible values:
- no-stu-r : STU-R isn't on this span
- stu-r : STU-R is on this span
Parameter type: <Shdsl::SRU1>
( no-sru-1
| sru-1 )
Possible values:
- no-sru-1 : SRU-1 isn't on this span
- sru-1 : SRU-1 is on this span
Parameter type: <Shdsl::SRU2>
( no-sru-2
| sru-2 )
Possible values:
- no-sru-2 : SRU-2 isn't on this span
- sru-2 : SRU-2 is on this span
Parameter type: <Shdsl::SRU3>
( no-sru-3
| sru-3 )
Possible values:
- no-sru-3 : SRU-3 isn't on this span
- sru-3 : SRU-3 is on this span
Parameter type: <Shdsl::SRU4>
( no-sru-4
| sru-4 )
Possible values:
- no-sru-4 : SRU-4 isn't on this span
- sru-4 : SRU-4 is on this span
Parameter type: <Shdsl::SRU5>
( no-sru-5
| sru-5 )
Possible values:
- no-sru-5 : SRU-5 isn't on this span
- sru-5 : SRU-5 is on this span
Parameter type: <Shdsl::SRU6>
( no-sru-6
| sru-6 )
Possible values:
- no-sru-6 : SRU-6 isn't on this span
- sru-6 : SRU-6 is on this span
Parameter type: <Shdsl::SRU7>
( no-sru-7

Released

STU-C
This element is only shown in
detail mode.

STU-R
This element is only shown in
detail mode.

SRU-1
This element is only shown in
detail mode.

SRU-2
This element is only shown in
detail mode.

SRU-3
This element is only shown in
detail mode.

SRU-4
This element is only shown in
detail mode.

SRU-5
This element is only shown in
detail mode.

SRU-6
This element is only shown in
detail mode.

SRU-7
This element is only shown in

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name

det-sru-8

inv-stu-c

inv-stu-r

inv-sru-1

inv-sru-2

inv-sru-3

inv-sru-4

inv-sru-5

inv-sru-6

3HH-04416-EBAA-TCZZA 01

Type

Description

| sru-7 )
Possible values:
- no-sru-7 : SRU-7 isn't on this span
- sru-7 : SRU-7 is on this span
Parameter type: <Shdsl::SRU8>
( no-sru-8
| sru-8 )
Possible values:
- no-sru-8 : SRU-8 isn't on this span
- sru-8 : SRU-8 is on this span
Parameter type: <Shdsl::STUC>
( no-stu-c
| stu-c )
Possible values:
- no-stu-c : STU-C isn't on this span
- stu-c : STU-C is on this span
Parameter type: <Shdsl::STUR>
( no-stu-r
| stu-r )
Possible values:
- no-stu-r : STU-R isn't on this span
- stu-r : STU-R is on this span
Parameter type: <Shdsl::SRU1>
( no-sru-1
| sru-1 )
Possible values:
- no-sru-1 : SRU-1 isn't on this span
- sru-1 : SRU-1 is on this span
Parameter type: <Shdsl::SRU2>
( no-sru-2
| sru-2 )
Possible values:
- no-sru-2 : SRU-2 isn't on this span
- sru-2 : SRU-2 is on this span
Parameter type: <Shdsl::SRU3>
( no-sru-3
| sru-3 )
Possible values:
- no-sru-3 : SRU-3 isn't on this span
- sru-3 : SRU-3 is on this span
Parameter type: <Shdsl::SRU4>
( no-sru-4
| sru-4 )
Possible values:
- no-sru-4 : SRU-4 isn't on this span
- sru-4 : SRU-4 is on this span
Parameter type: <Shdsl::SRU5>
( no-sru-5
| sru-5 )
Possible values:
- no-sru-5 : SRU-5 isn't on this span
- sru-5 : SRU-5 is on this span
Parameter type: <Shdsl::SRU6>
( no-sru-6
| sru-6 )
Possible values:
- no-sru-6 : SRU-6 isn't on this span

detail mode.

SRU-8
This element is only shown in
detail mode.

STU-C
This element is only shown in
detail mode.

STU-R
This element is only shown in
detail mode.

SRU-1
This element is only shown in
detail mode.

SRU-2
This element is only shown in
detail mode.

SRU-3
This element is only shown in
detail mode.

SRU-4
This element is only shown in
detail mode.

SRU-5
This element is only shown in
detail mode.

SRU-6
This element is only shown in
detail mode.

Released

2511

93 SHDSL Status Commands

name

Type
- sru-6 : SRU-6 is on this span
Parameter type: <Shdsl::SRU7>
( no-sru-7
| sru-7 )
Possible values:
- no-sru-7 : SRU-7 isn't on this span
- sru-7 : SRU-7 is on this span
Parameter type: <Shdsl::SRU8>
( no-sru-8
| sru-8 )
Possible values:
- no-sru-8 : SRU-8 isn't on this span
- sru-8 : SRU-8 is on this span
Parameter type: <Shdsl::STUC>
( no-stu-c
| stu-c )
Possible values:
- no-stu-c : STU-C isn't on this span
- stu-c : STU-C is on this span
Parameter type: <Shdsl::STUR>
( no-stu-r
| stu-r )
Possible values:
- no-stu-r : STU-R isn't on this span
- stu-r : STU-R is on this span
Parameter type: <Shdsl::SRU1>
( no-sru-1
| sru-1 )
Possible values:
- no-sru-1 : SRU-1 isn't on this span
- sru-1 : SRU-1 is on this span
Parameter type: <Shdsl::SRU2>
( no-sru-2
| sru-2 )
Possible values:
- no-sru-2 : SRU-2 isn't on this span
- sru-2 : SRU-2 is on this span
Parameter type: <Shdsl::SRU3>
( no-sru-3
| sru-3 )
Possible values:
- no-sru-3 : SRU-3 isn't on this span
- sru-3 : SRU-3 is on this span
Parameter type: <Shdsl::SRU4>
( no-sru-4
| sru-4 )
Possible values:
- no-sru-4 : SRU-4 isn't on this span
- sru-4 : SRU-4 is on this span
Parameter type: <Shdsl::SRU5>
( no-sru-5
| sru-5 )
Possible values:
- no-sru-5 : SRU-5 isn't on this span
- sru-5 : SRU-5 is on this span
Parameter type: <Shdsl::SRU6>
( no-sru-6

inv-sru-7

inv-sru-8

con-stu-c

con-stu-r

con-sru-1

con-sru-2

con-sru-3

con-sru-4

con-sru-5

con-sru-6

2512

Released

Description
SRU-7
This element is only shown in
detail mode.

SRU-8
This element is only shown in
detail mode.

STU-C
This element is only shown in
detail mode.

STU-R
This element is only shown in
detail mode.

SRU-1
This element is only shown in
detail mode.

SRU-2
This element is only shown in
detail mode.

SRU-3
This element is only shown in
detail mode.

SRU-4
This element is only shown in
detail mode.

SRU-5
This element is only shown in
detail mode.

SRU-6
This element is only shown in

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name

con-sru-7

con-sru-8

stat-losw

stat-lp-attn

stat-snr

stat-dc

stat-dev

stat-conf

stat-lp-act

3HH-04416-EBAA-TCZZA 01

Type

Description

| sru-6 )
Possible values:
- no-sru-6 : SRU-6 isn't on this span
- sru-6 : SRU-6 is on this span
Parameter type: <Shdsl::SRU7>
( no-sru-7
| sru-7 )
Possible values:
- no-sru-7 : SRU-7 isn't on this span
- sru-7 : SRU-7 is on this span
Parameter type: <Shdsl::SRU8>
( no-sru-8
| sru-8 )
Possible values:
- no-sru-8 : SRU-8 isn't on this span
- sru-8 : SRU-8 is on this span
Parameter type: <Shdsl::LOSW>
( no-losw
| losw )
Possible values:
- no-losw : no loss of word
- losw : loss of word
Parameter type: <Shdsl::LpAttn>
( no-lp-attn
| lp-attn )
Possible values:
- no-lp-attn : no loop attenuation
- lp-attn : loop attenuation
Parameter type: <Shdsl::SNR>
( no-snr
| snr )
Possible values:
- no-snr : no snr margin alarm
- snr : snr margin alarm
Parameter type: <Shdsl::DC>
( no-dc
| dc )
Possible values:
- no-dc : no dc continuity fault
- dc : dc continuity fault
Parameter type: <Shdsl::Dev>
( no-dev
| dev )
Possible values:
- no-dev : no device fault
- dev : device fault
Parameter type: <Shdsl::Conf>
( no-conf
| conf )
Possible values:
- no-conf : no configuration error
- conf : configuration error
Parameter type: <Shdsl::LpAct>
( no-lp-act
| lp-act )
Possible values:
- no-lp-act : no loopback active

detail mode.

SRU-7
This element is only shown in
detail mode.

SRU-8
This element is only shown in
detail mode.

loss of word
This element is only shown in
detail mode.

loop attenuation alarm


This element is only shown in
detail mode.

snr margin alarm


This element is only shown in
detail mode.

dc continuity fault
This element is only shown in
detail mode.

device fault
This element is only shown in
detail mode.

configuration error
This element is only shown in
detail mode.

loopback active
This element is only shown in
detail mode.

Released

2513

93 SHDSL Status Commands

name

Type

stat-no-con

stat-lcd

stat-lop

stat-ncd

stat-act-fail

first-port

second-port

third-port

2514

Description

- lp-act : loopback active


Parameter type: <Shdsl::NoCon>
( no-no-con
| no-con )
Possible values:
- no-no-con : conform to stu-c of stu-r initiated management
flow
- no-con : not conform to stu-c of stu-r initiated management
flow
Parameter type: <Shdsl::LCD>
( no-lcd
| lcd )
Possible values:
- no-lcd : no ATM loss of cell delineation
- lcd : ATM loss of cell delineation
Parameter type: <Shdsl::LOP>
( no-lop
| lop )
Possible values:
- no-lop : no loss of power
- lop : loss of power
Parameter type: <Shdsl::NCD>
( no-ncd
| ncd )
Possible values:
- no-ncd : disable no-cell-delineation
- ncd : no cell delineation
Parameter type: <Shdsl::ActFail>
( no-act-fail
| act-fail )
Possible values:
- no-act-fail : no activation failure
- act-fail : activation failure
Parameter type: <Shdsl::FirstPort>
( first-pair
| second-pair
| third-pair
| fourth-pair )
Possible values:
- first-pair : first pair
- second-pair : second pair
- third-pair : third pair
- fourth-pair : fourth pair
Parameter type: <Shdsl::SecondPort>
( first-pair
| second-pair
| third-pair
| fourth-pair )
Possible values:
- first-pair : first pair
- second-pair : second pair
- third-pair : third pair
- fourth-pair : fourth pair
Parameter type: <Shdsl::ThirdPort>
( first-pair
| second-pair
| third-pair

Released

not conform to stu-c of stu-r


initiated management flow
This element is only shown in
detail mode.

ATM loss of cell delineation


This element is only shown in
detail mode.

loss of power
This element is only shown in
detail mode.

no cell delineation
This element is only shown in
detail mode.

activation failure
This element is only shown in
detail mode.

first-port
This element is always shown.

second-port
This element is always shown.

third-port
This element is always shown.

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name

fourth-port

curr-data-rate
tc-pam-modu

efm-hs-mode

3HH-04416-EBAA-TCZZA 01

Type
| fourth-pair )
Possible values:
- first-pair : first pair
- second-pair : second pair
- third-pair : third pair
- fourth-pair : fourth pair
Parameter type: <Shdsl::FourthPort>
( first-pair
| second-pair
| third-pair
| fourth-pair )
Possible values:
- first-pair : first pair
- second-pair : second pair
- third-pair : third pair
- fourth-pair : fourth pair
Parameter type: <Shdsl::BitRate>
- bitrate
- unit: kbits/sec
Parameter type: <Shdsl::SpanTCPAMModulation>
( tc-pam32
| tc-pam16
| unknown )
Possible values:
- tc-pam32 : tcPam32 modulation
- tc-pam16 : tcPam16 modulation
- unknown : unknown modulation
Parameter type: <Shdsl::SpanEFMHandshakeMode>
( unknown
| ieee
| itu
| not-applicable )
Possible values:
- unknown : unknown handshake mode
- ieee : ieee 2base-tl
- itu : itu-t g.991.2 ptm 64/65otc
- not-applicable : not-applicable for atm/ima mode

Description

fourth-port
This element is always shown.

the current SHDSL data rate


This element is always shown.
the current TC-PAM modulation
of the span
This element is always shown.

the actual handshake mode for


the span
This element is always shown.

Released

2515

93 SHDSL Status Commands

93.4 SHDSL Unit Status Command


Command Description
This command displays the SHDSL unit status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl unit-status [ (if-index) [ unit-id <Shdsl::UnitId> ] ]

Command Parameters
Table 93.4-1 "SHDSL Unit Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3

unit-id

2516

Released

Description

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

Resource Identifier

Type

Description

- sru-4 : the SHDSL unit is SRU-4


- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8

Command Output
Table 93.4-2 "SHDSL Unit Status Command" Display parameters
Specific Information
name
dc-pow

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::UnitDCPowering>


( local-pow
| span-pow )
Possible values:
- local-pow : locally powered
- span-pow : span powered

the powering mode of this


SHDSL span
This element is always shown.

Released

2517

93 SHDSL Status Commands

93.5 SHDSL Segment Status Command


Command Description
This command displays the status of individual segment end points in an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl segment-status [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide> ] [ wire-pair
<Shdsl::SegmentTerminationWirePair> ] ]

Command Parameters
Table 93.5-1 "SHDSL Segment Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2

unit-id

2518

Released

Description

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

Resource Identifier

Type

Description

- sru-3 : the SHDSL unit is SRU-3


- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Parameter type: <Shdsl::SegmentTerminationWirePair>
Format:
( one
| two
| three
| four )
Possible values:
- one : the first pair
- two : the second pair
- three : the third pair
- four : the fourth pair

side

wire-pair

the particular side of an SHDSL


unit in an SHDSL segment

the particular wire pair of an


SHDSL segment

Command Output
Table 93.5-2 "SHDSL Segment Status Command" Display parameters
Specific Information
name
seg-st-losw

seg-st-lp-attn

seg-st-snr

seg-st-dc

seg-st-dev

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::LOSW>


( no-losw
| losw )
Possible values:
- no-losw : no loss of word
- losw : loss of word
Parameter type: <Shdsl::LpAttn>
( no-lp-attn
| lp-attn )
Possible values:
- no-lp-attn : no loop attenuation
- lp-attn : loop attenuation
Parameter type: <Shdsl::SNR>
( no-snr
| snr )
Possible values:
- no-snr : no snr margin alarm
- snr : snr margin alarm
Parameter type: <Shdsl::DC>
( no-dc
| dc )
Possible values:
- no-dc : no dc continuity fault
- dc : dc continuity fault
Parameter type: <Shdsl::Dev>
( no-dev

loss of word
This element is only shown in
detail mode.

loop attenuation alarm


This element is only shown in
detail mode.

snr margin alarm


This element is only shown in
detail mode.

dc continuity fault
This element is only shown in
detail mode.

device fault
This element is only shown in

Released

2519

93 SHDSL Status Commands

name

seg-st-conf

seg-st-lp-act

seg-st-no-con

seg-st-lcd

seg-st-lop

seg-st-ncd

seg-st-act-fail

lpbk-stat

snr-mgn

2520

Released

Type

Description

| dev )
Possible values:
- no-dev : no device fault
- dev : device fault
Parameter type: <Shdsl::Conf>
( no-conf
| conf )
Possible values:
- no-conf : no configuration error
- conf : configuration error
Parameter type: <Shdsl::LpAct>
( no-lp-act
| lp-act )
Possible values:
- no-lp-act : no loopback active
- lp-act : loopback active
Parameter type: <Shdsl::NoCon>
( no-no-con
| no-con )
Possible values:
- no-no-con : conform to stu-c of stu-r initiated management
flow
- no-con : not conform to stu-c of stu-r initiated management
flow
Parameter type: <Shdsl::LCD>
( no-lcd
| lcd )
Possible values:
- no-lcd : no ATM loss of cell delineation
- lcd : ATM loss of cell delineation
Parameter type: <Shdsl::LOP>
( no-lop
| lop )
Possible values:
- no-lop : no loss of power
- lop : loss of power
Parameter type: <Shdsl::NCD>
( no-ncd
| ncd )
Possible values:
- no-ncd : disable no-cell-delineation
- ncd : no cell delineation
Parameter type: <Shdsl::ActFail>
( no-act-fail
| act-fail )
Possible values:
- no-act-fail : no activation failure
- act-fail : activation failure
Parameter type: <Shdsl::SegmentTermLoopbackState>
( no-lpbk
| norm
| spec )
Possible values:
- no-lpbk : no loopback
- norm : normal loopback
- spec : special loopback
Parameter type: <Shdsl::SegmentTerminationSnrMargin>

detail mode.

configuration error
This element is only shown in
detail mode.

loopback active
This element is only shown in
detail mode.

not conform to stu-c of stu-r


initiated management flow
This element is only shown in
detail mode.

ATM loss of cell delineation


This element is only shown in
detail mode.

loss of power
This element is only shown in
detail mode.

no cell delineation
This element is only shown in
detail mode.

activation failure
This element is only shown in
detail mode.

the loopback mode at this


SHDSL segment termination
This element is always shown.

the SNR margin at this SHDSL

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name

lp-at

pbo-l1

tip-ring-reversal

pbo-mode

curr-data-rate

act-state

act-fail
tc-pam-modu

3HH-04416-EBAA-TCZZA 01

Type

Description

- an SNR margin value measured for an SHDSL segment


- unit: db
- range: [-128...127]
Parameter type: <Shdsl::SegmentTermLoopAttenuation>
- a loop attenuation value measured for an SHDSL segment
- unit: db
- range: [-128...127]
Parameter type: <Shdsl::SegmentTermPowerBackoffLv1>
- power backoff level 1 value measured for SHDSL segment
- unit: db
- range: [0...31]
Parameter type: <Shdsl::SegmentTermTRReversal>
( normal
| reversed )
Possible values:
- normal : normal mode
- reversed : reversed mode
Parameter type: <Shdsl::SegmentTerminationPBOStatus>
( default
| selected
| disabled )
Possible values:
- default : default mode
- selected : selected mode
- disabled : disable PBO
Parameter
type:
<Shdsl::SegmentTerminationCurrentDataRate>
- the current shdsl data rate of this segment termination
- unit: kb/s
- range: [0,192...5696]
Parameter
type:
<Shdsl::SegmentTerminationActivationState>
( active
| idle
| unknown
| initialization
| exception
| testing
| fwdownloading )
Possible values:
- active : the state is active
- idle : the state is idle
- unknown : the status is unknown
- initialization : the state is initializing
- exception : the state is exception
- testing : the state is testing
- fwdownloading : the state is firmware downloading
Parameter type: <UnsignedSignedInteger>
- an unsigned integer

segment termination
This element is always shown.

Parameter
<Shdsl::SegmentTerminationTCPAMModulation>
( tc-pam32
| tc-pam16
| unknown )
Possible values:
- tc-pam32 : tcPam32 modulation

the loop attenuation at this


SHDSL segment termination
This element is always shown.
the power backoff level 1 value at
this SHDSL segment termination
This element is always shown.
the tip/ring pair state at this
SHDSL segment termination
This element is always shown.

the power backoff state at this


SHDSL segment termination
This element is always shown.

the current shdsl data rate of this


segment termination
This element is always shown.
the state of this segment
termination
This element is always shown.

the coded reason of activation


failure
This element is always shown.
type: the current TC-PAM modulation
of the segment termination
This element is always shown.

Released

2521

93 SHDSL Status Commands

name

Type

Description

- tc-pam16 : tcPam16 modulation


- unknown : unknown modulation

2522

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.6 SHDSL Segment Counters Current Interval


Status Command
Command Description
This command displays the operational data of individual segment end points in an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl segment-counters current-15min [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide>
] [ wire-pair <Shdsl::SegmentTerminationWirePair> ] ]

Command Parameters
Table 93.6-1 "SHDSL Segment Counters Current Interval Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C

unit-id

3HH-04416-EBAA-TCZZA 01

Description

Released

2523

93 SHDSL Status Commands

Resource Identifier

Type

Description

- stu-r : the SHDSL unit is STU-R


- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3
- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Parameter type: <Shdsl::SegmentTerminationWirePair>
Format:
( one
| two
| three
| four )
Possible values:
- one : the first pair
- two : the second pair
- three : the third pair
- four : the fourth pair

side

wire-pair

the particular side of an SHDSL


unit in an SHDSL segment

the particular wire pair of an


SHDSL segment

Command Output
Table 93.6-2 "SHDSL Segment Counters Current Interval Status Command" Display parameters
Specific Information
name
time-el

Description

Parameter
type: the elapsed seconds in the current
<Shdsl::SegmentTermCurr15MTimeElapsed>
15-minute interval
- an elapsed seconds in the current 15-minute interval
This element is always shown.
- unit: sec
Parameter type: <Counter>
number of errored seconds
- 32 bit counter
This element is always shown.
Parameter type: <Counter>
number of severely errored
- 32 bit counter
seconds
This element is always shown.
Parameter type: <Counter>
number of CRC anomalies
- 32 bit counter
This element is always shown.
Parameter type: <Counter>
number of loss of sync word
- 32 bit counter
This element is always shown.
Parameter type: <Counter>
number of unavailable seconds
- 32 bit counter
This element is always shown.
Parameter
type: the number of previous intervals
<Shdsl::SegmentTermCurr15MValidIntervals>
for which data has been stored
- a number of previous intervals for which data has been This element is always shown.
stored
- range: [0...96]
Parameter type: <Shdsl::IntervalInvalidDataFlag>
validity flag of the corresponding
( true
PM data in current 15 minutes
| false )
This element is always shown.

es
ses
crc
losws
uas
va-int

inv-flag

2524

Type

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name

re-init-fail

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of failed re-inits


This element is always shown.

Released

2525

93 SHDSL Status Commands

93.7 SHDSL Segment Counters Current Day Status


Command
Command Description
This command displays the current day counters of individual segment end points in an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl segment-counters current-1day [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide> ]
[ wire-pair <Shdsl::SegmentTerminationWirePair> ] ]

Command Parameters
Table 93.7-1 "SHDSL Segment Counters Current Day Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C

unit-id

2526

Released

Description

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

Resource Identifier

side

wire-pair

Type

Description

- stu-r : the SHDSL unit is STU-R


- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3
- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Parameter type: <Shdsl::SegmentTerminationWirePair>
Format:
( one
| two
| three
| four )
Possible values:
- one : the first pair
- two : the second pair
- three : the third pair
- four : the fourth pair

the particular side of an SHDSL


unit in an SHDSL segment

the particular wire pair of an


SHDSL segment

Command Output
Table 93.7-2 "SHDSL Segment Counters Current Day Status Command" Display parameters
Specific Information
name
time-el

es
ses
crc
losws
uas
va-int

inv-flag

3HH-04416-EBAA-TCZZA 01

Type
Parameter
<Shdsl::SegmentTermCurr1DTimeElapsed>
- an elapsed seconds in the current day interval
- unit: sec
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

Description
type: the elapsed seconds in the current
day interval
This element is always shown.

number of errored seconds


This element is always shown.
number of severely errored
seconds
This element is always shown.
Parameter type: <Counter>
number of CRC anomalies
- 32 bit counter
This element is always shown.
Parameter type: <Counter>
number of loss of sync word
- 32 bit counter
This element is always shown.
Parameter type: <Counter>
number of unavailable seconds
- 32 bit counter
This element is always shown.
Parameter
type: the number of previous intervals
<Shdsl::SegmentTermCurr1DValidIntervals>
for which data has been stored
- a number of previous intervals for which data has been This element is always shown.
stored
- range: [0...30]
Parameter type: <Shdsl::IntervalInvalidDataFlag>
validity flag of the corresponding
( true
PM data in current day
| false )
This element is always shown.

Released

2527

93 SHDSL Status Commands

name

re-init-fail

2528

Released

Type

Description

Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

number of failed re-inits


This element is always shown.

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.8 SHDSL Segment Counters Previous Interval


Status Command
Command Description
This command displays the previous interval counters of individual segment end points in an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl segment-counters previous-15min [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side
<Shdsl::SegmentSide> ] [ wire-pair <Shdsl::SegmentTerminationWirePair> ] [ int-no <Shdsl::IntervalNumber> ] ]

Command Parameters
Table 93.8-1 "SHDSL Segment Counters Previous Interval Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C

unit-id

3HH-04416-EBAA-TCZZA 01

Description

Released

2529

93 SHDSL Status Commands

Resource Identifier

Type

Description

- stu-r : the SHDSL unit is STU-R


- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3
- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Parameter type: <Shdsl::SegmentTerminationWirePair>
Format:
( one
| two
| three
| four )
Possible values:
- one : the first pair
- two : the second pair
- three : the third pair
- four : the fourth pair
Parameter type: <Shdsl::IntervalNumber>
Format:
- a performance interval number
- range: [1...96]

side

wire-pair

int-no

the particular side of an SHDSL


unit in an SHDSL segment

the particular wire pair of an


SHDSL segment

the performance interval number

Command Output
Table 93.8-2 "SHDSL Segment Counters Previous Interval Status Command" Display parameters
Specific Information
name
mon-sec
es
ses
crc

Description

Parameter type: <Shdsl::PreviousIntevalMoniSecs>


- a monitored seconds number
- unit: sec
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

number of actually monitored


seconds in this interval
This element is always shown.
number of errored seconds
This element is always shown.
number of severely errored
seconds
This element is always shown.
number of CRC anomalies
This element is always shown.
number of loss of sync word
This element is always shown.
number of unavailable seconds
This element is always shown.
validity flag of the corresponding
PM data in previous 15-minutes
interval
This element is always shown.

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Shdsl::IntervalInvalidDataFlag>
( true
| false )
Possible values:
- true : data is not valid

losws
uas
inv-flag

2530

Type

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

name
interval-time
re-init-fail

3HH-04416-EBAA-TCZZA 01

Type

Description

- false : data is valid


Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)
Parameter type: <Counter>
- 32 bit counter

specifies the start time of interval


This element is always shown.
number of failed re-inits
This element is always shown.

Released

2531

93 SHDSL Status Commands

93.9 SHDSL Segment Counters Previous Day


Status Command
Command Description
This command displays the previous day counters of individual segment end points in an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl segment-counters previous-1day [ (if-index) [ unit-id <Shdsl::UnitId> ] [ side <Shdsl::SegmentSide>
] [ wire-pair <Shdsl::SegmentTerminationWirePair> ] [ int-no <Shdsl::Interval1DayNumber> ] ]

Command Parameters
Table 93.9-1 "SHDSL Segment Counters Previous Day Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C

unit-id

2532

Released

Description

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

Resource Identifier

side

wire-pair

int-no

Type

Description

- stu-r : the SHDSL unit is STU-R


- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3
- sru-4 : the SHDSL unit is SRU-4
- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side
Parameter type: <Shdsl::SegmentTerminationWirePair>
Format:
( one
| two
| three
| four )
Possible values:
- one : the first pair
- two : the second pair
- three : the third pair
- four : the fourth pair
Parameter type: <Shdsl::Interval1DayNumber>
Format:
- a performance interval one day number
- range: [1...30]

the particular side of an SHDSL


unit in an SHDSL segment

the particular wire pair of an


SHDSL segment

the performance interval number

Command Output
Table 93.9-2 "SHDSL Segment Counters Previous Day Status Command" Display parameters
Specific Information
name
mon-sec
es
ses
crc
losws
uas
inv-flag

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::PreviousInteval1DayMoniSecs>


- a monitored seconds number
- unit: sec
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

number of actually monitored


seconds in this interval
This element is always shown.
number of errored seconds
This element is always shown.
number of severely errored
seconds
This element is always shown.
number of CRC anomalies
This element is always shown.
number of loss of sync word
This element is always shown.
number of unavailable seconds
This element is always shown.
validity flag of the corresponding
PM data in previous day interval
This element is always shown.

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Shdsl::IntervalInvalidDataFlag>
( true
| false )
Possible values:
- true : data is not valid

Released

2533

93 SHDSL Status Commands

name
interval-time
re-init-fail

2534

Released

Type

Description

- false : data is valid


Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)
Parameter type: <Counter>
- 32 bit counter

specifies the start time of interval


This element is always shown.
number of failed re-inits
This element is always shown.

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.10 SHDSL Span Current Interval Performance


Data Status Command
Command Description
This command displays the current interval performance data of an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl span-counters current-15min [ (if-index) ]

Command Parameters
Table 93.10-1 "SHDSL Span Current Interval Performance Data Status Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 93.10-2 "SHDSL Span Current Interval Performance Data Status Command" Display
parameters
Specific Information
name
time-el
re-init

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::PMCurr15MinTimeElapsed>


- an elapsed seconds in the current 15-minute interval
- unit: sec
Parameter type: <Counter>
- 32 bit counter

the elapsed seconds in the current


15-minute interval
This element is always shown.
number of total reinitializations
This element is always shown.

Released

2535

93 SHDSL Status Commands

name

Type

Description

re-init-lpr

Parameter type: <Counter>


- 32 bit counter

valid-interval

Parameter type: <Shdsl::PM15MinValidIntervals>


- number of previous intrvl for which data is stored
- range: [0...96]
Parameter type: <Counter>
- 32 bit counter

number of total reinitializations


due to lpr events
This element is always shown.
the number of previous intervals
for which data has been stored
This element is always shown.
Count of the re-initializations
failed
This element is always shown.
validity flag of the corresponding
PM data in current 15 minutes
This element is always shown.

re-init-fail
inv-flag

2536

Parameter type: <Shdsl::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.11 SHDSL Span Current Day Performance Data


Status Command
Command Description
This command displays the current day performance data of an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl span-counters current-1day [ (if-index) ]

Command Parameters
Table 93.11-1 "SHDSL Span Current Day Performance Data Status Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 93.11-2 "SHDSL Span Current Day Performance Data Status Command" Display
parameters
Specific Information
name
time-el
re-init

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shdsl::PMCurr1DayTimeElapsed>


- an elapsed seconds in the current day interval
- unit: sec
Parameter type: <Counter>
- 32 bit counter

the elapsed seconds in the current


day interval
This element is always shown.
number of total reinitializations
This element is always shown.

Released

2537

93 SHDSL Status Commands

name

Type

Description

re-init-lpr

Parameter type: <Counter>


- 32 bit counter

valid-interval

Parameter type: <Shdsl::PM1DayValidIntervals>


- number of previous 1day intrvl for which data is stored
- range: [0...30]
Parameter type: <Counter>
- 32 bit counter

number of total reinitializations


due to lpr events
This element is always shown.
the number of previous intervals
for which data has been stored
This element is always shown.
Count of the re-initializations
failed
This element is always shown.
validity flag of the corresponding
PM data in current day
This element is always shown.

re-init-fail
inv-flag

2538

Parameter type: <Shdsl::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

Released

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.12 SHDSL Span Previous Interval Performance


Data Status Command
Command Description
This command displays the previous interval performance data of an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl span-counters previous-15min [ (if-index) [ interval-number <Shdsl::PM15MinIntervalNumber> ] ]

Command Parameters
Table 93.12-1 "SHDSL Span Previous Interval Performance Data Status Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::PM15MinIntervalNumber>
the performance interval number
Format:
- a performance interval number
- range: [1...96]

interval-number

Description

Command Output
Table 93.12-2 "SHDSL Span Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name

Type

Description

moni-secs

Parameter type: <Shdsl::PM15MinIntevalMoniSecs>

number of actually monitored

3HH-04416-EBAA-TCZZA 01

Released

2539

93 SHDSL Status Commands

name
re-init
re-init-lpr
re-init-fail

Description

- a monitored seconds in a previous 15-minute interval


- unit: sec
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

seconds in this interval


This element is always shown.
number of total reinitializations
This element is always shown.
number of total reinitializations
due to lpr events
This element is always shown.
Count of re-initializations Failed
This element is always shown.
validity of the corresponding PM
data in previous 15-minutes
This element is always shown.

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Shdsl::IntervalInvalidDataFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)

inv-flag

interval-time

2540

Type

Released

specifies the start time of interval


This element is always shown.

3HH-04416-EBAA-TCZZA

01

93 SHDSL Status Commands

93.13 SHDSL Span Previous Day Performance Data


Status Command
Command Description
This command displays the previous day performance data of an SHDSL span.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show shdsl span-counters previous-1day [ (if-index) [ interval-number <Shdsl::PM1DayIntervalNumber> ] ]

Command Parameters
Table 93.13-1 "SHDSL Span Previous Day Performance Data Status Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::PM1DayIntervalNumber>
the performance interval number
Format:
- a performance interval number
- range: [1...30]

interval-number

Description

Command Output
Table 93.13-2 "SHDSL Span Previous Day Performance Data Status Command" Display
parameters
Specific Information
name

Type

Description

moni-secs

Parameter type: <Shdsl::PM1DayIntevalMoniSecs>

number of actually monitored

3HH-04416-EBAA-TCZZA 01

Released

2541

93 SHDSL Status Commands

name
re-init
re-init-lpr
re-init-fail

Description

- a monitored seconds in a previous 1 day interval


- unit: sec
Parameter type: <Counter>
- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

seconds in this interval


This element is always shown.
number of total reinitializations
This element is always shown.
number of total reinitializations
due to lpr events
This element is always shown.
Count of re-initializations Failed
This element is always shown.
validity of the corresponding PM
data in previous day interval
This element is always shown.

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Shdsl::IntervalInvalidDataFlag>
( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Xdsl::PmTimeStamp>
- Timestamp for Pm interval(yyyymmdd:hour:minutes)

inv-flag

interval-time

2542

Type

Released

specifies the start time of interval


This element is always shown.

3HH-04416-EBAA-TCZZA

01

94- IMA Status Commands

94.1 IMA Status Command Tree


94.2 IMA Group Status Command
94.3 IMA Group Near-End Current Interval Performance
Data Status Command
94.4 IMA Group Near-End Previous Interval Performance
Data Status Command
94.5 IMA Group Far-End Current Interval Performance Data
Status Command
94.6 IMA Group Far-End Previous Interval Performance
Data Status Command
94.7 IMA Link Status Command
94.8 IMA Link Near-End Current Interval Performance Data
Status Command
94.9 IMA Link Near-End Previous Interval Performance
Data Status Command
94.10 IMA Link Far-End Current Interval Performance Data
Status Command
94.11 IMA Link Far-End Previous Interval Performance
Data Status Command

3HH-04416-EBAA-TCZZA 01

94-2544
94-2545
94-2550
94-2552
94-2554
94-2556
94-2558
94-2562
94-2564
94-2566
94-2568

Released

2543

94 IMA Status Commands

94.1 IMA Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IMA Status Commands".

Command Tree
----show
----ima
----group
----state
- (if-index)
----counters
----near-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----far-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----link
----state
- (if-index)
----counters
----near-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no
----far-end
----current-interval
- (if-index)
----previous-interval
- (if-index)
- interval-no

2544

Released

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

94.2 IMA Group Status Command


Command Description
This command displays the IMA group status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima group state [ (if-index) ]

Command Parameters
Table 94.2-1 "IMA Group Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.2-2 "IMA Group Status Command" Display parameters
Specific Information
name
grp-if-index

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::ImaLine>


the logical interface number
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / assigned to this IMA group
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Released

2545

94 IMA Status Commands

name

Type

Description

near-end
short name: ne

Parameter type: <Ima::GroupState>


( ( not-conf | nc )
| ( start-up | su )
| ( start-up-ack | sua )
| ( conf-abt-unsupported | cau )
| ( conf-abt-incomp-sym | cais )
| ( conf-abt-other | cao )
| ( insuff-links | il )
| ( blked | blk )
| op )
Possible values:
- not-conf : not configured
- nc : not configured
- start-up : start up
- su : start up
- start-up-ack : start up acknowledgement
- sua : start up acknowledgement
- conf-abt-unsupported : config abort unsupported m
- cau : config abort unsupported m
- conf-abt-incomp-sym : config abort incompatible
symmetry
- cais : config abort incompatible symmetry
- conf-abt-other : config abort other
- cao : config abort other
- insuff-links : insufficient links
- il : insufficient links
- blked : blocked
- blk : blocked
- op : operational
Parameter type: <Ima::GroupState>
( ( not-conf | nc )
| ( start-up | su )
| ( start-up-ack | sua )
| ( conf-abt-unsupported | cau )
| ( conf-abt-incomp-sym | cais )
| ( conf-abt-other | cao )
| ( insuff-links | il )
| ( blked | blk )
| op )
Possible values:
- not-conf : not configured
- nc : not configured
- start-up : start up
- su : start up
- start-up-ack : start up acknowledgement
- sua : start up acknowledgement
- conf-abt-unsupported : config abort unsupported m
- cau : config abort unsupported m
- conf-abt-incomp-sym : config abort incompatible
symmetry
- cais : config abort incompatible symmetry
- conf-abt-other : config abort other
- cao : config abort other
- insuff-links : insufficient links
- il : insufficient links
- blked : blocked
- blk : blocked

the operational state of the


near-end IMA group state
machine
This element is always shown.

far-end
short name: fe

2546

Released

the operational state of the


far-end IMA group state machine
This element is always shown.

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name
failure-status
short name: fa-st

fe-tx-clk-mode

tx-timing-ref-link

rx-timing-ref-link

3HH-04416-EBAA-TCZZA 01

Type

Description

- op : operational
Parameter type: <Ima::GroupFailureStatus>
the failure status of the IMA
( ( no-fail | nf )
group
| ( start-up-ne | sun )
This element is always shown.
| ( start-up-fe | suf )
| ( inv-m-val-ne | imvn )
| ( inv-m-val-fe | imvf )
| ( fail-asym-ne | fan )
| ( fail-asym-fe | faf )
| ( insuff-links-ne | iln )
| ( insuff-links-fe | ilf )
| ( blked-ne | bn )
| ( blked-fe | bf )
| ( other-fail | of ) )
Possible values:
- no-fail : no failure
- nf : no failure
- start-up-ne : start up near end
- sun : start up near end
- start-up-fe : start up far end
- suf : start up far end
- inv-m-val-ne : invalid m-value near end
- imvn : invalid m-value near end
- inv-m-val-fe : invalid m-value far end
- imvf : invalid m-value far end
- fail-asym-ne : failed asymmetric near end
- fan : failed asymmetric near end
- fail-asym-fe : failed asymmetric far end
- faf : failed asymmetric far end
- insuff-links-ne : insufficient links near end
- iln : insufficient links near end
- insuff-links-fe : insufficient links far end
- ilf : insufficient links far end
- blked-ne : blocked near end
- bn : blocked near end
- blked-fe : blocked far end
- bf : blocked far end
- other-fail : other failure
- of : other failure
Parameter type: <Ima::GroupTxClkMode>
the transmit clocking mode of the
( ctc
IMA group far end
| itc )
This element is only shown in
Possible values:
detail mode.
- ctc : the transmit clocking mode is ctc
- itc : the transmit clocking mode is itc
Parameter type: <Itf::ShdslLine>
the transmit timing reference link
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface number
<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Itf::ShdslLine>
the receive timing reference link

Released

2547

94 IMA Status Commands

name

Type

rx-ima-id
short name: rii
rx-frm-len

least-delay-link

diff-delay-max-obs

rs

uas

near-end-fail
short name: ne-fa
fe-num-failures
short name: fe-fa
tx-avail-cell-rate

rx-avail-cell-rate

2548

Description

<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface number


<Eqpt::PortId>
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::GroupRxImaId>
the imd id used by the far-end
- an imd id used by the far-end ima function
ima function
- range: [0...255]
This element is always shown.
Parameter type: <Ima::GroupFrameLength>
the frame length used by the
( m32
remote IMA function
| m64
This element is only shown in
| m128
detail mode.
| m256 )
Possible values:
- m32 : the frame length is 32 cells
- m64 : the frame length is 64 cells
- m128 : the frame length is 128 cells
- m256 : the frame length is 256 cells
Parameter type: <Itf::ShdslLine>
the interface number identifies
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the smallest propagation delay
<Eqpt::PortId>
link
Field type <Eqpt::RackId>
This element is only shown in
- the rack number
detail mode.
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::GroupDiffDelayMaxObs>
the
maximum
observed
- a maximum observed milliseconds of delay differential
milliseconds of delay differential
- unit: ms
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
the running seconds of the ima
- a signed integer
group
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
the unavailable seconds of the
- a signed integer
ima group
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
the number of failures occurred at
- a signed integer
the near end
This element is always shown.
Parameter type: <SignedInteger>
the number of failures occurred at
- a signed integer
the far end
This element is always shown.
Parameter type: <SignedInteger>
the available cell rate in transmit
- a signed integer
direction
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
the available cell rate in receive

Released

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

- a signed integer

direction
This element is only shown in
detail mode.
the number of links configured to
transmit
This element is always shown.
the number of links configured to
receive
This element is always shown.
the number of links configured to
transmit and must be acitve
This element is always shown.
the number of links configured to
receive and must be acitve
This element is always shown.

tx-num-cfg-links
short name: tncl

Parameter type: <SignedInteger>


- a signed integer

rx-num-cfg-links
short name: rncl

Parameter type: <SignedInteger>


- a signed integer

tx-num-act-links
short name: tnal

Parameter type: <SignedInteger>


- a signed integer

rx-num-act-links
short name: rnal

Parameter type: <SignedInteger>


- a signed integer

3HH-04416-EBAA-TCZZA 01

Released

2549

94 IMA Status Commands

94.3 IMA Group Near-End Current Interval


Performance Data Status Command
Command Description
This command displays the IMA groups near-end current interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima group counters near-end current-interval [ (if-index) ]

Command Parameters
Table 94.3-1 "IMA Group Near-End Current Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.3-2 "IMA Group Near-End Current Interval Performance Data Status Command"
Display parameters
Specific Information
name
time-el
valid-interval

2550

Released

Type

Description

Parameter type: <Ima::GroupCurrentTimeElapsed>


- a number of time elapsed in a current interval
- range: [0...899]
Parameter type: <Ima::GroupCurrentValidIntervals>
- a number of previous valid intervals

the number of time elapsed in the


current interval
This element is always shown.
the number of previous valid
intervals

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

uas

- range: [0...32]
Parameter type: <Gauge>
- gauge

This element is always shown.


the number of unavailable
seconds in the current interval
This element is always shown.
the number of failures in the
current interval
This element is always shown.
validity flag of the corresponding
Ima-Group-Near-End's PM data
in current 15 minutes
This element is always shown.

fc

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2551

94 IMA Status Commands

94.4 IMA Group Near-End Previous Interval


Performance Data Status Command
Command Description
This command displays the IMA groups near-end previous interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima group counters near-end previous-interval [ (if-index) [ interval-no <Ima::GroupIntervalNumber> ] ]

Command Parameters
Table 94.4-1 "IMA Group Near-End Previous Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::GroupIntervalNumber>
the number of the interval
Format:
number
- a number of a interval number
- range: [1...32]

interval-no

Description

Command Output
Table 94.4-2 "IMA Group Near-End Previous Interval Performance Data Status Command"
Display parameters
Specific Information
name

Type

Description

uas

Parameter type: <Gauge>

the

2552

Released

3HH-04416-EBAA-TCZZA

number

of

unavailable

01

94 IMA Status Commands

name

Type

Description

- gauge

seconds in the previous interval


This element is always shown.
the number of failures in the
previous interval
This element is always shown.
validity flag of the corresponding
Ima-Group-Near-End's PM data
in one of the previous 32
intervals of 15-minutes
This element is always shown.

fc

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2553

94 IMA Status Commands

94.5 IMA Group Far-End Current Interval


Performance Data Status Command
Command Description
This command displays the IMA groups far-end current interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima group counters far-end current-interval [ (if-index) ]

Command Parameters
Table 94.5-1 "IMA Group Far-End Current Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.5-2 "IMA Group Far-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name
time-el
valid-interval

2554

Released

Type

Description

Parameter type: <Ima::GroupFarEndTimeElapsed>


- a number of time elapsed in a current interval
- range: [0...899]
Parameter type: <Ima::GroupFarEndValidIntervals>
- a number of previous valid intervals

the number of time elapsed in the


far end interval
This element is always shown.
the number of the far end valid
intervals

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

fc

- range: [0...32]
Parameter type: <Gauge>
- gauge

This element is always shown.


the number of failures in the far
end interval
This element is always shown.
validity flag of the corresponding
Ima-Group-Far-End's PM data in
current 15 minutes
This element is always shown.

inv-flag

3HH-04416-EBAA-TCZZA 01

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

Released

2555

94 IMA Status Commands

94.6 IMA Group Far-End Previous Interval


Performance Data Status Command
Command Description
This command displays the IMA groups far-end previous interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima group counters far-end previous-interval [ (if-index) [ interval-no <Ima::GroupFarEndIntervalNumber>
]]

Command Parameters
Table 94.6-1 "IMA Group Far-End Previous Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::GroupFarEndIntervalNumber>
the number of the previous
Format:
interval number
- a number of a previous interval number
- range: [1...32]

interval-no

Description

Command Output
Table 94.6-2 "IMA Group Far-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information

2556

Released

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

fc

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

the number of failures in the far


end previous interval
This element is always shown.
validity flag of the corresponding
Ima-Group-Far-End's PM data in
one of the previous 32 intervals
of 15-minutes
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2557

94 IMA Status Commands

94.7 IMA Link Status Command


Command Description
This command displays the IMA link status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima link state [ (if-index) ]

Command Parameters
Table 94.7-1 "IMA Link Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.7-2 "IMA Link Status Command" Display parameters
Specific Information
name
ne-tx-state

2558

Released

Type

Description

Parameter type: <Ima::LinkState>


( not-in-grp
| uus-not-gi-rea
| uus-fau
| uus-mis-con
| uus-blk
| uus-fail
| use
| act )
Possible values:
- not-in-grp : not in group

the mandatory state of the


near-end transmit link
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

ne-rx-state

fe-tx-state

fe-rx-state

3HH-04416-EBAA-TCZZA 01

Type
- uus-not-gi-rea : unusable not given reason
- uus-fau : unusable fault
- uus-mis-con : unusable misconnected
- uus-blk : unusable blocked
- uus-fail : unusable failed
- use : usable
- act : active
Parameter type: <Ima::LinkState>
( not-in-grp
| uus-not-gi-rea
| uus-fau
| uus-mis-con
| uus-blk
| uus-fail
| use
| act )
Possible values:
- not-in-grp : not in group
- uus-not-gi-rea : unusable not given reason
- uus-fau : unusable fault
- uus-mis-con : unusable misconnected
- uus-blk : unusable blocked
- uus-fail : unusable failed
- use : usable
- act : active
Parameter type: <Ima::LinkState>
( not-in-grp
| uus-not-gi-rea
| uus-fau
| uus-mis-con
| uus-blk
| uus-fail
| use
| act )
Possible values:
- not-in-grp : not in group
- uus-not-gi-rea : unusable not given reason
- uus-fau : unusable fault
- uus-mis-con : unusable misconnected
- uus-blk : unusable blocked
- uus-fail : unusable failed
- use : usable
- act : active
Parameter type: <Ima::LinkState>
( not-in-grp
| uus-not-gi-rea
| uus-fau
| uus-mis-con
| uus-blk
| uus-fail
| use
| act )
Possible values:
- not-in-grp : not in group
- uus-not-gi-rea : unusable not given reason
- uus-fau : unusable fault
- uus-mis-con : unusable misconnected

Description

the mandatory state of the


near-end receive link
This element is only shown in
detail mode.

the mandatory state of the far-end


transmit link
This element is only shown in
detail mode.

the mandatory state of the far-end


receive link
This element is only shown in
detail mode.

Released

2559

94 IMA Status Commands

name

Type

Description

ima-violations
short name: iv

- uus-blk : unusable blocked


- uus-fail : unusable failed
- use : usable
- act : active
Parameter type: <Ima::LinkFailureStatus>
( no-fail
| ima-lk-fail
| lif-fail
| lods-fail
| mis-con
| blked
| fau
| fe-tx-lk-uus
| fe-rx-lk-uus )
Possible values:
- no-fail : no failure
- ima-lk-fail : ima link failure
- lif-fail : lif failure
- lods-fail : lods failure
- mis-con : mis connected
- blked : blocked
- fau : fault
- fe-tx-lk-uus : far end tx link unusable
- fe-rx-lk-uus : far end rx link unusable
Parameter type: <Ima::LinkFailureStatus>
( no-fail
| ima-lk-fail
| lif-fail
| lods-fail
| mis-con
| blked
| fau
| fe-tx-lk-uus
| fe-rx-lk-uus )
Possible values:
- no-fail : no failure
- ima-lk-fail : ima link failure
- lif-fail : lif failure
- lods-fail : lods failure
- mis-con : mis connected
- blked : blocked
- fau : fault
- fe-tx-lk-uus : far end tx link unusable
- fe-rx-lk-uus : far end rx link unusable
Parameter type: <Ima::LinkTxLid>
- an outgoing LID used on a link
- range: [0...31]
Parameter type: <Ima::LinkRxLid>
- an incoming LID used on a link
- range: [0...31]
Parameter type: <Ima::LinkRelDelay>
- a number of milliseconds of a measured delay
- unit: ms
Parameter type: <SignedInteger>
- a signed integer

oif-anomalies

Parameter type: <SignedInteger>

ne-rx-fail-stat

fe-rx-fail-stat

tx-lid
short name: tl
rx-lid
short name: rl
rel-delay
short name: rd

2560

Released

the mandatory link failure status


of the near-end receive link
This element is only shown in
detail mode.

the mandatory link failure status


of the far-end receive link
This element is only shown in
detail mode.

the outgoing LID used on the link


This element is always shown.
the incoming LID used on the
link
This element is always shown.
the latest measured delay on this
link relative to the link
This element is always shown.
the number of the count of
invalid ICP cells
This element is always shown.
the number of OIF anomalies

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

short name: oa

- a signed integer

ne-ses
short name: ns

Parameter type: <SignedInteger>


- a signed integer

fe-ses

Parameter type: <SignedInteger>


- a signed integer

ne-uas
short name: nu

Parameter type: <SignedInteger>


- a signed integer

fe-uas
short name: fu

Parameter type: <SignedInteger>


- a signed integer

ne-tx-uus
short name: ntu

Parameter type: <SignedInteger>


- a signed integer

ne-rx-uus
short name: nru

Parameter type: <SignedInteger>


- a signed integer

fe-tx-uus
short name: ftu

Parameter type: <SignedInteger>


- a signed integer

fe-rx-uus
short name: fru

Parameter type: <SignedInteger>


- a signed integer

ne-tx-fail
short name: ntf

Parameter type: <SignedInteger>


- a signed integer

ne-rx-fail
short name: nrf

Parameter type: <SignedInteger>


- a signed integer

fe-tx-fail
short name: ftf

Parameter type: <SignedInteger>


- a signed integer

fe-rx-fail
short name: frf

Parameter type: <SignedInteger>


- a signed integer

tx-stuffs
short name: ts

Parameter type: <SignedInteger>


- a signed integer

rx-stuffs
short name: rs

Parameter type: <SignedInteger>


- a signed integer

during non-SES-IMA
This element is always shown.
the number of the count of one
second intervals containing link
defects
This element is always shown.
the number of the count of one
second
intervals
containing
RDI-IMA defects
This element is only shown in
detail mode.
the number of the count of
unavailable seconds at near-end
This element is always shown.
the number of the count of
unavailable seconds at far-end
This element is always shown.
the number of the count of
unusable seconds at near end Tx
This element is always shown.
the number of the count of
unusable seconds at near end Rx
This element is always shown.
the number of the count of
unusable seconds at far end Tx
This element is always shown.
the number of the count of
unusable seconds at far end Rx
This element is always shown.
the number of the failure of the
near end transmit
This element is always shown.
the number of the failure of the
near end receive
This element is always shown.
the number of the failure of the
far end transmit
This element is always shown.
the number of the failure of the
far end receive
This element is always shown.
the number of the count of stuff
events in transmit
This element is always shown.
the number of the count of stuff
events in receive
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2561

94 IMA Status Commands

94.8 IMA Link Near-End Current Interval


Performance Data Status Command
Command Description
This command displays the IMA links near-end current interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima link counters near-end current-interval [ (if-index) ]

Command Parameters
Table 94.8-1 "IMA Link Near-End Current Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.8-2 "IMA Link Near-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name
time-el
valid-interval

2562

Released

Type

Description

Parameter type: <Ima::LinkCurrentTimeElapsed>


- a number of time elapsed in a current interval of a link
- range: [0...899]
Parameter type: <Ima::LinkCurrentValidIntervals>
- a number of previous valid intervals of a link

the number of time elapsed in the


current interval of the link
This element is always shown.
the number of previous valid
intervals of the link

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

iv

- range: [0...32]
Parameter type: <Gauge>
- gauge

This element is always shown.


the number of IMA violation
events in the current interval
This element is always shown.
the number of out of IMA frame
events in the current interval
This element is always shown.
the number of severely errored
seconds in the current interval
This element is always shown.
the number of unavailable
seconds in the current interval of
the link
This element is always shown.
the number of unusable seconds
in the current interval of the
transmit link
This element is always shown.
the number of unusable seconds
in the current interval of the
receive link
This element is always shown.
the number of failures in the
current interval of the transmit
link
This element is always shown.
the number of failures in the
current interval of the receive
link
This element is always shown.
the number of IMA stuffs in the
current interval of the transmit
link
This element is always shown.
the number of IMA stuffs in the
current interval of the receive
link
This element is always shown.
validity flag of the corresponding
Ima-Link-Near-End's PM data in
current 15 minutes
This element is always shown.

oif

Parameter type: <Gauge>


- gauge

ses

Parameter type: <Gauge>


- gauge

uas

Parameter type: <Gauge>


- gauge

tx-uus

Parameter type: <Gauge>


- gauge

rx-uus

Parameter type: <Gauge>


- gauge

tx-fc

Parameter type: <Gauge>


- gauge

rx-fc

Parameter type: <Gauge>


- gauge

tx-stuffs

Parameter type: <Gauge>


- gauge

rx-stuffs

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2563

94 IMA Status Commands

94.9 IMA Link Near-End Previous Interval


Performance Data Status Command
Command Description
This command displays the IMA links near-end previous interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima link counters near-end previous-interval [ (if-index) [ interval-no <Ima::LinkIntervalNumber> ] ]

Command Parameters
Table 94.9-1 "IMA Link Near-End Previous Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::LinkIntervalNumber>
the number of the interval value
Format:
in the link
- a number of a interval number in a link
- range: [1...32]

interval-no

Description

Command Output
Table 94.9-2 "IMA Link Near-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name

Type

Description

iv

Parameter type: <Gauge>

the number of ima violation

2564

Released

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

- gauge

events of the link in the previous


interval
This element is always shown.
the number of out of ima frame
events of the link in the previous
interval
This element is always shown.
the number of severely errored
seconds of the link in the
previous interval
This element is always shown.
the number of unavailable
seconds of the link in the
previous interval
This element is always shown.
the number of unusable seconds
of the transmit link in the
previous interval
This element is always shown.
the number of unusable seconds
of the receive link in the previous
interval
This element is always shown.
the number of failures of the
transmit link in the previous
interval
This element is always shown.
the number of failures of the
receive link in the previous
interval
This element is always shown.
the number of ima stuff events of
the transmit link in the previous
interval
This element is always shown.
the number of ima stuff events of
the receive link in the previous
interval
This element is always shown.
validity flag of the corresponding
Ima-Link-Near-End's PM data in
one of the previous 32 intervals
of 15-minutes
This element is always shown.

oif

Parameter type: <Gauge>


- gauge

ses

Parameter type: <Gauge>


- gauge

uas

Parameter type: <Gauge>


- gauge

tx-uus

Parameter type: <Gauge>


- gauge

rx-uus

Parameter type: <Gauge>


- gauge

tx-fc

Parameter type: <Gauge>


- gauge

rx-fc

Parameter type: <Gauge>


- gauge

tx-stuffs

Parameter type: <Gauge>


- gauge

rx-stuffs

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2565

94 IMA Status Commands

94.10 IMA Link Far-End Current Interval


Performance Data Status Command
Command Description
This command displays the IMA links far-end current interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima link counters far-end current-interval [ (if-index) ]

Command Parameters
Table 94.10-1 "IMA Link Far-End Current Interval Performance Data Status Command" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 94.10-2 "IMA Link Far-End Current Interval Performance Data Status Command" Display
parameters
Specific Information
name
time-el
valid-interval

2566

Released

Type

Description

Parameter type: <Ima::LinkFarEndTimeElapsed>


- a number of time elapsed of a link in a far end interval
- range: [0...899]
Parameter type: <Ima::LinkFarEndValidIntervals>
- a number of a far end valid intervals of a link

the number of time elapsed of the


link in the far end interval
This element is always shown.
the number of the far end valid
intervals of the link

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

ses

- range: [0...32]
Parameter type: <Gauge>
- gauge

This element is always shown.


the number of severely errored
seconds of the link in the current
interval
This element is always shown.
the number of unavailable
seconds of the link in the current
interval
This element is always shown.
the number of unusable seconds
of the transmit link in the current
interval
This element is always shown.
the number of unusable seconds
of the receive link in the current
interval
This element is always shown.
the number of failures of the
transmit link in the current
interval
This element is always shown.
the number of failures of the
receive link in the current interval
This element is always shown.
validity flag of the corresponding
Ima-Link-Far-End's PM data in
current 15 minutes
This element is always shown.

uas

Parameter type: <Gauge>


- gauge

tx-uus

Parameter type: <Gauge>


- gauge

rx-uus

Parameter type: <Gauge>


- gauge

tx-fc

Parameter type: <Gauge>


- gauge

rx-fc

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2567

94 IMA Status Commands

94.11 IMA Link Far-End Previous Interval


Performance Data Status Command
Command Description
This command displays the IMA links far-end previous interval status.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show ima link counters far-end previous-interval [ (if-index) [ interval-no <Ima::LinkFarEndIntervalNumber> ] ]

Command Parameters
Table 94.11-1 "IMA Link Far-End Previous Interval Performance Data Status Command"
Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Ima::LinkFarEndIntervalNumber>
the number of the previous
Format:
interval number in the far end
- a number of a interval number in a far end link
link
- range: [1...32]

interval-no

Description

Command Output
Table 94.11-2 "IMA Link Far-End Previous Interval Performance Data Status Command" Display
parameters
Specific Information
name

Type

Description

ses

Parameter type: <Gauge>

the number of severely errored

2568

Released

3HH-04416-EBAA-TCZZA

01

94 IMA Status Commands

name

Type

Description

- gauge

seconds of the far end link in the


previous interval
This element is always shown.
the number of unavailable
seconds of the far end link in the
previous interval
This element is always shown.
the number of unusable seconds
of the far end transmit link in the
previous interval
This element is always shown.
the number of unusable seconds
of the far end receive link in the
previous interval
This element is always shown.
the number of failures of the far
end transmit link in the previous
interval
This element is always shown.
the number of failures of the far
end receive link in the previous
interval
This element is always shown.
validity flag of the corresponding
Ima-Link-Far-End's PM data in
one of the previous 32 intervals
of 15-minutes
This element is always shown.

uas

Parameter type: <Gauge>


- gauge

tx-uus

Parameter type: <Gauge>


- gauge

rx-uus

Parameter type: <Gauge>


- gauge

tx-fc

Parameter type: <Gauge>


- gauge

rx-fc

Parameter type: <Gauge>


- gauge

inv-flag

Parameter type: <Ima::IntervalInvalidDataFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid

3HH-04416-EBAA-TCZZA 01

Released

2569

95- Voice Status Commands

95.1 Voice Status Command Tree


95.2 Voice Sip Server Status Commands
95.3 Voice Sip User Agent Access Point Show Commands
95.4 Voice Sip Statistics System Status Command
95.5 Voice Sip Statistics Perfinfo Status Command
95.6 Voice Sip Termination Statistics Command for
Current 15 Minutes
95.7 Voice Sip Termination Statistics Command for
Current Day
95.8 Voice Sip Termination Statistics Command for
Previous 15 Minutes
95.9 Voice Sip Termination Statistics Command for
Previous day
95.10 Voice Sip Call Statistics Command
95.11 Voice Sip board Statistics Command for Current one
Day
95.12 Voice Sip Board Statistics Command for Previous
day
95.13 Voice Sip Board Statistics Command for Current 15
Minutes
95.14 Voice Sip Board Statistics Command for Previous 15
Minutes
95.15 Voice Sip Statistics Perfinfo Status Command per
board
95.16 Voice Sip restoration: Redundancy Status
Commands
95.17 Voice Sip restoration: Redundancy Status
Commands
95.18 Voice Sip Redundancy Status Commands
95.19 Voice Sip Termination Status Commands
95.20 Voice Megaco Equipment Board Status Commands
95.21 Voice Megaco Equipment Status Commands
95.22 Voice Megaco MGI Status Commands
95.23 Voice Megaco Database Status Commands
95.24 Voice Megaco IP Status Commands
95.25 Voice Megaco SGI Status Commands

2570

Released

95-2571
95-2573
95-2574
95-2576
95-2577
95-2579
95-2582
95-2585
95-2588
95-2591
95-2593
95-2597
95-2601
95-2605
95-2609
95-2611
95-2613
95-2615
95-2616
95-2619
95-2621
95-2624
95-2626
95-2627
95-2628

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.1 Voice Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Voice Status Commands".

Command Tree
----show
----voice
----sip
----server
- (name)
----user-agent-ap
- (name)
- slot-id
----statistics
----system
----perf-info
- (if-index)
----termination
----current-15min
- (if-index)
----current-1day
- (if-index)
----prev-15min
- (if-index)
- interval-num
----prev-1day
- (if-index)
- interval-num
----call
- (if-index)
----interval
- (interval-num)
- start-time
- icid
----board
----current-1day
- (slot-id)
----prev-1day
- (slot-id)
- interval-num
----current-15min
- (slot-id)
----prev-15min
- (slot-id)
- interval-num
----board-perfinfo
- (slot-id)
----redundancy-node
----redundancy-state
- (admin-name)
- slot-id

3HH-04416-EBAA-TCZZA 01

Released

2571

95 Voice Status Commands

----ext-redundancy-state
- (admin-name)
- slot-id
- term-group
----redundancy-cmd
- (provider-name)
----termination
- (if-index)
----cluster
- (cluster-id)
----board
- (equip-id)
- board-id
----termination
- (equip-id)
- port-id
----media-gateway
- (media-gateway-id)
----database
----ip
----signal-gateway
- (signal-gateway-id)

2572

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.2 Voice Sip Server Status Commands


Command Description
This command allows the operator to show the Voice Sip Server profile.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip server [ (name) ]

Command Parameters
Table 95.2-1 "Voice Sip Server Status Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies this voice server
- length: x<=32

uniquely identify of this voice


server

Command Output
Table 95.2-2 "Voice Sip Server Status Commands" Display parameters
Specific Information
name
server-id
oper-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sip::ServerId>


- the SIP server table index
- range: [1...32]
Parameter type: <Sip::ServerOperStatus>
( up
| down )
Possible values:
- up : the status of the server opera is up
- down : the status of the server opera is down

server idr
This element is always shown.
the operational status of server
This element is always shown.

Released

2573

95 Voice Status Commands

95.3 Voice Sip User Agent Access Point Show


Commands
Command Description
This command allows the operator to show the Voice Sip user agent access point profile.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip user-agent-ap [ (name) [ slot-id <SIP::SlotIndex> ] ]

Command Parameters
Table 95.3-1 "Voice Sip User Agent Access Point Show Commands" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- uniquely identifies the User Agent
- length: 1<=x<=32
Parameter type: <SIP::SlotIndex>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt
| ntio
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt : nt-slot
- ntio : ntio-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

uniquely identify of the user


agent

slot-id

slot id associated with this user


agent access point

Command Output
Table 95.3-2 "Voice Sip User Agent Access Point Show Commands" Display parameters

2574

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

Specific Information
name
oper-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sip::UaApOperStatus>


( up
| down )
Possible values:
- up : the sip UaAp oper status is up
- down : the sip UaAp oper status is down

the opera status of user agent


access point
This element is always shown.

Released

2575

95 Voice Status Commands

95.4 Voice Sip Statistics System Status Command


Command Description
This command allows the operator to show the various system parameters including the number of configured and
available sip termination, the number of configured and unavailable sip termination, the number of unconfigured
sip termination.

User Level
The command can be accessed by operators with forStatsPerSystem privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics system

Command Output
Table 95.4-2 "Voice Sip Statistics System Status Command" Display parameters
Specific Information
name

Type

Description

config-avail-term

Parameter type: <Sip::NumberOfTerm>


- the number of termination

config-unavail-term

Parameter type: <Sip::NumberOfTerm>


- the number of termination

unconfig-term

Parameter type: <Sip::NumberOfTerm>


- the number of termination

The number of configured and


available sip termination
This element is always shown.
The number of configured and
unavailable sip termination
This element is always shown.
The number of unconfigured sip
termination
This element is always shown.

2576

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.5 Voice Sip Statistics Perfinfo Status Command


Command Description
This command allows the operator to show the various parameters including elapsed times for current 15-minutes
interval and 1-day interval per termination, the number of pervious 15-minutes interval and 1-day interval per
termination.

User Level
The command can be accessed by operators with forStatsPerLine privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics perf-info [ (if-index) ]

Command Parameters
Table 95.5-1 "Voice Sip Statistics Perfinfo Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 95.5-2 "Voice Sip Statistics Perfinfo Status Command" Display parameters
Specific Information
name

Type

Description

cur-15min-elapsedtime

Parameter type: <Sip::ElapsedTime>


- the elapsed time
- unit: sec

cur-1day-elapsedtime

Parameter type: <Sip::ElapsedTime>


- the elapsed time
- unit: sec

prev-15min-num

Parameter type: <Sip::PerfInterval>

number of second elapsed in


current 15 minutes interval
measurement
This element is always shown.
number of second elapsed in
current
1
day
interval
measurement
This element is always shown.
number of previous 15 minutes

3HH-04416-EBAA-TCZZA 01

Released

2577

95 Voice Status Commands

name
prev-1day-num

2578

Type

Description

- the number of interval

intervals
This element is always shown.
number of previous 1 day
intervals
This element is always shown.

Parameter type: <Sip::PerfInterval>


- the number of interval

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.6 Voice Sip Termination Statistics Command for


Current 15 Minutes
Command Description
This command allows the operator to show the Voice Sip Termination Statistics for current 15 minutes.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics termination current-15min [ (if-index) ]

Command Parameters
Table 95.6-1 "Voice Sip Termination Statistics Command for Current 15 Minutes" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 95.6-2 "Voice Sip Termination Statistics Command for Current 15 Minutes" Display
parameters
Specific Information
name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>

amount of time in sec that


statistics have been counted
This element is only shown in
detail mode.
validity of the corresponding

3HH-04416-EBAA-TCZZA 01

Released

2579

95 Voice Status Commands

name

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)

avg-rtrip-delay(ms)

peak-jitter(ms)

peak-rtrip-delay(ms)

avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

avg-jbfl-g723(%)

2580

Released

Type

Description

( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

performance monitoring data in


current 15m interval
This element is always shown.

number of rtp packets transmitted


by this termination in current
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this termination in current
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this termination in current
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this termination in current 15m
interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving rtp
- the number of lost rtp packets
packets for this termination in
current 15m interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this termination in
termination
current 15m interval
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this
- average of jitter for the termination
termination in current 15m
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this termination in current 15m
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this
- average of jitter for the termination
termination in current 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
termination in current 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this termination in current
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage
termination
for this termination in current
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

avg-jbfl-g729(%)

reg-req-suc

reg-req-fail

reg-active

out-call-ans

in-call-ans

3HH-04416-EBAA-TCZZA 01

Type

Description

- average of jitter buffer fill level percentage for the encoded with G723 percentage
termination
for this termination in current
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G729 percentage
termination
for this termination in current
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the successful registration
- the counter of CMCC for signal statistics
Num during the interval for this
termination in current 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the failed registration Num
- the counter of CMCC for signal statistics
during the interval for this
termination in current 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the activing Registration
- the counter of CMCC for signal statistics
Status at the start of the interval
this termination in current 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered out-going call count
- the counter of CMCC for signal statistics
for this termination in current
15m interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered incoming call count
- the counter of CMCC for signal statistics
for this termination in current
15m interval
This element is always shown.

Released

2581

95 Voice Status Commands

95.7 Voice Sip Termination Statistics Command for


Current Day
Command Description
This command allows the operator to show the Voice Sip Termination Statistics for current 1 day.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics termination current-1day [ (if-index) ]

Command Parameters
Table 95.7-1 "Voice Sip Termination Statistics Command for Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 95.7-2 "Voice Sip Termination Statistics Command for Current Day" Display parameters
Specific Information
name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )

amount of time in sec that


statistics have been counted
This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
current 1day interval

2582

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)

avg-rtrip-delay(ms)

peak-jitter(ms)

peak-rtrip-delay(ms)

avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

avg-jbfl-g723(%)

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

This element is always shown.

number of rtp packets transmitted


by this termination in current
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this termination in current
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this termination in current
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this termination in current 1day
interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving rtp
- the number of lost rtp packets
packets for this termination in
current 1day interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this termination in
termination
current 1day interval
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this
- average of jitter for the termination
termination in current 1day
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this termination in current 1day
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this
- average of jitter for the termination
termination in current 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
termination in current 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this termination in current
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage
termination
for this termination in current
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G723 percentage
termination
for this termination in current

Released

2583

95 Voice Status Commands

name

Type

avg-jbfl-g729(%)

reg-req-suc

reg-req-fail

reg-active

out-call-ans

in-call-ans

2584

Description

- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G729 percentage
termination
for this termination in current
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the successful registration
- the counter of CMCC for signal statistics
Num during the interval for this
termination in current 1d interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the failed registration Num
- the counter of CMCC for signal statistics
during the interval for this
termination in current 1d interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the activing Registration
- the counter of CMCC for signal statistics
Status at the start of the interval
this termination in current 1d
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered out-going call count
- the counter of CMCC for signal statistics
for this termination in current 1d
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered incoming call count
- the counter of CMCC for signal statistics
for this termination in current 1d
interval
This element is always shown.

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.8 Voice Sip Termination Statistics Command for


Previous 15 Minutes
Command Description
This command allows the operator to show the Voice Sip Termination Statistics for previous 15 minutes.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics termination prev-15min [ (if-index) [ interval-num <Sip::IntervalNumber15min> ] ]

Command Parameters
Table 95.8-1 "Voice Sip Termination Statistics Command for Previous 15 Minutes" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Sip::IntervalNumber15min>
identifies prev 15min intervals,
Format:
value 1 as the latest interval
- the measured time interval
- range: [1...96]

interval-num

Description

Command Output
Table 95.8-2 "Voice Sip Termination Statistics Command for Previous 15 Minutes" Display
parameters
Specific Information
name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>

amount of time in sec that

3HH-04416-EBAA-TCZZA 01

Released

2585

95 Voice Status Commands

name

in-valid-flag

Description

- the measured time of interval


- unit: sec

statistics have been counted


This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
previous 15m interval
This element is always shown.

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)

avg-rtrip-delay(ms)

peak-jitter(ms)

peak-rtrip-delay(ms)

avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

2586

Type

Released

number of rtp packets transmitted


by this termination in previous
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this termination in previous
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this termination in previous
15m interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this termination in previous 15m
interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving rtp
- the number of lost rtp packets
packets for this termination in
previous 15m interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this termination in
termination
previous 15m interval
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this
- average of jitter for the termination
termination in previous 15m
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this termination in previous 15m
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this
- average of jitter for the termination
termination in previous 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
termination in previous 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this termination in previous
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

avg-jbfl-g723(%)

avg-jbfl-g729(%)

reg-req-suc

reg-req-fail

reg-active

out-call-ans

in-call-ans

3HH-04416-EBAA-TCZZA 01

Type

Description

termination
for this termination in previous
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G723 percentage
termination
for this termination in previous
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G729 percentage
termination
for this termination in previous
- unit: percentage
15m interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the successful registration
- the counter of CMCC for signal statistics
Num during the interval for this
termination in previous 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the failed registration Num
- the counter of CMCC for signal statistics
during the interval for this
termination in previous 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the activing Registration
- the counter of CMCC for signal statistics
Status at the start of the interval
this termination in previous 15m
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered out-going call count
- the counter of CMCC for signal statistics
for this termination in previous
15m interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered incoming call count
- the counter of CMCC for signal statistics
for this termination in previous
15m interval
This element is always shown.

Released

2587

95 Voice Status Commands

95.9 Voice Sip Termination Statistics Command for


Previous day
Command Description
This command allows the operator to show the Voice Sip Termination Statistics for previous 1 day.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics termination prev-1day [ (if-index) [ interval-num <Sip::IntervalNumber1day> ] ]

Command Parameters
Table 95.9-1 "Voice Sip Termination Statistics Command for Previous day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Sip::IntervalNumber1day>
identifies prev 1 day intervals,
Format:
value 1 as the latest interval
- the measured time interval
- range: [1...3]

interval-num

Description

Command Output
Table 95.9-2 "Voice Sip Termination Statistics Command for Previous day" Display parameters
Specific Information
name
measured-time

2588

Released

Type

Description

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

amount of time in sec that


statistics have been counted
This element is only shown in

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

Type

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)

avg-rtrip-delay(ms)

peak-jitter(ms)

peak-rtrip-delay(ms)

avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
validity of the corresponding
performance monitoring data in
previous 1day interval
This element is always shown.

number of rtp packets transmitted


by this termination in previous
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this termination in previous
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this termination in previous
1day interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this termination in previous 1day
interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving rtp
- the number of lost rtp packets
packets for this termination in
previous 1day interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this termination in
termination
previous 1day interval
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this
- average of jitter for the termination
termination in previous 1day
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this termination in previous 1day
- unit: millisec
interval
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this
- average of jitter for the termination
termination in previous 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
termination in previous 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this termination in previous
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage
termination
for this termination in previous
- unit: percentage
1day interval.

Released

2589

95 Voice Status Commands

name

Type

avg-jbfl-g723(%)

avg-jbfl-g729(%)

reg-req-suc

reg-req-fail

reg-active

out-call-ans

in-call-ans

2590

Description

- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G723 percentage
termination
for this termination in previous
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G729 percentage
termination
for this termination in previous
- unit: percentage
1day interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the successful registration
- the counter of CMCC for signal statistics
Num during the interval for this
termination in previous 1d
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the failed registration Num
- the counter of CMCC for signal statistics
during the interval for this
termination in previous 1d
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Count the activing Registration
- the counter of CMCC for signal statistics
Status at the start of the interval
this termination in previous 1d
interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered out-going call count
- the counter of CMCC for signal statistics
for this termination in previous
1d interval
This element is always shown.
Parameter type: <Sip::SignalCounter>
Answered incoming call count
- the counter of CMCC for signal statistics
for this termination in previous
1d interval
This element is always shown.

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.10 Voice Sip Call Statistics Command


Command Description
This command allows the operator to show the Voice Sip Call Statistics.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics call (if-index) interval [ (interval-num) [ start-time <Sip::SipTimeInSecs> ] [ icid
<Sip::ICId> ] ]

Command Parameters
Table 95.10-1 "Voice Sip Call Statistics Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of this port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identifies 15min intervals, value
- the measured time interval
1 as the latest interval
- range: [1...96]
Parameter type: <Sip::SipTimeInSecs>
time value in seconds when the
Format:
call was initialized
- the time (yyyy-mm-dd:hour:minutes:secs)
Parameter type: <Sip::ICId>
the ims charging id in sip
Format:
- the ims charging id in SIP
- length: x<=38

(interval-num)
start-time
icid

Description

Command Output
Table 95.10-2 "Voice Sip Call Statistics Command" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

2591

95 Voice Status Commands

name

Type

Description

end-time

Parameter type: <Sys::timeInSecs>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

send-packets

Parameter type: <Counter>


- 32 bit counter

send-octets

Parameter type: <Counter>


- 32 bit counter

receive-packets

Parameter type: <Counter>


- 32 bit counter

receive-octets

Parameter type: <Counter>


- 32 bit counter

avg-jitter

Parameter type: <Sip::Jitter>


- average of jitter for the termination
- unit: millisec
Parameter type: <Sip::RoundTripDelay>
- average of round-trip delay for this termination
- unit: millisec
Parameter type: <Sip::Jitter>
- average of jitter for the termination
- unit: millisec
Parameter type: <Sip::RoundTripDelay>
- average of round-trip delay for this termination
- unit: millisec
Parameter type: <Sip::LostPackets>
- the number of lost rtp packets

time value in seconds when the


call was end
This element is only shown in
detail mode.
number of rtp packets transmitted
in this call portion
This element is always shown.
number of rtp octets transmitted
in this call portion
This element is always shown.
number of rtp packets received in
this call portion
This element is always shown.
number of rtp octets received in
this call portion
This element is always shown.
average
inter-arrival
jitter
measured in this call portion
This element is always shown.
average
round-trip
delay
measured in this call portion
This element is always shown.
peak inter-arrival jitter measured
in this call portion
This element is always shown.
peak round-trip delay measured
in this call portion
This element is always shown.
total number of lost receiving rtp
packets in this call portion
This element is always shown.
total number of discarded rtp
packets due to the jitter buffer
over-flow in this call portion
This element is always shown.
per call dialog state flag
This element is always shown.

avg-rtrip-delay
peak-jitter
peak-rtrip-delay
lost-packets
dis-pack-jb-over

Parameter type: <Counter>


- 32 bit counter

dialogue-state-flag

Parameter type: <Sip::DialogStateFlag>


( single-interval-dialog
| end-dialog
| continue-dialog
| start-dialog )
Possible values:
- single-interval-dialog: one dialog starts and ends in the
same interval
- end-dialog : one dialog ends in different intervals
- continue-dialog : dialog still continue
- start-dialog : one dialog starts not end yet interval reached

2592

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.11 Voice Sip board Statistics Command for


Current one Day
Command Description
This command allows the operator to show the Voice Sip board Statistics for current one day.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics board current-1day [ (slot-id) ]

Command Parameters
Table 95.11-1 "Voice Sip board Statistics Command for Current one Day" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

interface index of this LT board.

Command Output
Table 95.11-2 "Voice Sip board Statistics Command for Current one Day" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

2593

95 Voice Status Commands

name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

amount of time in sec that


statistics have been counted.
This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
current 1day interval.
This element is always shown.

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)
avg-rtrip-delay(ms)

peak-jitter(ms)
peak-rtrip-delay(ms)
avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

2594

Released

number
of
RTP
packets
transmitted by this board in
current 1day interval.
This element is always shown.
Parameter type: <Counter>
number of RTP octets transmitted
- 32 bit counter
by this board in current 1day
interval.
This element is always shown.
Parameter type: <Counter>
number of RTP packets received
- 32 bit counter
by this board in current 1day
interval.
This element is always shown.
Parameter type: <Counter>
number of RTP octets received
- 32 bit counter
by this board in current 1day
interval.
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving RTP
- the number of lost rtp packets
packets for this board in current
1day interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this board in
termination
current 1day interval.
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this board in
- average of jitter for the termination
current 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this board in current 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this board in
- average of jitter for the termination
current 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
board in current 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this board in current 1day
- unit: percentage
interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage
termination
for this board in current 1day
- unit: percentage
interval.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name
avg-jbfl-g723(%)

avg-jbfl-g729(%)

avg-cpu-load(%)

avg-mem-usage(%)

Type

Description

- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sys::cpuloadaverage>
- average load for the measurement period , expressed in
percentage
- unit: percentage
- range: [0...100]
Parameter type: <Sys::memusageUtilization>
- memory size
- unit: Mbyte

This element is always shown.


average of jitter buffer fill level
encoded with G723 percentage
for this board in current 1day
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G729 percentage
for this board in current 1day
interval.
This element is always shown.
average the CPU load for this
board in current 1day interval.
This element is always shown.

avg-mem-free(mb)

Parameter type: <Sys::memusageFree>


- memory size
- unit: Mbyte

avg-mem-used(mb)

Parameter type: <Sys::memusageAbsolute>


- memory size
- unit: Mbyte

mem-total(mb)

Parameter type: <Sys::totalMem>


- memory size
- unit: Mbyte
Parameter type: <Sip::NumberOfTerm>
- the number of termination

spare-ports

active-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

inactive-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

reg-req-suc

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

reg-req-fail

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

3HH-04416-EBAA-TCZZA 01

average amount of semi and


dynamic memory been used,
expressed as a portion of the total
memory for this board in current
1day interval.
This element is always shown.
average amount of free semi and
dynamic memory for this board
in current 1day interval.
This element is always shown.
average amount of semi and
dynamic memory been used for
this board in current 1day
interval.
This element is always shown.
total amount memory on this
board in current 1day interval.
This element is always shown.
the number of unconfigured sip
termination in this board at the
beginning of current 1day
interval.
This element is always shown.
the number of active sip
termination in this board at the
beginning of current 1day
interval.
This element is always shown.
the number of inactive sip
termination (locked) in this board
at the beginning of current 1day
interval.
This element is always shown.
Count the successful registration
Num for whole board in current 1
day interval
This element is always shown.
Count the failed registration Num
for whole board in current 1 day
interval
This element is always shown.

Released

2595

95 Voice Status Commands

name

Type

Description

reg-active

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

out-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

in-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

Count the activing Registration


Status at the start of whole board
in current 1 day interval
This element is always shown.
Answered out-going call count
for whole board in current 1 day
interval
This element is always shown.
Answered incoming call count
for whole board in current 1 day
interval
This element is always shown.

2596

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.12 Voice Sip Board Statistics Command for


Previous day
Command Description
This command allows the operator to show the Voice Sip Board Statistics for previous 1 day.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics board prev-1day [ (slot-id) [ interval-num <Sip::IntervalNumber1day> ] ]

Command Parameters
Table 95.12-1 "Voice Sip Board Statistics Command for Previous day" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Sip::IntervalNumber1day>
Format:
- the measured time interval
- range: [1...3]

interface index of this LT board.

interval-num

identifies prev 1 day intervals,


value 1 as the latest interval.

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2597

95 Voice Status Commands

Table 95.12-2 "Voice Sip Board Statistics Command for Previous day" Display parameters
Specific Information
name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

amount of time in sec that


statistics have been counted.
This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
previous 1day interval.
This element is always shown.

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)
avg-rtrip-delay(ms)

peak-jitter(ms)
peak-rtrip-delay(ms)
avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

2598

Released

number
of
RTP
packets
transmitted by this board in
previous 1day interval.
This element is always shown.
Parameter type: <Counter>
number of RTP octets transmitted
- 32 bit counter
by this board in previous 1day
interval.
This element is always shown.
Parameter type: <Counter>
number of RTP packets received
- 32 bit counter
by this board in previous 1day
interval.
This element is always shown.
Parameter type: <Counter>
number of RTP octets received
- 32 bit counter
by this board in previous 1day
interval.
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving RTP
- the number of lost rtp packets
packets for this board in previous
1day interval.
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this board in
termination
previous 1day interval.
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this board in
- average of jitter for the termination
previous 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this board in previous 1day
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this board in
- average of jitter for the termination
previous 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
board in previous 1day interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this board in previous 1day
- unit: percentage
interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

avg-jbfl-g723(%)

avg-jbfl-g729(%)

avg-cpu-load(%)

avg-mem-usage(%)

Type

Description

- average of jitter buffer fill level percentage for the


termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sys::cpuloadaverage>
- average load for the measurement period , expressed in
percentage
- unit: percentage
- range: [0...100]
Parameter type: <Sys::memusageUtilization>
- memory size
- unit: Mbyte

encoded with G711_u percentage


for this board in previous 1day
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G723 percentage
for this board in previous 1day
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G729 percentage
for this board in previous 1day
interval.
This element is always shown.
average the CPU load for this
board in previous 1day interval.
This element is always shown.

avg-mem-free(mb)

Parameter type: <Sys::memusageFree>


- memory size
- unit: Mbyte

avg-mem-used(mb)

Parameter type: <Sys::memusageAbsolute>


- memory size
- unit: Mbyte

mem-total(mb)

Parameter type: <Sys::totalMem>


- memory size
- unit: Mbyte
Parameter type: <Sip::NumberOfTerm>
- the number of termination

spare-ports

active-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

inactive-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

reg-req-suc

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

reg-req-fail

Parameter type: <Sip::SignalCounter>

3HH-04416-EBAA-TCZZA 01

average amount of semi and


dynamic memory been used,
expressed as a portion of the total
memory for this board in
previous 1day interval.
This element is always shown.
average amount of free semi and
dynamic memory for this board
in previous 1day interval.
This element is always shown.
average amount of semi and
dynamic memory been used for
this board in previous 1day
interval.
This element is always shown.
total amount memory on this
board in previous 1day interval.
This element is always shown.
the number of unconfigured sip
termination in this board at the
beginning of previous 1day
interval.
This element is always shown.
the number of active sip
termination in this board at the
beginning of previous 1day
interval.
This element is always shown.
the number of inactive sip
termination (locked) in this board
at the beginning of previous 1day
interval.
This element is always shown.
Count the successful registration
Num for whole board in previous
1 day interval
This element is always shown.
Count the failed registration Num

Released

2599

95 Voice Status Commands

name

Type

Description

- the counter of CMCC for signal statistics

for whole board in previous 1 day


interval
This element is always shown.
Count the activing Registration
Status at the start of whole board
in previous 1 day interval
This element is always shown.
Answered out-going call count
for whole board in previous 1 day
interval
This element is always shown.
Answered incoming call count
for whole board in previous 1 day
interval
This element is always shown.

reg-active

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

out-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

in-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

2600

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.13 Voice Sip Board Statistics Command for


Current 15 Minutes
Command Description
This command allows the operator to show the Voice Sip Board Statistics for current 15 minutes.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics board current-15min [ (slot-id) ]

Command Parameters
Table 95.13-1 "Voice Sip Board Statistics Command for Current 15 Minutes" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

interface index of this LT board

Command Output
Table 95.13-2 "Voice Sip Board Statistics Command for Current 15 Minutes" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

2601

95 Voice Status Commands

name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

amount of time in sec that


statistics have been counted
This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
current 15m interval
This element is always shown.

send-packets

send-octets

receive-packets

receive-octets
lost-packets

avg-jbfl(%)

avg-jitter(ms)
avg-rtrip-delay(ms)

peak-jitter(ms)
peak-rtrip-delay(ms)
avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

2602

Released

number of rtp packets transmitted


by this board in current 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this board in current 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this board in current 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this board in current 15m interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving RTP
- the number of lost rtp packets
packets for this board in current
15m interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this board in
termination
current 15m interval.
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this board in
- average of jitter for the termination
current 15m interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this board in current 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this board in
- average of jitter for the termination
current 15m interval
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
board in current 15m interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this board in current 15m
- unit: percentage
interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_u percentage
termination
for this board in current 15m
- unit: percentage
interval.
- range: [0...100]
This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

Type

Description

avg-jbfl-g723(%)

Parameter type: <Sip::JBFL>


- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sys::cpuloadaverage>
- average load for the measurement period , expressed in
percentage
- unit: percentage
- range: [0...100]
Parameter type: <Sys::memusageUtilization>
- memory size
- unit: Mbyte

average of jitter buffer fill level


encoded with G723 percentage
for this board in current 15m
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G729 percentage
for this board in current 15m
interval.
This element is always shown.
average the CPU load for this
board in current 15m interval.
This element is always shown.

avg-jbfl-g729(%)

avg-cpu-load(%)

avg-mem-usage(%)

avg-mem-free(mb)

Parameter type: <Sys::memusageFree>


- memory size
- unit: Mbyte

avg-mem-used(mb)

Parameter type: <Sys::memusageAbsolute>


- memory size
- unit: Mbyte

mem-total(mb)

Parameter type: <Sys::totalMem>


- memory size
- unit: Mbyte
Parameter type: <Sip::NumberOfTerm>
- the number of termination

spare-ports

active-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

inactive-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

reg-req-suc

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

reg-req-fail

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

reg-active

Parameter type: <Sip::SignalCounter>

3HH-04416-EBAA-TCZZA 01

average amount of semi and


dynamic memory been used,
expressed as a portion of the total
memory for this board in current
15m interval.
This element is always shown.
average amount of free semi and
dynamic memory for this board
in current 15m interval.
This element is always shown.
average amount of semi and
dynamic memory been used for
this board in current 15m
interval.
This element is always shown.
total amount memory on this
board in current 15m interval.
This element is always shown.
the number of unconfigured sip
termination in this board at the
beginning of current 15m
interval.
This element is always shown.
the number of active sip
termination in this board at the
beginning of current 15m
interval.
This element is always shown.
the number of inactive sip
termination (locked) in this board
at the beginning of current 15m
interval.
This element is always shown.
Count the successful registration
Num for whole board in current
15 minutes interval
This element is always shown.
Count the failed registration Num
for whole board in current 15
minutes interval
This element is always shown.
Count the activing Registration

Released

2603

95 Voice Status Commands

name

Type

Description

- the counter of CMCC for signal statistics

Status at the start of whole board


in current 15 minutes interval
This element is always shown.
Answered out-going call count
for whole board in current 15
minutes interval
This element is always shown.
Answered incoming call count
for whole board in current 15
minutes interval
This element is always shown.

out-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

in-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

2604

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.14 Voice Sip Board Statistics Command for


Previous 15 Minutes
Command Description
This command allows the operator to show the Voice Sip Board Statistics for previous 15 minutes.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics board prev-15min [ (slot-id) [ interval-num <Sip::IntervalNumber15min> ] ]

Command Parameters
Table 95.14-1 "Voice Sip Board Statistics Command for Previous 15 Minutes" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <Sip::IntervalNumber15min>
Format:
- the measured time interval
- range: [1...96]

interface index of this LT board

interval-num

identifies prev 15min intervals,


value 1 as the latest interval

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2605

95 Voice Status Commands

Table 95.14-2 "Voice Sip Board Statistics Command for Previous 15 Minutes" Display parameters
Specific Information
name

Type

Description

measured-time

Parameter type: <Sip::IntervalMeasureTime>


- the measured time of interval
- unit: sec

in-valid-flag

Parameter type: <Sip::IntervalValidityFlag>


( true
| false )
Possible values:
- true : data is not valid
- false : data is valid
Parameter type: <Counter>
- 32 bit counter

amount of time in sec that


statistics have been counted
This element is only shown in
detail mode.
validity of the corresponding
performance monitoring data in
previous 15m interval
This element is always shown.

send-packets

send-octets

receive-packets

receive-octets

lost-packets

avg-jbfl(%)

avg-jitter(ms)
avg-rtrip-delay(ms)

peak-jitter(ms)
peak-rtrip-delay(ms)
avg-jbfl-g711a(%)

avg-jbfl-g711u(%)

2606

Released

number of rtp packets transmitted


by this board in previous 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets transmitted
- 32 bit counter
by this board in previous 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp packets received
- 32 bit counter
by this board in previous 15m
interval
This element is always shown.
Parameter type: <Counter>
number of rtp octets received by
- 32 bit counter
this board in previous 15m
interval
This element is always shown.
Parameter type: <Sip::LostPackets>
number of lost receiving RTP
- the number of lost rtp packets
packets for this board in previous
15m interval
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the percentage for this board in
termination
previous 15m interval.
- unit: percentage
This element is always shown.
- range: [0...100]
Parameter type: <Sip::Jitter>
average of jitter for this board in
- average of jitter for the termination
previous 15m interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
average of round-trip delay for
- average of round-trip delay for this termination
this board in previous 15m
- unit: millisec
interval.
This element is always shown.
Parameter type: <Sip::Jitter>
peak inter-arrival for this board in
- average of jitter for the termination
previous 15m interval
- unit: millisec
This element is always shown.
Parameter type: <Sip::RoundTripDelay>
peak of round-trip delay for this
- average of round-trip delay for this termination
board in previous 15m interval.
- unit: millisec
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level
- average of jitter buffer fill level percentage for the encoded with G711_a percentage
termination
for this board in previous 15m
- unit: percentage
interval.
- range: [0...100]
This element is always shown.
Parameter type: <Sip::JBFL>
average of jitter buffer fill level

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

avg-jbfl-g723(%)

avg-jbfl-g729(%)

avg-cpu-load(%)

avg-mem-usage(%)

Type

Description

- average of jitter buffer fill level percentage for the


termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sip::JBFL>
- average of jitter buffer fill level percentage for the
termination
- unit: percentage
- range: [0...100]
Parameter type: <Sys::cpuloadaverage>
- average load for the measurement period , expressed in
percentage
- unit: percentage
- range: [0...100]
Parameter type: <Sys::memusageUtilization>
- memory size
- unit: Mbyte

encoded with G711_u percentage


for this board in previous 15m
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G723 percentage
for this board in previous 15m
interval.
This element is always shown.
average of jitter buffer fill level
encoded with G729 percentage
for this board in previous 15m
interval.
This element is always shown.
average the CPU load for this
board in previous 15m interval.
This element is always shown.

avg-mem-free(mb)

Parameter type: <Sys::memusageFree>


- memory size
- unit: Mbyte

avg-mem-used(mb)

Parameter type: <Sys::memusageAbsolute>


- memory size
- unit: Mbyte

mem-total(mb)

Parameter type: <Sys::totalMem>


- memory size
- unit: Mbyte
Parameter type: <Sip::NumberOfTerm>
- the number of termination

spare-ports

active-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

inactive-ports

Parameter type: <Sip::NumberOfTerm>


- the number of termination

reg-req-suc

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

reg-req-fail

Parameter type: <Sip::SignalCounter>

3HH-04416-EBAA-TCZZA 01

average amount of semi and


dynamic memory been used,
expressed as a portion of the total
memory for this board in
previous 15m interval.
This element is always shown.
average amount of free semi and
dynamic memory for this board
in previous 15m interval.
This element is always shown.
average amount of semi and
dynamic memory been used for
this board in previous 15m
interval.
This element is always shown.
total amount memory on this
board in previous 15m interval.
This element is always shown.
the number of unconfigured sip
termination in this board at the
beginning of previous 15m
interval.
This element is always shown.
the number of active sip
termination in this board at the
beginning of previous 15m
interval.
This element is always shown.
the number of inactive sip
termination (locked) in this board
at the beginning of previous 15m
interval.
This element is always shown.
Count the successful registration
Num for whole board in previous
15 minutes interval
This element is always shown.
Count the failed registration Num

Released

2607

95 Voice Status Commands

name

Type

Description

- the counter of CMCC for signal statistics

for whole board in previous 15


minutes interval
This element is always shown.
Count the activing Registration
Status at the start of whole board
in previous 15 minutes interval
This element is always shown.
Answered out-going call count
for whole board in previous 15
minutes interval
This element is always shown.
Answered incoming call count
for whole board in previous 15
minutes interval
This element is always shown.

reg-active

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

out-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

in-call-ans

Parameter type: <Sip::SignalCounter>


- the counter of CMCC for signal statistics

2608

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.15 Voice Sip Statistics Perfinfo Status


Command per board
Command Description
This command allows the operator to show the various parameters including elapsed times for current 15-minutes
interval and 1-day interval per Board, the number of pervious 15-minutes interval and 1-day interval per Board

User Level
The command can be accessed by operators with forStatsPerBoard privileges.

Command Syntax
The command has the following syntax:
> show voice sip statistics board-perfinfo [ (slot-id) ]

Command Parameters
Table 95.15-1 "Voice Sip Statistics Perfinfo Status Command per board" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

interface index of this LT board.

Command Output
Table 95.15-2 "Voice Sip Statistics Perfinfo Status Command per board" Display parameters

3HH-04416-EBAA-TCZZA 01

Released

2609

95 Voice Status Commands

Specific Information
name

Type

Description

cur-15min-elapsedtime

Parameter type: <Sip::ElapsedTime>


- the elapsed time
- unit: sec

cur-1day-elapsedtime

Parameter type: <Sip::ElapsedTime>


- the elapsed time
- unit: sec

pre-15min-num

Parameter type: <Sip::PerfInterval>


- the number of interval

pre-1days-num

Parameter type: <Sip::PerfInterval>


- the number of interval

number of second elapsed in


current 15 minutes interval
measurement
This element is always shown.
number of second elapsed in
current
1
day
interval
measurement
This element is always shown.
number of previous 15 minutes
interval
This element is always shown.
number of previous 1 day interval
This element is always shown.

2610

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.16 Voice Sip restoration: Redundancy Status


Commands
Command Description
This command allows the operator to show the Voice Sip restoration, Redundancy status.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip redundancy-node redundancy-state [ (admin-name) [ slot-id <SIP::SlotIndex> ] ]

Command Parameters
Table 95.16-1 "Voice Sip restoration: Redundancy Status Commands" Resource Parameters
Resource Identifier

Type

Description

(admin-name)

Format:
- uniquely name of this element
- length: x<=32
Parameter type: <SIP::SlotIndex>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt
| ntio
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt : nt-slot
- ntio : ntio-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

The name of the administrative


domain that hosts the redundancy
group.
slot id associated with this
redundancy state table.

slot-id

Command Output
Table 95.16-2 "Voice Sip restoration: Redundancy Status Commands" Display parameters

3HH-04416-EBAA-TCZZA 01

Released

2611

95 Voice Status Commands

Specific Information
name
state

2612

Type

Description

Parameter type: <Sip::netwRedunState>


State:connected-to-primary(1),connected
( connect-primary
This element is always shown.
| connect-geo-back
| connect-sos-back
| server-fo-ongoing
| server-fb-ongoing
| geo-fo-ongoing
| geo-fb-ongoing
| sos-fo-ongoing
| sos-fb-ongoing
| deli-upd-ongoing )
Possible values:
- connect-primary : Redundancy state :connect-primary
- connect-geo-back : Redundancy state : connect-geo-back
- connect-sos-back : Redundancy state : connect-sos-back
server-fo-ongoing
:
Redundancy
state
:sip-server-fail-over-ongoing
server-fb-ongoing
:
Redundancy
state
:
sip-server-fail-back-ongoing
- geo-fo-ongoing : Redundancy state : geo-fail-over-ongoing
geo-fb-ongoing
:
Redundancy
state
:geo-fail-back-ongpoing
- sos-fo-ongoing : Redundancy state : sos-fail-over-ongoing
- sos-fb-ongoing : Redundancy state : sos-fail-back-ongoing
deli-upd-ongoing
:
Redundancy
state
:
deliberate-update-ongoing

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.17 Voice Sip restoration: Redundancy Status


Commands
Command Description
This command allows the operator to show the Voice Sip restoration, Redundancy status.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip redundancy-node ext-redundancy-state [ (admin-name) [ slot-id <SIP::SlotIndex> ] [ term-group
<SIP::sipTerminationGroupID> ] ]

Command Parameters
Table 95.17-1 "Voice Sip restoration: Redundancy Status Commands" Resource Parameters
Resource Identifier

Type

Description

(admin-name)

Format:
- uniquely name of this element
- length: x<=32
Parameter type: <SIP::SlotIndex>
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt
| ntio
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt : nt-slot
- ntio : ntio-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number
Parameter type: <SIP::sipTerminationGroupID>
Format:
- the termination group termination belongs to
- range: [0...72]

The name of the administrative


domain that hosts the redundancy
group.
slot id associated with this
redundancy state table.

slot-id

term-group

3HH-04416-EBAA-TCZZA 01

slot id associated with


redundancy state table.

Released

2613

this

95 Voice Status Commands

Command Output
Table 95.17-2 "Voice Sip restoration: Redundancy Status Commands" Display parameters
Specific Information
name
state

sip-server-address

2614

Released

Type

Description

Parameter type: <Sip::netwRedunNewState>


( connect-primary
| connect-geo-back
| connect-sos-back
| server-fo-ongoing
| server-fb-ongoing
| geo-fo-ongoing
| geo-fb-ongoing
| sos-fo-ongoing
| sos-fb-ongoing
| deli-upd-ongoing
| deli-upd-ongoing-bu
| server-fo-ongoing-bu
| server-fb-ongoing-bu )
Possible values:
- connect-primary : Redundancy state :connect-primary
- connect-geo-back : Redundancy state : connect-geo-back
- connect-sos-back : Redundancy state : connect-sos-back
server-fo-ongoing
:
Redundancy
state
:sip-server-fail-over-ongoing
server-fb-ongoing
:
Redundancy
state
:
sip-server-fail-back-ongoing
- geo-fo-ongoing : Redundancy state : geo-fail-over-ongoing
geo-fb-ongoing
:
Redundancy
state
:geo-fail-back-ongpoing
- sos-fo-ongoing : Redundancy state : sos-fail-over-ongoing
- sos-fb-ongoing : Redundancy state : sos-fail-back-ongoing
deli-upd-ongoing
:
Redundancy
state
:
deliberate-update-ongoing
deli-upd-ongoing-bu
:
Redundancy
state
:
deliberate-update-ongoing-bu
server-fo-ongoing-bu
:
Redundancy
state
:sip-server-fail-over-ongoing-bu
server-fb-ongoing-bu
:
Redundancy
state
:
sip-server-fail-back-ongoing-bu
Parameter type: <Sip::sipServerAddr>
- name of the SipServer that can be resolved to an IP address
via a DNS Server
- length: 7<=x<=64

State:connected-to-primary(1),connected
This element is always shown.

the SIP server termination


registered to
This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.18 Voice Sip Redundancy Status Commands


Command Description
This command allows the operator to show the Voice Sip Redundancy status.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip redundancy-node redundancy-cmd [ (provider-name) ]

Command Parameters
Table 95.18-1 "Voice Sip Redundancy Status Commands" Resource Parameters
Resource Identifier

Type

Description

(provider-name)

Format:
- provider name,Currently supports only vsp1
- length: x<=32

uniquely identify provider name

Command Output
Table 95.18-2 "Voice Sip Redundancy Status Commands" Display parameters
Specific Information
name
progress

result

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Sip::FailXProgress>


( not-started
| running
| successful-completed
| failed )
Possible values:
- not-started : geo fo/fb not started
- running : geo fo/fb is ongoing
- successful-completed : geo fo/fb complete and successful
- failed : geo fo/fb failed
Parameter type: <Sip::FailXResult>
- Fail X result.
- length: x<=32

Fail X progress
This element is always shown.

Fail X result.
This element is always shown.

Released

2615

95 Voice Status Commands

95.19 Voice Sip Termination Status Commands


Command Description
This command allows the operator to show the Voice Sip termination profile.

User Level
The command can be accessed by operators with sip privileges.

Command Syntax
The command has the following syntax:
> show voice sip termination [ (if-index) ]

Command Parameters
Table 95.19-1 "Voice Sip Termination Status Commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
The unique internal identifier of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / the termination port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 95.19-2 "Voice Sip Termination Status Commands" Display parameters
Specific Information
name
contact-user-info

Description

Parameter type: <SIP::SipTerminationContact>


The user-info of contact field in
- The user-info of contact field in SIP message associated SIP message associated with the
with the user
user
- length: 1<=x<=128
This element is always shown.
Parameter type: <Sip::TermOperStatus>
the
operational
status
of
( up
application server
| down )
This element is always shown.
Possible values:
- up : the status of the termination opera is up
- down : the status of the termination is down

oper-status

2616

Type

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

Type

Description

operstatus-downreason

Parameter type: <Sip::TermOpDownReason>


(
| registering
| registrationfailure
| physicalfailure )
Possible values:
- : the term opera status down reason is none
- registering : the term opera status down reason is
registering
- registrationfailure : the term opera status down reason is
registration failure
- physicalfailure : the term opera status down reason is
physical failure
Parameter type: <Sip::TermCallStatus>
( unknown
| on-hook
| off-hook
| dialing
| calling
| connected
| idle-offhook
| ringing
| releasing
| ringback )
Possible values:
- unknown : the call status is unknown
- on-hook : the call status is on-hook
- off-hook : the call status is off-hook
- dialing : the call status is dialing
- calling : the call status is calling
- connected : the call status is connected
- idle-offhook : the call status is idle-offhook
- ringing : the call status is ringing
- releasing : the call status is releasing
- ringback : the call status is ringback
Parameter type: <Sip::TermTestStatus>
( no-testing
| mta-testing
| ilt-testing )
Possible values:
- no-testing : the termination is not under testing
- mta-testing : the termination is under mta testing
- ilt-testing : the termination is under integrated line testing
Parameter type: <SIP::sipTerminationGroupID>
- the termination group termination belongs to
- range: [0...72]
Parameter type: <Sip::sipServerAddr>
- name of the SipServer that can be resolved to an IP address
via a DNS Server
- length: 7<=x<=64
Parameter type: <Sip::TestAccessState>
( on
| off )
Possible values:
- on : turn on TestAccessState
- off : turn off TestAccessState
Parameter type: <Sip::TestAccessBusyOverWrite>

the reason of operational status of


application server is down
This element is always shown.

call-status

test-status

termination-group
sip-server-address

testaccess-state

busyoverwrite

3HH-04416-EBAA-TCZZA 01

the call status of a termination


This element is always shown.

the test status of a termination


This element is always shown.

the group termination belongs to


This element is always shown.
the SIP server termination
registered to
This element is always shown.
test access status
This element is always shown.

test access busyoverwrite status

Released

2617

95 Voice Status Commands

name

accesson-timeout

2618

Released

Type

Description

( true
| false )
Possible values:
- true : enable TestAccessBusyOverWrite parameter
- false : disable TestAccessBusyOverWrite parameter
Parameter type: <Sip::TestAccessonTimeout>
- value of test access on expires.
- unit: second
- range: [0...300]

This element is always shown.

test access statatus on timeout


value
This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.20 Voice Megaco Equipment Board Status


Commands
Command Description
This command allows the operator to show the Voice board communication status.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) board [ (equip-id) [ board-id <Equipm::PortSlotIndex> ] ]

Command Parameters
Table 95.20-1 "Voice Megaco Equipment Board Status Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]
Parameter type: <Equipm::PortSlotIndex>
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number

uniquely identify of this xvps


cluster

(equip-id)
board-id

uniquely
identify
equipment

of

this

uniquely identify of this board.


the CLI slot numbering method is
based on logical concept.for XD
shelf, CLI logic slot-id(1 to 16) is
mapped to physical slot-id from 4
to 19. for FD shelf, CLI logic
slot-id(1 to 16) is mapped to
physical slot-id from 1 to 8 and
12 to 19.

Command Output
Table 95.20-2 "Voice Megaco Equipment Board Status Commands" Display parameters
Specific Information
name
comm-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <MEGACO::BoardCommStatus>


( up

the communication
board

Released

2619

status

of

95 Voice Status Commands

name

Type

actual-type

2620

Description

| down
This element is always shown.
| unknown )
Possible values:
- up : The communication status is up
- down : the communication status is down
- unknown : the communication status is unknown
Parameter type: <Equipm::ActBoardType>
the actual type of board
Data driven field type
This element is always shown.
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

Released

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.21 Voice Megaco Equipment Status Commands


Command Description
This command allows the operator to show the Voice termination operational status.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) termination [ (equip-id) [ port-id <Itf::MegacoPotsLine> ] ]

Command Parameters
Table 95.21-1 "Voice Megaco Equipment Status Commands" Resource Parameters
Resource Identifier

Type

(cluster-id)

Format:
uniquely identify of this xvps
- the xvps cluster id
cluster
- range: [1...8]
Format:
uniquely
identify
of
this
- id of equipment
equipment
- range: [1...32]
Parameter type: <Itf::MegacoPotsLine>
uniquely identify of this board.
Format:
the CLI slot numbering method is
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> / based on logical concept.for XD
<Eqpt::MegacoPortId>
shelf, CLI logic slot-id(1 to 16) is
Field type <Eqpt::RackId>
mapped to physical slot-id from 4
- the rack number
to 19. for FD shelf, CLI logic
Field type <Eqpt::ShelfId>
slot-id(1 to 16) is mapped to
- the shelf number
physical slot-id from 1 to 8 and
Field type <Eqpt::NewSlotId>
12 to 19.
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

(equip-id)
port-id

Description

Command Output
Table 95.21-2 "Voice Megaco Equipment Status Commands" Display parameters
Specific Information
name
termination-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <MEGACO::accessTerminationId>


- the termination id
- range: [0...32767]

the
unique
identifier
of
termination.
This element is always shown.

Released

2621

95 Voice Status Commands

name

Type

Description

port-type

Parameter
type:
<MEGACO::accTerminationUserPortType>
( pstn
| isdn )
Possible values:
- pstn : the termination type is pstn
- isdn : the termination type is isdn
Parameter type: <MEGACO::TerminationOperStatus>
( up
| down
| shuttingdown )
Possible values:
- up : The operational status is up
- down : the operational status is down
- shuttingdown : the operational status is shuttingdown
Parameter type: <MEGACO::accTerminationAdminStatus>
( locked
| unlocked )
Possible values:
- locked : the admin status of termination is locked
- unlocked : the admin status of termination is unlocked
Parameter type: <MEGACO::accTerminationCallStatus>
(
| on-hook
| off-hook
| dialing
| calling
| connected
| idle-offhook
| busy-tone
| howler-tone
| ringing
| releasing
| ringback
| caller-connected
| callee-connected )
Possible values:
- : the call status is unknown
- on-hook : the call status is on-hook
- off-hook : the call status is off-hook
- dialing : the call status is dialing
- calling : the call status is calling
- connected : the call status is connected
- idle-offhook : the call status is idle-offhook
- busy-tone : the call status is busy tone
- howler-tone : the call status is howler tone
- ringing : the call status is ringing
- releasing : the call status is releasing
- ringback : the call status is releasing
- caller-connected : the call status is caller connected
- callee-connected : the call status is callee connected
Parameter type: <MEGACO::accTerminationTestStatus>
( no-testing
| mta-testing
| ilt-testing )
Possible values:
- no-testing : the termination is not under testing

the type of termination port.


This element is always shown.

oper-status

admin-status

call-status

test-status

2622

Released

the
operational
status
of
termination.
This element is always shown.

the admin status of termination.


This element is always shown.

the call status of a termination


This element is always shown.

the test status of a termination


This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name
operstatus-downreason

channel-status

ps1

ps2

3HH-04416-EBAA-TCZZA 01

Type

Description

- mta-testing : the termination is under mta testing


- ilt-testing : the termination is under integrated line testing
Parameter
type:
<MEGACO::accTerminationOpDownReason>
(
| registering
| registrationfailure
| physicalfailure )
Possible values:
- : the term opera status down reason is none
- registering : the term opera status down reason is
registering
- registrationfailure : the term opera status down reason is
registration failure
- physicalfailure : the term opera status down reason is
physical failure
Parameter
type:
<MEGACO::accTerminationChannelStatus>
(
| idle
| b1-busy
| b2-busy
| both-channels-busy )
Possible values:
- : the term opera status down reason is none
- idle : both channels are idle.
- b1-busy : B1 channel is busy. B2 is idle
- b2-busy : B2 channel is busy. B1 is idle
- both-channels-busy : both channels are busy
Parameter
type:
<MEGACO::accTerminationPowerSourceStatus>
(
| normal
| abnormal )
Possible values:
- : the term opera status power source is none
- normal : ..............
- abnormal : ................
Parameter
type:
<MEGACO::accTerminationPowerSourceStatus>
(
| normal
| abnormal )
Possible values:
- : the term opera status power source is none
- normal : ..............
- abnormal : ................

the reason of operational status of


termination is down
This element is always shown.

The channel status of this access


termination
This element is always shown.

The power source 1 status of this


access termination
This element is always shown.

The power source 2 status of this


access termination
This element is always shown.

Released

2623

95 Voice Status Commands

95.22 Voice Megaco MGI Status Commands


Command Description
this command allows the operator to show the voice mgi operational status and the currently-associated mgc.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) media-gateway [ (media-gateway-id) ]

Command Parameters
Table 95.22-1 "Voice Megaco MGI Status Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- the media gateway table index
- range: [1]

uniquely identify of this xvps


cluster

(media-gateway-id)

uniquely identify of this media


gateway

Command Output
Table 95.22-2 "Voice Megaco MGI Status Commands" Display parameters
Specific Information
name
oper-status

active-mgc

2624

Released

Type

Description

Parameter type: <MEGACO::MGIOperStatus>


( up
| down
| shuttingdown )
Possible values:
- up : The operational status is up
- down : the operational status is down
- shuttingdown : the operational status is shuttingdown
Parameter type: <MEGACO::MGICtrlrActiveAddress>
( primary
| secondary
| none
| other
| tertiary
| quaternary

the operational status of MGI


This element is always shown.

the currently associated MGC


This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

mg-sgi

prim-mgc-ip

prim-mgc-port

sec-mgc-ip

sec-mgc-port

tert-mgc-ip

tert-mgc-port

quat-mgc-ip

quat-mgc-port

esa-mgc-ip

esa-mgc-port

3HH-04416-EBAA-TCZZA 01

Type

Description

| esa )
Possible values:
- primary : the primary MGC is currently associated
- secondary : the secondary MGC is currently associated
- none : No MGC is currently associated
- other : Another MGC(neither primary MGC nor secondary
MGC is currently associated
- tertiary : the tertiary MGC is currently associated
- quaternary : the quaternary MGC is currently associated
- esa : the esa MGC is currently associated
Parameter type: <MEGACO::mediaGatewaySGI>
the unique signaling gateway id
- a signed integer
which identifies this media
gateway
This element is always shown.
Parameter type: <Ip::V4Address>
the ip address of the primary
- IPv4-address
media gateway controller
This element is only shown in
detail mode.
Parameter
type: the udp port of primary mgc
<MEGACO::medGwyCtrlrPrimaryUDPPort>
This element is only shown in
- the primary udp port of media gateway controller
detail mode.
- range: [1...65534]
Parameter type: <Ip::V4Address>
the ip address of the secondary
- IPv4-address
media gateway controller
This element is only shown in
detail mode.
Parameter
type: the udp port of secondary mgc
<MEGACO::medGwyCtrlrSecondaryUDPPort>
This element is only shown in
- the secondary udp port of media gateway controller
detail mode.
- range: [1...65534]
Parameter type: <Ip::V4Address>
the ip address of the tertiary
- IPv4-address
media gateway controller
This element is only shown in
detail mode.
Parameter
type: the udp port of tertiary mgc
<MEGACO::medGwyCtrlrTertiaryUDPPort>
This element is only shown in
- the tertiary udp port of media gateway controller
detail mode.
- range: [1...65534]
Parameter type: <Ip::V4Address>
the ip address of the quaternary
- IPv4-address
media gateway controller
This element is only shown in
detail mode.
Parameter
type: the udp port of quaternary mgc
<MEGACO::medGwyCtrlrQuaternaryUDPPort>
This element is only shown in
- the quaternary udp port of media gateway controller
detail mode.
- range: [1...65534]
Parameter type: <Ip::V4Address>
the ip address of the esa media
- IPv4-address
gateway controller
This element is only shown in
detail mode.
Parameter
type: the udp port of esa mgc
<MEGACO::medGwyCtrlrESAMgcUDPPort>
This element is only shown in
- the esa mgc udp port of media gateway controller
detail mode.
- range: [0...65535]

Released

2625

95 Voice Status Commands

95.23 Voice Megaco Database Status Commands


Command Description
This command allows the operator to show the voice megaco xvps database status.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) database

Command Parameters
Table 95.23-1 "Voice Megaco Database Status Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

Command Output
Table 95.23-2 "Voice Megaco Database Status Commands" Display parameters
Specific Information
name
progress-status

2626

Released

Type

Description

Parameter type: <MEGACO::SaveStatus>


( ongoing
| successful
| failed )
Possible values:
- ongoing : save ongoig
- successful : save successful
- failed : save failed

the current db save progress


status of the cluster
This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

95.24 Voice Megaco IP Status Commands


Command Description
This command allows the operator to show the xvps signaling udp port status.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) ip

Command Parameters
Table 95.24-1 "Voice Megaco IP Status Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

Command Output
Table 95.24-2 "Voice Megaco IP Status Commands" Display parameters
Specific Information
name
udp-port

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <MEGACO::ivpsXLESUDPPort>


- the signaling udp port of xvps
- range: [0...65535]

the signaling udp port of the xvps


cluster
This element is always shown.

Released

2627

95 Voice Status Commands

95.25 Voice Megaco SGI Status Commands


Command Description
this command allows the operator to show the voice sgi operational status and sctp port and the
currently-associated sgi.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show voice cluster (cluster-id) signal-gateway [ (signal-gateway-id) ]

Command Parameters
Table 95.25-1 "Voice Megaco SGI Status Commands" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- the signal gateway table index
- range: [1]

uniquely identify of this xvps


cluster

(signal-gateway-id)

uniquely identify of this signal


gateway

Command Output
Table 95.25-2 "Voice Megaco SGI Status Commands" Display parameters
Specific Information
name
sgi-ass-asp

2628

Released

Type

Description

Parameter type: <MEGACO::SGIAssocASP>


( none
| primary
| secondary
| both
| tertiary
| quaternary )
Possible values:
- none : No SGI is currently associated
- primary : the primary SGI is currently associated
- secondary : the secondary SGI is currently associated
- both : the both SGI is currently associated
- tertiary : the tertiary SGI is currently associated
- quaternary : the quaternary SGI is currently associated

the currently associated SGI


This element is always shown.

3HH-04416-EBAA-TCZZA

01

95 Voice Status Commands

name

Type

Description

sctp-port

Parameter type: <MEGACO::SGISCTPPort>


- the sctp port of the signal gateway
- range: [0...65535]
Parameter type: <MEGACO::SGIOperStatus>
( up
| down )
Possible values:
- up : The operational status is up
- down : the operational status is down

the sctp port of the signal


gateway
This element is always shown.
the operational status of SGI
This element is always shown.

oper-status

3HH-04416-EBAA-TCZZA 01

Released

2629

96- L2CP Status Commands

96.1 L2CP Status Command Tree


96.2 L2CP Status Command
96.3 L2CP Status Command
96.4 L2CP Status Command
96.5 L2CP Partition Status Command

2630

Released

96-2631
96-2632
96-2634
96-2636
96-2637

3HH-04416-EBAA-TCZZA

01

96 L2CP Status Commands

96.1 L2CP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "L2CP Status Commands".

Command Tree
----show
----l2cp
----session-status
- (index)
----session-peers
- (index)
----session-stats
- (index)
----partition
- (partition-id)
- user-port

3HH-04416-EBAA-TCZZA 01

Released

2631

96 L2CP Status Commands

96.2 L2CP Status Command


Command Description
This command allows the operator to display the L2CP session status.
It shows the status of the GSMP Adjacency Protocol.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show l2cp session-status [ (index) ]

Command Parameters
Table 96.2-1 "L2CP Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- identity of the l2cp session
- range: [1...255]

index to the l2cp session table

Command Output
Table 96.2-2 "L2CP Status Command" Display parameters
Specific Information
name
state

gsmp-version
gsmp-sub-version
topo-discovery

2632

Released

Type

Description

Parameter type: <L2cp::State>


( null
| sync-sent
| sync-rcvd
| estab )
Possible values:
- null : null state
- sync-sent : sync sent state
- sync-rcvd : sync received state
- estab : established state
Parameter type: <L2cp::Version>
- version of the GSMP protocol
- range: [3]
Parameter type: <L2cp::SubVersion>
- sub version of the GSMP protocol
- range: [1]
Parameter type: <L2cp::AccessTopologyDiscovery>

state of the l2cp session


This element is always shown.

version of gsmp protocol


This element is always shown.
sub version of gsmp protocol
This element is always shown.
access topology discovery is

3HH-04416-EBAA-TCZZA

01

96 L2CP Status Commands

name

Type

Description

short name: topo-disc

( ( disabled | no )
| ( enabled | yes ) )
Possible values:
- disabled : no topology discovery
- no : no topology discovery
- enabled : topology discovery
- yes : topology discovery
Parameter type: <L2cp::Layer2OAM>
( ( disabled | no )
| ( enabled | yes ) )
Possible values:
- disabled : no layer2 oam
- no : no layer2 oam
- enabled : layer2 oam
- yes : layer2 oam
Parameter type: <L2cp::UpTime>
- a signed integer

supported
This element is always shown.

layer2-oam
short name: l2-oam

sec-since-system-up
bras-ip-address

3HH-04416-EBAA-TCZZA 01

Parameter type: <L2cp::InetAddress>


- IPv4-address

layer2 OAM is supported


This element is always shown.

the value of sysUpTime when the


session came to established state.
This element is always shown.
IPv4 address used for the GSMP
session peer
This element is always shown.

Released

2633

96 L2CP Status Commands

96.3 L2CP Status Command


Command Description
This command allows the operator to display the L2CP session peers.
This command shows the identity of the peers.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show l2cp session-peers [ (index) ]

Command Parameters
Table 96.3-1 "L2CP Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- identity of the l2cp session
- range: [1...255]

index to the l2cp session table

Command Output
Table 96.3-2 "L2CP Status Command" Display parameters
Specific Information
name
dslam-name
bras-name
vrf-id

Type

Description

Parameter type: <L2cp::DslamName>


- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Parameter type: <L2cp::DslamName>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Parameter type: <L2cp::VrfIndex>
- the VRF ID which uniquely identify a VRF
- range: [0]

the name of the DSLAM


This element is always shown.

dslam-ip-address

Parameter type: <L2cp::InetAddress>


- IPv4-address

bras-ip-address

Parameter type: <L2cp::InetAddress>


- IPv4-address

dslam-instance

Parameter type: <L2cp::Instance>

2634

Released

the name of the BRAS


This element is always shown.
vrf containing own IP address
and route table to be used for the
connectivity to the GSMP peer.
This element is always shown.
IPv4 address used for the GSMP
session peer
This element is always shown.
IPv4 address used for the GSMP
session peer
This element is always shown.
instance number used by the

3HH-04416-EBAA-TCZZA

01

96 L2CP Status Commands

name

Type

Description

bras-instance

- identity of the instance


- range: [0...16777215]
Parameter type: <L2cp::Instance>
- identity of the instance
- range: [0...16777215]

DSLAM during this session.


This element is always shown.
instance number used by the
BRAS during this session.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2635

96 L2CP Status Commands

96.4 L2CP Status Command


Command Description
This command allows the operator to display the L2CP session statistics.
The operator may also want to see real activity by checking traffic counters for L2CP messages via this show
command.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show l2cp session-stats [ (index) ]

Command Parameters
Table 96.4-1 "L2CP Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- identity of the l2cp session
- range: [1...255]

index to the l2cp session table

Command Output
Table 96.4-2 "L2CP Status Command" Display parameters
Specific Information
name

Type

Description

sent-msgs

Parameter type: <Counter>


- 32 bit counter

rcvd-valid-msgs

Parameter type: <Counter>


- 32 bit counter

discarded-msgs

Parameter type: <Counter>


- 32 bit counter

number of messages that have


been sent in this session
This element is always shown.
number of messages that have
been received and processed in
this session
This element is always shown.
number of messages that in this
session have been received and
discarded.
This element is always shown.

2636

Released

3HH-04416-EBAA-TCZZA

01

96 L2CP Status Commands

96.5 L2CP Partition Status Command


Command Description
This command lists the interfaces associated to a given partition in the Dslam. This command will not list the
interfaces associated to the default partition 0.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show l2cp partition [ (partition-id) [ user-port <Itf::XdslShdslLine> ] ]

Command Parameters
Table 96.5-1 "L2CP Partition Status Command" Resource Parameters
Resource Identifier

Type

(partition-id)

Format:
partition id
- partition id
- range: [1...127]
Parameter type: <Itf::XdslShdslLine>
interface index of the port
Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

user-port

3HH-04416-EBAA-TCZZA 01

Description

Released

2637

97- MSTP Status Commands

97.1 MSTP Status Command Tree


97.2 SHub MSTP Bridge Status Command
97.3 SHub MSTP Instance Status Command
97.4 SHub MSTP Network Port Status Command
97.5 SHub MSTP Port Instance Status Command

2638

Released

97-2639
97-2640
97-2642
97-2644
97-2647

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

97.1 MSTP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "MSTP Status Commands".

Command Tree
----show
----mstp
----bridge
----instance
- (instance)
----network-port
- (port)
----port-instance
- (network-port)
- instance

3HH-04416-EBAA-TCZZA 01

Released

2639

97 MSTP Status Commands

97.2 SHub MSTP Bridge Status Command


Command Description
This command displays all common spanning tree instances for the whole bridge.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show mstp bridge

Command Output
Table 97.2-2 "SHub MSTP Bridge Status Command" Display parameters
Specific Information
name

Type

Description

root-id

Parameter type: <Shub::MstpBridgeId>


- the mstp bridge id
- length: 8

root-cost

Parameter type: <Shub::MstpRootCost>


- root cost

root-port

Parameter type: <Shub::MstpZeroNetworkPort>


( network : <Shub::MstpNetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- nt : active nt slot
- none : no port
- network : network port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Parameter type: <Shub::MstpInteger>

the bridgeId of the CIST root


used in the PDUs originated by
this node.
This element is only shown in
detail mode.
cost of the path to the CIST Root
seen from the bridge
This element is only shown in
detail mode.
port which offers the lowest path
cost to the Root bridge
This element is only shown in
detail mode.

hold-time

2640

Released

interval between no more then

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

name

Type

Description

- a signed integer

two PDUs are transmitted


This element is only shown in
detail mode.
max age of STP information
learned on a port before it is
discarded
This element is only shown in
detail mode.
time between transmission of
PDUs on a port when it is the
root
This element is only shown in
detail mode.
time how long a port stays in a
state before moving to the
forwarding state
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.
cost of the path to the CIST
regional Root seen from the
bridge
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.
the time since the TcWhile timer
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.

max-age

Parameter type: <Shub::MstpInteger>


- a signed integer

hello-time

Parameter type: <Shub::MstpInteger>


- a signed integer

fwd-delay

Parameter type: <Shub::MstpInteger>


- a signed integer

regional-root-id

Parameter type: <Shub::MstpBridgeId>


- the mstp bridge id
- length: 8

regional-root-cost

Parameter type: <Shub::MstpRootCost>


- root cost

bridge-mac-addr

Parameter type: <Sys::MacAddr>


- a mac-address (example : 01:02:03:04:05:06)
- length: 6

topology-chg-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec
Parameter type: <Shub::MstpCounter>
- an unsigned integer

topology-chg

root-bridge-chg

3HH-04416-EBAA-TCZZA 01

Parameter type: <Shub::MstpCounter>


- an unsigned integer

Released

2641

97 MSTP Status Commands

97.3 SHub MSTP Instance Status Command


Command Description
This command displays all parameters of a multiple spanning tree instance.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show mstp instance [ (instance) ]

Command Parameters
Table 97.3-1 "SHub MSTP Instance Status Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...16]

mstp instance number

Command Output
Table 97.3-2 "SHub MSTP Instance Status Command" Display parameters
Specific Information
name

Type

Description

root-cost
short name: root/cost

Parameter type: <Shub::MstpRootCost>


- root cost

root-port
short name: root/port

Parameter type: <Shub::MstpZeroNetworkPort>


( network : <Shub::MstpNetworkPort>
| none
| nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex> )
Possible values:
- nt : active nt slot
- none : no port
- network : network port
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Shub::MstpNetworkPort>

cost of the path to the MSTI


Regional Root seen by the bridge
This element is always shown.
port which offers the lowest path
cost to the MSTI Region Root
bridge
This element is always shown.

2642

Released

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

name

old-designated-root
regional-root-id

Type
- Network Port on Shub
Field type <Eqpt::PortIndex>
- the faceplate port number
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8

topology-chg-time
short name:
topology/chg-time

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

topology-chg
short name: topology/chg

Parameter type: <Shub::MstpCounter>


- an unsigned integer

root-bridge-chg

Parameter type: <Shub::MstpCounter>


- an unsigned integer

3HH-04416-EBAA-TCZZA 01

Description

the bridge id of the old root of the


mstp instance
This element is always shown.
the bridgeId of the MSTI regional
root id used in the PDUs
originated by this node.
This element is always shown.
the time since the TcWhile timer
for any port in this Bridge was
non-zero for this spanning tree
instance
This element is only shown in
detail mode.
The number of times that there
have been at least one non-zero
TcWhile Timer on this Bridge for
this spanning tree instance
This element is only shown in
detail mode.
The number of times this Bridge
has detected a Root Bridge
change for this spanning tree
instance.
This element is only shown in
detail mode.

Released

2643

97 MSTP Status Commands

97.4 SHub MSTP Network Port Status Command


Command Description
This command displays all mstp network port information.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show mstp network-port [ (port) ]

Command Parameters
Table 97.4-1 "SHub MSTP Network Port Status Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub

port number

Command Output
Table 97.4-2 "SHub MSTP Network Port Status Command" Display parameters
Specific Information
name
state

2644

Released

Type

Description

Parameter type: <Shub::MstpPortState>


( disabled
| discarding
| learning
| forwarding )
Possible values:
- disabled : disabled

state of the port


This element is always shown.

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

name

p2p-port
short name: port/p2p

edge-port
short name: port/edge

designated-root
short name:
designated/root
designated-port
short name:
designated/port
designated-bridge
short name:
designated/bridge
designated-cost
short name:
designated/cost
current-port-role
short name:
port-role/current

selected-port-role
short name:
port-role/selected

regional-path-cost
short name:
regional/path-cost
regional-root
short name: regional/root

3HH-04416-EBAA-TCZZA 01

Type
- discarding : discarding
- learning : learning
- forwarding : forwarding
Parameter type: <Shub::Boolean>
( yes
| no )
Possible values:
- yes : true
- no : false
Parameter type: <Shub::Boolean>
( yes
| no )
Possible values:
- yes : true
- no : false
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Shub::DesignatedPort>
- designated port 2 byte octet string
- length: 2
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Shub::MstpShowPathCost>
- port designated path cost
Parameter type: <Shub::MstpCistPortRole>
( disabled
| alternate
| backup
| root
| designated )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
Parameter type: <Shub::MstpCistPortRole>
( disabled
| alternate
| backup
| root
| designated )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
Parameter type: <Shub::MstpShowPathCost>
- port designated path cost
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id

Description

point-to-point status of the LAN


segment
This element is always shown.

operational value of the edge port


parameter
This element is always shown.

bridge identifier of the MSTI


regional root
This element is always shown.
port identifier of the port on the
designated bridge
This element is always shown.
bridge identifier of designated
bridge
This element is always shown.
path cost of the designated port
This element is always shown.
current port role of the port for
this spanning tree instance
This element is always shown.

selected port role of the port for


this spanning tree instance
This element is always shown.

contribution of this port to the


path cost
This element is only shown in
detail mode.
bridge id of the bridge recorded
as the CIST Regional Root

Released

2645

97 MSTP Status Commands

name

Type

Description

- length: 8

This element is only shown in


detail mode.
BPDUs transmitted on this port
for this spanning tree instance
This element is only shown in
detail mode.
This element is only shown in
detail mode.
invalid BPDUs received on this
port
This element is only shown in
detail mode.
migration count from one STP
protocol version to another
This element is only shown in
detail mode.

bpdu-tx
short name: bpdu/tx

Parameter type: <Shub::MstpCounter>


- an unsigned integer

bpdu-rx
short name: bpdu/rx
bpdu-invalid-rx
short name:
bpdu/invalid-rx

Parameter type: <Shub::MstpCounter>


- an unsigned integer
Parameter type: <Shub::MstpCounter>
- an unsigned integer

prot-migration

Parameter type: <Shub::MstpCounter>


- an unsigned integer

2646

Released

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

97.5 SHub MSTP Port Instance Status Command


Command Description
This command displays all mstp port instances.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show mstp port-instance [ (network-port) [ instance <Shub::MstpInstance> ] ]

Command Parameters
Table 97.5-1 "SHub MSTP Port Instance Status Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub
Parameter type: <Shub::MstpInstance>
Format:
- MSTP Instance
- range: [1...16]

port number

instance

mstp instance

Command Output
Table 97.5-2 "SHub MSTP Port Instance Status Command" Display parameters
Specific Information
name
state

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Shub::MstpPortState>


( disabled

state of the port


This element is always shown.

Released

2647

97 MSTP Status Commands

name

designated-root
short name:
designated/root
designated-bridge
short name:
designated/bridge
designated-port
short name:
designated/port
designated-cost
short name:
designated/cost
current-port-role
short name:
port-role/current

Description

| discarding
| learning
| forwarding )
Possible values:
- disabled : disabled
- discarding : discarding
- learning : learning
- forwarding : forwarding
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Shub::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Shub::DesignatedPort>
- designated port 2 byte octet string
- length: 2
Parameter type: <Shub::MstpShowPathCost>
- port designated path cost

bridge identifier of the MSTI


regional root
This element is always shown.
bridge identifier of designated
bridge
This element is always shown.
port identifier of the port on the
designated bridge
This element is always shown.
path cost of the designated port
This element is always shown.

Parameter type: <Shub::MstpMstiPortRole>


( disabled
| alternate
| backup
| root
| designated
| master )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
- master : master
Parameter type: <Shub::MstpMstiPortRole>
( disabled
| alternate
| backup
| root
| designated
| master )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
- master : master
Parameter type: <Shub::MstpCounter>
- an unsigned integer

selected-port-role
short name:
port-role/selected

bpdu-tx
short name: bpdu/tx
bpdu-rx
short name: bpdu/rx
bpdu-invalid-rx
short name:
bpdu/invalid-rx

2648

Type

Parameter type: <Shub::MstpCounter>


- an unsigned integer
Parameter type: <Shub::MstpCounter>
- an unsigned integer

Released

current port role of the port for


this spanning tree instance
This element is always shown.

selected port role of the port for


this spanning tree instance
This element is always shown.

BPDUs transmitted on this port


for this spanning tree instance
This element is only shown in
detail mode.
This element is only shown in
detail mode.
invalid BPDUs received on this
port
This element is only shown in

3HH-04416-EBAA-TCZZA

01

97 MSTP Status Commands

name

Type

fwd-transition

Parameter type: <Shub::MstpCounter>


- an unsigned integer

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
transition count to the forwarding
state
This element is only shown in
detail mode.

Released

2649

98- Ethernet Lt Configuration Data Status


Commands

98.1 Ethernet Lt Configuration Data Status Command Tree


98.2 Ethernet Port Interface Configuration Status
Command
98.3 Ethernet IGMP Configuration Status Command
98.4 Ethernet Security PAE Configuration Status
Command
98.5 Ethernet BridgePort Configuration Status Command
98.6 Ethernet QoS Configuration Status Command

2650

Released

98-2651
98-2652
98-2654
98-2657
98-2660
98-2664

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

98.1 Ethernet Lt Configuration Data Status


Command Tree
Description
This chapter gives an overview of nodes that are handled by "Ethernet Lt Configuration Data Status Commands".

Command Tree
----show
----config-data-port
- (if-index)
----interface-port
- [no] admin-state
- [no] link-updown-trap
- [no] user
- [no] severity
----igmp
- (port)
- perm-pkg-bitmap
- max-num-group
----security-pae
- (port)
- [no] controlled-port
- [no] quiet-period
- [no] tx-period
- [no] supp-timeout
- [no] server-timeout
- [no] max-req
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
- [no] initialize
----bridge-port
- (port)
- pvid
- default-priority
- mac-learn-off
- max-unicast-mac
- accept-frame-type
- prio-regen-prof
- prio-regen-name
- [no] qos-profile
----qos
- scheduler-profile
- cac-profile

3HH-04416-EBAA-TCZZA 01

Released

2651

98 Ethernet Lt Configuration Data Status Commands

98.2 Ethernet Port Interface Configuration Status


Command
Command Description
This command displays the Ethernet port interface configuration data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show config-data-port (if-index) interface-port [ no admin-state | admin-state <Eth::EthAdminStatus> ] [ no
link-updown-trap
|
link-updown-trap
<Itf::ifLinkUpDownTrapEnable>
]
[
no
user
|
user
<Itf::asamIfExtCustomerId> ] [ no severity | severity <Itf::asamIfExtAlmReportingSeverity> ]

Command Parameters
Table 98.2-1 "Ethernet Port Interface Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 98.2-2 "Ethernet Port Interface Configuration Status Command" Command Parameters
Parameter

Type

Description

[no] admin-state

Parameter type: <Eth::EthAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Itf::ifLinkUpDownTrapEnable>
Format:
( link-updown-trap

optional parameter with default


value: "admin-down"
the state of the interface

[no] link-updown-trap

2652

Released

optional parameter with default


value: "no-link-updown-trap"
indicates
whether

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Parameter

[no] user

[no] severity

3HH-04416-EBAA-TCZZA 01

Type

Description

| no-link-updown-trap )
Possible values:
- link-updown-trap : enable link-up/link-down traps
- no-link-updown-trap : disable link-up/link-down traps
Parameter type: <Itf::asamIfExtCustomerId>
Format:
- a string identifying the customer or user
- length: x<=64
Parameter type: <Itf::asamIfExtAlmReportingSeverity>
Format:
( indeterminate
| warning
| minor
| major
| critical
| no-alarms
| default
| no-value )
Possible values:
- indeterminate : not a definite known severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
- no-alarms : do not report alarm
- default : take default as specified via Interface Alarm
Configuration command
- no-value : no entry in the table

link-up/link-down
generated

traps

are

optional parameter with default


value: "available"
description of the user connected
to this interface
optional parameter with default
value: "default"
severity for alarm to be reported

Released

2653

98 Ethernet Lt Configuration Data Status Commands

98.3 Ethernet IGMP Configuration Status Command


Command Description
This command displays the Ethernet IGMP configuration data.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show config-data-port (if-index) igmp [ (port) ] perm-pkg-bitmap <Igmp::PermPkgBitMap> max-num-group
<Igmp::ChannelMaxNumGroup>

Command Parameters
Table 98.3-1 "Ethernet IGMP Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

(port)

2654

Released

Description

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>

3HH-04416-EBAA-TCZZA 01

Released

2655

98 Ethernet Lt Configuration Data Status Commands

Resource Identifier

Type

Description

- the ONT PORT identifier


Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 98.3-2 "Ethernet IGMP Configuration Status Command" Command Parameters


Parameter

Type

Description

perm-pkg-bitmap

Parameter type: <Igmp::PermPkgBitMap>


Format:
- a binary string
- length: 128
Parameter type: <Igmp::ChannelMaxNumGroup>
Format:
- max group number this port can support
- range: [0...1024]

optional parameter
packages, the user is allowed to
join

max-num-group

2656

Released

optional parameter
max group number this port

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

98.4 Ethernet Security PAE Configuration Status


Command
Command Description
This command displays the Ethernet security PAE configuration data.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show config-data-port (if-index) security-pae [ (port) ] [ no controlled-port | controlled-port
<Aaa::PaeControlledPortControl> ] [ no quiet-period | quiet-period <Aaa::paeQuitTime> ] [ no tx-period | tx-period
<Aaa::paeTime> ] [ no supp-timeout | supp-timeout <Aaa::paeTime> ] [ no server-timeout | server-timeout
<Aaa::paeTime> ] [ no max-req | max-req <Aaa::paeMaxReq> ] [ no authentication | authentication
<Aaa::PortAuthState> ] [ no init-authreq-off | init-authreq-off <Aaa::PortAuthReq> ] [ no handshake | handshake
<Aaa::PortHandShakeMode> ] [ no handshake-period | handshake-period <Aaa::PortHandShakePeriod> ] [ no
initialize | initialize <Aaa::InitCont> ]

Command Parameters
Table 98.4-1 "Ethernet Security PAE Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>

(port)

3HH-04416-EBAA-TCZZA 01

Description
interface index of the port
/

identification of the port or


/ virtual channel
/
/
/
/

Released

2657

98 Ethernet Lt Configuration Data Status Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / voip


| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 98.4-2 "Ethernet Security PAE Configuration Status Command" Command Parameters
Parameter

Type

Description

[no] controlled-port

Parameter type: <Aaa::PaeControlledPortControl>


Format:
( force-unauthorized
| auto
| force-authorized )
Possible values:
- force-unauthorized : force unauthorized control
- auto : automatic control
- force-authorized : force authorized control
Parameter type: <Aaa::paeQuitTime>
Format:
- quietPeriod
- range: [0...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeTime>
Format:
- authentication time
- range: [1...65535]
Parameter type: <Aaa::paeMaxReq>
Format:

optional parameter with default


value: "auto"
current value of the controlled
Port

[no] quiet-period

[no] tx-period

[no] supp-timeout

[no] server-timeout

[no] max-req

2658

Released

optional parameter with default


value: 60
quietPeriod constant currently
used, value in seconds
optional parameter with default
value: 30
txPeriod constant currently used,
value in seconds
optional parameter with default
value: 30
suppTimeout constant currently
used, value in seconds
optional parameter with default
value: 30
serverTimeout constant currently
used, value in seconds
optional parameter with default
value: 2

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Parameter
[no] authentication

[no] init-authreq-off

[no] handshake

[no] handshake-period

[no] initialize

3HH-04416-EBAA-TCZZA 01

Type

Description

- max number of requests


maxReq constant currently used
- range: [1...10]
Parameter type: <Aaa::PortAuthState>
optional parameter with default
Format:
value: "no-authen"
( authentication
enable 802.1x authentication
| no-authen )
Possible values:
- authentication : enable 802.1x authentication
- no-authen : disable 802.1x aithentication
Parameter type: <Aaa::PortAuthReq>
optional parameter with default
Format:
value: "initiate-authreq"
( initiate-authreq
specify initiate authentication
| init-authreq-off )
request to supplicant
Possible values:
- initiate-authreq : enable initiate authentication request to
supplicant
- init-authreq-off : disable initiate authentication request to
supplicant
Parameter type: <Aaa::PortHandShakeMode>
optional parameter with default
Format:
value: "no-handshake"
( handshake
enable handshake for this port
| no-handshake )
Possible values:
- handshake : enable handshake for this port
- no-handshake : disable handshake for this port
Parameter type: <Aaa::PortHandShakePeriod>
optional parameter with default
Format:
value: 15
- handshake time interval
specify the handshake time
- range: [5...90]
interval
Parameter type: <Aaa::InitCont>
optional parameter with default
Format:
value: "no-initialize"
( initialize
initialization control for this port
| no-initialize )
Possible values:
- initialize : initalize this port
- no-initialize : don't initialize this port

Released

2659

98 Ethernet Lt Configuration Data Status Commands

98.5 Ethernet BridgePort Configuration Status


Command
Command Description
This command displays the Bridge Port configured data.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show config-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority
<Vlan::Priority> mac-learn-off <Vlan::learnStatus> max-unicast-mac <Vlan::MaxMac> accept-frame-type
<Vlan::VlanFrameTypes>
prio-regen-prof
<Vlan::PrioRegenProfile>
prio-regen-name
<Vlan::PrioRegenProfileName> [ no qos-profile | qos-profile <Vlan::QosProfileName> ]

Command Parameters
Table 98.5-1 "Ethernet BridgePort Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
virtual channel
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

Description

Table 98.5-2 "Ethernet BridgePort Configuration Status Command" Command Parameters

2660

Released

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Parameter

Type

Description

pvid

Parameter type: <Vlan::StackedVlan>


Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: <Vlan::learnStatus>
Format:
( mac-learning
| mac-learn-off )
Possible values:
- mac-learning : enable self learning of mac address
- mac-learn-off : disable self learning of mac address
Parameter type: <Vlan::MaxMac>
Format:
- number of unicast mac addresses
- range: [1...8192]
Parameter type: <Vlan::VlanFrameTypes>
Format:
( single-tagged
| untagged
| mixed-tagged )
Possible values:
- single-tagged : admit only vlan tagged
- untagged : admit only vlan untagged
- mixed-tagged : admit vlan tagged and vlan untagged
Parameter type: <Vlan::PrioRegenProfile>
Format:
( none
| trusted-port
| best-effort
| cl-all-prio-3
| cl-all-prio-4
| background
| be-cl-voice
| be-cl-1d-voice
| be-voice
| l2-vpn-3
| l2-vpn-4
| 11
| 12
| 13
| 14
| 15

optional parameter
default vlan id for untagged
frames

default-priority

mac-learn-off

max-unicast-mac

accept-frame-type

prio-regen-prof

3HH-04416-EBAA-TCZZA 01

optional parameter
priority to be set in upstream
frames
optional parameter
self learning of mac address

optional parameter
max unicast mac addresses
optional parameter
accept frame types

optional parameter
priority regeneration profile

Released

2661

98 Ethernet Lt Configuration Data Status Commands

Parameter

Type

prio-regen-name

2662

Description

| 16
| 17
| 18
| 19
| 20
| 21
| 22
| 23
| 24
| 25
| 26
| 27
| 28
| 29
| 30
| 31
| 32 )
Possible values:
- none : default value
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority 3 traffic
- cl-all-prio-4 : controlled load, all priority 4 traffic
- background : background
- be-cl-voice : best effort, controlled load, voice
- be-cl-1d-voice : best effort, controlled load, 802.Id Annex
G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes
- 11 : operator-defined profile
- 12 : operator-defined profile
- 13 : operator-defined profile
- 14 : operator-defined profile
- 15 : operator-defined profile
- 16 : operator-defined profile
- 17 : operator-defined profile
- 18 : operator-defined profile
- 19 : operator-defined profile
- 20 : operator-defined profile
- 21 : operator-defined profile
- 22 : operator-defined profile
- 23 : operator-defined profile
- 24 : operator-defined profile
- 25 : operator-defined profile
- 26 : operator-defined profile
- 27 : operator-defined profile
- 28 : operator-defined profile
- 29 : operator-defined profile
- 30 : operator-defined profile
- 31 : operator-defined profile
- 32 : operator-defined profile
Parameter type: <Vlan::PrioRegenProfileName>
optional parameter
Format:
priority regeneration profile name
( none
| name : <Vlan::IgnoredVlanProfileName> )
Possible values:

Released

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Parameter

[no] qos-profile

3HH-04416-EBAA-TCZZA 01

Type

Description

- none : no profile name to associate


- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Vlan::QosProfileName>
optional parameter with default
Format:
value: "none"
( none
qos profile name
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

Released

2663

98 Ethernet Lt Configuration Data Status Commands

98.6 Ethernet QoS Configuration Status Command


Command Description
This command displays the Ethernet QoS configuration data.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show config-data-port (if-index) qos scheduler-profile <Qos::QosSchedulerProfileName> cac-profile
<Qos::QosCacProfileName>

Command Parameters
Table 98.6-1 "Ethernet QoS Configuration Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 98.6-2 "Ethernet QoS Configuration Status Command" Command Parameters


Parameter

Type

Description

scheduler-profile

Parameter type: <Qos::QosSchedulerProfileName>


Format:
( none
| name : <Qos::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
Parameter type: <Qos::QosCacProfileName>
Format:
( name : <Qos::IgnoredQosProfileName>

optional parameter
the name of the scheduler profile
to be mapped on this dsl link3

cac-profile

2664

Released

optional parameter
the name of the cac profile to be
mapped on this dsl link3

3HH-04416-EBAA-TCZZA

01

98 Ethernet Lt Configuration Data Status Commands

Parameter

Type

Description

| none )
Possible values:
- none : no profile name to associated
- name : enter profile name to be associated
Data driven field type
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

3HH-04416-EBAA-TCZZA 01

Released

2665

99- Ethernet Status Commands

99.1 Ethernet Status Command Tree


99.2 Interface MAU Status Command
99.3 SFP status commands
99.4 Ethernet Counters Near End Line Current 15 Min
99.5 Ethernet Counters Near End Line Current Day
99.6 Ethernet Counters Near End Line Previous 15 Min
99.7 Ethernet Counters Near End Line Previous Day
99.8 Ethernet PM Interval Per Interface Status Command
99.9 Ethernet Lt Dot3 Status Command
99.10 Ethernet RMON Counters Status Command
99.11 Ethernet Statistics Line Status Command

2666

Released

99-2667
99-2668
99-2673
99-2675
99-2678
99-2681
99-2684
99-2687
99-2689
99-2691
99-2695

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.1 Ethernet Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Ethernet Status Commands".

Command Tree
----show
----ethernet
----mau
- (if-index)
- index
----sfp
- (if-index)
- index
----counters
----near-end
----line
----current-interval
- (if-index)
----current-1day
- (if-index)
----previous-interval
- (if-index)
- interval-no
----previous-1day
- (if-index)
- interval-no
----eth-int
- (if-index)
----dot3stats
- (stats-index)
----etherstats
- (stats-index)
----statistics
----line
- (if-index)

3HH-04416-EBAA-TCZZA 01

Released

2667

99 Ethernet Status Commands

99.2 Interface MAU Status Command


Command Description
This command displays the Ethernet MAU parameters.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet mau [ (if-index) [ index <Transport::Index> ] ]

Command Parameters
Table 99.2-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the mau
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Transport::Index>
identify MAU, among others
Format:
connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]

index

Description

Command Output
Table 99.2-2 "Interface MAU Status Command" Display parameters
Specific Information
name
type

2668

Released

Type

Description

Parameter type: <Ether::MAUType>


( 10baset
| 100basetxhd
| 100basetxfd
| 100basefxhd
| 100basefxfd

Specifies the MAU type. If the


MAU type is unknown, then
unknown Mac type will be
returned. If the MAU is a link or
fiber type then media-available is
equivalent to the link test fail

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

media-available

3HH-04416-EBAA-TCZZA 01

Type

Description

| 1000basexhd
| 1000basexfd
| 1000baselxhd
| 1000baselxfd
| 1000basesxhd
| 1000basesxfd
| 1000basethd
| 1000basetfd
| 10gbaser
| 10gbaseer
| 10gbaselr
| 100basebx10d
| 100basebx10u
| 100baselx10
| 1000basebx10d
| 1000basebx10u
| 1000baselx10
| unknown )
Possible values:
- 10baset : UTP 10M
- 100basetxhd : UTP 100M half duplex
- 100basetxfd : UTP 100M full duplex
- 100basefxhd : X fiber over PMT half duplex
- 100basefxfd : X fiber over PMT full duplex
- 1000basexhd : PCS/PMA,unknown PMD, half duplex
- 1000basexfd : PCS/PMA,unknown PMD, full duplex
- 1000baselxhd : fiber over long-wavelength laser half
duplex
- 1000baselxfd : fiber over long-wavelength laser full duplex
- 1000basesxhd : fiber over short-wavelength laser half
duplex
- 1000basesxfd : fiber over short-wavelength laser full
duplex
- 1000basethd : UTP 1G half duplex
- 1000basetfd : UTP 1G full duplex
- 10gbaser : fiber 1OG ethernet
- 10gbaseer : fiber 1OG ethernet extended reach, 30km
- 10gbaselr : fiber 1OG ethernet long reach, 10km
- 100basebx10d : one single-mode fiber OLT long
wavelength, 10km, 100 base
- 100basebx10u : one single-mode fiber ONU, long
wavelength, 10km, 100 base
- 100baselx10 : two single-mode fibers over long
wavelength, 10km, 100 base
- 1000basebx10d : one single-mode fiber OLT over long
wavelength, 10km, 1000 base
- 1000basebx10u : one single-mode fiber ONU over long
wavelength, 10km, 1000 base
- 1000baselx10 : two single-mode fibers over long
wavelength, 10km, 1000 base
- unknown : unknown type
Parameter type: <Transport::MauAvailable>
( other
| unknown
| available
| not-available
| remote-fault

state/low light function. For an


AUI or a coax (including
broadband) MAU this indicates
whether or not loopback is
detected on the DI circuit. The
value of this attribute persists
between packets for MAU types
AUI, 10BASE5, 10BASE2,
10BROAD36, and 10BASE-FP.
This element is always shown.

Specifies whether the media is


availble for the MAU or not.
This element is always shown.

Released

2669

99 Ethernet Status Commands

name

Type
| invalid-signal
| remote-jabber
| remote-link-loss
| remote-test
| off-line
| auto-neg-error )
Possible values:
- other : MAU in other state
- unknown : MAU's true state is unknown
- available :
- not-available : MAU is fully functional
- remote-fault : power down
- invalid-signal : reset the MAU
- remote-jabber : power down
- remote-link-loss : power down
- remote-test : power down
- off-line : power down
- auto-neg-error : power down
Parameter type: <Transport::MauJabber>
( other
| unknown
| no-jabber
| jabbering )
Possible values:
- other : if not in any state
- unknown : MAU's true state is unknown
- no-jabber : MAU not jabbering
- jabbering : MAU is jabbering
Parameter type: <Ether::B100BaseFXFD>
( yes
| no )
Possible values:
- yes : 100basefxfd supported
- no : 100basefxfd not supported
Parameter type: <Ether::B100BaseLX10>
( yes
| no )
Possible values:
- yes : 100baselx10 supported
- no : 100baselx10 not supported
Parameter type: <Ether::B100BaseBX10D>
( yes
| no )
Possible values:
- yes : 100basebx10d supported
- no : 100basebx10d not supported
Parameter type: <Ether::B100BaseBX10U>
( yes
| no )
Possible values:
- yes : 100basebx10u supported
- no : 100basebx10u supported
Parameter type: <Ether::B100BaseTXFD>
( yes
| no )
Possible values:
- yes : 100basetxfd supported

jabber-state

b100basefxfd

b100baselx10

b100basebx10d

b100basebx10u

b100basetxfd

2670

Released

Description

The
jabber-state
indicates
whether this entity is jabbering,
not jabbering, unknown or other
state.
This element is always shown.

X fiber over PMT full duplex


This element is only shown in
detail mode.

two single-mode fibers over long


wavelength, 10km, 100 base
This element is only shown in
detail mode.
one single-mode fiber OLT long
wavelength, 10km, 100 base
This element is only shown in
detail mode.
one single-mode fiber ONU, long
wavelength, 10km, 100 base
This element is only shown in
detail mode.
UTP 100M full duplex
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name
b1000basetfd

b1000basesxfd

b1000baselx10

b1000baselxfd

b1000basebx10u

b1000basebx10d

b10gbaser

b10gbaselr

b10gbaseer

auto-neg-supported

3HH-04416-EBAA-TCZZA 01

Type
- no : 100basetxfd not supported
Parameter type: <Ether::B1000BaseTFD>
( yes
| no )
Possible values:
- yes : 1000basetfd supported
- no : 1000basetfd not supported
Parameter type: <Ether::B1000BaseSXFD>
( yes
| no )
Possible values:
- yes : 1000basesxfd supported
- no : 1000basesxfd not supported
Parameter type: <Ether::B1000BaseLX10>
( yes
| no )
Possible values:
- yes : 1000baselx10 supported
- no : 1000baselx10 not supported
Parameter type: <Ether::B1000BaseLXFD>
( yes
| no )
Possible values:
- yes : 1000baselxfd supported
- no : 1000baselxfd not supported
Parameter type: <Ether::B1000BaseBX10U>
( yes
| no )
Possible values:
- yes : 1000basebx10u supported
- no : 1000basebx10u not supported
Parameter type: <Ether::B1000BaseBX10D>
( yes
| no )
Possible values:
- yes : 1000basebx10d supported
- no : 1000basebx10d not supported
Parameter type: <Ether::B10GBaseR>
( yes
| no )
Possible values:
- yes : 10GbaseR supported
- no : 10GbaseR not supported
Parameter type: <Ether::B10GBaseLR>
( yes
| no )
Possible values:
- yes : 10GbaseLR supported
- no : 10GbaseLR not supported
Parameter type: <Ether::B10GBaseER>
( yes
| no )
Possible values:
- yes : 10GbaseER supported
- no : 10GbaseER not supported
Parameter type: <Ether::TruthValue>
( true

Description
UTP 1G full duplex
This element is only shown in
detail mode.

fiber over short-wavelength laser


full duplex
This element is only shown in
detail mode.
two single-mode fibers over long
wavelength, 10km, 1000 base
This element is only shown in
detail mode.
fiber over long-wavelength laser
full duplex
This element is only shown in
detail mode.
one single-mode fiber ONU over
long wavelength, 10km, 1000
base
This element is only shown in
detail mode.
one single-mode fiber OLT over
long wavelength, 10km, 1000
base
This element is only shown in
detail mode.
two single-mode fiber 10G base
This element is only shown in
detail mode.

two single-mode fiber 10km 10G


base
This element is only shown in
detail mode.
two single-mode fiber 30km 10G
base
This element is only shown in
detail mode.
Specifies
whether
or
not
auto-negotiation is supported on

Released

2671

99 Ethernet Status Commands

name

auto-neg-status

cap1000base-xfd

cap1000base-tfd

2672

Released

Type

Description

| false )
Possible values:
- true : autonegotiation is supported
- false : autonegotiation is not supported
Parameter type: <Ether::AutoNegStatus>
( other
| configuring
| complete
| disabled
| paralleldetectfail )
Possible values:
- other : unknown auto-negotiation status
- configuring : auto-negotiation still ongoing
- complete : auto-negotiation completed
- disabled : auto-negotiation disabled
- paralleldetectfail : parallel detection failed
Parameter type: <Ether::ACAP_1000BaseXFD>
( yes
| no )
Possible values:
- yes : 1000BaseXFD supported
- no : 1000BaseXFD not supported
Parameter type: <Ether::ACAP_1000BaseTFD>
( yes
| no )
Possible values:
- yes : 1000BaseTFD supported
- no : 1000BaseTFD not supported

this MAU.
This element is always shown.
Displays the auto-negotiation
status of this MAU.
This element is always shown.

optical
1G
full
duplex
autonegotiation capable
This element is only shown in
detail mode.
electrical
1G
full
duplex
autonegotiation capable
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.3 SFP status commands


Command Description
This command displays the Ethernet SFP parameters

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet sfp [ (if-index) [ index <Transport::Index> ] ]

Command Parameters
Table 99.3-1 "SFP status commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the sfp
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Transport::Index>
identify sfp, among others
Format:
connected to same interface
- port to which the MAU is connected
- range: [1...2147483647]

index

Description

Command Output
Table 99.3-2 "SFP status commands" Display parameters
Specific Information
name
sfp-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Transport::SFPstatus>


( operational-up
| interface-down
| no-alcatel-label
| als
| type-mismatch

identifies the status of the sfp


This element is always shown.

Released

2673

99 Ethernet Status Commands

name

Type

sfp-inventory

2674

Description

| local-power-off
| brother-power-off
| active-power-off )
Possible values:
- operational-up : SFP is operational up
- interface-down : SFP is not plugged in, interface is down
- no-alcatel-label : SFP is plugged in but in power down
because no Alcatel-Lucent label
- als : SFP is plugged in but in power down because of ALS
- type-mismatch : SFP real type mismatch with configured
type
- local-power-off : local SFP power off since temperature
over
- brother-power-off : brother SFP power off since
temperature over
- active-power-off : SFP power down actively by operator
Parameter type: <Transport::SFPinventory>
indicates the information of the
- specification of Sfp inventory.
sfp vendor
- length: 1<=x<=128
This element is only shown in
detail mode.

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.4 Ethernet Counters Near End Line Current 15


Min
Command Description
Represents for the current interval the FCS failure count.
Represents for the current interval the frame too Long count.
Represents for interval MAC sublayer transmit error.
Represents for intervall MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
Store the time interval.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet counters near-end line current-interval [ (if-index) ]

Command Parameters
Table 99.4-1 "Ethernet Counters Near End Line Current 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 99.4-2 "Ethernet Counters Near End Line Current 15 Min" Display parameters

3HH-04416-EBAA-TCZZA 01

Released

2675

99 Ethernet Status Commands

Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

fcs

Parameter type: <Counter>


- 32 bit counter

too-long

Parameter type: <Counter>


- 32 bit counter

mac-trans

Parameter type: <Counter>


- 32 bit counter

mac-rec

Parameter type: <Counter>


- 32 bit counter

in-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

Represents for the current 15


minute interval the LOS failure
count
This element is always shown.
Represents for the current 15
minute interval the FCS failure
count
This element is always shown.
Represents for the current 15
minute interval the frame too
Long count
This element is always shown.
Represents for the internal MAC
sublayer transmit error
This element is always shown.
Represents for the internal MAC
sublayer receive error
This element is always shown.
Represents for the total bytes
received
This element is only shown in
detail mode.
Represents for the total packets
received
This element is only shown in
detail mode.
Represents for the total errored
packets received
This element is only shown in
detail mode.
Represents for the total discarded
packets at receive
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at receive
This element is only shown in
detail mode.
Represents for the total bytes
transmitted
This element is only shown in
detail mode.
Represents for the total packets
transmitted
This element is only shown in
detail mode.
Represents for the total errored
packets transmitted
This element is only shown in
detail mode.
Represents for the total packets
discarded at transmit
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at transmit

2676

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

Type

mea-time

Parameter type: <ETHITF::MeaTime>


- the specification of measuredtime
- range: [0...86400]

inv-data-flag

Parameter type: <ETHITF::DataFlag>


- the specification of invalid-data-flag
- range: [0...1]
Parameter type: <ETHITF::Val15m>
- the specification of validintervals
- range: [0...96]

val-int

3HH-04416-EBAA-TCZZA 01

Description
This element is only shown in
detail mode.
Measured in seconds, that
statistics for this entry have been
counted
This element is always shown.
Indicates the validity of the
corresponding PM data
This element is always shown.
Store the time interval
This element is always shown.

Released

2677

99 Ethernet Status Commands

99.5 Ethernet Counters Near End Line Current Day


Command Description
Represents for the current 1day the FCS failure count.
Represents for the current 1 day the frame too Long count.
Represents for 1day MAC sublayer transmit error.
Represents for 1dayl MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.
Store the time interval.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet counters near-end line current-1day [ (if-index) ]

Command Parameters
Table 99.5-1 "Ethernet Counters Near End Line Current Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 99.5-2 "Ethernet Counters Near End Line Current Day" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>

Represents for the current 1day

2678

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

Type

Description

- 32 bit counter

the LOS failure count


This element is always shown.
Represents for the current 1day
the FCS failure count
This element is always shown.
Represents for the current 1 day
the frame too Long count
This element is always shown.
Represents for 1day MAC
sublayer transmit error
This element is always shown.
Represents for 1dayl MAC
sublayer receive error
This element is always shown.
Represents for the total bytes
received
This element is only shown in
detail mode.
Represents for the total packets
received
This element is only shown in
detail mode.
Represents for the total errored
packets received
This element is only shown in
detail mode.
Represents for the total discarded
packets at receive
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at receive
This element is only shown in
detail mode.
Represents for the total bytes
transmitted
This element is only shown in
detail mode.
Represents for the total packets
transmitted
This element is only shown in
detail mode.
Represents for the total errored
packets at transmit
This element is only shown in
detail mode.
Represents for the total packets
discarded at transmit
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at transmit
This element is only shown in
detail mode.
Measured in seconds, that
statistics for this entry have been
counted

fcs

Parameter type: <Counter>


- 32 bit counter

too-long

Parameter type: <Counter>


- 32 bit counter

mac-trans

Parameter type: <Counter>


- 32 bit counter

mac-rec

Parameter type: <Counter>


- 32 bit counter

in-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

mea-time

Parameter type: <ETHITF::MeaTime>


- the specification of measuredtime
- range: [0...86400]

3HH-04416-EBAA-TCZZA 01

Released

2679

99 Ethernet Status Commands

name

Type

inv-data-flag

Parameter type: <ETHITF::DataFlag>


- the specification of invalid-data-flag
- range: [0...1]
Parameter type: <ETHITF::Val1day>
- the specification of 1day-valid-intervals
- range: [0...30]

val-day

2680

Released

Description
This element is always shown.
Indicates the validity of the
corresponding PM data
This element is always shown.
Store the time interval
This element is always shown.

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.6 Ethernet Counters Near End Line Previous 15


Min
Command Description
Represents for the previous interval the FCS failure count.
Represents for the previous interval the frame too Long count.
Represents for previous interval MAC sublayer transmit error.
Represents for previous interval MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
>
show
ethernet
counters
near-end
<ETHITF::IntervalNumber15min> ] ]

line

previous-interval

(if-index)

interval-no

Command Parameters
Table 99.6-1 "Ethernet Counters Near End Line Previous 15 Min" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <ETHITF::IntervalNumber15min>
15 minute interval number
Format:
- the specification of 15min-interval-number
- range: [1...96]

interval-no

Description

Command Output
3HH-04416-EBAA-TCZZA 01

Released

2681

99 Ethernet Status Commands

Table 99.6-2 "Ethernet Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

fcs

Parameter type: <Counter>


- 32 bit counter

too-long

Parameter type: <Counter>


- 32 bit counter

mac-trans

Parameter type: <Counter>


- 32 bit counter

mac-rec

Parameter type: <Counter>


- 32 bit counter

in-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

Represents for the previous 15


minute interval the LOS failure
count
This element is always shown.
Represents for the previous 15
minute interval the FCS failure
count
This element is always shown.
Represents for the previous 15
minute interval the frame too
Long count
This element is always shown.
Represents for the internal MAC
sublayer transmit error
This element is always shown.
Represents for the internal MAC
sublayer receive error
This element is always shown.
Represents for the total bytes
received
This element is only shown in
detail mode.
Represents for the total packets
received
This element is only shown in
detail mode.
Represents for the total errored
packets received
This element is only shown in
detail mode.
Represents for the total discarded
packets at receive
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at receive
This element is only shown in
detail mode.
Represents for the total bytes
transmitted
This element is only shown in
detail mode.
Represents for the total packets
transmitted
This element is only shown in
detail mode.
Represents for the total errored
packets transmitted
This element is only shown in
detail mode.
Represents for the total packets
discarded at transmit
This element is only shown in
detail mode.

2682

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

Type

Description

out-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

mea-time

Parameter type: <ETHITF::MeaTime>


- the specification of measuredtime
- range: [0...86400]

inv-data-flag

Parameter type: <ETHITF::DataFlag>


- the specification of invalid-data-flag
- range: [0...1]

Represents for the total errored


and discarded packets at transmit
This element is only shown in
detail mode.
Measured in seconds, that
statistics for this entry have been
counted
This element is always shown.
Indicates the validity of the
corresponding PM data
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2683

99 Ethernet Status Commands

99.7 Ethernet Counters Near End Line Previous


Day
Command Description
Represents for the previous 1day the FCS failure count.
Represents for the previous 1 day the frame too Long count.
Represents for previous 1day MAC sublayer transmit error.
Represents for previous 1day MAC sublayer receive error.
Measured in seconds, that statistics for this entry have been counted.
Indicates the validity of the corresponding PM data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet counters near-end line previous-1day [ (if-index) [ interval-no <ETHITF::IntervalNumber1day> ] ]

Command Parameters
Table 99.7-1 "Ethernet Counters Near End Line Previous Day" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <ETHITF::IntervalNumber1day>
1 day interval number
Format:
- the specification of 1day-valid-intervals
- range: [0...30]

interval-no

Description

Command Output

2684

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

Table 99.7-2 "Ethernet Counters Near End Line Previous Day" Display parameters
Specific Information
name

Type

Description

los

Parameter type: <Counter>


- 32 bit counter

fcs

Parameter type: <Counter>


- 32 bit counter

too-long

Parameter type: <Counter>


- 32 bit counter

mac-trans

Parameter type: <Counter>


- 32 bit counter

mac-rec

Parameter type: <Counter>


- 32 bit counter

in-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-drop-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

Represents for the previous 1day


the LOS failure count
This element is always shown.
Represents for the previous 1day
the FCS failure count
This element is always shown.
Represents for the previous 1day
the frame too Long count
This element is always shown.
Represents for the Previous 1 day
MAC sublayer transmit error
This element is always shown.
Represents for the previous 1day
MAC sublayer receive error
This element is always shown.
Represents for the total bytes
received
This element is only shown in
detail mode.
Represents for the total packets
received
This element is only shown in
detail mode.
Represents for the total errored
packets received
This element is only shown in
detail mode.
Represents for the total discarded
packets at receive
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at receive
This element is only shown in
detail mode.
Represents for the total bytes
transmitted
This element is only shown in
detail mode.
Represents for the total packets
transmitted
This element is only shown in
detail mode.
Represents for the total errored
packets transmitted
This element is only shown in
detail mode.
Represents for the total packets
discarded at transmit
This element is only shown in
detail mode.
Represents for the total errored
and discarded packets at transmit
This element is only shown in

3HH-04416-EBAA-TCZZA 01

Released

2685

99 Ethernet Status Commands

name

Type

mea-time

Parameter type: <ETHITF::MeaTime>


- the specification of measuredtime
- range: [0...86400]

inv-data-flag

Parameter type: <ETHITF::DataFlag>


- the specification of invalid-data-flag
- range: [0...1]

2686

Released

Description
detail mode.
Measured in seconds, that
statistics for this entry have been
counted
This element is always shown.
Indicates the validity of the
corresponding PM data
This element is always shown.

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.8 Ethernet PM Interval Per Interface Status


Command
Command Description
This command displays the number of available pm intervals per ethernet interface.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet eth-int [ (if-index) ]

Command Parameters
Table 99.8-1 "Ethernet PM Interval Per Interface Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 99.8-2 "Ethernet PM Interval Per Interface Status Command" Display parameters
Specific Information
name

Type

Description

cur-int-elapsedtime

Parameter type: <SignedInteger>


- a signed integer

cur-1day-elapsedtime

Parameter type: <SignedInteger>


- a signed integer

valid-intervals

Parameter type: <SignedInteger>

nbr of sec elapsed in cur intvl


err-measurement
This element is always shown.
nbr of sec elapsed in cur one day
err-measurement
This element is always shown.
nbr of prev intvl for which valid

3HH-04416-EBAA-TCZZA 01

Released

2687

99 Ethernet Status Commands

name
valid-1days

2688

Type

Description

- a signed integer

data has been stored


This element is always shown.
nbr of prev 1Days for which valid
data has been stored
This element is always shown.

Parameter type: <SignedInteger>


- a signed integer

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.9 Ethernet Lt Dot3 Status Command


Command Description
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The parameter stats-index gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC.
The fcs-error parameter gives a count of frames received on a particular interface that are an integral number of
octets in length, but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error. The count represented by an instance of this object is incremented when the
frameCheckError status is returned by the MAC service to the LLC.
The internal-mac-tx-error parameter gives a count of frames for which transmission on a particular interface fails
due to an internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not
counted by the corresponding instance of either the late collisions object, the excessive collisions object, or the
carrier sense errors object. The precise meaning of the count represented by an instance of this object is
implementation-specific. In particular, an instance of this object may represent a count of transmission errors on a
particular interface that are not otherwise counted.
The internal-mac-rx-error parameter gives a count of frames for which reception on a particular interface fails due
to an internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted
by the corresponding instance of either the frame toolongs object, the alignment errors object, or the FCS errors
object. The precise meaning of the count represented by an instance of this object is implementation-specific. In
particular, an instance of this object may represent a count of receive errors on a particular interface that are not
otherwise counted.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet dot3stats [ (stats-index) ]

Command Parameters
Table 99.9-1 "Ethernet Lt Dot3 Status Command" Resource Parameters
Resource Identifier

Type

(stats-index)

Format:
index of the interface to an
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / ethernet-like medium
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

3HH-04416-EBAA-TCZZA 01

Description

Released

2689

99 Ethernet Status Commands

Resource Identifier

Type

Description

- the shelf number


Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Command Output
Table 99.9-2 "Ethernet Lt Dot3 Status Command" Display parameters
Specific Information
name

Type

Description

align-err

Parameter type: <Counter>


- 32 bit counter

fcs-err

Parameter type: <Counter>


- 32 bit counter

internal-mac-tx-err

Parameter type: <Counter>


- 32 bit counter

internal-mac-rx-err

Parameter type: <Counter>


- 32 bit counter

A count of frames received on a


particular interface that are not an
integral number of octets in
length and do not pass the FCS
check. The count represented by
an instance of this object is
incremented
when
the
alignmentError status is returned
by the MAC service to the LLC
This element is always shown.
A count of frames received on a
particular interface that are not an
integral number of octets in
length and do not pass the FCS
check. The count represented by
an instance of this object is
incremented
when
the
frameCheckError
status
is
returned by the MAC service to
the LLC
This element is always shown.
A count of frames for which
transmission on a particular
interface fails due to an internal
MAC sublayer transmit error.
This element is only shown in
detail mode.
A count of frames for which
reception on a particular interface
fails due to an internal MAC
sublayer receive error.
This element is only shown in
detail mode.

2690

Released

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.10 Ethernet RMON Counters Status Command


Command Description
This command displays the statistics for a collection of Ethernet-like interfaces attached to a particular system.
There will be one row in this table for each Ethernet-like interface in the system. The parameter stats-index gives
an index value that uniquely identifies an interface to an Ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet etherstats [ (stats-index) ]

Command Parameters
Table 99.10-1 "Ethernet RMON Counters Status Command" Resource Parameters
Resource Identifier

Type

(stats-index)

Format:
index of the interface to an
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / ethernet-like medium
<Eqpt::PortId>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 99.10-2 "Ethernet RMON Counters Status Command" Display parameters
Specific Information

3HH-04416-EBAA-TCZZA 01

Released

2691

99 Ethernet Status Commands

name

Type

Description

entry-status

Parameter type: <ETHITF::CounterEntryStatus>


( valid
| invalid )
Possible values:
- valid : counters for this ifIndex are valid
- invalid : entry represents one of the device's addresses
Parameter type: <Counter32>
- 64 bit counter

The status of the entry. Valid


indicates the counters have actual
values, invalid means the
counters are unreliable.
This element is always shown.

drop-events

broadcast-pkts

Parameter type: <Counter32>


- 64 bit counter

multicast-pkts

Parameter type: <Counter32>


- 64 bit counter

oversize-pkts

Parameter type: <Counter32>


- 64 bit counter

undersize-pkts

Parameter type: <Counter32>


- 64 bit counter

fragments

Parameter type: <Counter32>


- 64 bit counter

jabbers

Parameter type: <Counter32>


- 64 bit counter

2692

Released

The total number of events in


which packets were dropped by
the probe due to lack of
resources. Note that this number
is not necessarily the number of
packets dropped; it is just the
number of times this condition
has been detected.
This element is only shown in
detail mode.
The total number of good packets
received that were directed to the
broadcast address. Note that this
does not include multicast
packets.
This element is only shown in
detail mode.
The total number of good packets
received that were directed to a
multicast address. Note that this
number does not include packets
directed to the broadcast address.
This element is only shown in
detail mode.
The total number of packets
received that were longer than
1518 octets (excluding framing
bits,but including FCS octets).
This element is only shown in
detail mode.
The total number of packets
received that were less than 64
octets long (excluding framing
bits, but including FCS octets)
This element is only shown in
detail mode.
The total number of packets
received that were less than 64
octets in length (excluding
framing bits but including FCS
octets) and had either a bad
Frame Check Sequence (FCS)
with an integral number of octets
(FCS Error) or a bad FCS with a
non-integral number of octets
(Alignment Error).
This element is only shown in
detail mode.
The total number of packets
received that were longer than
1518 octets (excluding framing

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

Type

packets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

total-64-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

total-65to127-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

total-128to255-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

total-256to511-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

total-512to1023-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

3HH-04416-EBAA-TCZZA 01

Description
bits, but including FCS octets),
and had either a bad Frame
Check Sequence (FCS) with an
integral number of octets (FCS
Error) or a bad FCS with a
non-integral number of octets
(Alignment Error).
This element is only shown in
detail mode.
The total number of packets
(including bad packets, broadcast
packets, and multicast packets)
received.
This element is always shown.
The total number of octets of data
(including those in bad packets)
received
on
the
network
(excluding framing bits but
including FCS octets).
This element is always shown.
The total number of packets
(including bad packets) received
that were 64 octets in length
(excluding framing bits but
including FCS octets).
This element is only shown in
detail mode.
The total number of packets
(including bad packets) received
that were between 65 and 127
octets in length inclusive
(excluding framing bits but
including FCS octets).
This element is only shown in
detail mode.
The total number of packets
(including bad packets) received
that were between 128 and 255
octets in length inclusive
(excluding framing bits but
including FCS octets).
This element is only shown in
detail mode.
The total number of packets
(including bad packets) received
that were between 256 and 511
octets in length inclusive
(excluding framing bits but
including FCS octets).
This element is only shown in
detail mode.
The total number of packets
(including bad packets) received
that were between 512 and 1023
octets in length inclusive
(excluding framing bits but
including FCS octets).

Released

2693

99 Ethernet Status Commands

name

Type

total-1024to1518-pkts

2694

Released

Description

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

This element is only shown in


detail mode.
The total number of packets
(including bad packets) received
that were between 1024 and 1518
octets in length inclusive
(excluding framing bits but
including FCS octets).
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

99.11 Ethernet Statistics Line Status Command


Command Description
This command allow the operator to display the ethernet line counter statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show ethernet statistics line [ (if-index) ]

Command Parameters
Table 99.11-1 "Ethernet Statistics Line Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the ethernet
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / line
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 99.11-2 "Ethernet Statistics Line Status Command" Display parameters
Specific Information
name

Type

Description

in-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-discard-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

the total number of octets


received
on
the
interface,including
framing
characters
This element is always shown.
the number of inbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being
deliverable
to
a

3HH-04416-EBAA-TCZZA 01

Released

2695

99 Ethernet Status Commands

name

Type

Description

in-ucast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-nucast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-bcast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

in-mcast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

pkts-unknown-proto

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-octets

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-disc-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

2696

Released

higher-layer protocol.
This element is only shown in
detail mode.
the number of packets, delivered
by this sub-layer to a higher
(sub-)layer, which were not
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
the number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
for packet-oriented interfaces, the
number of inbound packets that
contained errors preventing them
from being deliverable to a
higher-layer protocol.
This element is only shown in
detail mode.
the number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.
the number of packets, delivered
by this sub-layer to a higher
(sub-)layer,
which
were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
for packet-oriented interfaces, the
number of packets received via
the
interface
which
were
discarded because of an unknown
or unsupported protocol.
This element is only shown in
detail mode.
the total number of octets
transmitted out of the interface,
including framing characters.
This element is always shown.
the number of outbound packets
which were chosen to be
discarded even though no errors
had been detected to prevent their
being transmitted.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

99 Ethernet Status Commands

name

Type

out-ucast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-nucast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-err-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-mcast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

out-bcast-pkts

Parameter type: <OctetCounter64>


- 64 bit counter,range:[0-9223372036854775808]

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
the total number of packets that
higher-level protocols requested
be transmitted, and which were
not addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
the total number of packets that
higher-level protocols requested
be transmitted, and which were
addressed to a multicast or
broadcast
address
at
this
sub-layer.
This element is only shown in
detail mode.
for packet-oriented interfaces, the
number of outbound packets that
could not be transmitted because
of errors.
This element is only shown in
detail mode.
the total number of packets that
higher-level protocols requested
be transmitted, and which were
addressed to a multicast address
at this sub-layer.
This element is only shown in
detail mode.
the total number of packets that
higher-level protocols requested
be transmitted, and which were
addressed to a broadcast address
at this sub-layer.
This element is only shown in
detail mode.

Released

2697

100- Ethernet Lt Operational Data Status


Commands

100.1 Ethernet Lt Operational Data Status Command Tree


100.2 Ethernet Port Operational Status Command
100.3 Ethernet BridgePort Operational Status Command
100.4 Ethernet Port Interface Operational Status Command
100.5 Ethernet IGMP Operational Status Command
100.6 Ethernet Port Ip Bridge Operational Status
Command
100.7 Ethernet QoS Opertaional Status Command

2698

Released

100-2699
100-2700
100-2702
100-2704
100-2706
100-2709
100-2711

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

100.1 Ethernet Lt Operational Data Status


Command Tree
Description
This chapter gives an overview of nodes that are handled by "Ethernet Lt Operational Data Status Commands".

Command Tree
----show
----oper-data-port
- (if-index)
----ethernet
- admin-state
- opr-state
----bridge-port
- (port)
- pvid
- default-priority
- [no] qos-profile
----interface-port
- [no] admin-state
- oper-state
----igmp
- (port)
- curr-num-group
- curr-preview-num
- curr-uncfg-num
----ip-bridge-port
- (ip-bridge-port)
- rx-pkts
- rx-drop-pkts
- tx-pkts
----qos
- frame-net-bw
- m-cast-avail-bw
- m-cast-used-bw

3HH-04416-EBAA-TCZZA 01

Released

2699

100 Ethernet Lt Operational Data Status Commands

100.2 Ethernet Port Operational Status Command


Command Description
This command displays the Ethernet Port Operational data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) ethernet admin-state <Itf::ifAdminStatus> opr-state <ETHITF::combinedCol>

Command Parameters
Table 100.2-1 "Ethernet Port Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 100.2-2 "Ethernet Port Operational Status Command" Command Parameters


Parameter

Type

Description

admin-state

Parameter type: <Itf::ifAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <ETHITF::combinedCol>
Format:
( up
| down
| testing
| unknown
| dormant )
Possible values:

optional parameter
specifies state of the interface

opr-state

2700

Released

optional parameter
current operational state of the
interface.

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

Parameter

Type

Description

- up : up,traffic can pass


- down : down,no traffic is passing
- testing : testing,no traffic is passing
- unknown : unknown
- dormant : dormant,no traffic is passing

3HH-04416-EBAA-TCZZA 01

Released

2701

100 Ethernet Lt Operational Data Status Commands

100.3 Ethernet BridgePort Operational Status


Command
Command Description
This command displays the Bridge Port Operational data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) bridge-port [ (port) ] pvid <Vlan::StackedVlan> default-priority <Vlan::Priority> [
no qos-profile | qos-profile <Vlan::QosProfileName> ]

Command Parameters
Table 100.3-1 "Ethernet BridgePort Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identity of the PVC
( dsl : <Eqpt::VpiId> : <Eqpt::VciId>
| dsl )
Possible values:
- dsl : vdsl board
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port)

Description

Table 100.3-2 "Ethernet BridgePort Operational Status Command" Command Parameters


Parameter

Type

Description

pvid

Parameter type: <Vlan::StackedVlan>


Format:

optional parameter
default vlan id for untagged

2702

Released

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

Parameter

Type

Description
frames

default-priority

( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]
Parameter type: <Vlan::QosProfileName>
Format:
( none
| name : <Vlan::IgnoredQosProfileName> )
Possible values:
- none : no profile name to associate
- name : enter profile name to be associated
Field type <Vlan::IgnoredQosProfileName>
- name of the QoS profile
- length: 1<=x<=64

[no] qos-profile

3HH-04416-EBAA-TCZZA 01

optional parameter
port dynamic or static (if no
dynamic) default priority
optional parameter with default
value: "none"
qos profile name

Released

2703

100 Ethernet Lt Operational Data Status Commands

100.4 Ethernet Port Interface Operational Status


Command
Command Description
This command displays the Ethernet port interface operational data.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) interface-port [ no admin-state | admin-state <Eth::EthAdminStatus> ] oper-state
<Itf::ifOperStatus>

Command Parameters
Table 100.4-1 "Ethernet Port Interface Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 100.4-2 "Ethernet Port Interface Operational Status Command" Command Parameters
Parameter

Type

Description

[no] admin-state

Parameter type: <Eth::EthAdminStatus>


Format:
( up
| down )
Possible values:
- up : admin status is up
- down : admin status is down
Parameter type: <Itf::ifOperStatus>
Format:
( up
| down

optional parameter with default


value: "admin-down"
the desired state of the interface

oper-state

2704

Released

optional parameter
the operational state
interface

3HH-04416-EBAA-TCZZA

01

of

the

100 Ethernet Lt Operational Data Status Commands

Parameter

Type

Description

| testing
| unknown
| dormant )
Possible values:
- up : permanent virtual circuit
- down : bridge port
- testing : l2 VLAN
- unknown : IPoE
- dormant : PPPoE

3HH-04416-EBAA-TCZZA 01

Released

2705

100 Ethernet Lt Operational Data Status Commands

100.5 Ethernet IGMP Operational Status Command


Command Description
This command displays the Ethernet IGMP operational data.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) igmp [ (port) ] curr-num-group <Gauge> curr-preview-num <Counter>
curr-uncfg-num <Counter>

Command Parameters
Table 100.5-1 "Ethernet IGMP Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /

(port)

2706

Released

Description

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

Resource Identifier

Type

Description

<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :


<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>

3HH-04416-EBAA-TCZZA 01

Released

2707

100 Ethernet Lt Operational Data Status Commands

Resource Identifier

Type

Description

- the ONT PORT identifier


Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 100.5-2 "Ethernet IGMP Operational Status Command" Command Parameters


Parameter

Type

Description

curr-num-group

Parameter type: <Gauge>


Format:
- gauge
Parameter type: <Counter>
Format:
- 32 bit counter

optional parameter
Indicates the current group
number in this port
optional parameter
Indicates the number of preview
multicast group that igmp
channel joins currently
optional parameter
Indicates the current unconfig
group number in this port

curr-preview-num

curr-uncfg-num

2708

Parameter type: <Counter>


Format:
- 32 bit counter

Released

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

100.6 Ethernet Port Ip Bridge Operational Status


Command
Command Description
This command displays the Ethernet Port Ip Bridge Operational data.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) ip-bridge-port [ (ip-bridge-port) ] rx-pkts <Equipm::Octet-8> rx-drop-pkts
<Equipm::Octet-8> tx-pkts <Equipm::Octet-8>

Command Parameters
Table 100.6-1 "Ethernet Port Ip Bridge Operational Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number

(ip-bridge-port)

3HH-04416-EBAA-TCZZA 01

Description
interface index of the port
/

identification of the port or


/ virtual channel
/
/
/
/
/

Released

2709

100 Ethernet Lt Operational Data Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::ShelfId>


- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 100.6-2 "Ethernet Port Ip Bridge Operational Status Command" Command Parameters
Parameter

Type

Description

rx-pkts

Parameter type: <Equipm::Octet-8>


Format:
- a binary string
- length: 8
Parameter type: <Equipm::Octet-8>
Format:
- a binary string
- length: 8
Parameter type: <Equipm::Octet-8>
Format:
- a binary string
- length: 8

optional parameter
show the number of received
packets

rx-drop-pkts

tx-pkts

2710

Released

optional parameter
show the number of received
packets which are dropped
optional parameter
show the number of transmitted
packets

3HH-04416-EBAA-TCZZA

01

100 Ethernet Lt Operational Data Status Commands

100.7 Ethernet QoS Opertaional Status Command


Command Description
This command displays the Ethernet QoS operational data.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show oper-data-port (if-index) qos frame-net-bw <SignedInteger> m-cast-avail-bw <SignedInteger>
m-cast-used-bw <SignedInteger>

Command Parameters
Table 100.7-1 "Ethernet QoS Opertaional Status Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 100.7-2 "Ethernet QoS Opertaional Status Command" Command Parameters


Parameter

Type

Description

frame-net-bw

Parameter type: <SignedInteger>


Format:
- a signed integer

m-cast-avail-bw

Parameter type: <SignedInteger>


Format:
- a signed integer

optional parameter
Represents
the
approximate
bandwidth available for Ethernet
frames, which is guaranteed to be
available by the physical layer.
This approximation is made by
the configurable ATM overhead
factor.
optional parameter
Represents
the
bandwidth
available for multicast services,
calculated by the ISAM. This
value is what is left from
frame-net-bw after deducting

3HH-04416-EBAA-TCZZA 01

Released

2711

100 Ethernet Lt Operational Data Status Commands

Parameter

Type

m-cast-used-bw

2712

Parameter type: <SignedInteger>


Format:
- a signed integer

Released

Description
from
it
res-data-bw
and
res-voice-bw. The minimum of
m-cast-avail-bw
and
m-cast-max-bw will be the actual
limitation for user multicast
bandwidth usage per DSL link.
optional parameter
Shows the bandwidth currently in
use by pre-configured multicast
streams.

3HH-04416-EBAA-TCZZA

01

101- Debug Status Commands

101.1 Debug Status Command Tree


101.2 SW Error Log Status Command

3HH-04416-EBAA-TCZZA 01

101-2714
101-2715

Released

2713

101 Debug Status Commands

101.1 Debug Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Debug Status Commands".

Command Tree
----show
----debug-sw
----sw-error-log
- (sw-error-log-index)

2714

Released

3HH-04416-EBAA-TCZZA

01

101 Debug Status Commands

101.2 SW Error Log Status Command


Command Description
This command can be used to retrieve SW error log data.
To analyse critical SW problems, an emergency build can be delivered to a customer, which makes use of the
generic error logging. This means that, when the system detects critical SW problems, it can provide info related to
these problems in the SW error log.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show debug-sw sw-error-log [ (sw-error-log-index) ]

Command Parameters
Table 101.2-1 "SW Error Log Status Command" Resource Parameters
Resource Identifier

Type

Description

(sw-error-log-index)

Format:
- index for the sw error log
- range: [1...64]

the error string identification

Command Output
Table 101.2-2 "SW Error Log Status Command" Display parameters
Specific Information
name
errordata

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Debug::errorTracingLogString>


- ascii character string
- length: x<=80

textual description of the error


This element is always shown.

Released

2715

102- Trouble-Shooting Status Commands

102.1 Trouble-Shooting Status Command Tree


102.2 Trouble-shooting Statistics To One Port
102.3 Trouble-shooting Statistics on a Port (DSL or
Ethernet) or PVC Interface
102.4 Trouble-shooting Statistics To One VlanPort
102.5 Summary Trouble-shooting Statistics To Vlan Ports
102.6 Extensive Trouble-shooting Statistics To Vlan Ports
102.7 Extensive Trouble-shooting ipv4-antispoofing
Statistics To One UNI Port

2716

Released

102-2717
102-2718
102-2720
102-2722
102-2724
102-2727
102-2731

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

102.1 Trouble-Shooting Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Trouble-Shooting Status Commands".

Command Tree
----show
----trouble-shooting
----statistics
----interface
- (if-index)
----user
- (port)
----vlan
- (vlan-id)
----summary
----extensive
----uni-interface
- (if-index)

3HH-04416-EBAA-TCZZA 01

Released

2717

102 Trouble-Shooting Status Commands

102.2 Trouble-shooting Statistics To One Port


Command Description
This command allows the operator to show the trouble-shooting counters. When this show command is invoked, all
commands in underlying nodes are automatically executed. For specific help information,use the corresponding
help command of the underlying node. The help information related to underlying nodes will not be available in
this node.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics interface [ (if-index) ]

Command Parameters
Table 102.2-1 "Trouble-shooting Statistics To One Port" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier

2718

Released

Description
interface index of the port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntSlotId>


- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

3HH-04416-EBAA-TCZZA 01

Released

2719

102 Trouble-Shooting Status Commands

102.3 Trouble-shooting Statistics on a Port (DSL or


Ethernet) or PVC Interface
Command Description
This command allows the operator to show the trouble-shooting counters. When this show command is invoked, all
commands in underlying nodes are automatically executed. For specific help information,use the corresponding
help command of the underlying node. The help information related to underlying nodes will not be available in
this node.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics interface (if-index) user [ (port) ]

Command Parameters
Table 102.3-1 "Trouble-shooting Statistics on a Port (DSL or Ethernet) or PVC Interface" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier

2720

Released

Description
interface index of the port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

Resource Identifier

Type

Description

(port)

Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Format:
( port : <Eqpt::VpiId> : <Eqpt::VciId>
| port )
Possible values:
- port : dsl or ethernet port
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

specifies the port or the atm pvc

3HH-04416-EBAA-TCZZA 01

Released

2721

102 Trouble-Shooting Status Commands

102.4 Trouble-shooting Statistics To One VlanPort


Command Description
This command allows the operator to show extensive and summary counters of VLAN port. When this show
command is invoked, all commands in underlying nodes are automatically executed. For specific help
information,use the corresponding help command of the underlying node. The help information related to
underlying nodes will not be available in this node.
Both the summary and detailed counters are shown through the underlying nodes.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics interface (if-index) user (port) vlan [ (vlan-id) ]

Command Parameters
Table 102.4-1 "Trouble-shooting Statistics To One VlanPort" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni

2722

Released

Description
interface index of the port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

Resource Identifier

(port)

(vlan-id)

3HH-04416-EBAA-TCZZA 01

Type

Description

- vuni : virtual uni identifier


Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Format:
( port : <Eqpt::VpiId> : <Eqpt::VciId>
| port )
Possible values:
- port : dsl or ethernet port
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

specifies the port or the atm pvc

vlan associated to the bridge port

Released

2723

102 Trouble-Shooting Status Commands

102.5 Summary Trouble-shooting Statistics To Vlan


Ports
Command Description
This command shows summary counters of VLAN port.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics interface (if-index) user (port) vlan (vlan-id) summary

Command Parameters
Table 102.5-1 "Summary Trouble-shooting Statistics To Vlan Ports" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier

2724

Released

Description
interface index of the port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntSlotId>


- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Format:
( port : <Eqpt::VpiId> : <Eqpt::VciId>
| port )
Possible values:
- port : dsl or ethernet port
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(port)

(vlan-id)

specifies the port or the atm pvc

vlan associated to the bridge port

Command Output
Table 102.5-2 "Summary Trouble-shooting Statistics To Vlan Ports" Display parameters
Specific Information
name

Type

Description

up-forward

Parameter type: <Counter>


- 32 bit counter

up-discard

Parameter type: <Counter>


- 32 bit counter

dn-forward

Parameter type: <Counter>


- 32 bit counter

dn-discard

Parameter type: <Counter>


- 32 bit counter

the number of frames received


from the user side that are
successfully forwarded by the
l2-forwarding engine
This element is only shown in
detail mode.
the number of frames received
from the user side that are
discarded
by
l2-forwarding
engine or l2 user interface
This element is only shown in
detail mode.
the number of frames received
from the network side that are
successfully forwarded by the
l2-forwarding engine
This element is only shown in
detail mode.
the number of frames received
from the network side that are
discarded on the condition that
the user interface has been found
This element is only shown in

3HH-04416-EBAA-TCZZA 01

Released

2725

102 Trouble-Shooting Status Commands

name

Type

up-bcast-fwd

Parameter type: <Counter>


- 32 bit counter

up-ucast-fwd

Parameter type: <Counter>


- 32 bit counter

dn-bcast-fwd

Parameter type: <Counter>


- 32 bit counter

dn-ucast-fwd

Parameter type: <Counter>


- 32 bit counter

2726

Released

Description
detail mode.
the number of broadcast frames
received from the user side that
are successfully forwarded by the
l2-forwarding engine
This element is only shown in
detail mode.
the number of unicast frames
received from the user side that
are successfully forwarded by the
l2-forwarding engine
This element is only shown in
detail mode.
the number of broadcast frames
received from the network side
that are successfully forwarded
by the l2-forwarding engine
This element is only shown in
detail mode.
the number of unicast frames
received from the network side
that are successfully forwarded
by the l2-forwarding engine
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

102.6 Extensive Trouble-shooting Statistics To


Vlan Ports
Command Description
This command shows extensive counters of VLAN port.
The extensive counters are only given when the counters are enabled via the related configuration command.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics interface (if-index) user (port) vlan (vlan-id) extensive

Command Parameters
Table 102.6-1 "Extensive Trouble-shooting Statistics To Vlan Ports" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier

3HH-04416-EBAA-TCZZA 01

Description
interface index of the port
/
/
/
/
/

Released

2727

102 Trouble-Shooting Status Commands

Resource Identifier

Type

Description

obsolete alternative replaced by vuni


- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Format:
( port : <Eqpt::VpiId> : <Eqpt::VciId>
| port )
Possible values:
- port : dsl or ethernet port
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

(port)

(vlan-id)

specifies the port or the atm pvc

vlan associated to the bridge port

Command Output
Table 102.6-2 "Extensive Trouble-shooting Statistics To Vlan Ports" Display parameters
Specific Information
name

Type

Description

up-inv-dasa

Parameter type: <Counter>


- 32 bit counter

up-macport-lmt-exc

Parameter type: <Counter>


- 32 bit counter

up-macfdb-lmt-exc

Parameter type: <Counter>


- 32 bit counter

up-inv-prot

Parameter type: <Counter>


- 32 bit counter

the number of frames received


from the user side which have an
invalid destination or source mac
address
This element is only shown in
detail mode.
the number of frames received
from the user side which mac@
could not be learned
This element is only shown in
detail mode.
the number of frames received
from the user side which maxmac
is reached
This element is only shown in
detail mode.
number of frames received from
the user side with an invalid
protocol
This element is only shown in
detail mode.

2728

Released

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

name

Type

Description

up-ip-spoofing

Parameter type: <Counter>


- 32 bit counter

up-acl-discard

Parameter type: <Counter>


- 32 bit counter

up-policer-discard

Parameter type: <Counter>


- 32 bit counter

up-queue-discard

Parameter type: <Counter>


- 32 bit counter

up-ipv6-spoofing

Parameter type: <Counter>


- 32 bit counter

dn-mcast-fwd

Parameter type: <Counter>


- 32 bit counter

dn-nonmcast-fwd

Parameter type: <Counter>


- 32 bit counter

dn-mcast-discard

Parameter type: <Counter>


- 32 bit counter

dn-nonmcast-discard

Parameter type: <Counter>


- 32 bit counter

dn-acl-discard

Parameter type: <Counter>

number of frames received from


the user side with an ip address
not matching the assigned ip
address
This element is only shown in
detail mode.
the number of frames received
from the user side that are
discarded for acl
This element is only shown in
detail mode.
the number of frames received
from the user side that are
discarded due to policing
This element is only shown in
detail mode.
the number of frames received
from the user side that are
discarded in the uplink queue
This element is only shown in
detail mode.
number of frames received from
the user side with an IPv6 address
not matching the assigned IP
address
This element is only shown in
detail mode.
number of multicast frames
received from the network side
and successfully forwarded by
the l2-forwarding engine
This element is only shown in
detail mode.
number
of
non-multicast
(including broadcast) frames
received from the network side
and successfully forwarded by
the l2-forwarding engine
This element is only shown in
detail mode.
number of multicast frames
received from the network side,
routed to the vlan Port and then
discarded for any reason, even if
this reason is not related to the
vlan port functionality
This element is only shown in
detail mode.
number of non-multicast frames
received from the network side,
routed to the vlan port and then
discarded for any reason, even if
this reason is not related to the
Vlan Port functionality
This element is only shown in
detail mode.
the number of frames received

3HH-04416-EBAA-TCZZA 01

Released

2729

102 Trouble-Shooting Status Commands

name

Type

Description

- 32 bit counter

from the network side that are


discarded for acl/ccl filtering
This element is only shown in
detail mode.
the number of frames received
from the network side that is
discarded due to policing on l2
forwarder interface
This element is only shown in
detail mode.
number of frames received from
the network side, routed to the
vlan port and then discarded
because of queue overflow
This element is only shown in
detail mode.

dn-policer-discard

Parameter type: <Counter>


- 32 bit counter

dn-queue-discard

Parameter type: <Counter>


- 32 bit counter

2730

Released

3HH-04416-EBAA-TCZZA

01

102 Trouble-Shooting Status Commands

102.7 Extensive Trouble-shooting


ipv4-antispoofing Statistics To One UNI Port
Command Description
This command allows the operator to show the number of frames received from the uni that are discard for
ipv4-antispoofing.

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show trouble-shooting statistics uni-interface [ (if-index) ]

Command Parameters
Table 102.7-1 "Extensive Trouble-shooting ipv4-antispoofing Statistics To One UNI Port" Resource
Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> )
Possible values:
- ont : ont
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier

3HH-04416-EBAA-TCZZA 01

Description
interface index of the port
/
/
/
/
/
/

Released

2731

102 Trouble-Shooting Status Commands

Resource Identifier

Type

Description

Field type <Eqpt::OntId>


- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

Command Output
Table 102.7-2 "Extensive Trouble-shooting ipv4-antispoofing Statistics To One UNI Port" Display
parameters
Specific Information
name
ipv4-spoofing frame

2732

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

the number of frames received


from the user side that are
successfully forwarded by the
l2-forwarding engine
This element is always shown.

3HH-04416-EBAA-TCZZA

01

103- CFM Status Commands

103.1 CFM Status Command Tree


103.2 Maintenance Domain on NT Status Command
103.3 Maintenance Association on NT Status Command
103.4 Maintenance Association End Point on NT Status
Command
103.5 CFM Stack on NT Status Command
103.6 Maintenance Association End Point CCM Database
show Command
103.7 Maintenance Association End Point on NT Runtime
Info Command
103.8 LT CFM SLM Responder Statistics Table
103.9 PM proactive show
103.10 Proactive CFM PM show command for the current
15 min
103.11 Proactive CFM PM show command for the current
15 min
103.12 Proactive CFM PM show command for the current 1
day
103.13 Proactive CFM PM show command for the current 1
day
103.14 Proactive CFM PM show command for the previous
15 min
103.15 Proactive CFM PM show command for the previous
15 min
103.16 Proactive CFM PM show command for the previous
1 day
103.17 Proactive CFM PM show command for the previous
1 day

3HH-04416-EBAA-TCZZA 01

103-2734
103-2736
103-2738
103-2741
103-2745
103-2748
103-2751
103-2755
103-2757
103-2758
103-2759
103-2764
103-2765
103-2770
103-2771
103-2776
103-2777

Released

2733

103 CFM Status Commands

103.1 CFM Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "CFM Status Commands".

Command Tree
----show
----cfm
----md-config-data
----domain
- (domain-index)
----ma-config-data
----domain
- (domain-index)
- association
----mep-config-data
----domain
- (domain-index)
- association
- mep
----stack
- (location)
- vlan
- level
- direction
----ccm-database
----domain
- (domain-index)
- association
- mep
- remote-mep
----mep-info
----domain
- (domain-index)
- association
- mep
----slm-responder-stats
----domain
- (domain-index)
- association
- mep
- slm-initiator-mep
- slm-initiator-mac
- test-id
----y1731pm
----curr-15min-stats
----domain
- (domain-index)
- association
- mep
- session-id
----curr-day-stats

2734

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

----domain
- (domain-index)
- association
- mep
- session-id
----prev-15min-stats
----domain
- (domain-index)
- association
- mep
- session-id
- interval-number
----prev-day-stats
----domain
- (domain-index)
- association
- mep
- session-id
- interval-number

3HH-04416-EBAA-TCZZA 01

Released

2735

103 CFM Status Commands

103.2 Maintenance Domain on NT Status Command


Command Description
This command displays Maintenance Domain (MD) data.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm md-config-data domain [ (domain-index) ]

Command Parameters
Table 103.2-1 "Maintenance Domain on NT Status Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]

Maintenance
index

Domain

(MD)

Command Output
Table 103.2-2 "Maintenance Domain on NT Status Command" Display parameters
Specific Information
name
format:name

level

2736

Released

Type

Description

Parameter type: <Cfm::FormatString>


( mac : <Cfm::MacAddress>
| string : <Cfm::PrintableString>
| dns : <Cfm::PrintableString>
| none )
Possible values:
- mac : mac address
- string : string
- dns : dns
- none : No MD name.
Field type <Cfm::PrintableString>
- all characters except for characters 0 to 31
- length: 1<=x<=43
Field type <Cfm::MacAddress>
MAC
address
plus
2
hex
11:22:33:44:55:66:77:88
- length: 8
Parameter type: <Cfm::MdLevelType>

unique
identifier
for
a
Maintenance Domain (MD) name
which contains the format and
value
This element is always shown.

octets,

e.g.
Maintenance Domain (MD) level

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

- Maintenance Domain (MD) level


- range: [0...7]

This element is always shown.

Released

2737

103 CFM Status Commands

103.3 Maintenance Association on NT Status


Command
Command Description
This command displays the Maintenance Association (MA) data.
An MA is contained within a Maintenance Domain (MD) and is identified by the combination of MD index and MA
index.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm ma-config-data domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] ]

Command Parameters
Table 103.3-1 "Maintenance Association on NT Status Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]

Maintenance
index

association

Domain

(MD)

Maintenance Association (MA)


index

Command Output
Table 103.3-2 "Maintenance Association on NT Status Command" Display parameters
Specific Information
name
vlan

2738

Released

Type

Description

Parameter type: <Vlan::StackedVlan>


( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]

VlanId for the Maintenance


Association (MA)
This element is always shown.

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

bridgeport

mhf-creation

maformat:maname

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Vlan::SVlanIndex>


- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]
Parameter type: <Cfm::InterfaceZeroIndex>
( none
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> )
Possible values:
- none : no port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Cfm::CfmMhfCreationType>
( mhf-none
| mhf-default )
Possible values:
- mhf-none : No MHF creation for this VLAN ID
- mhf-default : MHF creation for this VLAN ID on related
bridge ports
Parameter type: <Cfm::MaFormatedString>
( pvid : <Cfm::MaNamePvid>
| string : <Cfm::MaNameCharstr>
| uint16 : <Cfm::MaNameUint16>
| vpnid : <Cfm::MaVpnid>
| icc : <Cfm::MaNameIcc> )
Possible values:
- pvid : pvid
- string : string
- uint16 : unsigned
- vpnid : vpnId
- icc : raw ascii
Field type <Cfm::MaNamePvid>
- MaName Pvid Range [0...4094]
- length: x<=4
Field type <Cfm::MaNameCharstr>
- Raw ascii up to 45 Characters, except the character code
0-31 decimal
- length: x<=45
Field type <Cfm::MaNameUint16>
- MaName Uint16 Range [0...65535]

IfIndex of UNI
This element is always shown.

MIP Half Function (MHF)


creation control for an MA
This element is always shown.

unique
identifier
for
a
Maintenance Association (MA)
name which contains the format
and value
This element is always shown.

Released

2739

103 CFM Status Commands

name

Type

ccmint

ccmaware

ccmadmin

2740

Description

- length: x<=5
Field type <Cfm::MaVpnid>
- MaName VpnId 7 Octet Format : xxx:xxxx, where x is a
between 00 and FF eg:11FF33:AABBCCDD
- length: 15
Field type <Cfm::MaNameIcc>
- MaName Icc Raw ascii exactly 13 characters
- length: 13
Parameter type: <Cfm::CfmMaCcmInterval>
MA CCM Interval
(0
This element is always shown.
|1
| 10
| 60
| 600 )
Possible values:
- 0 : CCM CCM Rx disable
- 1 : CCM Interval 1 secs
- 10 : CCM Interval 10 secs
- 60 : CCM Interval 1 Min
- 600 : CCM Interval 10 Min
Parameter type: <Cfm::CfmMaCcmAware>
MA CCM Aware
( ccm-aware
This element is always shown.
| ccm-unaware )
Possible values:
- ccm-aware : sets MA as CCMAware
- ccm-unaware : sets MA as CCMunAware
Parameter type: <Cfm::CfmMaCcmAdminState>
MA CCM AdminState
( unlock
This element is always shown.
| lock )
Possible values:
- unlock : sets CCM AdminState to Lock
- lock : sets CCM AdminState to UnLock

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.4 Maintenance Association End Point on NT


Status Command
Command Description
This command displays the Maintenance association End Point (MEP) data.
A MEP is contained within a Maintenance Assocation (MA) and is identified by the combination of Maintenance
Domain (MD) index, MA index and MEP ID.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm mep-config-data domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] ]

Command Parameters
Table 103.4-1 "Maintenance Association End Point on NT Status Command" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association (MA)
Format:
index
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance association End
Format:
Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

association

mep

Description

Command Output
Table 103.4-2 "Maintenance Association End Point on NT Status Command" Display parameters
Specific Information
name
location

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Cfm::location>


Maintenance association End
( user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Point (MEP) location
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
This element is always shown.

Released

2741

103 CFM Status Commands

name

Type

cci-enable

ccm-priority
low-pri-defect

2742

Description

| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /


<Eqpt::PortId>
| slot : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Possible values:
- user : User bridge-port location
- slot : slot location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Cfm::MepCcmEnableDisable>
( cci-enable
| cci-disable )
Possible values:
- cci-enable : CCM generation is enabled on the current
MEP
- cci-disable : CCM generation is disabled on the current
MEP
Parameter type: <Cfm::MepCcmPriority>
- Priority value for CCMs transmitted by the MEP
- range: [0...7]
Parameter type: <Cfm::MepLowPriorityDefect>
( all-def
| mac-rem-err-xcon
| rem-err-xcon
| err-xcon
| xcon
| no-xcon )
Possible values:
all-def
:
For
DefRDICCM,
DefMACstatus,

Released

Enable/Disable CCM generation


on the current MEP
This element is always shown.

Priority
value
for
CCMs
transmitted by the MEP
This element is always shown.
The lowest priority defect that is
allowed to generate fault alarm
This element is always shown.

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

fng-alarm-time

fng-reset-time

direction

mac
slm-responder

dm-responder

lm-responder

slm-initiator

lm-initiator

3HH-04416-EBAA-TCZZA 01

Type

Description

DefRemoteCCM,DefErrorCCM, and DefXconCCM


mac-rem-err-xcon
:
Only
DefMACstatus,
DefRemoteCCM,DefErrorCCM,
and
DefXconCCM
(default)
- rem-err-xcon : Only DefRemoteCCM, DefErrorCCM, and
DefXconCCM
- err-xcon : Only DefErrorCCM and DefXconCCM
- xcon : Only DefXconCCM
- no-xcon : No defects DefXcon or lower are to be reported
Parameter type: <Cfm::MepFngAlarmTime>
multiples
of
250
ticks
are
supported(250,500,750,1000).default = 250 ticks(2.5sec)
- unit: 1/100 sec
- range: [250...1000]
Parameter type: <Cfm::MepFngResetTime>
- multiples of 250 ticks are supported(250,500,750,1000).
default = 1000 ticks(10sec)
- unit: 1/100 sec
- range: [250...1000]
Parameter type: <Cfm::CfmDirectionType>
( down
| up )
Possible values:
- down : points away from bridge (MIPs are always down)
- up : points towards bridge
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Cfm::MepSlmShowEnableDisable>
( enabled
| disabled )
Possible values:
- enabled : slm responder is enabled on the current mep
- disabled : slm responder is disabled on the current mep
Parameter type: <Cfm::MepDmShowEnableDisable>
( enabled
| disabled )
Possible values:
- enabled : dm responder is enabled on the current mep
- disabled : dm responder is disabled on the current mep
Parameter type: <Cfm::MepLmShowEnableDisable>
( disabled
| enabled-per-vlan
| enabled-per-pbit )
Possible values:
- disabled : lm responder is disabled on the current mep
- enabled-per-vlan : lm responder is enabled per vlan on the
current mep
- enabled-per-pbit : lm responder is enabled per vlan per pbit
on the current mep
Parameter type: <Cfm::MepSlmInitShowEnableDisable>
( enabled
| disabled )
Possible values:
- enabled : slm initiator is enabled on the current mep
- disabled : slm initiator is disabled on the current mep
Parameter type: <Cfm::MepLmInitShowEnableDisable>

The time in ticks(1 tick=10ms)


that defects must be present
before a Fault alarm is issued.
This element is always shown.
The time in ticks (1tick = 10ms)
that defects must be absent before
re-enabling a Fault Alarm.
This element is always shown.
Maintenance EndPoint direction
This element is always shown.

MAC address of the Maintenance


End Point (MEP)
This element is always shown.
status of slm responder on the
current mep
This element is always shown.

status of dm responder on the


current mep
This element is always shown.

status of lm responder on the


current mep
This element is always shown.

status of slm initiator on the


current mep
This element is always shown.

status of lm initiator on the

Released

2743

103 CFM Status Commands

name

Type

Description

( disabled
current mep
| enabled-per-vlan
This element is always shown.
| enabled-per-pbit )
Possible values:
- disabled : lm initiator is disabled on the current mep
- enabled-per-vlan : lm initiator is enabled per vlan on the
current mep
- enabled-per-pbit : lm initiator is enabled per vlan per pbit
on the current mep

2744

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.5 CFM Stack on NT Status Command


Command Description
This command displays CFM stack table entries by specifying any of the following: location (user bridgeport or
slot), VLAN, MD level, and direction. The information displayed is for the associated MPs (MIPs and MEPs).

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm stack [ (location) [ vlan <Vlan::StackedVlan> ] [ level <Cfm::MdLevelType> ] [ direction
<Cfm::CfmDirectionType> ] ]

Command Parameters
Table 103.5-1 "CFM Stack on NT Status Command" Resource Parameters
Resource Identifier

Type

(location)

Format:
Maintenance Point (MEP or MIP)
( user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / location
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| slot : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| user : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Possible values:
- user : User bridge-port location
- slot : slot location
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>

3HH-04416-EBAA-TCZZA 01

Description

Released

2745

103 CFM Status Commands

Resource Identifier

Type

Description

- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Parameter type: <Vlan::StackedVlan>
Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]
Parameter type: <Cfm::MdLevelType>
Format:
- Maintenance Domain (MD) level
- range: [0...7]
Parameter type: <Cfm::CfmDirectionType>
Format:
( down
| up )
Possible values:
- down : points away from bridge (MIPs are always down)
- up : points towards bridge

vlan

level

direction

VlanId associated with the MA

Maintenance Domain (MD) level

Maintenance Point (MEP or MIP)


direction

Command Output
Table 103.5-2 "CFM Stack on NT Status Command" Display parameters
Specific Information
name
domain-index

Description

Parameter type: <Cfm::CfmDomainIndexType>


Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
This element is always shown.
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association (MA)
- Maintenance Association (MA) index. Unique within an index
MD
This element is always shown.
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
MEP Id or zero for MIP
- MA End Point (MEP) ID. Unique within an MA
This element is always shown.
- range: [0,1...8191,65535]
Parameter type: <Vlan::MacAddr>
MAC address of the location

association-index

mep-id
mac

2746

Type

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

- mac address (aa:bb:cc:a1:02:03)


- length: 6

This element is always shown.

Released

2747

103 CFM Status Commands

103.6 Maintenance Association End Point CCM


Database show Command
Command Description
This command displays the Maintenance association End Point (MEP) CCM Database.
The CCM Database is maintained per Remote MEP and is identified by the combination of Maintenance Domain
(MD) index, MA index , MEP ID and Remote MEP ID.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm ccm-database domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] [ remote-mep <Cfm::MepIdType> ] ]

Command Parameters
Table 103.6-1 "Maintenance Association End Point CCM Database show Command" Resource
Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association (MA)
Format:
index
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance association End
Format:
Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::MepIdType>
Remote Maintenance association
Format:
End Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

association

mep

remote-mep

Description

Command Output
Table 103.6-2 "Maintenance Association End Point CCM Database show Command" Display

2748

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

parameters
Specific Information
name
state

failed-ok-time

mac-addr
rdi

status

port-status

interface-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Cfm::RemoteMepState>


( rmep-idle
| rmep-start
| rmep-failed
| rmep-ok )
Possible values:
- rmep-idle : Remote MEP Idle State
- rmep-start : Remote MEP Start State
- rmep-failed : Remote MEP Failed State
- rmep-ok : Remote MEP Ok State
Parameter type: <Cfm::ElapsedTime>
- Time elapsed since last Ok or Failed RMEP received

Current state of the Remote MEP


state machine
This element is always shown.

Time at which the Remote MEP


state machine entered either the
rMepFailed or rMepOk state
This element is always shown.
The MAC address of the remote
MEP
This element is always shown.
State of the RDI bit in the last
received CCM
This element is always shown.

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Cfm::RemoteMepRdi>
( rdi-set
| rdi-not-set )
Possible values:
- rdi-set : RDI bit is set
- rdi-not-set : RDI bit is not set
Parameter type: <Cfm::RemoteMepStatus>
Indicates whether the Remote
( rmep-active
MEP is active
| rmep-not-active )
This element is always shown.
Possible values:
- rmep-active : Remote MEP is active
- rmep-not-active : Remote MEP is not active
Parameter type: <Cfm::RemoteMepPortStatus>
An enumerated value of the Port
( ps-no-tlv
status TLV received in the last
| ps-blocked
CCM
| ps-up )
This element is only shown in
Possible values:
detail mode.
- ps-no-tlv : No CCM received or No Port Status TLV
present in the received CCM
- ps-blocked : Port Status Blocked
- ps-up : Port Status Up
Parameter type: <Cfm::RemoteMepInterfaceStatus>
An enumerated value of the
( is-no-tlv
Interface status TLV received in
| is-up
the last CCM
| is-down
This element is only shown in
| is-testing
detail mode.
| is-unknown
| is-dormant
| is-not-present
| is-lower-layer-down )
Possible values:
- is-no-tlv : No CCM received or No Interface Status TLV
present in the received CCM
- is-up : Interface Status Up
- is-down : Interface Status Down
- is-testing : Interface Status Testing
- is-unknown : Interface Status Unknown

Released

2749

103 CFM Status Commands

name

Type

chassis-id-format

chassis-id

mgmt-addr-domain

Parameter type: <Object>


- an object identifier

mgmt-addr

Parameter type: <Cfm::MgmtAddrType>


- a variable length octet string 0..50
- length: x<=50

2750

Description

- is-dormant : Interface Status Dormant


- is-not-present : Interface Status Not Present
- is-lower-layer-down : Interface Status Lower Layer Down
Parameter type: <Cfm::LldpChassisIdSubtype>
( not-applic
| chassis-component
| interface-alias
| port-component
| mac-address
| network-address
| interface-name
| local
| <SignedInteger> )
Possible values:
- not-applic : not applicable
- chassis-component : Reference IETF RFC 2737
- interface-alias : Reference IETF RFC 2863
- port-component : Reference IETF RFC 2737
- mac-address :
- network-address :
- interface-name : Reference IETF RFC 2863
- local : An alph-numeric string.
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::LldpChassisIdType>
- a variable length octet string 0..16
- length: x<=16

Released

Format of the Chassis ID


received in the last CCM
This element is only shown in
detail mode.

The Chassis ID received in the


last CCM
This element is only shown in
detail mode.
Identifies the type and format of
the management address of the
Remote MEP
This element is only shown in
detail mode.
The management address of the
Remote MEP
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.7 Maintenance Association End Point on NT


Runtime Info Command
Command Description
This command displays the Maintenance association End Point (MEP) runtime information.
A MEP is contained within a Maintenance Assocation (MA) and is identified by the combination of Maintenance
Domain (MD) index, MA index and MEP ID.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm mep-info domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] ]

Command Parameters
Table 103.7-1 "Maintenance Association End Point on NT Runtime Info Command" Resource
Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association (MA)
Format:
index
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance association End
Format:
Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

association

mep

Description

Command Output
Table 103.7-2 "Maintenance Association End Point on NT Runtime Info Command" Display
parameters
Specific Information
name

Type

Description

direction

Parameter type: <Cfm::CfmDirectionType>

Maintenance EndPoint direction

3HH-04416-EBAA-TCZZA 01

Released

2751

103 CFM Status Commands

name

mac

cci-enable

Description

( down
| up )
Possible values:
- down : points away from bridge (MIPs are always down)
- up : points towards bridge
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

This element is always shown.

MAC address of the Maintenance


End Point (MEP)
This element is only shown in
detail mode.
Enable/Disable CCM generation
on the current MEP
This element is only shown in
detail mode.

Parameter type: <Cfm::MepCcmEnableDisable>


( cci-enable
| cci-disable )
Possible values:
- cci-enable : CCM generation is enabled on the current
MEP
- cci-disable : CCM generation is disabled on the current
MEP
Parameter type: <Cfm::MepCcmPriority>
Priority
value
for
CCMs
- Priority value for CCMs transmitted by the MEP
transmitted by the MEP
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::MepLowPriorityDefect>
The lowest priority defect that is
( all-def
allowed to generate fault alarm
| mac-rem-err-xcon
This element is only shown in
| rem-err-xcon
detail mode.
| err-xcon
| xcon
| no-xcon )
Possible values:
all-def
:
For
DefRDICCM,
DefMACstatus,
DefRemoteCCM,DefErrorCCM, and DefXconCCM
mac-rem-err-xcon
:
Only
DefMACstatus,
DefRemoteCCM,DefErrorCCM,
and
DefXconCCM
(default)
- rem-err-xcon : Only DefRemoteCCM, DefErrorCCM, and
DefXconCCM
- err-xcon : Only DefErrorCCM and DefXconCCM
- xcon : Only DefXconCCM
- no-xcon : No defects DefXcon or lower are to be reported
Parameter type: <Cfm::FngState>
Current state of the MEP Fault
( fng-reset
Notification Generator State
| fng-defect
Machine
| fng-report-defect
This element is always shown.
| fng-defect-reported
| fng-defect-clearing )
Possible values:
- fng-reset : No defect has been present since the
dot1agCfmMepFngResetTime timer expired, or since the
state machine was last reset
- fng-defect : A defect is present, but not for a long enough
time to be reported (dot1agCfmMepFngAlarmTime)
- fng-report-defect : A momentary state during which the
defect is reported by sending a dot1agCfmFaultAlarm
notification, if that action is enabled
- fng-defect-reported : A defect is present, and some defect
has been reported
- fng-defect-clearing : No defect is present, but the

ccm-priority

low-pri-defect

fng-state

2752

Type

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name
highest-pri-defect

def-rdi-ccm

def-mac-status

def-remote-ccm

def-error-ccm

def-xcon-ccm

sent-ccms
ccm-sequence-errors

3HH-04416-EBAA-TCZZA 01

Type

Description

dot1agCfmMepFngResetTime timer has not yet expired


Parameter type: <Cfm::MepHighestPrDefect>
( none
| def-rdi-ccm
| def-mac-status
| def-remote-ccm
| def-error-ccm
| def-xcon-ccm )
Possible values:
- none : No defects since FNG_RESET
- def-rdi-ccm : A remote MEP has reported the RDI bit in its
last CCM
- def-mac-status : Either some remote MEP is reporting its
Interface Status TLV as not isUp, or all remote MEPs are
reporting a Port Status TLV that contains some value other
than psUp
- def-remote-ccm : The MEP is not receiving valid CCMs
from at least one of the remote MEPs
- def-error-ccm : The MEP has received at least one invalid
CCM whose CCM Interval has not yet timed out
- def-xcon-ccm : The MEP has received at least one CCM
from either another MAID or a lower MD Level whose
CCM Interval has not yet timed out
Parameter type: <Cfm::MepDefectRDICCM>
( not-present
| present )
Possible values:
- not-present : DefRDICCM is not present
- present : DefRDICCM is present
Parameter type: <Cfm::MepDefectMACstatus>
( not-present
| present )
Possible values:
- not-present : DefMACstatus is not present
- present : DefMACstatus is present
Parameter type: <Cfm::MepDefectRemoteCCM>
( not-present
| present )
Possible values:
- not-present : DefRemoteCCM is not present
- present : DefRemoteCCM is present
Parameter type: <Cfm::MepDefectErrorCCM>
( not-present
| present )
Possible values:
- not-present : DefErrorCCM is not present
- present : DefErrorCCM is present
Parameter type: <Cfm::MepDefectXconCCM>
( not-present
| present )
Possible values:
- not-present : DefXconCCM is not present
- present : DefXconCCM is present
Parameter type: <Cfm::UnsignedIntType>
- Unsigned Integer.
- range: [0...4294967295]
Parameter type: <Cfm::UnsignedIntType>

The highest priority defect that


has been present since the MEPs
Fault Notification Generator
State Machine was last in the
FNG_RESET state
This element is always shown.

Status of the RDICCM defect for


this MEP
This element is only shown in
detail mode.
Status of the MACstatus defect
for this MEP
This element is only shown in
detail mode.
Status of the RemoteCCM defect
for this MEP
This element is only shown in
detail mode.
Status of the ErrorCCM defect
for this MEP
This element is only shown in
detail mode.
Status of the XconCCM defect
for this MEP
This element is only shown in
detail mode.
Total number of Continuity
Check messages transmitted
This element is always shown.
The
total
number
of

Released

2753

103 CFM Status Commands

name

Type

Description

- Unsigned Integer.
- range: [0...4294967295]

out-of-sequence CCMs received


from all remote MEPs
This element is always shown.
The last-received CCM that
triggered an DefErrorCCM fault
This element is only shown in
detail mode.
The last-received CCM that
triggered a DefXconCCM fault
This element is only shown in
detail mode.

error-ccm-last-frame

Parameter type: <Cfm::CCmErrorFrame>


- CCM Error Packet information

xcon-ccm-last-frame

Parameter type: <Cfm::CCmErrorFrame>


- CCM Error Packet information

2754

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.8 LT CFM SLM Responder Statistics Table


Command Description
This command displays the CFM SLM Responder Statistics.
The SLM Responder Statistics Table is maintained per Test Instance basis and is identified by the combination of
Maintenance Domain (MD) index, MA index , MEP ID ,RespRemoteMep Id , RespRemoteMep TestId and
RespRemoteMep Mac address.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm slm-responder-stats domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] [ slm-initiator-mep <Cfm::MepIdType> ] [ slm-initiator-mac <Vlan::MacAddr> ] [ test-id
<Cfm::UnsignedIntType> ] ]

Command Parameters
Table 103.8-1 "LT CFM SLM Responder Statistics Table" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance Domain (MD)
- Maintenance Domain (MD) index
index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association (MA)
Format:
index
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance association End
Format:
Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::MepIdType>
Responder Remote Maintenance
Format:
association End Point (MEP) ID
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Vlan::MacAddr>
MAC address of the remote MEP
Format:
which initiated the SLM
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Cfm::UnsignedIntType>
Test identifier in the SLM
Format:
message sent by the remote MEP
- Unsigned Integer.

association

mep

slm-initiator-mep

slm-initiator-mac

test-id

3HH-04416-EBAA-TCZZA 01

Description

Released

2755

103 CFM Status Commands

Resource Identifier

Type

Description

- range: [0...4294967295]

Command Output
Table 103.8-2 "LT CFM SLM Responder Statistics Table" Display parameters
Specific Information
name

Type

Description

txfcf

Parameter type: <Cfm::UnsignedIntType>


- Unsigned Integer.
- range: [0...4294967295]

txfcb

Parameter type: <Cfm::UnsignedIntType>


- Unsigned Integer.
- range: [0...4294967295]

The
number
of
synthetic
frames(SLM) transmitted by the
SLM initiator as part of a given
test ID.The value is obtained
from the SLM packet sent by the
initiator
This element is always shown.
The
number
of
synthetic
frames(SLR) transmitted by the
SLM responder as part of a given
test ID.The value is a local
counter maintained by the
responder
This element is always shown.

2756

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.9 PM proactive show


Command Description
This command is used to show the PM test results.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm

3HH-04416-EBAA-TCZZA 01

Released

2757

103 CFM Status Commands

103.10 Proactive CFM PM show command for the


current 15 min
Command Description
This command displays the PM proactive loss measurement for the current 15 min.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm curr-15min-stats

2758

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.11 Proactive CFM PM show command for the


current 15 min
Command Description
This command displays the PM proactive loss measurement for the current 15 min.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm curr-15min-stats domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] [ session-id <Cfm::SessionIdType> ] ]

Command Parameters
Table 103.11-1 "Proactive CFM PM show command for the current 15 min" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance domain.
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance association.
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance End Point.
Format:
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::SessionIdType>
PM Proactive test SessionId.
Format:
- Session Id for PM proactive
- range: [1...960]

association

mep

session-id

Description

Command Output
Table 103.11-2 "Proactive CFM PM show command for the current 15 min" Display parameters
Specific Information
name

Type

Description

test-type

Parameter type: <Cfm::PmTestType>

Y1731 PM Test type

3HH-04416-EBAA-TCZZA 01

Released

2759

103 CFM Status Commands

name

interval(sec)

measurement-intvl(sec)

dest-mac

elapsed-time(sec)

measured-time(sec)

data-tlv-size

priority

valid-intervals

invalid-data-flag

pdu-sent

2760

Released

Type

Description

( single-ended-slm
| single-ended-lm )
Possible values:
- single-ended-slm : sets test type to SLM
- single-ended-lm : sets test type to LM
Parameter type: <Cfm::PmIntervalType>
- PM interval (sec) SLM: [1...10] LM: [60 or 300]
- range: [1...10,60,300]

This element is only shown in


detail mode.

Interval in which PM packets are


transmitted.
This element is only shown in
detail mode.
Parameter type: <Cfm::PmMeasurementIntervalType>
The time for which the synthetic
( not-applicable
loss
calculation
is
made
| <Cfm::PmMeasurementInterval> )
periodically.
Possible values:
This element is only shown in
- not-applicable : For single-ended-lm, the value of this detail mode.
object is not-applicable
Field type <Cfm::PmMeasurementInterval>
- Measurement interval
- unit: seconds
- range: [60,300]
Parameter type: <Vlan::MacAddr>
MAC address of the PM
- mac address (aa:bb:cc:a1:02:03)
responder(Target).
- length: 6
This element is only shown in
detail mode.
Parameter type: <Cfm::PmCurr15MinTimeElapsedType>
Time elapsed since the start of
- Elapsed time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::Pm15MinTimeMeasuredType>
Time measured since the start of
- Measured time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::PmDataSizeType>
Data size of the SLM proactive
( not-applicable
test
| <Cfm::PmDataSize> )
This element is only shown in
Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmDataSize>
- Datasize for the SLM proactive test
- range: [0...1500]
Parameter type: <Vlan::Priority>
Vlan Priority for PM proactive
- priority of ethernet frames
messages being transmitted
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmCurr15MinValidIntervalsType>
The number of previous 15 min
- The number of previous 15 min intervals for which valid intervals for which valid data was
data was collected for this test.
collected for this test.
- range: [0...96]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmInvalidDataFlagType>
Indicates the validity of the
- Indicates the validity of the corresponding PM data.
corresponding PM data.It is set to
- range: [0...1]
1 when the PM data is incomplete
or invalid and set to 0 when the
PM data is complete and valid.
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of Y1731 PM PDUs sent

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

Type

Description

- 32 bit counter

by this MEP in the current 15


minutes
This element is only shown in
detail mode.
Number of Y1731 PM PDUs
received by this MEP in the
current 15 minutes
This element is only shown in
detail mode.
Number of Y1731 PM PDUs
discarded by this MEP in the
current 15 minutes
This element is only shown in
detail mode.
PM Proactive test Id.
This element is only shown in
detail mode.

pdu-rcvd

Parameter type: <Counter>


- 32 bit counter

pdu-discarded

Parameter type: <Counter>


- 32 bit counter

test-id

Parameter type: <Cfm::PmTestIdType>


( not-applicable
| <Cfm::PmTestId> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmTestId>
- Test Id for PM proactive
- range: [1...65535]
Parameter type: <Cfm::PmMepIdType>
( unavailable
| not-applicable
| <Cfm::MepId> )
Possible values:
- unavailable : No SLR received yet
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::MepId>
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

remote-mep

Only Show Details: loss calculation


name
Type
total-tx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-tx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-far

Parameter type: <Cfm::Pm8byteOctetType>

3HH-04416-EBAA-TCZZA 01

Responder
Maintenance
Association End Point.
This element is only shown in
detail mode.

Description
Total no of PM proactive
messages TXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages TXed in the far end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the far-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the near-end
This element is only shown in
detail mode.
Total loss of PM proactive

Released

2761

103 CFM Status Commands

name

un-ack

Type

Description

- Pdu count

messages in the far-end


This element is only shown in
detail mode.
Total number of SLM frames that
are unacknowledged
This element is only shown in
detail mode.

Parameter type: <Cfm::Pm8byteOctetWithNAType>


( not-applicable
| <Cfm::Pm8byteOctet> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::Pm8byteOctet>
- Pdu count

Only Show Details: frame loss ratio - near end


name
Type
flr-min-near

flr-avg-near

flr-max-near

Only Show Details: frame loss ratio - far end


name
Type
flr-min-far

Frame loss ratio(in %) minimum


in the near end
This element is only shown in
detail mode.

The average of accumulated


Frame Loss Ratio (%) within the
test duration of 15 minutes.
This element is only shown in
detail mode.

Frame loss ratio(in %) maximum


in the near end
This element is only shown in
detail mode.

Description

Parameter type: <Cfm::PmPercentageType>


Frame loss ratio(in %) minimum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
The average of accumulated

flr-avg-far

2762

Description

Parameter type: <Cfm::PmPercentageType>


( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

Type

flr-max-far

( invalid
Frame Loss Ratio (%) within the
| <Cfm::PmPercentage> )
test duration of 15 minutes.
Possible values:
This element is only shown in
- invalid : Negative Loss ratio or Loss ratio more than 100 detail mode.
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
Frame loss ratio(in %) maximum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

3HH-04416-EBAA-TCZZA 01

Description

Released

2763

103 CFM Status Commands

103.12 Proactive CFM PM show command for the


current 1 day
Command Description
This command displays the PM Proactive loss measurement for the current day.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm curr-day-stats

2764

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.13 Proactive CFM PM show command for the


current 1 day
Command Description
This command displays the PM Proactive loss measurement for the current day.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm curr-day-stats domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType> ] [ session-id <Cfm::SessionIdType> ] ]

Command Parameters
Table 103.13-1 "Proactive CFM PM show command for the current 1 day" Resource Parameters
Resource Identifier

Type

(domain-index)

Format:
Maintenance domain.
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance association.
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance End Point.
Format:
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::SessionIdType>
PM Proactive test SessionId.
Format:
- Session Id for PM proactive
- range: [1...960]

association

mep

session-id

Description

Command Output
Table 103.13-2 "Proactive CFM PM show command for the current 1 day" Display parameters
Specific Information
name

Type

Description

test-type

Parameter type: <Cfm::PmTestType>

Y1731 PM Test type

3HH-04416-EBAA-TCZZA 01

Released

2765

103 CFM Status Commands

name

interval(sec)

measurement-intvl(sec)

dest-mac

elapsed-time(sec)

measured-time(sec)

data-tlv-size

priority

valid-intervals

invalid-data-flag

pdu-sent

2766

Released

Type

Description

( single-ended-slm
| single-ended-lm )
Possible values:
- single-ended-slm : sets test type to SLM
- single-ended-lm : sets test type to LM
Parameter type: <Cfm::PmIntervalType>
- PM interval (sec) SLM: [1...10] LM: [60 or 300]
- range: [1...10,60,300]

This element is only shown in


detail mode.

Interval in which PM packets are


transmitted.
This element is only shown in
detail mode.
Parameter type: <Cfm::PmMeasurementIntervalType>
The time for which the synthetic
( not-applicable
loss
calculation
is
made
| <Cfm::PmMeasurementInterval> )
periodically.
Possible values:
This element is only shown in
- not-applicable : For single-ended-lm, the value of this detail mode.
object is not-applicable
Field type <Cfm::PmMeasurementInterval>
- Measurement interval
- unit: seconds
- range: [60,300]
Parameter type: <Vlan::MacAddr>
MAC address of the PM
- mac address (aa:bb:cc:a1:02:03)
responder(Target).
- length: 6
This element is only shown in
detail mode.
Parameter type: <Cfm::PmCurr1DayTimeElapsedType>
Time elapsed since the start of
- Elapsed time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::Pm1DayTimeMeasuredType>
Time measured since the start of
- Measured time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::PmDataSizeType>
Datasize for the SLM proactive
( not-applicable
test
| <Cfm::PmDataSize> )
This element is only shown in
Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmDataSize>
- Datasize for the SLM proactive test
- range: [0...1500]
Parameter type: <Vlan::Priority>
Vlan Priority for PM proactive
- priority of ethernet frames
messages being transmitted
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmCurr1DayValidIntervalsType>
The number of previous 1 Day
- The number of previous 1 Day intervals for which valid intervals for which valid data was
data was collected for this test.
collected for this test.
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmInvalidDataFlagType>
Indicates the validity of the
- Indicates the validity of the corresponding PM data.
corresponding PM data.It is set to
- range: [0...1]
1 when the PM data is incomplete
or invalid and set to 0 when the
PM data is complete and valid.
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of PM Y1731 PDUs sent

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

Type

Description

- 32 bit counter

by this MEP in the current 1Day


This element is only shown in
detail mode.
Number of PM Y1731 PDUs
received by this MEP in the
current 1Day
This element is only shown in
detail mode.
Number of PM Y1731 PDUs
discarded by this MEP in the
current 1Day
This element is only shown in
detail mode.
PM Proactive test Id.
This element is only shown in
detail mode.

pdu-rcvd

Parameter type: <Counter>


- 32 bit counter

pdu-discarded

Parameter type: <Counter>


- 32 bit counter

test-id

Parameter type: <Cfm::PmTestIdType>


( not-applicable
| <Cfm::PmTestId> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmTestId>
- Test Id for PM proactive
- range: [1...65535]
Parameter type: <Cfm::PmMepIdType>
( unavailable
| not-applicable
| <Cfm::MepId> )
Possible values:
- unavailable : No SLR received yet
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::MepId>
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

remote-mep

Only Show Details: loss calculation


name
Type
total-tx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-tx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

3HH-04416-EBAA-TCZZA 01

Remote Maintenance Association


End Point
This element is only shown in
detail mode.

Description
Total no of PM proactive
messages TXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages TXed in the far end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the far-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the near-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the far-end

Released

2767

103 CFM Status Commands

name

Type

un-ack

Description

Parameter type: <Cfm::Pm8byteOctetWithNAType>


( not-applicable
| <Cfm::Pm8byteOctet> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::Pm8byteOctet>
- Pdu count

Only Show Details: frame loss ratio - near end


name
Type
flr-min-near

flr-max-near

Only Show Details: frame loss ratio - far end


name
Type
flr-min-far

Frame loss ratio(in %) minimum


in the near end
This element is only shown in
detail mode.

The average of accumulated


Frame Loss Ratio (%) within the
test duration of 1 Day.
This element is only shown in
detail mode.

Frame loss ratio(in %) maximum


in the near end
This element is only shown in
detail mode.

Description

Parameter type: <Cfm::PmPercentageType>


Frame loss ratio(in %) minimum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
The average of accumulated
( invalid
Frame Loss Ratio (%) within the

flr-avg-far

2768

Description

Parameter type: <Cfm::PmPercentageType>


( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

flr-avg-near

This element is only shown in


detail mode.
Total number of SLM frames that
are unacknowledged
This element is only shown in
detail mode.

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

flr-max-far

3HH-04416-EBAA-TCZZA 01

Type

Description

| <Cfm::PmPercentage> )
test duration of 1 Day.
Possible values:
This element is only shown in
- invalid : Negative Loss ratio or Loss ratio more than 100 detail mode.
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
Frame loss ratio(in %) maximum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Released

2769

103 CFM Status Commands

103.14 Proactive CFM PM show command for the


previous 15 min
Command Description
This command displays the PM proactive loss measurement for the previous 15 min.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm prev-15min-stats

2770

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.15 Proactive CFM PM show command for the


previous 15 min
Command Description
This command displays the PM proactive loss measurement for the previous 15 min.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm prev-15min-stats domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType>
]
[
session-id
<Cfm::SessionIdType>
]
[
interval-number
<Cfm::PmPrevious15MinIntervalNumberType> ] ]

Command Parameters
Table 103.15-1 "Proactive CFM PM show command for the previous 15 min" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Format:
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::SessionIdType>
Format:
- Session Id for PM proactive
- range: [1...960]
Parameter
type:
<Cfm::PmPrevious15MinIntervalNumberType>
Format:
- Previous 15 min interval number
- range: [1...96]

Maintenance domain.

association

mep

session-id

interval-number

Maintenance association.

Maintenance End Point.

PM Proactive test SessionId.

PM Proactive Previous 15 min


interval number.

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2771

103 CFM Status Commands

Table 103.15-2 "Proactive CFM PM show command for the previous 15 min" Display parameters
Specific Information
name
test-type

interval(sec)

measurement-intvl(sec)

dest-mac

measured-time(sec)

data-tlv-size

priority

invalid-data-flag

pdu-sent

pdu-rcvd

2772

Released

Type

Description

Parameter type: <Cfm::PmTestType>


( single-ended-slm
| single-ended-lm )
Possible values:
- single-ended-slm : sets test type to SLM
- single-ended-lm : sets test type to LM
Parameter type: <Cfm::PmIntervalType>
- PM interval (sec) SLM: [1...10] LM: [60 or 300]
- range: [1...10,60,300]

Y1731 PM Test type


This element is only shown in
detail mode.

Interval in which PM packets are


transmitted.
This element is only shown in
detail mode.
Parameter type: <Cfm::PmMeasurementIntervalType>
The time for which the synthetic
( not-applicable
loss
calculation
is
made
| <Cfm::PmMeasurementInterval> )
periodically.
Possible values:
This element is only shown in
- not-applicable : For single-ended-lm, the value of this detail mode.
object is not-applicable
Field type <Cfm::PmMeasurementInterval>
- Measurement interval
- unit: seconds
- range: [60,300]
Parameter type: <Vlan::MacAddr>
MAC address of the PM
- mac address (aa:bb:cc:a1:02:03)
responder(Target).
- length: 6
This element is only shown in
detail mode.
Parameter type: <Cfm::Pm15MinTimeMeasuredType>
Time measured since the start of
- Measured time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::PmDataSizeType>
Data size of the SLM proactive
( not-applicable
test
| <Cfm::PmDataSize> )
This element is only shown in
Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmDataSize>
- Datasize for the SLM proactive test
- range: [0...1500]
Parameter type: <Vlan::Priority>
Vlan Priority for PM proactive
- priority of ethernet frames
messages being transmitted
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmInvalidDataFlagType>
Indicates the validity of the
- Indicates the validity of the corresponding PM data.
corresponding PM data.It is set to
- range: [0...1]
1 when the PM data is incomplete
or invalid and set to 0 when the
PM data is complete and valid.
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of Y1731 PM PDUs sent
- 32 bit counter
by this MEP in the previous 15
minutes
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of Y1731 PM PDUs

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

Type

Description

- 32 bit counter

received by this MEP in the


previous 15 minutes
This element is only shown in
detail mode.
Number of Y1731 PM PDUs
discarded by this MEP in the
previous 15 minutes
This element is only shown in
detail mode.
PM Proactive test Id.
This element is only shown in
detail mode.

pdu-discarded

Parameter type: <Counter>


- 32 bit counter

test-id

Parameter type: <Cfm::PmTestIdType>


( not-applicable
| <Cfm::PmTestId> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmTestId>
- Test Id for PM proactive
- range: [1...65535]
Parameter type: <Cfm::PmMepIdType>
( unavailable
| not-applicable
| <Cfm::MepId> )
Possible values:
- unavailable : No SLR received yet
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::MepId>
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

remote-mep

Only Show Details: loss calculation


name
Type
total-tx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-tx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

un-ack

Parameter type: <Cfm::Pm8byteOctetWithNAType>


( not-applicable

3HH-04416-EBAA-TCZZA 01

Remote Maintenance Association


End Point.
This element is only shown in
detail mode.

Description
Total no of PM proactive
messages TXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages TXed in the far end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the far-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the near-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the far-end
This element is only shown in
detail mode.
Total number of SLM frames that
are unacknowledged

Released

2773

103 CFM Status Commands

name

Type

Description

| <Cfm::Pm8byteOctet> )
This element is only shown in
Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::Pm8byteOctet>
- Pdu count

Only Show Details: frame loss ratio - near end


name
Type
flr-min-near

flr-avg-near

flr-max-near

Only Show Details: frame loss ratio - far end


name
Type
flr-min-far

Frame loss ratio(in %) minimum


in the near end
This element is only shown in
detail mode.

The average of accumulated


Frame Loss Ratio (%) within the
test duration of 15 Minutes.
This element is only shown in
detail mode.

Frame loss ratio(in %) maximum


in the near end
This element is only shown in
detail mode.

Description

Parameter type: <Cfm::PmPercentageType>


Frame loss ratio(in %) minimum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
The average of accumulated
( invalid
Frame Loss Ratio (%) within the
| <Cfm::PmPercentage> )
test duration of 15 Minutes.
Possible values:
This element is only shown in
- invalid : Negative Loss ratio or Loss ratio more than 100 detail mode.
percent

flr-avg-far

2774

Description

Parameter type: <Cfm::PmPercentageType>


( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

flr-max-far

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Cfm::PmPercentage>


- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Frame loss ratio(in %) maximum


in the far end
This element is only shown in
detail mode.

Released

2775

103 CFM Status Commands

103.16 Proactive CFM PM show command for the


previous 1 day
Command Description
This command displays the PM Proactive loss measurement for the previous 1 day.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm prev-day-stats

2776

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

103.17 Proactive CFM PM show command for the


previous 1 day
Command Description
This command displays the PM Proactive loss measurement for the previous 1 day.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cfm y1731pm prev-day-stats domain [ (domain-index) [ association <Cfm::CfmMaIndexType> ] [ mep
<Cfm::MepIdType>
]
[
session-id
<Cfm::SessionIdType>
]
[
interval-number
<Cfm::PmPrevious1DayIntervalNumberType> ] ]

Command Parameters
Table 103.17-1 "Proactive CFM PM show command for the previous 1 day" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Format:
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]
Parameter type: <Cfm::SessionIdType>
Format:
- Session Id for PM proactive
- range: [1...960]
Parameter
type:
<Cfm::PmPrevious1DayIntervalNumberType>
Format:
- Previous 15 min interval number
- range: [1...7]

Maintenance domain.

association

mep

session-id

interval-number

Maintenance association.

Maintenance End Point.

PM Proactive test SessionId.

PM Proactive Previous 1 day


interval number.

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2777

103 CFM Status Commands

Table 103.17-2 "Proactive CFM PM show command for the previous 1 day" Display parameters
Specific Information
name
test-type

interval(sec)

measurement-intvl(sec)

dest-mac

measured-time(sec)

data-tlv-size

priority

invalid-data-flag

pdu-sent

pdu-rcvd

2778

Released

Type

Description

Parameter type: <Cfm::PmTestType>


( single-ended-slm
| single-ended-lm )
Possible values:
- single-ended-slm : sets test type to SLM
- single-ended-lm : sets test type to LM
Parameter type: <Cfm::PmIntervalType>
- PM interval (sec) SLM: [1...10] LM: [60 or 300]
- range: [1...10,60,300]

Y1731 PM Test type


This element is only shown in
detail mode.

Interval in which PM packets are


transmitted.
This element is only shown in
detail mode.
Parameter type: <Cfm::PmMeasurementIntervalType>
The time for which the synthetic
( not-applicable
loss
calculation
is
made
| <Cfm::PmMeasurementInterval> )
periodically.
Possible values:
This element is only shown in
- not-applicable : For single-ended-lm, the value of this detail mode.
object is not-applicable
Field type <Cfm::PmMeasurementInterval>
- Measurement interval
- unit: seconds
- range: [60,300]
Parameter type: <Vlan::MacAddr>
MAC address of the PM
- mac address (aa:bb:cc:a1:02:03)
responder(Target).
- length: 6
This element is only shown in
detail mode.
Parameter type: <Cfm::Pm1DayTimeMeasuredType>
Time measured since the start of
- Measured time
the PM proactive test
- unit: seconds
This element is only shown in
detail mode.
Parameter type: <Cfm::PmDataSizeType>
Data size of the SLM proactive
( not-applicable
test
| <Cfm::PmDataSize> )
This element is only shown in
Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmDataSize>
- Datasize for the SLM proactive test
- range: [0...1500]
Parameter type: <Vlan::Priority>
Vlan Priority for PM proactive
- priority of ethernet frames
messages being transmitted
- range: [0...7]
This element is only shown in
detail mode.
Parameter type: <Cfm::PmInvalidDataFlagType>
Indicates the validity of the
- Indicates the validity of the corresponding PM data.
corresponding PM data.It is set to
- range: [0...1]
1 when the PM data is incomplete
or invalid and set to 0 when the
PM data is complete and valid.
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of PM Y1731 PDUs sent
- 32 bit counter
by this MEP in the previous 1Day
This element is only shown in
detail mode.
Parameter type: <Counter>
Number of PM Y1731 PDUs
- 32 bit counter
received by this MEP in the

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

Type

Description

pdu-discarded

Parameter type: <Counter>


- 32 bit counter

test-id

Parameter type: <Cfm::PmTestIdType>


( not-applicable
| <Cfm::PmTestId> )
Possible values:
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::PmTestId>
- Test Id for PM proactive
- range: [1...65535]
Parameter type: <Cfm::PmMepIdType>
( unavailable
| not-applicable
| <Cfm::MepId> )
Possible values:
- unavailable : No SLR received yet
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::MepId>
- MA End Point (MEP) ID. Unique within an MA
- range: [1...8191]

remote-mep

Only Show Details: loss calculation


name
Type
total-tx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-tx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

total-rx-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-near

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

loss-far

Parameter type: <Cfm::Pm8byteOctetType>


- Pdu count

un-ack

Parameter type: <Cfm::Pm8byteOctetWithNAType>


( not-applicable
| <Cfm::Pm8byteOctet> )

3HH-04416-EBAA-TCZZA 01

previous 1Day
This element is only shown in
detail mode.
Number of PM Y1731 PDUs
discarded by this MEP in the
previous 1Day
This element is only shown in
detail mode.
PM Proactive test Id.
This element is only shown in
detail mode.

Remote Maintenance Association


End Point Id.
This element is only shown in
detail mode.

Description
Total no of PM proactive
messages TXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages TXed in the far end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the near-end
This element is only shown in
detail mode.
Total no of PM proactive
messages RXed in the far-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the near-end
This element is only shown in
detail mode.
Total loss of PM proactive
messages in the far-end
This element is only shown in
detail mode.
Total number of SLM frames that
are unacknowledged
This element is only shown in

Released

2779

103 CFM Status Commands

name

Type

Description

Possible values:
detail mode.
- not-applicable : For single-ended-lm, the value of this
object is not-applicable
Field type <Cfm::Pm8byteOctet>
- Pdu count

Only Show Details: frame loss ratio - near end


name
Type
flr-min-near

flr-avg-near

flr-max-near

Only Show Details: frame loss ratio - far end


name
Type
flr-min-far

Frame loss ratio(in %) minimum


in the near end
This element is only shown in
detail mode.

The average of accumulated


Frame Loss Ratio (%) within the
test duration of 1 Day.
This element is only shown in
detail mode.

Frame loss ratio(in %) maximum


in the near end
This element is only shown in
detail mode.

Description

Parameter type: <Cfm::PmPercentageType>


Frame loss ratio(in %) minimum
( invalid
in the far end
| <Cfm::PmPercentage> )
This element is only shown in
Possible values:
detail mode.
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
The average of accumulated
( invalid
Frame Loss Ratio (%) within the
| <Cfm::PmPercentage> )
test duration of 1 Day.
Possible values:
This element is only shown in
- invalid : Negative Loss ratio or Loss ratio more than 100 detail mode.
percent
Field type <Cfm::PmPercentage>

flr-avg-far

2780

Description

Parameter type: <Cfm::PmPercentageType>


( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Released

3HH-04416-EBAA-TCZZA

01

103 CFM Status Commands

name

flr-max-far

3HH-04416-EBAA-TCZZA 01

Type

Description

- Frame loss ratio in percentage


- unit: percentage
- range: [0.00...100.00,655.35]
Parameter type: <Cfm::PmPercentageType>
( invalid
| <Cfm::PmPercentage> )
Possible values:
- invalid : Negative Loss ratio or Loss ratio more than 100
percent
Field type <Cfm::PmPercentage>
- Frame loss ratio in percentage
- unit: percentage
- range: [0.00...100.00,655.35]

Frame loss ratio(in %) maximum


in the far end
This element is only shown in
detail mode.

Released

2781

104- IPoA/E IW Status Commands

104.1 IPoA/E IW Status Command Tree


104.2 IPoA/E IW Interworking Port Status Command

2782

Released

104-2783
104-2784

3HH-04416-EBAA-TCZZA

01

104 IPoA/E IW Status Commands

104.1 IPoA/E IW Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IPoA/E IW Status Commands".

Command Tree
----show
----ipoa/e-iw
----port
- (interworking-port)

3HH-04416-EBAA-TCZZA 01

Released

2783

104 IPoA/E IW Status Commands

104.2 IPoA/E IW Interworking Port Status


Command
Command Description
This command displays the status of ipoa/oe iwl port's L2 connectivity.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ipoa/e-iw port [ (interworking-port) ]

Command Parameters
Table 104.2-1 "IPoA/E IW Interworking Port Status Command" Resource Parameters
Resource Identifier

Type

(interworking-port)

Format:
index
of
rack/shelf/slot/port
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / user-bridgeport
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

Description

Command Output
Table 104.2-2 "IPoA/E IW Interworking Port Status Command" Display parameters
Specific Information
name

Type

Description

oper-status

Parameter type: <IpoaccM::operState>

l2 connectivity operational state

2784

Released

3HH-04416-EBAA-TCZZA

01

104 IPoA/E IW Status Commands

name

down-reason

src-mac-addr

er-mac-addr

3HH-04416-EBAA-TCZZA 01

Type

Description

( up
| down )
Possible values:
- up : the data plane is fully ready for forwarding
- down : the data plane is not fully ready for forwarding
Parameter type: <IpoaccM::downReason>
( no-error
| net-vlan-miss
| gw-cfg-miss
| gw-mac-unresolved
| interface-down )
Possible values:
- no-error : no error
- net-vlan-miss : network vlan not attached
- gw-cfg-miss : gateway not configured
- gw-mac-unresolved : gateway mac address not resolved
- interface-down : corresponding vlan port interface down in
operational
Parameter type: <IpoaccM::macAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

This element is always shown.

Parameter type: <IpoaccM::macAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

l2 connectivity status reason


This element is only shown in
detail mode.

source mac address allocated for


iwl user
This element is only shown in
detail mode.
gateway mac address for iwl user
This element is only shown in
detail mode.

Released

2785

105- LineTest Status Commands

105.1 LineTest Status Command Tree


105.2 Megaco LineTest Available Session Status
Command
105.3 Megaco LineTest Session Status Command
105.4 Megaco LineTest Line Status Command
105.5 Megaco LineTest LineId ExtReport Status Command
105.6 SINGLE LineTest Available Session Status
Command
105.7 SINGLE LineTest Session Status Command
105.8 SINGLE LineTest Line Status Command
105.9 SINGLE LineTest LineId ExtReport Status Command
105.10 SINGLE LineTest Chipset Data Command
105.11 SINGLE LineTest Session busy port Command

2786

Released

105-2787
105-2788
105-2789
105-2791
105-2795
105-2801
105-2802
105-2805
105-2809
105-2815
105-2816

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.1 LineTest Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "LineTest Status Commands".

Command Tree
----show
----linetest
----cluster
- (clusterid)
----avail-sess
----ltsession
- (sessionid)
----ltline
- (sessionid)
- lineid
----lineid-ext-rept
- (sessionid)
- lineid
- test-name(unit)
- result-index
----single
----avail-sess
----ltsession
- (sessionid)
----ltline
- (sessionid)
- lineid
----lineid-ext-rept
- (sessionid)
- lineid
- test-name(unit)
- result-index
----chipsetdata-for-slot
- (ltboardposition)
----busy-status
- (sessionid)
- lineid

3HH-04416-EBAA-TCZZA 01

Released

2787

105 LineTest Status Commands

105.2 Megaco LineTest Available Session Status


Command
Command Description
This command allows the operator to check whether there is an available session to line test.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show linetest cluster (clusterid) avail-sess

Command Parameters
Table 105.2-1 "Megaco LineTest Available Session Status Command" Resource Parameters
Resource Identifier

Type

Description

(clusterid)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

Command Output
Table 105.2-2 "Megaco LineTest Available Session Status Command" Display parameters
Specific Information
name
available-sess
max-session

2788

Released

Type

Description

Parameter type: <LineTest::Session>


- session number
- range: [0...16]
Parameter type: <LineTest::Session>
- session number
- range: [0...16]

the available seesion to do line


test
This element is always shown.
the max number of session
This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.3 Megaco LineTest Session Status Command


Command Description
This command displays session related parameters.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show linetest cluster (clusterid) ltsession [ (sessionid) ]

Command Parameters
Table 105.3-1 "Megaco LineTest Session Status Command" Resource Parameters
Resource Identifier

Type

Description

(clusterid)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- available session id
- range: [1]

uniquely identify of this xvps


cluster

(sessionid)

uniquely identify of session

Command Output
Table 105.3-2 "Megaco LineTest Session Status Command" Display parameters
Specific Information
name
session-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <LineTest::SessionStatus>


the status of session
( idle
This element is always shown.
| revcmd
| runcmd
| revinfo
| testover
| stateerror
| testhold )
Possible values:
- idle : indicate the session is not initialized, you can create it
- revcmd : indicate the session receives test cmd
- runcmd : indicate the session runs test cmd
- revinfo : indicate the session receives info cmd
- testover : indicate the session test is finished
- stateerror : something is wrong

Released

2789

105 LineTest Status Commands

name

Type

Description

- testhold : indicate the session is held for sub test of talking


test or 1 round is finished in continuous test

2790

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.4 Megaco LineTest Line Status Command


Command Description
This command displays all parameters on a specific line id of a session.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show linetest cluster (clusterid) ltline [ (sessionid) [ lineid <Itf::LineTestMegacoLineId> ] ]

Command Parameters
Table 105.4-1 "Megaco LineTest Line Status Command" Resource Parameters
Resource Identifier

Type

Description

(clusterid)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- available session id
- range: [1]
Parameter type: <Itf::LineTestMegacoLineId>
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::NewSlotId> / <Eqpt::MegacoPortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

uniquely identify of this xvps


cluster

(sessionid)
lineid

uniquely identify of session


line id

Command Output
Table 105.4-2 "Megaco LineTest Line Status Command" Display parameters
Specific Information
name

Type

Description

line-status

Parameter type: <LineTest::LineStatus>

the test result status

3HH-04416-EBAA-TCZZA 01

Released

2791

105 LineTest Status Commands

name

Type

comm-status

2792

Description

( none
This element is always shown.
| intest
| testover
| rstpartlyready )
Possible values:
- none : null
- intest : put the line in test
- testover : the line tested, and the result is ready for polling,
it is read-only
- rstpartlyready : defined for dp/dtmf test
Parameter type: <LineTest::LTComErrCode>
the test result status
( unfinished
This element is always shown.
| finish
| stop-by-timeout
| cancel-by-operator
| break-by-user
| ppfailed
| linebusy
| ltime-no-operator
| linestatus-error
| out-memory
| timer-operfail
| type-empty
| type-logic-err
| type-unknown
| para-lineid-err
| para-oper-err
| pare-serialnum-err
| line-intesting
| otherfail
| ended-by-oper
| onhook-by-oper
| paraval-err
| session-timeout
| invalid-portid
| miss-message
| redundancy-ports
| end-sequence-num
| port-disable
| poltfail
| port-unknown-state
| outofmem
| new-timer-err
| start-timer-err
| send-msg-err
| get-ipudp-err
| enable-lock
| disable-unlock
| disable-lock
| abort-timer-err
| empty-test-type
| mismatch-with-mode
| disable-net-unlock
| disable-unlock-gk
| disable-unlock-oc
| disable-unlock-ot
| disable-net-lock

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

Type

Description

| disable-lock-gk
| disable-lock-oc
| disable-lock-ot
| not-support
| mta-testing
| board-intesting
| finish-pass
| finish-fail )
Possible values:
- unfinished : the line test is not finished yet
- finish : the total logic result outcome
- stop-by-timeout : if reset all cmd is arrived, the later
coming test request is wrong
- cancel-by-operator : as an error flag to construct the result
package
- break-by-user : stop while testing by user
- ppfailed : pp failed, hardware failed
- linebusy : the line is busy in used
- ltime-no-operator : in continuous/talking test, long time no
further operator(600s)
- linestatus-error : timer operator failed
- out-memory : fail to apply result buffer in lt board
- timer-operfail : operation fail of timer
- type-empty : no test type in test request
- type-logic-err : measurement no supported
- type-unknown : the test command is illegal
- para-lineid-err : the lineid in test command is not valid
- para-oper-err : illegal operation
- pare-serialnum-err : error session id
- line-intesting : the line is in another line test
- otherfail : some other fail
- ended-by-oper : the test was over because of end operation
of operator
- onhook-by-oper : the test was over because operator on
hook
- paraval-err : for dtmf test, test para less than 1
- session-timeout : test session time out
- invalid-portid : lineid is not valid
- miss-message : line test message is not received
- redundancy-ports : redundancy port ids for the testtype
only support 1 port every test
- end-sequence-num : end command used wrong session id
- port-disable : line test board is not available
- poltfail : line test board failed
- port-unknown-state : this line is in an unknown state
- outofmem : xVPS or NT run out of memory
- new-timer-err : create timer failed
- start-timer-err : start timer failed
- send-msg-err : send message failed
- get-ipudp-err : get line ip/udp failed
- enable-lock : line enable but locked
- disable-unlock : line disable and unlocked
- disable-lock : line disable and locked
- abort-timer-err : abort timer failed
- empty-test-type : the test type bitmap is empty
- mismatch-with-mode : test type mismatch with test mode
- disable-net-unlock : adminstate:unlock, operstate:disable

3HH-04416-EBAA-TCZZA 01

Released

2793

105 LineTest Status Commands

name

Type

val-num
hook-chag-status

2794

Description

from mgc
- disable-unlock-gk : adminstate:unlock, operstate:disable
from tg(ground key)
- disable-unlock-oc : adminstate:unlock, operstate:disable
from tg(over current)
- disable-unlock-ot : adminstate:unlock, operstate:disable
from tg(over temperature)
- disable-net-lock : adminstate:lock, operstate:disable form
mgc
- disable-lock-gk : adminstate:lock, operstate:disable from
tg(ground key)
- disable-lock-oc : adminstate:lock, operstate:disable from
tg(over current)
- disable-lock-ot : adminstate:lock, operstate:disable from
tg(over temperature)
- not-support : line test is no supported for the port
- mta-testing : the port is undergoing in mta test now
- board-intesting : the board is in another line test
- finish-pass : gr909 group test passed
- finish-fail : gr909 group test failed
Parameter type: <LineTest::RpValNum>
- available results numbers
- range: [0...72]
Parameter type: <LineTest::LineHookChagStat>
( others
| offhook-to-onhook
| onhook-to-offhook )
Possible values:
- others : no hook state change
- offhook-to-onhook : the tested line has hook state change
from off hook to on hook
- onhook-to-offhook : the tested line has hook state change
from on hook to off hook

Released

available results numbers


This element is always shown.
line hook state change
This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.5 Megaco LineTest LineId ExtReport Status


Command
Command Description
This command displays parameters for lineid report multi results.

User Level
The command can be accessed by operators with megaco privileges.

Command Syntax
The command has the following syntax:
> show linetest cluster (clusterid) lineid-ext-rept [ (sessionid) [ lineid <Itf::LineTestMegacoLineId> ] [
test-name(unit) <LineTest::TestTypeMegaco> ] [ result-index <LineTest::RpRsIndex> ] ]

Command Parameters
Table 105.5-1 "Megaco LineTest LineId ExtReport Status Command" Resource Parameters
Resource Identifier

Type

(clusterid)

Format:
uniquely identify of this xvps
- the xvps cluster id
cluster
- range: [1...8]
Format:
uniquely identify of session
- available session id
- range: [1]
Parameter type: <Itf::LineTestMegacoLineId>
line id
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::NewSlotId> / <Eqpt::MegacoPortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco
Parameter type: <LineTest::TestTypeMegaco>
test type
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)

(sessionid)
lineid

test-name(unit)

3HH-04416-EBAA-TCZZA 01

Description

Released

2795

105 LineTest Status Commands

Resource Identifier

Type

Description

| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)
| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)
| resist-rt(ohm)
| resist-tg(ohm)
| resist-rg(ohm)
| resist-tbat(ohm)
| resist-rbat(ohm)
| capacitanc-tr(nf)
| capacitanc-rt(nf)
| capacitanc-tg(nf)
| capacitanc-rg(nf)
| impedance-tr(ohm)
| impedance-tg(ohm)
| impedance-rg(ohm)
| low-capacit-phone
| bat-imped-discard
| dialton-delay(ms)
| msocket-detection
| ac-current-tr(ua)
| ac-current-tg(ua)
| ac-current-rg(ua)
| dc-current-tr(ua)
| dc-current-tg(ua)
| dc-current-rg(ua)
| noise-lv-0.001dbm
| howler-test-park
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub(ohm)
| feeded-dc-tg(mv)
| feeded-dc-rg(mv)
| impedance-rt(ohm)
| isdn-loopback
| ringer-ren(1000ren)
| dialtone-delay-db(ms)
| gr909-roh
| gr909-hazardous-p
| gr909-femf
| gr909-resistive-f )
Possible values:
- feeded-ac-tr(mv) : feeded ac rms voltage of user line
(tip-ring)
- feeded-ac-tg(mv) : feeded ac rms voltage of user line
(tip-ground)

2796

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

Resource Identifier

Type

Description

- feeded-ac-rg(mv) : feeded ac rms voltage of user line


(ring-ground)
- foreign-ac-tr(mv) : foreign ac rms voltage of user line
(tip-ring)
- foreign-ac-tg(mv) : foreign ac rms voltage of user line
(tip-ground)
- foreign-ac-rg(mv) : foreign ac rms voltage of user line
(ring-ground)
- feeded-dc-tr(mv) : feeded dc voltage of user line (tip-ring)
- foreign-dc-tr(mv) : foreign dc voltage of user line (tip-ring)
- foreign-dc-tg(mv) : foreign dc voltage of user line
(tip-ground)
- foreign-dc-rg(mv) : foreign dc voltage of user line
(ring-ground)
- feed-current(ua) : feeding current (tip-ring)
- feeded-dc-rt(mv) : feeded dc voltage of user line (ring-tip)
- resist-tr(ohm) : insulating resistance of user line (tip-ring)
- resist-rt(ohm) : insulating resistance of user line (ring-tip)
- resist-tg(ohm) : insulating resistance of user line
(tip-ground)
- resist-rg(ohm) : insulating resistance of user line
(ring-ground)
- resist-tbat(ohm) : insulating battery resistance of user line
(tip-bat)
- resist-rbat(ohm) : insulating battery resistance of user line
(ring-bat)
- capacitanc-tr(nf) : capacitance of user line (tip-ring)
- capacitanc-rt(nf) : capacitance of user line (ring-tip)
- capacitanc-tg(nf) : capacitance of user line (tip-ground)
- capacitanc-rg(nf) : capacitance of user line (ring-ground)
- impedance-tr(ohm) : impedance of user circuit (tip-ring)
- impedance-tg(ohm) : impedance of user circuit
(tip-ground)
- impedance-rg(ohm) : impedance of user circuit
(ring-ground)
- low-capacit-phone : low capacitance phone detect
- bat-imped-discard : battery impedance (ring-bat) discarded
- dialton-delay(ms) : dial tone delay of user circuit only in
idle
- msocket-detection : termination (m socket detection)
- ac-current-tr(ua) : ac current test normal test (tip-ring)
- ac-current-tg(ua) : ac current test normal test (tip-ground)
- ac-current-rg(ua) : ac current test normal test (ring-ground)
- dc-current-tr(ua) : dc current test normal test (tip-ring)
- dc-current-tg(ua) : dc current test normal test (tip-ground)
- dc-current-rg(ua) : dc current test normal test (ring-ground)
- noise-lv-0.001dbm : noise level normal test
- howler-test-park : howler test under normal test condition
only in parking
- status-monitored : status monitored test
- cable-pair-ident : cable pair identification test
- talking-father : talking test (father test item)
- line-reverse-sub : line reverse test, subtest of talking test
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test

3HH-04416-EBAA-TCZZA 01

Released

2797

105 LineTest Status Commands

Resource Identifier

Type

Description

- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking


test
- userloop-sub(ohm) : resistance of user loop (rip-ring),
subtest of talking test
- feeded-dc-tg(mv) : feeded dc voltage of user line
(tip-ground)
- feeded-dc-rg(mv) : feeded dc voltage of user line
(ring-ground)
- impedance-rt(ohm) : impedance of user circuit (ring-tip)
- isdn-loopback : isdn loop back test
- ringer-ren(1000ren) : gr909 ringer equivalency number
testing
- dialtone-delay-db(ms) : gr909 draw and break dial tone
delay testing
- gr909-roh : gr909 receiver off hook testing
- gr909-hazardous-p : gr909 Hazardous Potential testing
- gr909-femf : gr909 Foreign ElectroMotive Force testing
- gr909-resistive-f : gr909 resistive faults testing
Parameter type: <LineTest::RpRsIndex>
Index of multi results
Format:
- index of multi results
- range: [1...20]

result-index

Command Output
Table 105.5-2 "Megaco LineTest LineId ExtReport Status Command" Display parameters
Specific Information
name
validity

2798

Released

Type

Description

Parameter type: <LineTest::LTErrCode>


( success
| ppnom-measurefail
| ppnom-hookdet
| ppnom-alreadrun
| ppnom-notimple
| ppnet-offhook
| ppnet-inval-opmode
| ppnet-other
| ppnet-vin-unsupp
| ppnet-slic-unsupp
| testbeyd-cdethres
| test-timeout
| test-interrupt
| test-errother
| test-errvin
| test-erronhook
| test-erroffhook
| testbeyd-confthre
| degrade-daccuracy
| thermal-fault
| exc-ac-induct
| cmsaturation
| diffsaturation
| exec-foreign-vol
| capoutofrange
| exec-low-res
| receiveroffhook

the test result status


This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

value

3HH-04416-EBAA-TCZZA 01

Type

Description

| testnotpassed
| gndreported
| resoutofrange
| linestatus-unsupport
| not-applicable
| pass
| fail )
Possible values:
- success : pp success
- ppnom-measurefail : pp measurement fail
- ppnom-hookdet : pp hook detected
- ppnom-alreadrun : pp already running
- ppnom-notimple : pp not implemented
- ppnet-offhook : pp off hook detected
- ppnet-inval-opmode : pp invalid opmode
- ppnet-other : pp other error
- ppnet-vin-unsupp : pp vin unsupport
- ppnet-slic-unsupp : pp slic unsupport
- testbeyd-cdethres : test beyond cde threshold
- test-timeout : test timeout
- test-interrupt : test course was interrupted
- test-errother : test other error
- test-errvin : error coursed vy vinetic chip
- test-erronhook : test ended by on hook event
- test-erroffhook : test ended by off hook event
- testbeyd-confthre : test result beyond the threshold that
operator configed
- degrade-daccuracy : the accuracy of the results are
degraded because of low leakage resistance
- thermal-fault : a thermal fault was detected during the test
- exc-ac-induct : excessive ac induction was detected during
the test
- cmsaturation : common mode saturation was detected
during the test
- diffsaturation : differential saturation was detected during
the test
- exec-foreign-vol : a large foreign voltage prevented the
respective tests from being executed
- capoutofrange : capacitor were too large to be measured
- exec-low-res : test has not been executed due to the
presence of a very low fault resistance
- receiveroffhook : test failed because the measured voltage
never settled to within tolerancelimits
- testnotpassed : test result beyond the threshold that
operator configed
- gndreported : a single resistance to ground
- resoutofrange : resistance were too large to be measured
- linestatus-unsupport : test not executed because of the
unsupported line status
- not-applicable : test not executed because it not applicable
- pass : gr909 sub test passed
- fail : gr909 sub test failed
Parameter type: <LineTest::ExtRpVal>
line test result value of the
- line test result value of the specified line and test type.The specified line and test type
specific range is dependent on the specific line test item.The This element is always shown.
following is the max range.
- range: [-2147483647...2147483647]

Released

2799

105 LineTest Status Commands

2800

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.6 SINGLE LineTest Available Session Status


Command
Command Description
This command allows the operator to check whether there is an available session to line test.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single avail-sess

Command Output
Table 105.6-2 "SINGLE LineTest Available Session Status Command" Display parameters
Specific Information
name
available-session
max-session

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <LineTest::Session>


- session number
- range: [0...16]
Parameter type: <LineTest::Session>
- session number
- range: [0...16]

the available seesion to do line


test
This element is always shown.
the max number of session
This element is always shown.

Released

2801

105 LineTest Status Commands

105.7 SINGLE LineTest Session Status Command


Command Description
This command displays session related parameters.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single ltsession [ (sessionid) ]

Command Parameters
Table 105.7-1 "SINGLE LineTest Session Status Command" Resource Parameters
Resource Identifier

Type

Description

(sessionid)

Format:
- available session id
- range: [1...16]

uniquely identify of session

Command Output
Table 105.7-2 "SINGLE LineTest Session Status Command" Display parameters
Specific Information
name
session-status

Description

Parameter type: <LineTest::SessionStatus>


the status of session
( idle
This element is always shown.
| revcmd
| runcmd
| revinfo
| testover
| stateerror
| testhold )
Possible values:
- idle : indicate the session is not initialized, you can create it
- revcmd : indicate the session receives test cmd
- runcmd : indicate the session runs test cmd
- revinfo : indicate the session receives info cmd
- testover : indicate the session test is finished
- stateerror : something is wrong
- testhold : indicate the session is held for sub test of talking
test or 1 round is finished in continuous test
Parameter type: <LineTest::SessionErrCode>
the input error code of session

input-err-code

2802

Type

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

Type

Description

( noerr
This element is always shown.
| paramnuminconsis
| paramnumoutrange
| typeneednoparam
| nontestingtype
| missingparamconf
| missingtimeout
| timeoutnotenough
| linenuminconsis
| linenumoutrange
| invalidlineid
| duplicatedline
| missingtesttype
| invalidtesttype
| thresholdnumerr
| neednothreshold
| threshfornon
| typemismatchmode
| linenummismatch
| wrongstatusforsub
| notonetestitem
| lineidinnontest
| modenotsupportrep
| sessionstateerr
| internalerror
| inactivetimeroutrange )
Possible values:
- noerr : no error
- paramnuminconsis : the actual input param number in
ltTestParamTable is not equal to ltTestParamNum
- paramnumoutrange : the input param number is out of
range, from 0 to 4 is allowed
- typeneednoparam : the input test param is meaningless,
because those test types not need any test para
- nontestingtype : the input test param for those test types
which are not in current test session
- missingparamconf : missing test param configuration for
those test types which must have test param
- missingtimeout : missing ltTimeOutPeriod value
- timeoutnotenough : the input ltTimeOutPeriod is not
enough for test
- linenuminconsis : the actual input line number in
ltLineIdTable is not equal to ltLineNum
- linenumoutrange : the input line number is out of range,
from 1 to 72 is allowed
- invalidlineid : the input lineId is invalid
- duplicatedline : the same lineId configed twice
- missingtesttype : missing ltTestTypeHigh and
ltTestTypeLow
- invalidtesttype : the input ltTestTypeHigh and
ltTestTypeLow is incorrect
- thresholdnumerr : input too many threshold, the number of
threshold from 0 to 39 is allowed
- neednothreshold : the input threshold is meaningless,
because those test types do not need any threshold
- threshfornon : the input threshold for those test types
which are not in current test session

3HH-04416-EBAA-TCZZA 01

Released

2803

105 LineTest Status Commands

name

Type

Description

- typemismatchmode : the input test type does not match


with the test mode
- linenummismatch : the input line number is not match test
mode and test type. All talking test, cable pair test, block test
and continuous test only support one line for certain test
- wrongstatusforsub : the line status for subtest is not in
holding or the line which has no father test first
- notonetestitem : block test and continous test must be only
one test type
- lineidinnontest : the input lineId is not in testing status
- modenotsupportrep : repeate test can only be done in
continous test mode
- sessionstateerr : the command not allowed in current
session state
- internalerror : internal system error
- inactivetimeroutrange : the input session inactive timer is
out of range, 0 and from 120 to 65535 is allowed

2804

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.8 SINGLE LineTest Line Status Command


Command Description
This command displays all parameters on a specific line id of a session.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single ltline [ (sessionid) [ lineid <Itf::LineTestSingleLineId> ] ]

Command Parameters
Table 105.8-1 "SINGLE LineTest Line Status Command" Resource Parameters
Resource Identifier

Type

(sessionid)

Format:
uniquely identify of session
- available session id
- range: [1...16]
Parameter type: <Itf::LineTestSingleLineId>
line id
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

lineid

Description

Command Output
Table 105.8-2 "SINGLE LineTest Line Status Command" Display parameters
Specific Information
name
line-status

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <LineTest::LineStatus>


( none
| intest
| testover

the test result status


This element is always shown.

Released

2805

105 LineTest Status Commands

name

Type

comm-status

2806

Description

| rstpartlyready )
Possible values:
- none : null
- intest : put the line in test
- testover : the line tested, and the result is ready for polling,
it is read-only
- rstpartlyready : defined for dp/dtmf test
Parameter type: <LineTest::LTComErrCode>
the test result status
( unfinished
This element is always shown.
| finish
| stop-by-timeout
| cancel-by-operator
| break-by-user
| ppfailed
| linebusy
| ltime-no-operator
| linestatus-error
| out-memory
| timer-operfail
| type-empty
| type-logic-err
| type-unknown
| para-lineid-err
| para-oper-err
| pare-serialnum-err
| line-intesting
| otherfail
| ended-by-oper
| onhook-by-oper
| paraval-err
| session-timeout
| invalid-portid
| miss-message
| redundancy-ports
| end-sequence-num
| port-disable
| poltfail
| port-unknown-state
| outofmem
| new-timer-err
| start-timer-err
| send-msg-err
| get-ipudp-err
| enable-lock
| disable-unlock
| disable-lock
| abort-timer-err
| empty-test-type
| mismatch-with-mode
| disable-net-unlock
| disable-unlock-gk
| disable-unlock-oc
| disable-unlock-ot
| disable-net-lock
| disable-lock-gk
| disable-lock-oc
| disable-lock-ot

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

Type

Description

| not-support
| mta-testing
| board-intesting
| finish-pass
| finish-fail )
Possible values:
- unfinished : the line test is not finished yet
- finish : the total logic result outcome
- stop-by-timeout : if reset all cmd is arrived, the later
coming test request is wrong
- cancel-by-operator : as an error flag to construct the result
package
- break-by-user : stop while testing by user
- ppfailed : pp failed, hardware failed
- linebusy : the line is busy in used
- ltime-no-operator : in continuous/talking test, long time no
further operator(600s)
- linestatus-error : timer operator failed
- out-memory : fail to apply result buffer in lt board
- timer-operfail : operation fail of timer
- type-empty : no test type in test request
- type-logic-err : measurement no supported
- type-unknown : the test command is illegal
- para-lineid-err : the lineid in test command is not valid
- para-oper-err : illegal operation
- pare-serialnum-err : error session id
- line-intesting : the line is in another line test
- otherfail : some other fail
- ended-by-oper : the test was over because of end operation
of operator
- onhook-by-oper : the test was over because operator on
hook
- paraval-err : for dtmf test, test para less than 1
- session-timeout : test session time out
- invalid-portid : lineid is not valid
- miss-message : line test message is not received
- redundancy-ports : redundancy port ids for the testtype
only support 1 port every test
- end-sequence-num : end command used wrong session id
- port-disable : line test board is not available
- poltfail : line test board failed
- port-unknown-state : this line is in an unknown state
- outofmem : xVPS or NT run out of memory
- new-timer-err : create timer failed
- start-timer-err : start timer failed
- send-msg-err : send message failed
- get-ipudp-err : get line ip/udp failed
- enable-lock : line enable but locked
- disable-unlock : line disable and unlocked
- disable-lock : line disable and locked
- abort-timer-err : abort timer failed
- empty-test-type : the test type bitmap is empty
- mismatch-with-mode : test type mismatch with test mode
- disable-net-unlock : adminstate:unlock, operstate:disable
from mgc
- disable-unlock-gk : adminstate:unlock, operstate:disable
from tg(ground key)

3HH-04416-EBAA-TCZZA 01

Released

2807

105 LineTest Status Commands

name

Type

comm-status-text
val-num
hook-chag-status

stop-time
remaining-time

2808

Description

- disable-unlock-oc : adminstate:unlock, operstate:disable


from tg(over current)
- disable-unlock-ot : adminstate:unlock, operstate:disable
from tg(over temperature)
- disable-net-lock : adminstate:lock, operstate:disable form
mgc
- disable-lock-gk : adminstate:lock, operstate:disable from
tg(ground key)
- disable-lock-oc : adminstate:lock, operstate:disable from
tg(over current)
- disable-lock-ot : adminstate:lock, operstate:disable from
tg(over temperature)
- not-support : line test is no supported for the port
- mta-testing : the port is undergoing in mta test now
- board-intesting : the board is in another line test
- finish-pass : gr909 group test passed
- finish-fail : gr909 group test failed
Parameter type: <LineTest::comm-status-text>
- the text mapper of comm-stat
- length: x<=256
Parameter type: <LineTest::RpValNum>
- available results numbers
- range: [0...72]
Parameter type: <LineTest::LineHookChagStat>
( others
| offhook-to-onhook
| onhook-to-offhook )
Possible values:
- others : no hook state change
- offhook-to-onhook : the tested line has hook state change
from off hook to on hook
- onhook-to-offhook : the tested line has hook state change
from on hook to off hook
Parameter type: <LineTest::GaugeTimeInSecs>
- the time (yyyy-mm-dd:hour:minutes:secs)
Parameter type: <LineTest::SearchToneRemainingTime>
- search tone remaining time
- unit: second
- range: [0...7200]

Released

the test result status


This element is always shown.
available results numbers
This element is always shown.
line hook state change
This element is always shown.

line test stop time


This element is always shown.
search tone remaining time
This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.9 SINGLE LineTest LineId ExtReport Status


Command
Command Description
This command displays parameters for lineid report multi results.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single lineid-ext-rept [ (sessionid) [ lineid <Itf::LineTestSingleLineId> ] [ test-name(unit)
<LineTest::TestTypeSip> ] [ result-index <LineTest::RpRsIndex> ] ]

Command Parameters
Table 105.9-1 "SINGLE LineTest LineId ExtReport Status Command" Resource Parameters
Resource Identifier

Type

(sessionid)

Format:
uniquely identify of session
- available session id
- range: [1...16]
Parameter type: <Itf::LineTestSingleLineId>
line id
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <LineTest::TestTypeSip>
test type
Format:
( feeded-ac-tr(mv)
| feeded-ac-tg(mv)
| feeded-ac-rg(mv)
| foreign-ac-tr(mv)
| foreign-ac-tg(mv)
| foreign-ac-rg(mv)

lineid

test-name(unit)

3HH-04416-EBAA-TCZZA 01

Description

Released

2809

105 LineTest Status Commands

Resource Identifier

Type

Description

| feeded-dc-tr(mv)
| foreign-dc-tr(mv)
| foreign-dc-tg(mv)
| foreign-dc-rg(mv)
| feed-current(ua)
| feeded-dc-rt(mv)
| resist-tr(ohm)
| resist-rt(ohm)
| resist-tg(ohm)
| resist-rg(ohm)
| resist-tbat(ohm)
| resist-rbat(ohm)
| capacitanc-tr(nf)
| capacitanc-rt(nf)
| capacitanc-tg(nf)
| capacitanc-rg(nf)
| impedance-tr(ohm)
| impedance-tg(ohm)
| impedance-rg(ohm)
| low-capacit-phone
| bat-imped-discard
| dialton-delay(ms)
| msocket-detection
| ac-current-tr(ua)
| ac-current-tg(ua)
| ac-current-rg(ua)
| dc-current-tr(ua)
| dc-current-tg(ua)
| dc-current-rg(ua)
| noise-lv-0.001dbm
| howler-test-park
| status-monitored
| cable-pair-ident
| talking-father
| line-reverse-sub
| p-meter-pulse-sub
| ring-subscrib-sub
| dpdtmf-signal-sub
| userloop-sub(ohm)
| capacit-sign(pf)
| resist-sign(ohm)
| feeded-dc-tg(mv)
| feeded-dc-rg(mv)
| impedance-rt(ohm)
| long-current(ua)
| diagnosis-caller
| diagnosis-callee
| conductance-tr(1/10us)
| conductance-tg(1/10us)
| conductance-rg(1/10us)
| susceptance-tr(1/10us)
| susceptance-tg(1/10us)
| susceptance-rg(1/10us)
| hazardous-volt(1/2)
| term-signature(1/0)
| term-capacitiv(1/0)
| ppa-test(ppa-variant)

2810

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

Resource Identifier

Type

Description

| roh-test(1/0) )
Possible values:
- feeded-ac-tr(mv) : feeded ac rms voltage of user line
(tip-ring)
- feeded-ac-tg(mv) : feeded ac rms voltage of user line
(tip-ground)
- feeded-ac-rg(mv) : feeded ac rms voltage of user line
(ring-ground)
- foreign-ac-tr(mv) : foreign ac rms voltage of user line
(tip-ring)
- foreign-ac-tg(mv) : foreign ac rms voltage of user line
(tip-ground)
- foreign-ac-rg(mv) : foreign ac rms voltage of user line
(ring-ground)
- feeded-dc-tr(mv) : feeded dc voltage of user line (tip-ring)
- foreign-dc-tr(mv) : foreign dc voltage of user line (tip-ring)
- foreign-dc-tg(mv) : foreign dc voltage of user line
(tip-ground)
- foreign-dc-rg(mv) : foreign dc voltage of user line
(ring-ground)
- feed-current(ua) : feeding current (tip-ring)
- feeded-dc-rt(mv) : feeded dc voltage of user line (ring-tip)
- resist-tr(ohm) : insulating resistance of user line (tip-ring)
- resist-rt(ohm) : insulating resistance of user line (ring-tip)
- resist-tg(ohm) : insulating resistance of user line
(tip-ground)
- resist-rg(ohm) : insulating resistance of user line
(ring-ground)
- resist-tbat(ohm) : insulating battery resistance of user line
(tip-bat)
- resist-rbat(ohm) : insulating battery resistance of user line
(ring-bat)
- capacitanc-tr(nf) : capacitance of user line (tip-ring)
- capacitanc-rt(nf) : capacitance of user line (ring-tip)
- capacitanc-tg(nf) : capacitance of user line (tip-ground)
- capacitanc-rg(nf) : capacitance of user line (ring-ground)
- impedance-tr(ohm) : impedance of user circuit (tip-ring)
- impedance-tg(ohm) : impedance of user circuit
(tip-ground)
- impedance-rg(ohm) : impedance of user circuit
(ring-ground)
- low-capacit-phone : low capacitance phone detect
- bat-imped-discard : battery impedance (ring-bat) discarded
- dialton-delay(ms) : dial tone delay of user circuit only in
idle
- msocket-detection : termination (m socket detection)
- ac-current-tr(ua) : ac current test normal test (tip-ring)
- ac-current-tg(ua) : ac current test normal test (tip-ground)
- ac-current-rg(ua) : ac current test normal test (ring-ground)
- dc-current-tr(ua) : dc current test normal test (tip-ring)
- dc-current-tg(ua) : dc current test normal test (tip-ground)
- dc-current-rg(ua) : dc current test normal test (ring-ground)
- noise-lv-0.001dbm : noise level normal test
- howler-test-park : howler test under normal test condition
only in parking
- status-monitored : status monitored test
- cable-pair-ident : cable pair identification test

3HH-04416-EBAA-TCZZA 01

Released

2811

105 LineTest Status Commands

Resource Identifier

Type

Description

- talking-father : talking test (father test item)


- line-reverse-sub : line reverse test, subtest of talking test
- p-meter-pulse-sub : private meter pulses test, subtest of
talking test
- ring-subscrib-sub : ring subscriber with auto ring test,
subtest of talking test
- dpdtmf-signal-sub : dp/dtmf signal test, subtest of talking
test
- userloop-sub(ohm) : resistance of user loop (rip-ring),
subtest of talking test
- capacit-sign(pf) : capacitance of etsi signature or electronic
ringer
- resist-sign(ohm) : resistance of etsi signature or electronic
ringer
- feeded-dc-tg(mv) : feeded dc voltage of user line
(tip-ground)
- feeded-dc-rg(mv) : feeded dc voltage of user line
(ring-ground)
- impedance-rt(ohm) : impedance of user circuit (ring-tip)
- long-current(ua) : difference between the currents on the
a-lead and the b-lead (longitudinal current)
- diagnosis-caller : H248 Voice Diagnosis Caller
- diagnosis-callee : H248 Voice Diagnosis Callee
- conductance-tr(1/10us): Conductance of user line
(Tip-Ring)
- conductance-tg(1/10us): Conductance of user line
(Tip-Ground)
- conductance-rg(1/10us): Conductance of user line
(Ring-Ground)
- susceptance-tr(1/10us): Susceptance of user line
(Tip-Ring)
- susceptance-tg(1/10us): Susceptance of user line
(Tip-Ground)
- susceptance-rg(1/10us): Susceptance of user line
(Ring-Ground)
- hazardous-volt(1/2) : whether voltage value is hazardous or
not(iltf-hazardous-voltage)
- term-signature(1/0) : whether termination signature is
detected(iltf-termination-signature)
- term-capacitiv(1/0) : whether termination capacitance is
detected(iltf-termination-capacitiv)
- ppa-test(ppa-variant) : test ppa variant(iltf-ppa)
- roh-test(1/0) : test termination roh
Parameter type: <LineTest::RpRsIndex>
Index of multi results
Format:
- index of multi results
- range: [1...20]

result-index

Command Output
Table 105.9-2 "SINGLE LineTest LineId ExtReport Status Command" Display parameters
Specific Information
name
validity

2812

Released

Type

Description

Parameter type: <LineTest::LTErrCode>


( success
| ppnom-measurefail

the test result status


This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

Type

Description

| ppnom-hookdet
| ppnom-alreadrun
| ppnom-notimple
| ppnet-offhook
| ppnet-inval-opmode
| ppnet-other
| ppnet-vin-unsupp
| ppnet-slic-unsupp
| testbeyd-cdethres
| test-timeout
| test-interrupt
| test-errother
| test-errvin
| test-erronhook
| test-erroffhook
| testbeyd-confthre
| degrade-daccuracy
| thermal-fault
| exc-ac-induct
| cmsaturation
| diffsaturation
| exec-foreign-vol
| capoutofrange
| exec-low-res
| receiveroffhook
| testnotpassed
| gndreported
| resoutofrange
| linestatus-unsupport
| not-applicable
| pass
| fail )
Possible values:
- success : pp success
- ppnom-measurefail : pp measurement fail
- ppnom-hookdet : pp hook detected
- ppnom-alreadrun : pp already running
- ppnom-notimple : pp not implemented
- ppnet-offhook : pp off hook detected
- ppnet-inval-opmode : pp invalid opmode
- ppnet-other : pp other error
- ppnet-vin-unsupp : pp vin unsupport
- ppnet-slic-unsupp : pp slic unsupport
- testbeyd-cdethres : test beyond cde threshold
- test-timeout : test timeout
- test-interrupt : test course was interrupted
- test-errother : test other error
- test-errvin : error coursed vy vinetic chip
- test-erronhook : test ended by on hook event
- test-erroffhook : test ended by off hook event
- testbeyd-confthre : test result beyond the threshold that
operator configed
- degrade-daccuracy : the accuracy of the results are
degraded because of low leakage resistance
- thermal-fault : a thermal fault was detected during the test
- exc-ac-induct : excessive ac induction was detected during
the test

3HH-04416-EBAA-TCZZA 01

Released

2813

105 LineTest Status Commands

name

Type

value

value2

value3

value4

value-vi

2814

Description

- cmsaturation : common mode saturation was detected


during the test
- diffsaturation : differential saturation was detected during
the test
- exec-foreign-vol : a large foreign voltage prevented the
respective tests from being executed
- capoutofrange : capacitor were too large to be measured
- exec-low-res : test has not been executed due to the
presence of a very low fault resistance
- receiveroffhook : test failed because the measured voltage
never settled to within tolerancelimits
- testnotpassed : test result beyond the threshold that
operator configed
- gndreported : a single resistance to ground
- resoutofrange : resistance were too large to be measured
- linestatus-unsupport : test not executed because of the
unsupported line status
- not-applicable : test not executed because it not applicable
- pass : gr909 sub test passed
- fail : gr909 sub test failed
Parameter type: <LineTest::ExtRpVal>
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]
Parameter type: <LineTest::ExtRpVal>
- line test result value of the specified line and test type.The
specific range is dependent on the specific line test item.The
following is the max range.
- range: [-2147483647...2147483647]

Released

line test result value of the


specified line and test type
This element is always shown.
line test result value of the
specified line and test type
This element is always shown.
line test result value of the
specified line and test type
This element is always shown.
line test result value of the
specified line and test type
This element is always shown.
line test validity identifier for all
result values
This element is always shown.

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

105.10 SINGLE LineTest Chipset Data Command


Command Description
This command displays the manufacturer, hardware version and firmware version of board's chipset.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single chipsetdata-for-slot [ (ltboardposition) ]

Command Parameters
Table 105.10-1 "SINGLE LineTest Chipset Data Command" Resource Parameters
Resource Identifier

Type

Description

(ltboardposition)

Format:
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

uniquely identify of linetest slot

Command Output
Table 105.10-2 "SINGLE LineTest Chipset Data Command" Display parameters
Specific Information
name
vendorid
hardware-version
firmware-version

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <LineTest::VendorString>


- uniquely identifies board vendor id
- length: x<=32
Parameter type: <LineTest::HardwareVersionString>
- uniquely identifies board hardware version
- length: x<=232
Parameter type: <LineTest::FirmwareVersionString>
- uniquely identifies board firmware version
- length: x<=32

the manufacturer identifier of


board
This element is always shown.
the hardware-version of the board
This element is always shown.
the firmware-version of the board
This element is always shown.

Released

2815

105 LineTest Status Commands

105.11 SINGLE LineTest Session busy port


Command
Command Description
This command displays busy port of session.

User Level
The command can be accessed by operators with sip , xdsl privileges.

Command Syntax
The command has the following syntax:
> show linetest single busy-status [ (sessionid) [ lineid <Itf::LineTestSingleLineId> ] ]

Command Parameters
Table 105.11-1 "SINGLE LineTest Session busy port Command" Resource Parameters
Resource Identifier

Type

(sessionid)

Format:
uniquely identify of session
- available session id
- range: [1...16]
Parameter type: <Itf::LineTestSingleLineId>
line id
Format:
<Eqpt::NodeId> / <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
Field type <Eqpt::NodeId>
- the Node number
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

lineid

Description

Command Output
Table 105.11-2 "SINGLE LineTest Session busy port Command" Display parameters
Specific Information
name

Type

Description

busy-status

Parameter type: <LineTest::LTBusyStatus>

busy reason of busy port

2816

Released

3HH-04416-EBAA-TCZZA

01

105 LineTest Status Commands

name

3HH-04416-EBAA-TCZZA 01

Type

Description

( tobetest
| inmeasurement
| insearchtone
| testover )
Possible values:
- tobetest : the port will be test
- inmeasurement : the port is in LineTestMeasurement
- insearchtone : the port is in SearchTone
- testover : the port is test finished

This element is always shown.

Released

2817

106- LACP status commands

106.1 LACP status commands Tree


106.2 LACP Port Status Command
106.3 LACP Group Status Command
106.4 LACP Member Port Status Command

2818

Released

106-2819
106-2820
106-2826
106-2828

3HH-04416-EBAA-TCZZA

01

106 LACP status commands

106.1 LACP status commands Tree


Description
This chapter gives an overview of nodes that are handled by "LACP status commands".

Command Tree
----show
----link-agg
----port-info
- (port)
----group-info
- (group)
----member-port
- (group)
- port

3HH-04416-EBAA-TCZZA 01

Released

2819

106 LACP status commands

106.2 LACP Port Status Command


Command Description
This command displays information for a member port of a Link Aggregation Group.

User Level
The command can be accessed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> show link-agg port-info [ (port) ]

Command Parameters
Table 106.2-1 "LACP Port Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 106.2-2 "LACP Port Status Command" Display parameters
Specific Information
name
aggregate

Type

Description

Parameter type: <Lacp::AggregateFlag>


( aggregate
| individual )
Possible values:
- aggregate : aggregate
- individual : individual

specifies whether the aggregation


port is able to aggregate or only
able to operate as an individual
link.
This element is always shown.

Only Show Details: aggregate/individual parameters


name
Type
actor-sys-id

2820

Parameter type: <Lacp::MacAddr>


- mac address (aa:bb:cc:a1:02:03)

Released

Description
specifies MAC addr that defines
the value of the system id for the

3HH-04416-EBAA-TCZZA

01

106 LACP status commands

name

Type

Description

- length: 6

actor-key

partner-sys-priority

partner-sys-id

partner-key

actual-aggregator-port

attached-aggreg-port

actor-port

partner-port

3HH-04416-EBAA-TCZZA 01

system
that
contains
this
aggregation port.
This element is only shown in
detail mode.
Parameter type: <Lacp::LacpKey>
current operational value of the
- link aggregate key
key for the aggregation port.
- range: [0...65535]
This element is only shown in
detail mode.
Parameter type: <Lacp::PartnerSysPriority>
operational value of priority
- the lacp system priority
associated with the partner's
- range: [0...65535]
system id.
This element is only shown in
detail mode.
Parameter type: <Lacp::MacAddr>
specifies MAC addr value
- mac address (aa:bb:cc:a1:02:03)
representing the current value of
- length: 6
the aggregation port's protocol
partner's system id.
This element is only shown in
detail mode.
Parameter type: <Lacp::LacpKey>
current operational value of the
- link aggregate key
key for the protocol partner.
- range: [0...65535]
This element is only shown in
detail mode.
Parameter type: <Itf::LaGroupZeroIndex>
specifies the aggregator that this
( none
aggregation port has currently
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / selected
<Eqpt::PortId> )
This element is only shown in
Possible values:
detail mode.
- none : no port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Itf::LaGroupZeroIndex>
specifies the aggregator that this
( none
aggregation port is currently
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / attached to. zero indicates that the
<Eqpt::PortId> )
aggregation port is not currently
Possible values:
attached to an aggregator.
- none : no port
This element is only shown in
Field type <Eqpt::RackId>
detail mode.
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Lacp::ActorPort>
port number locally assigned to
- la aggregate actor port
the aggregation port.
- range: [0...65535]
This element is only shown in
detail mode.
Parameter type: <Lacp::PartnerOperPort>
operational port number assigned
- la aggregate partner operational port
to this aggregation port by the

Released

2821

106 LACP status commands

name

Type

Description

- range: [0...65535]

aggregation
port's
protocol
partner.
This element is only shown in
detail mode.
priority value assigned to this
aggregation port by the partner.
This element is only shown in
detail mode.
actor oper lacp synch state
This element is only shown in
detail mode.

partner-port-priority

Parameter type: <Lacp::PartnerPortPriority>


- la aggregate port priority
- range: [0...255]

actor-synch-state

Parameter type: <Lacp::ActorOperLacpSynchState>


( synchronised
| not-synchronised )
Possible values:
- synchronised : actor is syncronised
- not-synchronised : actor is not synchronised
Parameter type: <Lacp::ActorOperLacpCollectState>
( collecting
| not-collecting )
Possible values:
- collecting : the actor is collecting
- not-collecting : the actor is not collecting
Parameter type: <Lacp::ActorOperLacpDistributeState>
( distributing
| not-distributing )
Possible values:
- distributing : the actor is distributing
- not-distributing : the actor is not distributing
Parameter type: <Lacp::ActorOperLacpDefaultedState>
( is-defaulted
| is-not-defaulted )
Possible values:
- is-defaulted : the actor is defaulted
- is-not-defaulted : the actor is not defaulted
Parameter type: <Lacp::ActorOperLacpExpiredState>
( is-expired
| is-not-expired )
Possible values:
- is-expired : actor is in lacp expired state
- is-not-expired : actor is not in lacp expired state
Parameter type: <Lacp::PartnerOperLacpSynchState>
( synchronised
| not-synchronised )
Possible values:
- synchronised : the partner is synchronised
- not-synchronised : the partner is not synchronisede
Parameter type: <Lacp::PartnerOperLacpCollectState>
( collecting
| not-collecting )
Possible values:
- collecting : the partner is collecting
- not-collecting : the partner is not collecting
Parameter type: <Lacp::PartnerOperLacpDistributeState>
( distributing
| not-distributing )
Possible values:
- distributing : the partner is distributing
- not-distributing : the partner is not distributing
Parameter type: <Lacp::PartnerOperLacpDefaultedState>

actor-collect-state

actor-distribute-state

actor-defaulted-state

actor-expired-state

partner-synch-state

partner-collect-state

partn-distribute-state

partn-defaulted-state

2822

Released

actor oper lacp collecting state


This element is only shown in
detail mode.

actor oper lacp distributing state


This element is only shown in
detail mode.

actor oper lacp defaulted state


This element is only shown in
detail mode.

actor oper lacp expired state


This element is only shown in
detail mode.

partner oper lacp synch state


This element is only shown in
detail mode.

partner oper lacp collecting state


This element is only shown in
detail mode.

partner oper lacp distributing


state
This element is only shown in
detail mode.
partner oper lacp defaulted state

3HH-04416-EBAA-TCZZA

01

106 LACP status commands

name

Type

Description
This element is only shown in
detail mode.

partner-expired-state

( is-defaulted
| is-not-defaulted )
Possible values:
- is-defaulted : the partner is defaulted
- is-not-defaulted : the partner is not defaulted
Parameter type: <Lacp::PartnerOperLacpExpiredState>
( is-expired
| is-not-expired )
Possible values:
- is-expired : partner is in lacp expired state
- is-not-expired : partner is not in lacp expired state

Only Show Details: link aggregation control protocol statistics


name
Type
lacp-pdus-rx

Parameter type: <Counter>


- 32 bit counter

marker-rx

Parameter type: <Counter>


- 32 bit counter

marker-response-rx

Parameter type: <Counter>


- 32 bit counter

unknown-rx

Parameter type: <Counter>


- 32 bit counter

illegal-rx

Parameter type: <Counter>


- 32 bit counter

lacp-pdus-tx

Parameter type: <Counter>


- 32 bit counter

marker-tx

Parameter type: <Counter>


- 32 bit counter

marker-response-tx

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

partner oper lacp expired state


This element is only shown in
detail mode.

Description
number of valid LACPDUs
received on this aggregation port.
This element is only shown in
detail mode.
nbr of valid marker PDUs
received on this aggregation port.
This element is only shown in
detail mode.
nbr of valid marker response
PDUs
received
on
this
aggregation port.
This element is only shown in
detail mode.
nbr of frames rx that either: carry
the slow protocols ethernet type
value, but contain an unknown
PDU,or: are addressed to the
slow protocols group MAC addr,
but do not carry the slow
protocols ethernet type.
This element is only shown in
detail mode.
nbr of frames rx that carry the
slow protocols ethernet type
value, but contain a badly formed
PDU or an illegal value of
protocol subtype.
This element is only shown in
detail mode.
number of LACPDUs transmitted
on this aggregation port.
This element is only shown in
detail mode.
number
of
marker
PDUs
transmitted on this aggregation
port.
This element is only shown in
detail mode.
nbr of marker response PDUs
transmitted on this aggregation
port.
This element is only shown in
detail mode.

Released

2823

106 LACP status commands

Only Show Details: debugging information


name
Type
rx-state

last-rx-time

mux-state

specifies receive state machine


for the aggregation port
This element is only shown in
detail mode.

Parameter type: <Lacp::MuxState>


( detached
| waiting
| attached
| collecting
| distributing
| collect-distributing )
Possible values:
- detached : detached
- waiting : waiting
- attached : attached
- collecting : collecting
- distributing : distributing
- collect-distributing : collecting and distributing
Parameter type: <PrintableString>
- printable string

mux-reason

actor-churn-state

Parameter type: <Lacp::ChurnState>


( no-churn
| churn
| churn-monitor )
Possible values:
- no-churn : no churn
- churn : churn
- churn-monitor : churn monitor
Parameter type: <Counter>
- 32 bit counter

actor-churn-count

actor-sync-transit-cnt

2824

Description

Parameter type: <Lacp::RxState>


( present
| expired
| defaulted
| initialize
| lacpdisabled
| portdisabled )
Possible values:
- present : present
- expired : expired
- defaulted : defaulted
- initialize : initialize
- lacpdisabled : lacp Disabled
- portdisabled : port Disabled
Parameter type: <TimeTicks>
- a timeout value
- unit: msec

Released

Parameter type: <Counter>


- 32 bit counter

specifies the value of a Time


Since SystemReset when the last
LACPDU was received by this
Aggregation Port
This element is only shown in
detail mode.
specifies the mux state machine
for the aggregation port
This element is only shown in
detail mode.

specifies the reason for the most


recent change of mux machine
state.
This element is only shown in
detail mode.
specifies the state of the actor
churn detection machine for the
aggregation port.
This element is only shown in
detail mode.

nbr of times the actor churn state


machine
has
entered
the
ACTOR_CHURN state.
This element is only shown in
detail mode.
nbr of times the actor's mux state
machine
has
entered
the
IN_SYNC state.
This element is only shown in

3HH-04416-EBAA-TCZZA

01

106 LACP status commands

name

Type

actor-lag-id-chg-count

Parameter type: <Counter>


- 32 bit counter

partner-churn-state

Parameter type: <Lacp::ChurnState>


( no-churn
| churn
| churn-monitor )
Possible values:
- no-churn : no churn
- churn : churn
- churn-monitor : churn monitor
Parameter type: <Counter>
- 32 bit counter

partner-churn-count

partn-sync-transit-cnt

Parameter type: <Counter>


- 32 bit counter

partner-lag-id-chg-cnt

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Description
detail mode.
nbr of times the actor's perception
of the lag id for this aggregation
port has changed.
This element is only shown in
detail mode.
specifies the state of the partner
churn detection machine for the
aggregation port.
This element is only shown in
detail mode.

nbr of times the partner churn


state machine has entered the
PARTNER_CHURN state.
This element is only shown in
detail mode.
nbr of times the partner's mux
state machine has entered the
IN_SYNC state.
This element is only shown in
detail mode.
nbr of times the partner's
perception of the lag id for this
aggregation port has changed.
This element is only shown in
detail mode.

Released

2825

106 LACP status commands

106.3 LACP Group Status Command


Command Description
This command displays information about a Link Aggregation Group, The operator identifies the group by means
of the primary port.

User Level
The command can be accessed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> show link-agg group-info [ (group) ]

Command Parameters
Table 106.3-1 "LACP Group Status Command" Resource Parameters
Resource Identifier

Type

(group)

Format:
interface index of
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description
the

link

Command Output
Table 106.3-2 "LACP Group Status Command" Display parameters
Specific Information
name

Type

Description

actor-system-id

Parameter type: <Lacp::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

actor-sys-priority

Parameter type: <Lacp::ActorSysPriority>


- the lacp system priority
- range: [0...65535]
Parameter type: <Lacp::LacpKey>

specifies MAC addr that defines


the value of the system id for the
system
that
contains
this
aggregator.
This element is always shown.
the lacp system priority.
This element is always shown.

actor-oper-key

2826

Released

the current operational value of

3HH-04416-EBAA-TCZZA

01

106 LACP status commands

name

Type

Description

partner-sys-id

- link aggregate key


- range: [0...65535]
Parameter type: <Lacp::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

the key for the aggregator.


This element is always shown.
Specifies MAC address for the
current protocol partner of this
aggregator
This element is always shown.
Specifies
priority
value
associated with the partner's
system id.
This element is always shown.
The current operational value for
the aggregator's current protocol
partner.
This element is always shown.

partner-sys-priority

Parameter type: <Lacp::PartnerSysPriority>


- the lacp system priority
- range: [0...65535]

partner-oper-key

Parameter type: <Lacp::LacpKey>


- link aggregate key
- range: [0...65535]

3HH-04416-EBAA-TCZZA 01

Released

2827

106 LACP status commands

106.4 LACP Member Port Status Command


Command Description
This command displays information about a Link Aggregation Group member port status. The operator identifies
the group by means of the primary port.

User Level
The command can be accessed by operators with lacp privileges.

Command Syntax
The command has the following syntax:
> show link-agg member-port [ (group) [ port <Itf::EthernetPortIndex> ] ]

Command Parameters
Table 106.4-1 "LACP Member Port Status Command" Resource Parameters
Resource Identifier

Type

(group)

Format:
interface index of the
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / aggregation group
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Itf::EthernetPortIndex>
Interface index of the port
Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

port

Description

Command Output
Table 106.4-2 "LACP Member Port Status Command" Display parameters

2828

Released

3HH-04416-EBAA-TCZZA

01

link

106 LACP status commands

Specific Information
name
standby

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Lacp::StandbyStatus>


( active
| standby )
Possible values:
- active : active
- standby : standby

specifies whether aggregation


port is in active or standby.
This element is always shown.

Released

2829

107- MSTP Status Commands

107.1 MSTP Status Command Tree


107.2 MSTP Bridge Status Command
107.3 MSTP Instance Status Command
107.4 MSTP Network Port Status Command
107.5 MSTP Port Instance Status Command

2830

Released

107-2831
107-2832
107-2834
107-2836
107-2839

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

107.1 MSTP Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "MSTP Status Commands".

Command Tree
----show
----xstp
----bridge
----instance
- (instance)
----port
- (port)
----port-instance
- (port)
- instance

3HH-04416-EBAA-TCZZA 01

Released

2831

107 MSTP Status Commands

107.2 MSTP Bridge Status Command


Command Description
This command displays all common spanning tree instances for the whole bridge.

User Level
The command can be accessed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> show xstp bridge

Command Output
Table 107.2-2 "MSTP Bridge Status Command" Display parameters
Specific Information
name
root-id

Description

Parameter type: <Mstp::MstpBridgeId>


- the mstp bridge id
- length: 8

the bridgeId of the CIST root


used in the PDUs originated by
this node.
This element is only shown in
detail mode.
Parameter type: <Mstp::MstpRootCost>
cost of the path to the CIST Root
- root cost
seen from the bridge
This element is only shown in
detail mode.
Parameter type: <Itf::LaGroupZeroIndex>
port which offers the lowest path
( none
cost to the Root bridge
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / This element is only shown in
<Eqpt::PortId> )
detail mode.
Possible values:
- none : no port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <SignedInteger>
interval between no more then
- a signed integer
two PDUs are transmitted
This element is only shown in
detail mode.
Parameter type: <SignedInteger>
max age of STP information

root-cost

root-port

hold-time

max-age

2832

Type

Released

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

name

Type

Description

- a signed integer

learned on a port before it is


discarded
This element is only shown in
detail mode.
time between transmission of
PDUs on a port when it is the
root
This element is only shown in
detail mode.
time how long a port stays in a
state before moving to the
forwarding state
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.
cost of the path to the CIST
regional Root seen from the
bridge
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.
the bridgeId of the CIST regional
root used in the PDUs originated
by this node.
This element is only shown in
detail mode.

hello-time

Parameter type: <SignedInteger>


- a signed integer

fwd-delay

Parameter type: <SignedInteger>


- a signed integer

regional-root-id

Parameter type: <Mstp::MstpBridgeId>


- the mstp bridge id
- length: 8

regional-root-cost

Parameter type: <Mstp::MstpRootCost>


- root cost

bridge-mac-addr

Parameter type: <Sys::MacAddr>


- a mac-address (example : 01:02:03:04:05:06)
- length: 6

root-bridge-chg

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2833

107 MSTP Status Commands

107.3 MSTP Instance Status Command


Command Description
This command displays all parameters of a multiple spanning tree instance.

User Level
The command can be accessed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> show xstp instance [ (instance) ]

Command Parameters
Table 107.3-1 "MSTP Instance Status Command" Resource Parameters
Resource Identifier

Type

Description

(instance)

Format:
- MSTP Instance
- range: [1...64]

mstp instance number

Command Output
Table 107.3-2 "MSTP Instance Status Command" Display parameters
Specific Information
name
root-cost

Description

Parameter type: <Mstp::MstpRootCost>


- root cost

cost of the path to the MSTI


Regional Root seen by the bridge
This element is always shown.
Parameter type: <Itf::LaGroupZeroIndex>
port which offers the lowest path
( none
cost to the MSTI Region Root
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / bridge
<Eqpt::PortId> )
This element is always shown.
Possible values:
- none : no port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Mstp::MstpBridgeId>
the bridgeId of the MSTI regional

root-port

regional-root-id

2834

Type

Released

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

name

root-bridge-chg

3HH-04416-EBAA-TCZZA 01

Type

Description

- the mstp bridge id


- length: 8

root id used in the PDUs


originated by this node.
This element is always shown.
The number of times this Bridge
has detected a Root Bridge
change for this spanning tree
instance.
This element is only shown in
detail mode.

Parameter type: <Counter>


- 32 bit counter

Released

2835

107 MSTP Status Commands

107.4 MSTP Network Port Status Command


Command Description
This command displays all mstp port information.

User Level
The command can be accessed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> show xstp port [ (port) ]

Command Parameters
Table 107.4-1 "MSTP Network Port Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Command Output
Table 107.4-2 "MSTP Network Port Status Command" Display parameters
Specific Information
name
state

2836

Released

Type

Description

Parameter type: <Mstp::MstpPortState>


( disabled
| discarding
| learning
| forwarding )
Possible values:
- disabled : disabled
- discarding : discarding
- learning : learning
- forwarding : forwarding

state of the port


This element is always shown.

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

name

Type

Description

p2p-port

Parameter type: <Mstp::Boolean>


( yes
| no )
Possible values:
- yes : true
- no : false
Parameter type: <Mstp::Boolean>
( yes
| no )
Possible values:
- yes : true
- no : false
Parameter type: <Mstp::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Mstp::DesignatedPort>
- designated port 2 byte octet string
- length: 2
Parameter type: <Mstp::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Mstp::MstpShowPathCost>
- port designated path cost
Parameter type: <Mstp::MstpCistPortRole>
( disabled
| alternate
| backup
| root
| designated )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
Parameter type: <Mstp::MstpCistPortRole>
( disabled
| alternate
| backup
| root
| designated )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
Parameter type: <Mstp::MstpShowPathCost>
- port designated path cost

point-to-point status of the LAN


segment
This element is always shown.

edge-port

designated-root
designated-port
designated-bridge
designated-cost
current-port-role

selected-port-role

regional-path-cost

regional-root

Parameter type: <Mstp::MstpBridgeId>


- the mstp bridge id
- length: 8

bpdu-tx

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

operational value of the edge port


parameter
This element is always shown.

bridge identifier of the MSTI


regional root
This element is always shown.
port identifier of the port on the
designated bridge
This element is always shown.
bridge identifier of designated
bridge
This element is always shown.
path cost of the designated port
This element is always shown.
current port role of the port for
this spanning tree instance
This element is always shown.

selected port role of the port for


this spanning tree instance
This element is always shown.

contribution of this port to the


path cost
This element is only shown in
detail mode.
bridge id of the bridge recorded
as the CIST Regional Root
This element is only shown in
detail mode.
BPDUs transmitted on this port
for this spanning tree instance

Released

2837

107 MSTP Status Commands

name

Type

bpdu-rx

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

bpdu-invalid-rx

prot-migration

2838

Parameter type: <Counter>


- 32 bit counter

Released

Description
This element is only shown in
detail mode.
This element is only shown in
detail mode.
invalid BPDUs received on this
port
This element is only shown in
detail mode.
migration count from one STP
protocol version to another
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

107.5 MSTP Port Instance Status Command


Command Description
This command displays all mstp port instances.

User Level
The command can be accessed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> show xstp port-instance [ (port) [ instance <Mstp::MstpInstance> ] ]

Command Parameters
Table 107.5-1 "MSTP Port Instance Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Mstp::MstpInstance>
mstp instance
Format:
- MSTP Instance
- range: [1...64]

instance

Description

Command Output
Table 107.5-2 "MSTP Port Instance Status Command" Display parameters
Specific Information
name
state

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Mstp::MstpPortState>


( disabled
| discarding
| learning
| forwarding )
Possible values:

state of the port


This element is always shown.

Released

2839

107 MSTP Status Commands

name

Type
- disabled : disabled
- discarding : discarding
- learning : learning
- forwarding : forwarding
Parameter type: <Mstp::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Mstp::MstpBridgeId>
- the mstp bridge id
- length: 8
Parameter type: <Mstp::DesignatedPort>
- designated port 2 byte octet string
- length: 2
Parameter type: <Mstp::MstpShowPathCost>
- port designated path cost
Parameter type: <Mstp::MstpMstiPortRole>
( disabled
| alternate
| backup
| root
| designated
| master )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
- master : master
Parameter type: <Mstp::MstpMstiPortRole>
( disabled
| alternate
| backup
| root
| designated
| master )
Possible values:
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
- master : master
Parameter type: <Counter>
- 32 bit counter

designated-root
designated-bridge
designated-port
designated-cost
current-port-role

selected-port-role

bpdu-tx

bpdu-rx

Parameter type: <Counter>


- 32 bit counter
Parameter type: <Counter>
- 32 bit counter

bpdu-invalid-rx

fwd-transition

2840

Parameter type: <Counter>


- 32 bit counter

Released

Description

bridge identifier of the MSTI


regional root
This element is always shown.
bridge identifier of designated
bridge
This element is always shown.
port identifier of the port on the
designated bridge
This element is always shown.
path cost of the designated port
This element is always shown.
current port role of the port for
this spanning tree instance
This element is always shown.

selected port role of the port for


this spanning tree instance
This element is always shown.

BPDUs transmitted on this port


for this spanning tree instance
This element is only shown in
detail mode.
This element is only shown in
detail mode.
invalid BPDUs received on this
port
This element is only shown in
detail mode.
transition count to the forwarding
state
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

107 MSTP Status Commands

3HH-04416-EBAA-TCZZA 01

Released

2841

108- Distributed Service Status Commands

108.1 Distributed Service Status Command Tree


108.2 Service Access Mapping Status Command
108.3 APIPE-PVC Statistics Command

2842

Released

108-2843
108-2844
108-2846

3HH-04416-EBAA-TCZZA

01

108 Distributed Service Status Commands

108.1 Distributed Service Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Distributed Service Status Commands".

Command Tree
----show
----dist-service
----accessport-svc
- (access-port)
----statistics
----apipe-pvc
- (port-index)

3HH-04416-EBAA-TCZZA 01

Released

2843

108 Distributed Service Status Commands

108.2 Service Access Mapping Status Command


Command Description
This command displays the Service Access Mapping to operator.

User Level
The command can be accessed by operators with drouter privileges.

Command Syntax
The command has the following syntax:
> show dist-service accessport-svc [ (access-port) ]

Command Parameters
Table 108.2-1 "Service Access Mapping Status Command " Resource Parameters
Resource Identifier

Type

(access-port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
Field type <Eqpt::OntSlotId>

2844

Released

Description
access port index
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

108 Distributed Service Status Commands

Resource Identifier

Type

Description

- the ONT SLOT identifier


Field type <Eqpt::OntPortId>
- the ONT PORT identifier

Command Output
Table 108.2-2 "Service Access Mapping Status Command " Display parameters
Specific Information
name
service-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Drouter::ServiceId>


- Service ID
- range: [1...2147483647]

specifies the service id mapped to


access port.
This element is always shown.

Released

2845

108 Distributed Service Status Commands

108.3 APIPE-PVC Statistics Command


Command Description
This command displays the APIPE-PVC statistics.

User Level
The command can be accessed by operators with drouter privileges.

Command Syntax
The command has the following syntax:
> show dist-service statistics apipe-pvc [ (port-index) ]

Command Parameters
Table 108.3-1 "APIPE-PVC Statistics Command" Resource Parameters
Resource Identifier

Type

(port-index)

Format:
the ATM PVC
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
:
<Eqpt::VpiMandatoryId>
:
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

Description

Command Output
Table 108.3-2 "APIPE-PVC Statistics Command" Display parameters
Specific Information
name
apipe-tot-in-cells

2846

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

The total number of valid ATM


cells received by this VCL
including both CLP=0 and
CLP=1 cells.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

108 Distributed Service Status Commands

name

Type

Description

apipe-tot-out-cells

Parameter type: <Counter>


- 32 bit counter

apipe-us-disc

Parameter type: <Counter>


- 32 bit counter

apipe-ds-disc

Parameter type: <Counter>


- 32 bit counter

The total number of valid ATM


cells transmitted by this VCL.
This includes both CLP=0 and
CLP=1 cells.
This element is always shown.
The total number of ATM cells
that are discarded in the upstream
direction.
This element is always shown.
The total number of ATM cells
that are discarded in the
downstream direction.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2847

109- IPv6 Users Status Commands

109.1 IPv6 Users Status Command Tree


109.2 IPv6 Users Status Command

2848

Released

109-2849
109-2850

3HH-04416-EBAA-TCZZA

01

109 IPv6 Users Status Commands

109.1 IPv6 Users Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "IPv6 Users Status Commands".

Command Tree
----show
----ipv6
----users
- (client)
- prefixandlength

3HH-04416-EBAA-TCZZA 01

Released

2849

109 IPv6 Users Status Commands

109.2 IPv6 Users Status Command


Command Description
This command displays the ipv6 users information.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ipv6 users [ (client) [ prefixandlength <ipv6::PrefixAndLength> ] ]

Command Parameters
Table 109.2-1 "IPv6 Users Status Command" Resource Parameters
Resource Identifier

Type

(client)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>

2850

Released

Description
The index value that uniquely
/ identifies the interface on which
: this prefix is configured
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:
/
:

3HH-04416-EBAA-TCZZA

01

109 IPv6 Users Status Commands

Resource Identifier

prefixandlength

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <ipv6::PrefixAndLength>
client ipv6 prefix assigned by
Format:
dhcp server
<ipv6::Prefix> / <ipv6::PrefixLength>
Field type <ipv6::Prefix>
- IPv6-address
Field type <ipv6::PrefixLength>
- length of IPv6 address or prefix
- range: [0...128]

Command Output

3HH-04416-EBAA-TCZZA 01

Released

2851

109 IPv6 Users Status Commands

Table 109.2-2 "IPv6 Users Status Command" Display parameters


Specific Information
name
prefixorigin

validlifetime

forwarderid

2852

Released

Type

Description

Parameter type: <ipv6::PrefixOrigin>


( other
| manual
| wellknown
| dhcp
| routeradv )
Possible values:
- other : indicates a prefix that acquired by other ways
- manual : indicates a prefix that was manually configured
- wellknown : indicates a well-known prefix
- dhcp : indicates a prefix that was assigned by a DHCP
- routeradv : indicates a prefix learned from a router
advertisement
Parameter type: <ipv6::PrefixAdvValidLifetime>
- The remaining length of time, in seconds, that this prefix
will continue to be valid
- unit: sec
- range: [0...4294967295]
Parameter type: <Vlan::StackedVlan>
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093,4094]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4094,4096]

the origin of this prefix


This element is always shown.

the remaining length of time, in


seconds, that this prefix will
continue to be valid
This element is always shown.
the id of the forwarder to which
this session belongs
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110- Security Status Commands

110.1 Security Status Command Tree


110.2 Operator Information Status Command
110.3 Domain Status Command
110.4 User Sessions Status Command
110.5 Connection Profile Status Command
110.6 RADIUS Authentication Server Statistics Command
110.7 RADIUS Authentication Server Status Command
110.8 RADIUS Accounting Server Statistics Command
110.9 RADIUS Accounting Server Status Command
110.10 RADIUS Dynamic Authentication Client Status
Command
110.11 RADIUS Next Available Index Command
110.12 RADIUS Client Status Command
110.13 PAE Authenticator Status Command
110.14 EAPOL Statistics Command
110.15 Diagnostic Information Status Command
110.16 Session Statistics Command
110.17 PAE Port System Status Command
110.18 MAC Address related EAPOL Status Command
110.19 SSH Server Status Command
110.20 PM File Upload Status Command
110.21 PM File Upload Status Command

3HH-04416-EBAA-TCZZA 01

110-2854
110-2856
110-2858
110-2859
110-2865
110-2866
110-2869
110-2870
110-2872
110-2873
110-2875
110-2876
110-2877
110-2880
110-2883
110-2888
110-2891
110-2893
110-2895
110-2896
110-2897

Released

2853

110 Security Status Commands

110.1 Security Status Command Tree


Description
This chapter gives an overview of nodes that are handled by "Security Status Commands".

Command Tree
----show
----security
----operator
- (name)
----aaa
----domain
- (name)
----user-session
- (index)
- user
- domain
----conn-profile
- (name)
----radius
----auth-server
----auth-stats
- (name)
- vrf-index
----state
- (name)
- vrf-index
----acc-server
----acc-stats
- (name)
- vrf-index
----state
- (name)
- vrf-index
----dyn-authclient-stats
- (name)
- vrf-index
----next-free-index
- (name)
----radius-client
----pae
----authenticator
- (port)
----eapol-stats
- (port)
----diagnostics
- (port)
----session-stats
- (port)
----port-details
- (port)
----mac-address

2854

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

- (last-src-mac)
----ssh
----server
----pmfile
----upload
- (upload-index)

3HH-04416-EBAA-TCZZA 01

Released

2855

110 Security Status Commands

110.2 Operator Information Status Command


Command Description
This command displays information about operators managed by the local authentication server. Operators
managed by a remote authentication server (for example Radius) are never shown.

User Level
The command can be accessed by operators with all,admin privileges.
Operators without security read or write permissions can never see the information about other operators.

Command Syntax
The command has the following syntax:
> show security operator [ (name) ]

Command Parameters
Table 110.2-1 "Operator Information Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11

the name of the operator

Command Output
Table 110.2-2 "Operator Information Status Command" Display parameters
Specific Information
name
last-login
last-failed
failed-logins

last-passwd-change

2856

Type

Description

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <Sys::Time>
- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC
Parameter type: <UnsignedInteger>
- an unsigned integer

the time of the last successfull


login
This element is always shown.
the time of the last unsuccessfull
login attempt
This element is always shown.
the number of unsuccessfull login
attempts since the last successfull
login
This element is always shown.
the time the password was
changed for the last time. It does
not matter if the change was
made by this operator itself or by
another operator.

Parameter type: <Sys::Time>


- the time (yyyy-mm-dd:hour:minutes:secs)
- unit: UTC

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2857

110 Security Status Commands

110.3 Domain Status Command


Command Description
This command displays the domain status.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa domain [ (name) ]

Command Parameters
Table 110.3-1 "Domain Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the domain
- length: 1<=x<=64

name of the domain

Command Output
Table 110.3-2 "Domain Status Command" Display parameters
Specific Information
name
active-sessions

2858

Released

Type

Description

Parameter type: <Gauge>


- gauge

the number of active sessions


This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.4 User Sessions Status Command


Command Description
This command displays the details of user sessions.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa user-session [ (index) [ user <Aaa::DisplayString> ] [ domain <Aaa::DisplayString> ] ]

Command Parameters
Table 110.4-1 "User Sessions Status Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- a signed integer
Parameter type: <Aaa::DisplayString>
Format:
- a description
- length: 1<=x<=64
Parameter type: <Aaa::DisplayString>
Format:
- a description
- length: 1<=x<=64

index to the domain user session


table
user name

user

domain

domain name

Command Output
Table 110.4-2 "User Sessions Status Command" Display parameters
Specific Information
name
interface

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::ComplexPortType>


( xdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| xdsl-channel : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-if : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /

the interface on which the session


is established.
This element is only shown in
detail mode.

Released

2859

110 Security Status Commands

name

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :


<Eqpt::VciId>
| l2-vlan : <Eqpt::VlanId>
| ip : <Eqpt::LogicalId>
| sw-loopback
| slip
| atm-bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bonding : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ip-gateway : <Eqpt::VrfId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| ip-line : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
/ <Eqpt::PortId>
| shdsl-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| atm-ima : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| ethernet-line : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId> :
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| ip-line : vlan : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| atm-pvc : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
:

2860

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

<Eqpt::UnstackedVlan>
| pon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| ont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| uni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| voip : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| la-group : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PortId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| epon : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
| eont : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId>
| ellid : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| dist-router-interface : slot-stacked : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::SVlan> :
<Eqpt::CVlan>
| dist-router-interface : slot-vlan : <Eqpt::RackId> /
<Eqpt::ShelfId> / <Eqpt::SlotId> / <Eqpt::UnstackedVlan>
| euni : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::EontSlotId> /
<Eqpt::EontPortId>
| bundle : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::BundleId> )
Possible values:
- xdsl-line : a static xdsl line interface
- xdsl-channel : a static xdsl channel interface
- atm-if : a static atm interface

3HH-04416-EBAA-TCZZA 01

Released

2861

110 Security Status Commands

name

Type

Description

- atm-pvc : an atm pvc interface


- bridge-port : a vlan bridge-port
- l2-vlan : a l2-vlan interface
- ip : an ip interface
- sw-loopback : a software loopback interface
- slip : a slip interface
- atm-bonding : atm bonding
obsolete alternative replaced by bonding
- bonding : bonding
- ip-gateway : ip user gateway interface
- ip-line : ip line interface
- shdsl-line : a static shdsl line interface
- atm-ima : atm ima
- ethernet-line : an ethernet line interface
- vlan-port : vlan port
- pon : pon
- bundle : bundle
- ont : ont
- uni : uni
- voip : voip
- epon : epon
- eont : epon ont
- ellid : epon logical link
- euni : euni
- la-group : link aggregation group
- dist-router-interface : dist router interface
Possible values:
- vlan : vlan port
Possible values:
- slot-vlan : slot unstacked
- slot-stacked : slot vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::BundleId>
- the BUNDLE identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

2862

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

protocol

auth-type

auth-server

acc-server

accounting-id

3HH-04416-EBAA-TCZZA 01

Type

Description

Field type <Eqpt::EontSlotId>


- Epon Ont Slot
Field type <Eqpt::EontPortId>
- Epon Ont Port
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VlanId>
- VLAN id
Field type <Eqpt::LogicalId>
- logical id
Field type <Eqpt::VrfId>
- VRF id
Parameter type: <Aaa::Protocol>
( ppp
| dot1x )
Possible values:
- ppp : ppp used to establish user sess
- dot1x : dot1x used to establish user sess
Parameter type: <Aaa::Authenticator>
( local
| radius : <Aaa::RadPolicyName> )
Possible values:
- local : authenticator type is local
- radius : authenticator type is RADIUS
Field type <Aaa::RadPolicyName>
- name of the radius policy
- length: 1<=x<=64
Parameter type: <Aaa::IgnoredRadAuthServer>
( none
| name : <Aaa::RadAuthServerName> )
Possible values:
- none : no radius server for authentication
- name : use a radius server for authentication
Field type <Aaa::RadAuthServerName>
- name of the RADIUS auth server
- length: 1<=x<=64
Parameter type: <Aaa::RadAccServer>
( none
| name : <Aaa::RadAccServerName> )
Possible values:
- none : no radius server for accounting
- name : use a radius server for accounting
Field type <Aaa::RadAccServerName>
- name of the RADIUS accounting server
- length: 1<=x<=64
Parameter type: <Aaa::DisplayString>
- a description
- length: 1<=x<=64

the protocol at user side that was


used to establish this user session
This element is only shown in
detail mode.
the Authentication type used for
establishing this user session
This element is only shown in
detail mode.

the name of the radius


authentication server used for this
user session
This element is only shown in
detail mode.

the name of the radius accounting


server used for this user session
This element is only shown in
detail mode.

the accounting id that is sent to


the radius accounting server for
this user session. It will be NULL
in case of no accounting.

Released

2863

110 Security Status Commands

name

Type

Description

vrf-index

Parameter type: <Aaa::VrfIndex>


- a vrf index
- range: [0...127]

ip-pool-index

Parameter type: <Aaa::DomainUserSessIpAddrPoolIndex>


- local IP Pool for allocating Ip address to user session
- range: [0...256]

ip-addr

Parameter type: <Aaa::InetAddress>


- IPv4-address

2864

Released

This element is only shown in


detail mode.
the vrf to which the ip-address of
this user session belongs to
This element is only shown in
detail mode.
the ip-pool that was used to
allocate an ip-address to the user
session
This element is only shown in
detail mode.
the IpAddress allocated to the
user session
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.5 Connection Profile Status Command


Command Description
This command displays the status of connection profiles.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa conn-profile [ (name) ]

Command Parameters
Table 110.5-1 "Connection Profile Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

name of connection profile

Command Output
Table 110.5-2 "Connection Profile Status Command" Display parameters
Specific Information
name

Type

Description

number-of-users

Parameter type: <AsamProfileRefCount>


- number of entities using this particular profile
- range: [0...65535]

index

Parameter type: <AsamProfileIndex>


- a profile index
- range: [1...250]

The number of entities using this


profile. The profile can only be
deleted when this number is 0.
This element is always shown.
connection profile index
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

2865

110 Security Status Commands

110.6 RADIUS Authentication Server Statistics


Command
Command Description
This command displays the details of RADIUS authentication server statistics.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius auth-server auth-stats [ (name) [ vrf-index <Aaa::VrfIndex> ] ]

Command Parameters
Table 110.6-1 "RADIUS Authentication Server Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS auth server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of RADIUS authentication


server

vrf-index

vrf to which this auth server


belongs

Command Output
Table 110.6-2 "RADIUS Authentication Server Statistics Command" Display parameters
Specific Information
name
auth-server-id
rndtrp-time
short name: rndtrp

num-access-req

2866

Type

Description

Parameter type: <Aaa::RadAuthServerIndex>


- uniquely identify a radius auth server
- range: [1...256]
Parameter type: <TimeTicks>
- a timeout value
- unit: msec

authentication server id
This element is always shown.

Parameter type: <Counter>

Released

The time interval between the


most
recent
Access-Reply/Access-Challenge
and the Access-Request that
matched it from this RADIUS
authentication server.
This element is always shown.
The number of RADIUS

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

short name: num-acs-rq

- 32 bit counter

num-access-retrn
short name: num-acs-ret

Parameter type: <Counter>


- 32 bit counter

num-access-acpts
short name: num-acs-acp

Parameter type: <Counter>


- 32 bit counter

num-access-rej
short name: num-acs-rj

Parameter type: <Counter>


- 32 bit counter

num-access-challenges
short name: num-acs-chlg

Parameter type: <Counter>


- 32 bit counter

num-malf-access-resp
short name: num-acs-res

Parameter type: <Counter>


- 32 bit counter

Access-Request packets sent to


this server. This does not include
retransmissions.
This element is always shown.
The number of RADIUS
Access-Request
packets
retransmitted to this RADIUS
authentication server.
This element is always shown.
The number of RADIUS
Access-Accept packets (valid or
invalid) received from this server.
This element is always shown.
The number of RADIUS
Access-Reject packets (valid or
invalid) received from this server.
This element is always shown.
The number of RADIUS
Access-Challenge packets (valid
or invalid) received from this
server.
This element is only shown in
detail mode.
The number of malformed
RADIUS
Access-Response
packets received from this server.
Malformed
packets
include
packets with an invalid length,
Bad authenticators or Signature
attributes or unknown types are
not included as malformed access
responses.
This element is only shown in
detail mode.
The number of RADIUS
Access-Response
packets
containing invalid authenticators
or signature received from this
server.
This element is only shown in
detail mode.
The number of RADIUS
Access-Request packets destined
for this server that have not yet
timed out or received a response.
This element is only shown in
detail mode.
The number of authentication
timeouts to this server.
This element is only shown in
detail mode.
The number of RADIUS packets
of unknown type which were
received from this server on the
authentication port.
This element is only shown in
detail mode.

num-bad-authenticators
Parameter type: <Counter>
short name: num-bad-auth - 32 bit counter

num-pending-req
short name: num-pd-rq

Parameter type: <Gauge>


- gauge

num-timeouts
short name: num-tout

Parameter type: <Counter>


- 32 bit counter

num-unknown
short name: num-ukwn

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2867

110 Security Status Commands

name

Type

Description

num-packets-dropped
short name: num-pkt-dpd

Parameter type: <Counter>


- 32 bit counter

The number of RADIUS packets


of which were received from this
server on the authentication port
and dropped.
This element is only shown in
detail mode.

2868

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.7 RADIUS Authentication Server Status


Command
Command Description
This command displays the state of the RADIUS authentication server.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius auth-server state [ (name) [ vrf-index <Aaa::VrfIndex> ] ]

Command Parameters
Table 110.7-1 "RADIUS Authentication Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS auth server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of RADIUS authentication


server

vrf-index

vrf to which this auth server


belongs

Command Output
Table 110.7-2 "RADIUS Authentication Server Status Command" Display parameters
Specific Information
name
auth-state

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Aaa::OperState>


( up
| down
| unknown )
Possible values:
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown

The operational state of the


authentication server.
This element is always shown.

Released

2869

110 Security Status Commands

110.8 RADIUS Accounting Server Statistics


Command
Command Description
This command displays the RADIUS accounting server statistics.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius acc-server acc-stats [ (name) [ vrf-index <Aaa::VrfIndex> ] ]

Command Parameters
Table 110.8-1 "RADIUS Accounting Server Statistics Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS accounting server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of the RADIUS accounting


server

vrf-index

vrf to which the RADIUS Acc


Server belongs

Command Output
Table 110.8-2 "RADIUS Accounting Server Statistics Command" Display parameters
Specific Information
name

Type

Description

rndtrip-time
short name: rndtp

Parameter type: <TimeTicks>


- a timeout value
- unit: msec

num-acc-req
short name: num-acrq

Parameter type: <Counter>


- 32 bit counter

The time interval between the


most recent accounting-response
and the accounting-request that
matched it from this RADIUS
accounting server.
This element is always shown.
The number of RADIUS
accounting-request packets sent.
This
does
not
include
retransmissions.
This element is always shown.

2870

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

num-req-retrans
short name: num-rq-rtn

Parameter type: <Counter>


- 32 bit counter

num-resp
short name: num-rec

Parameter type: <Counter>


- 32 bit counter

num-malf-resp
short name: num-rsp

Parameter type: <Counter>


- 32 bit counter

The number of RADIUS


accounting-request
packets
retransmitted to this RADIUS
accounting
server.
Retransmissions include retries
where
the
identifier
and
acct-delay have been updated, as
well as those in which they
remain the same.
This element is always shown.
The number of RADIUS packets
received on the accounting port
from this server.
This element is always shown.
The number of malformed
RADIUS
accounting-response
packets received from this server.
Malformed
packets
include
packets with an invalid length.
Bad authenticators and unknown
types are not included as
malformed accounting responses.
This element is only shown in
detail mode.
The number of RADIUS
accounting-response
packets
which
contained
invalid
authenticators received from this
server.
This element is only shown in
detail mode.
The number of RADIUS
accounting-request packets sent
to this server that have not yet
timed out or received a response.
This element is always shown.
The number of accounting
timeouts to this server.
This element is only shown in
detail mode.
The number of RADIUS packets
of unknown type which were
received from this server on the
accounting port.
This element is only shown in
detail mode.
The number of RADIUS packets
which were received from this
server on the accounting port and
dropped.
This element is only shown in
detail mode.

num-bad-authenticators
Parameter type: <Counter>
short name: num-bad-auth - 32 bit counter

num-pending-reqts
short name: num-pd-rqt

Parameter type: <Gauge>


- gauge

num-timeouts
short name: num-tout

Parameter type: <Counter>


- 32 bit counter

num-unknown
short name: num-ukwn

Parameter type: <Counter>


- 32 bit counter

num-packets-dropped
short name: num-pkt-dpd

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Released

2871

110 Security Status Commands

110.9 RADIUS Accounting Server Status Command


Command Description
This command displays the state of the RADIUS accounting server.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius acc-server state [ (name) [ vrf-index <Aaa::VrfIndex> ] ]

Command Parameters
Table 110.9-1 "RADIUS Accounting Server Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the RADIUS accounting server
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of the RADIUS accounting


server

vrf-index

vrf to which the RADIUS Acc


Server belongs

Command Output
Table 110.9-2 "RADIUS Accounting Server Status Command" Display parameters
Specific Information
name
acc-state

2872

Released

Type

Description

Parameter type: <Aaa::OperState>


( up
| down
| unknown )
Possible values:
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown

Specifies the operational state of


the accounting server.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.10 RADIUS Dynamic Authentication Client


Status Command
Command Description
This command displays the statistics of the RADIUS Dynamic Authentication Client.
The conceptual table lists the statistics of the RADIUS Dynamic Authorization Clients with which the server shares
a secret.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius dyn-authclient-stats [ (name) [ vrf-index <Aaa::VrfIndex> ] ]

Command Parameters
Table 110.10-1 "RADIUS Dynamic Authentication Client Status Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of dynamic auth client name
- length: 1<=x<=64
Parameter type: <Aaa::VrfIndex>
Format:
- a vrf index
- range: [0...127]

name of the RADIUS Dynamic


Authorization client

vrf-index

vrf to which the RADIUS Dyn


Auth Client belongs

Command Output
Table 110.10-2 "RADIUS Dynamic Authentication Client Status Command" Display parameters
Specific Information
name

Type

Description

num-disconnect-reqs

Parameter type: <Counter>


- 32 bit counter

num-disconnect-acks

Parameter type: <Counter>


- 32 bit counter

The number of RADIUS


Disconnect-Request
packets
recieved from this Dynamic
Authorization Client.
This element is always shown.
The number of RADIUS
Disconnect-ACK packets sent to
this Dynamic Authorization
Client.

3HH-04416-EBAA-TCZZA 01

Released

2873

110 Security Status Commands

name

Type

num-access-naks

Parameter type: <Counter>


- 32 bit counter

num-malf-disconn-req

Parameter type: <Counter>


- 32 bit counter

num-bad-auth-in-req

Parameter type: <Counter>


- 32 bit counter

num-disconn-pkts-drop

Parameter type: <Counter>


- 32 bit counter

num-pkts-unknown-type

Parameter type: <Counter>


- 32 bit counter

2874

Released

Description
This element is always shown.
The number of RADIUS
Disconnect-NAK packets sent to
this Dynamic Authorization
Client.
This element is always shown.
The number of malformed
RADIUS
Disconnect-Request
packets received from this
Dynamic Authorization client.
Bad authenticators and unknown
types are not included as
malformed Disconnect-Requests.
Malformed
packets
include
packets with an invalid length.
This element is only shown in
detail mode.
The number of RADIUS
Disconnect-Request
packets
which
contained
invalid
Signature attributes received
from this Dynamic Authorization
Client.
This element is only shown in
detail mode.
The number of incoming
Disconnect-Requests from this
Dynamic Authorization Client
silently discarded for some
reason other than malformed, bad
authenticators or unknown types.
This element is only shown in
detail mode.
The number of incoming packets
of unknown types which were
received on the Dynamic
Authorization port.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.11 RADIUS Next Available Index Command


Command Description
This command displays the next available index.
The index is used to uniquely identify an entry in this table. The next-free-index shows the unique number in a
RADIUS policy that can be used to create a new entry in the RADIUS server. The value 0 indicates that no
unassigned entry is available. To obtain the RADIUS server index value for a new entry, the manager issues a
management protocol retrieval operation to obtain the current value of this object. After each retrieval, the agent
modifies the value to the next unassigned index.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius next-free-index [ (name) ]

Command Parameters
Table 110.11-1 "RADIUS Next Available Index Command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- name of the radius policy
- length: 1<=x<=64

name of the RADIUS policy

Command Output
Table 110.11-2 "RADIUS Next Available Index Command" Display parameters
Specific Information
name
next-free-index

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Aaa::RadServerSetNextFreeIndex>


- unique nbr in radius policy for creating radServerSet.
- range: [0...2]

A unique number within a radius


policy that can be used for
creating a new radus server set.
This element is always shown.

Released

2875

110 Security Status Commands

110.12 RADIUS Client Status Command


Command Description
This command displays the RADIUS client parameters.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius radius-client

Command Output
Table 110.12-2 "RADIUS Client Status Command" Display parameters
Specific Information
name
auth-invl-server-addr

acc-invl-server-addr

dynauth-ser-inv-addr

acc-ser-get-nxt-idx

dyn-auth-get-nxt-idx

2876

Released

Type

Description

Parameter type: <Counter>


- 32 bit counter

The number of RADIUS


Access-Response
packets
received
from
unknown
addresses.
This element is always shown.
Parameter type: <Counter>
The number of RADIUS
- 32 bit counter
Accounting-Response
packets
received
from
unknown
addresses.
This element is always shown.
Parameter type: <Counter>
The number of RADIUS
- 32 bit counter
Disconnect-Request
packets
received
from
unknown
addresses.
This element is always shown.
Parameter type: <Aaa::RadAccServerGetNextFreeIndex>
The next free index value that can
- next free index for creating a radius accounting server
be used for creating a new entry
- range: [0...256]
in the radius accounting server.
This element is always shown.
Parameter
type: The next free index value that can
<Aaa::RadDynAuthClentGetNextFreeIndex>
be used for creating a new entry
- next free index for creating a radius dyn auth client
in the radius dyn auth client.
- range: [0...256]
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.13 PAE Authenticator Status Command


Command Description
This command displays the details of authentication configuration.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae authenticator [ (port) ]

Command Parameters
Table 110.13-1 "PAE Authenticator Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:

3HH-04416-EBAA-TCZZA 01

Description
the identification of the bridge
/ port
/
/
/
/
/

Released

2877

110 Security Status Commands

Resource Identifier

Type

Description

- voip : virtual uni identifier


obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 110.13-2 "PAE Authenticator Status Command" Display parameters
Specific Information
name
auth-pae-state

auth-backend-state

admin-contr-direct

2878

Released

Type

Description

Parameter type: <Aaa::AuthPaeState>


( initialize
| disconnected
| connecting
| authenticating
| authenticated
| aborting
| held
| force-auth
| force-unauth )
Possible values:
- initialize :
- disconnected :
- connecting :
- authenticating :
- authenticated :
- aborting :
- held :
- force-auth :
- force-unauth :
Parameter type: <Aaa::AuthBackendState>
( request
| response
| success
| fail
| timeout
| idle
| initialize )
Possible values:
- request :
- response :
- success :
- fail :
- timeout :
- idle :
- initialize :
Parameter type: <Aaa::PaeControlledDirections>
both
Possible values:
- both :

the current state of the


authenticator PAE state machine
This element is always shown.

the current state of the backend


authentication state machine
This element is always shown.

describes which directions for the


port are configured to be
controlled
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

oper-contr-direct

Parameter type: <Aaa::PaeControlledDirections>


both
Possible values:
- both :
Parameter type: <Aaa::PaeControlledPortStatus>
( authorized
| unauthorized )
Possible values:
- authorized :
- unauthorized :
Parameter type: <SignedInteger>
- a signed integer

describes which directions for the


port are currently be controlled
This element is only shown in
detail mode.
the current port status
This element is always shown.

port-status

re-auth-period

re-auth-enabled

key-tx-enabled

3HH-04416-EBAA-TCZZA 01

Parameter type: <Aaa::TruthValue>


( true
| false )
Possible values:
- true :
- false :
Parameter type: <Aaa::TruthValue>
( true
| false )
Possible values:
- true :
- false :

the
actual
re-authentication
period
This element is only shown in
detail mode.
true if re-authentication is
enabled
This element is only shown in
detail mode.
true if key transmission is
enabled
This element is only shown in
detail mode.

Released

2879

110 Security Status Commands

110.14 EAPOL Statistics Command


Command Description
This command displays EAPOL statistics.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae eapol-stats [ (port) ]

Command Parameters
Table 110.14-1 "EAPOL Statistics Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:

2880

Released

Description
identification of the port or
/ virtual channel
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

Resource Identifier

Type

Description

- voip : virtual uni identifier


obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 110.14-2 "EAPOL Statistics Command" Display parameters
Specific Information
name

Type

Description

rx-frames

Parameter type: <Counter>


- 32 bit counter

tx-frames

Parameter type: <Counter>


- 32 bit counter

starts

Parameter type: <Counter>


- 32 bit counter

logoffs

Parameter type: <Counter>


- 32 bit counter

rx-response-ids

Parameter type: <Counter>


- 32 bit counter

rx-responses

Parameter type: <Counter>


- 32 bit counter

tx-request-ids

Parameter type: <Counter>


- 32 bit counter

tx-requests

Parameter type: <Counter>


- 32 bit counter

invalid-frames

Parameter type: <Counter>


- 32 bit counter

the number of valid EAPOL


frames of any type that have been
received by this Authenticator
This element is always shown.
the number of EAPOL frames of
any type that have been
transmitted by this Authenticator
This element is always shown.
the number of EAPOL Start
frames that have been received
by this Authenticator
This element is always shown.
the number of EAPOL Logoff
frames that have been received
by this Authenticator
This element is always shown.
the number of EAP Resp/Id
frames that have been received
by this Authenticator
This element is only shown in
detail mode.
number of valid EAP Response
frames (other than Resp/Id
frames) that have been received
by this Authenticator
This element is only shown in
detail mode.
the number of EAP Req/Id
frames that have been transmitted
by this Authenticator
This element is only shown in
detail mode.
the number of EAP Request
frames (other than Rq/Id frames)
that have been transmitted by this
Authenticator
This element is only shown in
detail mode.
the number of EAPOL frames
that have been received by this
Authenticator in which the frame

3HH-04416-EBAA-TCZZA 01

Released

2881

110 Security Status Commands

name

Type

inv-length-frames

Parameter type: <Counter>


- 32 bit counter

last-eap-version

Parameter type: <SignedInteger>


- a signed integer

last-src-mac

Parameter type: <Vlan::MacAddr>


- mac address (aa:bb:cc:a1:02:03)
- length: 6

2882

Released

Description
type is not recognized
This element is always shown.
the number of EAPOL frames
that have been received by this
Authenticator in which the Packet
Body Length field is invalid
This element is only shown in
detail mode.
the protocol version number
carried in the most recently
received EAPOL frame
This element is only shown in
detail mode.
the source MAC address carried
in the most recently received
EAPOL frame
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.15 Diagnostic Information Status Command


Command Description
This command displays diagnostic information.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae diagnostics [ (port) ]

Command Parameters
Table 110.15-1 "Diagnostic Information Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>

3HH-04416-EBAA-TCZZA 01

Description
the identification of the bridge
/ port
/
/
/
/
/
/

Released

2883

110 Security Status Commands

Resource Identifier

Type

Description

- the ONT identifier


Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 110.15-2 "Diagnostic Information Status Command" Display parameters
Specific Information
name

Type

Description

to-connecting-cnt

Parameter type: <Counter>


- 32 bit counter

log-off-cnt

Parameter type: <Counter>


- 32 bit counter

authenticating-cnt

Parameter type: <Counter>


- 32 bit counter

authenticated-cnt

Parameter type: <Counter>


- 32 bit counter

timeout-cnt

Parameter type: <Counter>


- 32 bit counter

the number of times that the state


machine transitions to the
CONNECTING state from any
other state
This element is always shown.
the number of times that the state
machine
transitions
from
CONNECTING
to
DISCONNECTED as a result of
receiving an EAPOL-Logoff
message
This element is always shown.
the number of times that the state
machine
transitions
from
CONNECTING
to
AUTHENTICATING, as a result
of an EAP-Response/Identity
message being received from the
Supplicant
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATING
to
AUTHENTICATED, as a result
of the Backend Authentication
state
machine
indicating
successful authentication of the
Supplicant
(authSuccess
=
TRUE)
This element is always shown.
the number of times that the state
machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of the
Backend Authentication state
machine indicating authentication
timeout (authTimeout = TRUE)
This element is always shown.

2884

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

failed-cnt

Parameter type: <Counter>


- 32 bit counter

re-authenticating-cnt

Parameter type: <Counter>


- 32 bit counter

eap-start-cnt

Parameter type: <Counter>


- 32 bit counter

eap-logoff-cnt

Parameter type: <Counter>


- 32 bit counter

re-authenticated-cnt

Parameter type: <Counter>


- 32 bit counter

eap-connecting-cnt

Parameter type: <Counter>


- 32 bit counter

eap-logoff-cnt

Parameter type: <Counter>


- 32 bit counter

the number of times that the state


machine
transitions
from
AUTHENTICATING to HELD,
as a result of the Backend
Authentication state machine
indicating authentication failure
(authFail = TRUE)
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of a
reauthentication
request
(reAuthenticate = TRUE)
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of an
EAPOL-Start message being
received from the Supplicant
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of an
EAPOL-Logoff message being
received from the Supplicant
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATED
to
CONNECTING, as a result of a
reauthentication
request
(reAuthenticate = TRUE)
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATED
to
CONNECTING, as a result of an
EAPOL-Start message being
received from the Supplicant
This element is only shown in
detail mode.
the number of times that the state
machine
transitions
from
AUTHENTICATED
to
DISCONNECTED, as a result of
an EAPOL-Logoff message
being
received
from
the
Supplicant
This element is only shown in

3HH-04416-EBAA-TCZZA 01

Released

2885

110 Security Status Commands

name

Type

access-resp-cnt

Parameter type: <Counter>


- 32 bit counter

access-challenge-cnt

Parameter type: <Counter>


- 32 bit counter

eap-req-cnt

Parameter type: <Counter>


- 32 bit counter

resp-non-eap-nak-cnt

Parameter type: <Counter>


- 32 bit counter

eap-success-cnt

Parameter type: <Counter>


- 32 bit counter

2886

Released

Description
detail mode.
the number of times that the state
machine
sends
an
initial
Access-Request packet to the
Authentication server
This element is only shown in
detail mode.
the number of times that the state
machine receives an initial
Access-Challenge packet from
the Authentication server (i.e.,
aReq becomes TRUE, causing
exit from the RESPONSE state).
This
indicates
that
the
Authentication
Server
has
communication
with
the
Authenticator
This element is only shown in
detail mode.
the number of times that the state
machine sends an EAP-Request
packet (other than an Identity,
Notification, Failure or Success
message) to the Supplicant (i.e.,
executes txReq on entry to the
REQUEST state). This indicates
that the Authenticator chose an
EAP-method.
This element is only shown in
detail mode.
the number of times that the state
machine receives a response from
the Supplicant to an initial
EAP-Request, and the response is
something other than EAP-NAK
(i.e., rxResp becomes TRUE,
causing the state machine to
transition from REQUEST to
RESPONSE, and the response is
not an EAP-NAK). This indicates
that the Supplicant can respond to
the
Authenticator's
chosen
EAP-method
This element is only shown in
detail mode.
the number of times that the state
machine
receives
an
EAP-Success message from the
Authentication
Server
(i.e.,
aSuccess
becomes
TRUE,
causing a transition from
RESPONSE to SUCCESS). This
indicates that the Supplicant has
successfully authenticated to the
Authentication Server
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

name

Type

Description

num-eap-failure

Parameter type: <Counter>


- 32 bit counter

the number of times that the state


machine receives an EAP-Failure
message from the Authentication
Server (i.e., aFail becomes
TRUE, causing a transition from
RESPONSE to FAIL). This
indicates that the Supplicant has
not
authenticated
to
the
Authentication Server.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA 01

Released

2887

110 Security Status Commands

110.16 Session Statistics Command


Command Description
This command displays statistics for the sessions.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae session-stats [ (port) ]

Command Parameters
Table 110.16-1 "Session Statistics Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip : <Eqpt::LLId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni : <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:

2888

Released

Description
the identification of the bridge
/ port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

Resource Identifier

Type

Description

- voip : virtual uni identifier


obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 110.16-2 "Session Statistics Command" Display parameters
Specific Information
name

Type

Description

rx-octets

Parameter type: <Counter>


- 32 bit counter

tx-octets

Parameter type: <Counter>


- 32 bit counter

rx-user-frames

Parameter type: <Counter>


- 32 bit counter

tx-user-frames

Parameter type: <Counter>


- 32 bit counter

ses-id

Parameter type: <Vlan::AdminString>


- char string
- length: x<=80
Parameter type: <Aaa::AuthenticMethod>
( remote-auth-server
| local-auth-server )
Possible values:
- remote-auth-server :
- local-auth-server :
Parameter type: <TimeTicks>
- a timeout value
- unit: msec
Parameter type: <Aaa::TerminateCause>
( supplicant-logoff
| port-failure
| supplicant-restart
| reauth-failed
| auth-cntr-forceunauth
| port-reinit
| port-admin-disabled
| not-terminated-yet )
Possible values:
- supplicant-logoff :
- port-failure :
- supplicant-restart :

the number of octets transmitted


in user data frames on this port
during the session
This element is always shown.
the number of octets transmitted
in user data frames on this port
during the session
This element is always shown.
the number of user data frames
received on this port during the
session
This element is always shown.
the number of user data frames
transmitted on this port during
the session
This element is always shown.
a unique identifier for the session
This element is only shown in
detail mode.
the authentication method used to
establish the session
This element is only shown in
detail mode.

auth-method

ses-time
term-cause

3HH-04416-EBAA-TCZZA 01

the duration of the session


This element is always shown.
reason for the session termination
This element is only shown in
detail mode.

Released

2889

110 Security Status Commands

name

Type
- reauth-failed :
- auth-cntr-forceunauth :
- port-reinit :
- port-admin-disabled :
- not-terminated-yet :
Parameter type: <Vlan::AdminString>
- char string
- length: x<=80

user-name

2890

Released

Description

the name representing the identity


of the Supplicant PAE
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.17 PAE Port System Status Command


Command Description
This command displays the PAE system parameters for a port or virtual channel

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae port-details [ (port) ]

Command Parameters
Table 110.17-1 "PAE Port System Status Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

Released

2891

110 Security Status Commands

Resource Identifier

Type

Description

- the ONT identifier


Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Command Output
Table 110.17-2 "PAE Port System Status Command" Display parameters
Specific Information
name

Type

Description

prot-ver

Parameter type: <SignedInteger>


- a signed integer

capabilities

Parameter type: <Aaa::Capabilities>


( auth-capable
| supp-capable )
Possible values:
- auth-capable :
- supp-capable :
Parameter type: <Aaa::TruthValue>
( true
| false )
Possible values:
- true :
- false :

The protocol version associated


with this Port.
This element is always shown.
Indicates the PAE functionality
that this Port supports
This element is always shown.

reauth

2892

Released

Specifies currently in use by the


Authenticator PAE state machine.
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.18 MAC Address related EAPOL Status


Command
Command Description
This command displays the EAPOL data for each MAC address.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae mac-address [ (last-src-mac) ]

Command Parameters
Table 110.18-1 "MAC Address related EAPOL Status Command" Resource Parameters
Resource Identifier

Type

Description

(last-src-mac)

Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

the source MAC address carried


in the most recently received
EAPOL frame

Command Output
Table 110.18-2 "MAC Address related EAPOL Status Command" Display parameters
Specific Information
name
port

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <Itf::BridgePort>


( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>

the port identification


/ This element is always shown.
/
/
/
/
/
/

Released

2893

110 Security Status Commands

name

Type

user-name

port-status

2894

Description

- the rack number


Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Parameter type: <Vlan::AdminString>
- char string
- length: x<=80
Parameter type: <Aaa::PaeControlledPortStatus>
( authorized
| unauthorized )
Possible values:
- authorized :
- unauthorized :

Released

the name representing the identity


of the Supplicant PAE
This element is only shown in
detail mode.
the current port status
This element is always shown.

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.19 SSH Server Status Command


Command Description
This command displays the SSH Server related parameters

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show security ssh server

Command Output
Table 110.19-2 "SSH Server Status Command" Display parameters
Specific Information
name
public-key
fingerprint-hex
fingerprint-bubble-bab

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <PrintableString>


- printable string
Parameter type: <PrintableString>
- printable string

public key of the server


This element is always shown.
server public key fingerprint in
hex format
This element is always shown.
server public key fingerprint in
bubble-babble format
This element is always shown.

Parameter type: <PrintableString>


- printable string

Released

2895

110 Security Status Commands

110.20 PM File Upload Status Command


Command Description
This command displays PM file upload status

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show security pmfile

2896

Released

3HH-04416-EBAA-TCZZA

01

110 Security Status Commands

110.21 PM File Upload Status Command


Command Description
This command displays PM file upload status

User Level
The command can be accessed by operators with security privileges.

Command Syntax
The command has the following syntax:
> show security pmfile upload [ (upload-index) ]

Command Parameters
Table 110.21-1 "PM File Upload Status Command" Resource Parameters
Resource Identifier

Type

(upload-index)

Format:
the unique internal identifier of
- the unique internal identifier of PM file upload entry PM file upload entry
(1-VOICE, 2-DSL)
- range: [1...2]

Description

Command Output
Table 110.21-2 "PM File Upload Status Command" Display parameters
Specific Information
name
upload-progress

upload-error

3HH-04416-EBAA-TCZZA 01

Type

Description

Parameter type: <SwMngt::pmFileUploadProgress>


( idle
| ongoing
| finish-success
| finish-fail )
Possible values:
- idle : No PM File upload triggered
- ongoing : PM file upload is ongoing
- finish-success : PM file upload finished successfully
- finish-fail : PM file upload finished but failed
Parameter type: <SwMngt::pmFileUploadError>
( no-error
| file-not-exist
| server-unavailable
| name-pswd-wrong
| access-violation
| application-error

the progress of PM file upload


process
This element is always shown.

the root cause in case of a failing


PM file upload
This element is always shown.

Released

2897

110 Security Status Commands

name

Type

Description

| undefined )
Possible values:
- no-error : PM file transfer has no error
- file-not-exist : PM file does not exist
- server-unavailable : upload server is not available
- name-pswd-wrong : username or password is not correct
- access-violation : access violation
- application-error : internal application error
- undefined : the error is not defined

2898

Released

3HH-04416-EBAA-TCZZA

01

111- Alarm Management Commands

111.1 Alarm Management Command Tree


111.2 Alarm Management Command
111.3 Snapshot Management Command
111.4 SHub Snapshot Management Command
111.5 Shub Ospf Clear management Command
111.6 Alarm Delta Log Management Command
111.7 Log Management Command
111.8 Alarm Filetransfer Manual Clearance Management
Command

3HH-04416-EBAA-TCZZA 01

111-2900
111-2901
111-2902
111-2904
111-2905
111-2906
111-2907
111-2908

Released

2899

111 Alarm Management Commands

111.1 Alarm Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Alarm Management Commands".

Command Tree
----admin
----alarm
- (clr-logging)
- (clr-persist-loss)
- (clr-xhub-config-loss)
- (clr-xvps-conf-loss)
- (clr-inv-xvps-pair)
----snap-shot
- (start)
----shub
----snap-shot
- (start)
----clear-alarm
- (alarm-id)
- vrf
- interface
----delta-log
- (clr-indeterminate)
- (clr-warning)
- (clr-minor)
- (clr-major)
- (clr-critical)
----log
- (clr-error-log)
- (clr-set-log-table)
----clear-alarm
----filetransfer
- ip-address

2900

Released

3HH-04416-EBAA-TCZZA

01

111 Alarm Management Commands

111.2 Alarm Management Command


Command Description
This command allows the operator to manage alarms.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm [ (clr-logging) ] [ (clr-persist-loss) ] [ (clr-xhub-config-loss) ] [ (clr-xvps-conf-loss) ] [
(clr-inv-xvps-pair) ]

Command Parameters
Table 111.2-2 "Alarm Management Command" Command Parameters
Parameter

Type

Description

(clr-logging)

Format:
clr-logging
Possible values:
- clr-logging : clear log table - logging will start from index
1
Format:
clr-persist-loss
Possible values:
- clr-persist-loss : clear the loss of persistent data alarm
Format:
clr-xhub-config-loss
Possible values:
- clr-xhub-config-loss : clear the xhub configuration loss
alarm
Format:
clr-xvps-conf-loss
Possible values:
- clr-xvps-conf-loss : clear the xvps configuration loss alarm
Format:
clr-inv-xvps-pair
Possible values:
- clr-inv-xvps-pair : clear the invalid xvps pair redundancy
data alarm

optional parameter
clear log table - logging will start
from index 1

(clr-persist-loss)

(clr-xhub-config-loss)

(clr-xvps-conf-loss)

(clr-inv-xvps-pair)

3HH-04416-EBAA-TCZZA 01

optional parameter
clear the loss of persistent data
alarm
optional parameter
clear the xhub configuration loss
alarm
optional parameter
clear the xvps configuration loss
alarm
optional parameter
clear the invalid xvps
redundancy data alarm

Released

2901

pair

111 Alarm Management Commands

111.3 Snapshot Management Command


Command Description
This command allows the operator to create a snapshot for a particular severity level.
The owner-id can be read by other users to see who has created the snapshot.
This command will fail if the snapshot is already in use. The snapshot is only kept for a limited time and is
automatically cleared.
The snapshot is displayed with the show alarm snapshot command.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm snap-shot [ (start) ]

Command Parameters
Table 111.3-2 "Snapshot Management Command" Command Parameters
Parameter

Type

(start)

Format:
optional parameter
( start : indeterminate : <Alarm::alarmSnapShotOwner>
start or stop the snap shot
| start : warning : <Alarm::alarmSnapShotOwner>
| start : minor : <Alarm::alarmSnapShotOwner>
| start : major : <Alarm::alarmSnapShotOwner>
| start : critical : <Alarm::alarmSnapShotOwner>
| start : <SignedInteger> : <Alarm::alarmSnapShotOwner>
| stop )
Possible values:
- start : start reading the snap shot table
- stop : stop reading the snap shot table
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Field type <SignedInteger>
- a signed integer
Field type <Alarm::alarmSnapShotOwner>
- string to identify the owner (example: Tom),the string
should has less than or equal to 128 characters

2902

Released

Description

3HH-04416-EBAA-TCZZA

01

111 Alarm Management Commands

3HH-04416-EBAA-TCZZA 01

Released

2903

111 Alarm Management Commands

111.4 SHub Snapshot Management Command


Command Description
This command creates a snapshot for a particular severity level.
The command will fail if the snapshot is already in use. The snapshot is only kept for a limited time and is
automatically cleared.
The snapshot is displayed with the show alarm shub snapshot command.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm shub snap-shot [ (start) ]

Command Parameters
Table 111.4-2 "SHub Snapshot Management Command" Command Parameters
Parameter

Type

(start)

Format:
optional parameter
( start : indeterminate : <Alarm::alarmSnapShotOwner>
start or stop the snap shot
| start : warning : <Alarm::alarmSnapShotOwner>
| start : minor : <Alarm::alarmSnapShotOwner>
| start : major : <Alarm::alarmSnapShotOwner>
| start : critical : <Alarm::alarmSnapShotOwner>
| start : <SignedInteger> : <Alarm::alarmSnapShotOwner>
| stop )
Possible values:
- start : start reading the snap shot table
- stop : stop reading the snap shot table
Possible values:
- indeterminate : not a definite known severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
Field type <SignedInteger>
- a signed integer
Field type <Alarm::alarmSnapShotOwner>
- string to identify the owner (example: Tom),the string
should has less than or equal to 128 characters

2904

Released

Description

3HH-04416-EBAA-TCZZA

01

111 Alarm Management Commands

111.5 Shub Ospf Clear management Command


Command Description
This command allows the operator to clear the Ospf neighbour state changed alarms.
Note: User has to give the mandatory parameters to clear a required alarm.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm shub clear-alarm (alarm-id) vrf <Alarm::ClearAlarmIndex1> interface <Alarm::ClearAlarmIndex2>

Command Parameters
Table 111.5-2 "Shub Ospf Clear management Command" Command Parameters
Parameter

Type

Description

(alarm-id)

Format:
ospf-nhbr-statchg
Possible values:
- ospf-nhbr-statchg : OSPF neighbor state change
Parameter type: <Alarm::ClearAlarmIndex1>
Format:
- index value
- range: [1...2147483647]
Parameter type: <Alarm::ClearAlarmIndex2>
Format:
- index value
- range: [1...2147483647]

optional parameter
unique id for an alarm

vrf

interface

3HH-04416-EBAA-TCZZA 01

optional parameter
identify where the alarm index1
occurred
optional parameter
identify where the alarm index2
occurred

Released

2905

111 Alarm Management Commands

111.6 Alarm Delta Log Management Command


Command Description
This command allows the operator to manage the alarm delta logs.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm delta-log [ (clr-indeterminate) ] [ (clr-warning) ] [ (clr-minor) ] [ (clr-major) ] [ (clr-critical) ]

Command Parameters
Table 111.6-2 "Alarm Delta Log Management Command" Command Parameters
Parameter

Type

(clr-indeterminate)

Format:
optional parameter
clr-indeterminate
clear indeterminate delta-log
Possible values:
table - set index to 1
- clr-indeterminate : clear indeterminate delta-log table loggin will start from index 1
Format:
optional parameter
clr-warning
clear warning delta-log table - set
Possible values:
index to 1
- clr-warning : clear warning delta-log table - set index to 1
Format:
optional parameter
clr-minor
clear minor delta-log table - set
Possible values:
index to 1
- clr-minor : clear minor delta-log table - set index to 1
Format:
optional parameter
clr-major
clear major delta-log table - set
Possible values:
index to 1
- clr-major : clear major delta-log table - set index to 1
Format:
optional parameter
clr-critical
clear critical delta-log table - set
Possible values:
index to 1
- clr-critical : clear critical delta-log table - set index to 1

(clr-warning)

(clr-minor)

(clr-major)

(clr-critical)

2906

Released

Description

3HH-04416-EBAA-TCZZA

01

111 Alarm Management Commands

111.7 Log Management Command


Command Description
This command allows the operator to manage logs.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm log [ (clr-error-log) ] [ (clr-set-log-table) ]

Command Parameters
Table 111.7-2 "Log Management Command" Command Parameters
Parameter

Type

Description

(clr-error-log)

Format:
clr-error-log
Possible values:
- clr-error-log : clear the error log : index starts from 1
Format:
clr-set-log-table
Possible values:
- clr-set-log-table : clear the set log table : index starts from
1

optional parameter
clear the error log : index starts
from 1

(clr-set-log-table)

3HH-04416-EBAA-TCZZA 01

optional parameter
clear the set log table : index
starts from 1

Released

2907

111 Alarm Management Commands

111.8 Alarm Filetransfer Manual Clearance


Management Command
Command Description
This command allows the operator to manage the filetransfer alarm that should be cleared manually

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm clear-alarm filetransfer ip-address <Alarm::IpAddress>

Command Parameters
Table 111.8-2 "Alarm Filetransfer Manual Clearance Management Command" Command
Parameters
Parameter

Type

Description

ip-address

Parameter type: <Alarm::IpAddress>


Format:
- IPv4-address

optional parameter
identify where the alarm index1
occurred

2908

Released

3HH-04416-EBAA-TCZZA

01

112- ATM Management Commands

112.1 ATM Management Command Tree


112.2 ATM Port Management Command

3HH-04416-EBAA-TCZZA 01

112-2910
112-2911

Released

2909

112 ATM Management Commands

112.1 ATM Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "ATM Management Commands".

Command Tree
----admin
----atm
----port
- (port)
- f5-loopback-ete

2910

Released

3HH-04416-EBAA-TCZZA

01

112 ATM Management Commands

112.2 ATM Port Management Command


Command Description
This command allows the operator to configure ATM port management. An f5 loopback end-to-end test can be
started by giving the parameter f5-loopback-ete a value of start.
The result of this test is displayed with the info command.

User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> admin atm port (port) [ f5-loopback-ete <Atm::F5LoopbackTestStatus> ]

Command Parameters
Table 112.2-1 "ATM Port Management Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
the port under test
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
:
<Eqpt::VpiMandatoryId>
:
<Eqpt::VciMandatoryId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

Description

Table 112.2-2 "ATM Port Management Command" Command Parameters


Parameter

Type

Description

f5-loopback-ete

Parameter type: <Atm::F5LoopbackTestStatus>


Format:
start
Possible values:
- start : start the test

optional parameter
the f5 end-to-end loopback test

3HH-04416-EBAA-TCZZA 01

Released

2911

112 ATM Management Commands

2912

Released

3HH-04416-EBAA-TCZZA

01

113- IGMP Management Commands

113.1 IGMP Management Command Tree


113.2 IGMP Management Command
113.3 IGMP Multicast Sources Management Command
113.4 IGMP Multicast Channel Management Command
113.5 IGMP Multicast Channel Management Command
113.6 IGMP Slot Management Command
113.7 Shub IGMP CAC Bundle Management Command
113.8 Shub IGMP CAC Source Management Command
113.9 Shub IGMP CAC System Management Command
113.10 Shub IGMP VLAN System Management Command
113.11 IGMP Channel Management Command

3HH-04416-EBAA-TCZZA 01

113-2914
113-2915
113-2916
113-2917
113-2918
113-2920
113-2921
113-2922
113-2923
113-2924
113-2925

Released

2913

113 IGMP Management Commands

113.1 IGMP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "IGMP Management Commands".

Command Tree
----admin
----igmp
- (clear-all-stats)
- (clear-preview-cntr)
- (collect-cdr)
----X mcast-src
- (slot-index)
- address
- (clear-statistics)
----mcast-channel
- (slot-index)
- grp-ip-addr
- src-ip-addr
- (clear-statistics)
----mcast-chn
- (slot-index)
- grp-ip-addr
- src-ip-addr
- vlan-id
- (clear-statistics)
----module
- (slot-index)
- (clear-statistics)
----shub
----bundle
- (bundle-name)
- (clear-statistics)
----mcast-src
- (src)
- vlan-id
- ip-addr
- (clear-statistics)
----cac
----clear-stats
- (clear-stats)
----vlan
- clear-stats
----channel
- (port)
- (clear-statistics)

2914

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

113.2 IGMP Management Command


Command Description
This command allows the operator to manage IGMP.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin igmp [ (clear-all-stats) ] [ (clear-preview-cntr) ] [ (collect-cdr) ]

Command Parameters
Table 113.2-2 "IGMP Management Command" Command Parameters
Parameter

Type

(clear-all-stats)

Format:
optional parameter
clear-all-stats
clears all statistics
Possible values:
- clear-all-stats : clear all statistics
Format:
optional parameter
reset-pre-count
reset preview time for all mcast
Possible values:
src in 1day/1wk/1month
- reset-pre-count : reset all preview time for all multicast
source
Format:
optional parameter
collect-cdr
to trigger to collect CDRs
Possible values:
manually
- collect-cdr : trigger to collect CDRs manually

(clear-preview-cntr)

(collect-cdr)

3HH-04416-EBAA-TCZZA 01

Description

Released

2915

113 IGMP Management Commands

113.3 IGMP Multicast Sources Management


Command
Command Description
Obsolete command, replaced by admin igmp mcast-channel.
This command allows the operator to manage the IGMP multicast sources.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp mcast-src (slot-index) address <Igmp::MulticastAddress> [ (clear-statistics) ]
Obsolete command, replaced by admin igmp mcast-channel.

Command Parameters
Table 113.3-1 "IGMP Multicast Sources Management Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)

identify an IGMP module by the


logical SlotId

address

mcast src address in network-byte


order (big-endian)

Table 113.3-2 "IGMP Multicast Sources Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the statistics

2916

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

113.4 IGMP Multicast Channel Management


Command
Command Description
This command allows the operator to manage the IGMP multicast channels.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp mcast-channel (slot-index) grp-ip-addr <Igmp::MulticastAddress> src-ip-addr <Ip::V4Address> [
(clear-statistics) ]

Command Parameters
Table 113.4-1 "IGMP Multicast Channel Management Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

identify an IGMP module by the


logical SlotId

grp-ip-addr
src-ip-addr

ip address identifying
multicast group

ip address of the multicast server


originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr)

Table 113.4-2 "IGMP Multicast Channel Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the statistics

3HH-04416-EBAA-TCZZA 01

the

Released

2917

113 IGMP Management Commands

113.5 IGMP Multicast Channel Management


Command
Command Description
This command allows the operator to manage the IGMP multicast channels.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp mcast-chn (slot-index) grp-ip-addr <Igmp::MulticastAddress> src-ip-addr <Ip::V4Address> vlan-id
<Igmp::McastChannelVlan> [ (clear-statistics) ]

Command Parameters
Table 113.5-1 "IGMP Multicast Channel Management Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Parameter type: <Igmp::MulticastAddress>
Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

identify an IGMP module by the


logical SlotId

grp-ip-addr
src-ip-addr

vlan-id

Parameter type: <Igmp::McastChannelVlan>


Format:
- vlan id for multicast
- range: [1...4093]

ip address identifying
multicast group

ip address of the multicast server


originating
the
multicast
channel,value 0.0.0.0 means
ASM(any-src-ip-addr)
specifies the VLAN in which the
multicast channel is configured.

Table 113.5-2 "IGMP Multicast Channel Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics

optional parameter
clear the statistics

2918

Released

the

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

Parameter

Type

Description

Possible values:
- clear-statistics : clear the statistics

3HH-04416-EBAA-TCZZA 01

Released

2919

113 IGMP Management Commands

113.6 IGMP Slot Management Command


Command Description
This command allows the operator to manage IGMP related to a slot.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp module (slot-index) [ (clear-statistics) ]

Command Parameters
Table 113.6-1 "IGMP Slot Management Command" Resource Parameters
Resource Identifier

Type

Description

(slot-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

identify an IGMP module by the


logical slot id

Table 113.6-2 "IGMP Slot Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the statistics

2920

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

113.7 Shub IGMP CAC Bundle Management


Command
Command Description
This command allows the operator to manage IGMP CAC bundle level stauts, clear bundle entry status.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp shub bundle (bundle-name) [ (clear-statistics) ]

Command Parameters
Table 113.7-1 "Shub IGMP CAC Bundle Management Command" Resource Parameters
Resource Identifier

Type

Description

(bundle-name)

Format:
- the name of the bundle
- length: x<=32

name of this bundle

Table 113.7-2 "Shub IGMP CAC Bundle Management Command" Command Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the statistics

3HH-04416-EBAA-TCZZA 01

Released

2921

113 IGMP Management Commands

113.8 Shub IGMP CAC Source Management


Command
Command Description
This command allows the operator to manage IGMP CAC Source status, clear source entry status.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp shub mcast-src (src) vlan-id <Igmp::McastSrcVLANID> ip-addr <Ip::V4Address> [ (clear-statistics)
]

Command Parameters
Table 113.8-1 "Shub IGMP CAC Source Management Command" Resource Parameters
Resource Identifier

Type

Description

(src)

Format:
- multicast-address (range: 224.0.0.3....239.255.255.255)
Parameter type: <Igmp::McastSrcVLANID>
Format:
- VLAN for this multicast source
- range: [1...4093]
Parameter type: <Ip::V4Address>
Format:
- IPv4-address

mcast src address in network-byte


order(big-endian)
vlan for this multicast source

vlan-id

ip-addr

ip addr of mcast servr in


network-byte order(big-enaian)

Table 113.8-2 "Shub IGMP CAC Source Management Command" Command Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the statistics

2922

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

113.9 Shub IGMP CAC System Management


Command
Command Description
This command allows the operator to manage CAC system level status, clear the system,all bundle or all source
status.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp shub cac clear-stats [ (clear-stats) ]

Command Parameters
Table 113.9-2 "Shub IGMP CAC System Management Command" Command Parameters
Parameter

Type

Description

(clear-stats)

Format:
( all
| system
| bundle
| mcast-src )
Possible values:
- all : clear all statistics
- system : clear system object statistics
- bundle : clear all bundle table statistics
- mcast-src : clear all channel source table statistics

optional parameter
clear the cac related statistics
counters

3HH-04416-EBAA-TCZZA 01

Released

2923

113 IGMP Management Commands

113.10 Shub IGMP VLAN System Management


Command
Command Description
This command allows the operator to manage VLAN system clear statistics on a per Vlan basis.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp shub vlan clear-stats <Igmp::igmpClearStats>

Command Parameters
Table 113.10-2 "Shub IGMP VLAN System Management Command" Command Parameters
Parameter

Type

Description

clear-stats

Parameter type: <Igmp::igmpClearStats>


Format:
- clears all the IGMP statistics for the given Vlan
- range: [0...4094]

optional parameter
clears all the IGMP statistics for
the given Vlan

2924

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

113.11 IGMP Channel Management Command


Command Description
This command allows the operator to manage the IGMP channel.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp channel (port) [ (clear-statistics) ]

Command Parameters
Table 113.11-1 "IGMP Channel Management Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
identification of the port, vlanport
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / or virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3HH-04416-EBAA-TCZZA 01

Description

Released

2925

113 IGMP Management Commands

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 113.11-2 "IGMP Channel Management Command" Command Parameters

2926

Released

3HH-04416-EBAA-TCZZA

01

113 IGMP Management Commands

Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
accept/ignore request to clear
statistics of the table

3HH-04416-EBAA-TCZZA 01

Released

2927

114- PPPoX Management Commands

114.1 PPPoX Management Command Tree


114.2 PPPoX Engine Port Management Command

2928

Released

114-2929
114-2930

3HH-04416-EBAA-TCZZA

01

114 PPPoX Management Commands

114.1 PPPoX Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoX Management Commands".

Command Tree
----admin
----pppox-relay
----engine
- (vlan-id)
- (remove-all-ports)

3HH-04416-EBAA-TCZZA 01

Released

2929

114 PPPoX Management Commands

114.2 PPPoX Engine Port Management Command


Command Description
This command deletes all ports for a specific engine.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> admin pppox-relay engine (vlan-id) [ (remove-all-ports) ]

Command Parameters
Table 114.2-1 "PPPoX Engine Port Management Command" Resource Parameters
Resource Identifier

Type

Description

(vlan-id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan identity

Table 114.2-2 "PPPoX Engine Port Management Command" Command Parameters


Parameter

Type

Description

(remove-all-ports)

Format:
remove-all-ports
Possible values:
- remove-all-ports : remove all ports

optional parameter
remove all ports for a specific
engine

2930

Released

3HH-04416-EBAA-TCZZA

01

115- PPPoE Management Commands

115.1 PPPoE Management Command Tree


115.2 PPPoE Management Command

3HH-04416-EBAA-TCZZA 01

115-2932
115-2933

Released

2931

115 PPPoE Management Commands

115.1 PPPoE Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "PPPoE Management Commands".

Command Tree
----admin
----pppoe-client
----emulation
- (ifindex)
- client-id
- [no] command

2932

Released

3HH-04416-EBAA-TCZZA

01

115 PPPoE Management Commands

115.2 PPPoE Management Command


Command Description
This command allows the operator to manage the specific PPPoE client emulation.

User Level
The command can be accessed by operators with pppoe privileges, and executed by operators with pppoe
privileges.

Command Syntax
The command has the following syntax:
> admin pppoe-client emulation (ifindex) client-id <PPPoE::ClientId> [ no command | command
<PPPoE::pppoeClientEmulationCmd> ]

Command Parameters
Table 115.2-1 "PPPoE Management Command" Resource Parameters
Resource Identifier

Type

(ifindex)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Possible values:
- stacked : stacked vlan identity

3HH-04416-EBAA-TCZZA 01

Description
interface index of the PPPoE
/ client port
/
:
/
/
:

Released

2933

115 PPPoE Management Commands

Resource Identifier

Type

Description

Field type <Eqpt::UnstackedVlan>


- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <PPPoE::ClientId>
Format:
- the PPPoE client id
- range: [1]

client-id

the PPPoE client id

Table 115.2-2 "PPPoE Management Command" Command Parameters


Parameter

Type

Description

[no] command

Parameter type: <PPPoE::pppoeClientEmulationCmd>


Format:
( start
| stop )
Possible values:
- start : start the PPPoE emulation
- stop : abort emulation and terminate the PPPoE session

optional parameter with default


value: "none"
start or stop the PPPoE emulation

2934

Released

3HH-04416-EBAA-TCZZA

01

116- xDSL Management Commands

116.1 xDSL Management Command Tree


116.2 xDSL Line Management Command

3HH-04416-EBAA-TCZZA 01

116-2936
116-2937

Released

2935

116 xDSL Management Commands

116.1 xDSL Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "xDSL Management Commands".

Command Tree
----admin
----xdsl-line
- (if-index)
- loop-diagnostic

2936

Released

3HH-04416-EBAA-TCZZA

01

116 xDSL Management Commands

116.2 xDSL Line Management Command


Command Description
This command allows the operator do manage an xDSL Line.
Loop Diagnostic Indications:
start : start diagnostics on XDSL line.
stop : stop diagnostics on XDSL line.
completed : diagnostic results ready for retrieval.
failed : diagnostic failed.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> admin xdsl-line (if-index) [ loop-diagnostic <Xdsl::LoopDiagMode> ]

Command Parameters
Table 116.2-1 "xDSL Line Management Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 116.2-2 "xDSL Line Management Command" Command Parameters


Parameter

Type

Description

loop-diagnostic

Parameter type: <Xdsl::LoopDiagMode>


Format:
( stop
| start )
Possible values:
- stop : stop the loop diagnostic test
- start : start the diagnostic test

optional parameter
controls the loop diagnostic test

3HH-04416-EBAA-TCZZA 01

Released

2937

116 xDSL Management Commands

2938

Released

3HH-04416-EBAA-TCZZA

01

117- Software Management Commands

117.1 Software Management Command Tree


117.2 Software Management Command
117.3 OSWP Software Management Command
117.4 Database Management Command
117.5 File Management Command
117.6 SHub Software Management Command
117.7 SHub Database Management Command
117.8 Update the SHub Boot ROM Command
117.9 CDE Management Command

3HH-04416-EBAA-TCZZA 01

117-2940
117-2941
117-2942
117-2944
117-2946
117-2947
117-2948
117-2949
117-2950

Released

2939

117 Software Management Commands

117.1 Software Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Software Management Commands".

Command Tree
----admin
----software-mngt
- (clr-db-rollback-alrm)
- (clr-sw-rollback-alrm)
----oswp
- (index)
- download
- activate
- (commit)
- (abort-download)
----database
- download
- upload
----disk-file
- (path)
- (remove)
----shub
----database
- (save)
----boot-rom
- (package)
----cdeprof
- download
- activate

2940

Released

3HH-04416-EBAA-TCZZA

01

117 Software Management Commands

117.2 Software Management Command


Command Description
This command allows the operator to manage the software of the system.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt [ (clr-db-rollback-alrm) ] [ (clr-sw-rollback-alrm) ]

Command Parameters
Table 117.2-2 "Software Management Command" Command Parameters
Parameter

Type

Description

(clr-db-rollback-alrm)

Format:
clr-db-rollback-alrm
Possible values:
- clr-db-rollback-alrm : clear the implicit database rollback
alarm
Format:
clr-sw-rollback-alrm
Possible values:
- clr-sw-rollback-alrm : clear the implicit software rollback
alarm

optional parameter
clear the implicit
rollback alarm

database

optional parameter
clear the implicit
rollback alarm

software

(clr-sw-rollback-alrm)

3HH-04416-EBAA-TCZZA 01

Released

2941

117 Software Management Commands

117.3 OSWP Software Management Command


Command Description
This command allows the operator to manage the OSWP software packages.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt oswp (index) [ download <SwMngt::oswpName> ] [ activate <SwMngt::activationType> ]
[ (commit) ] [ (abort-download) ]

Command Parameters
Table 117.3-1 "OSWP Software Management Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
- id of one of the two oswps
- range: [1...2]

index to the swm oswp table

Table 117.3-2 "OSWP Software Management Command" Command Parameters


Parameter

Type

Description

download

Parameter type: <SwMngt::oswpName>


Format:
- path and name of the oswp ,file name less than 160 char
- range: [a-zA-Z0-9-_./:]
- length: 1<=x<=255
Parameter type: <SwMngt::activationType>
Format:
( with-linked-db
| with-default-db
| clear-db )
Possible values:
- with-linked-db : activate OSWP with linked database
- with-default-db : activate OSWP with default database
- clear-db : ISAM shutdown => only NT plugout/re-plugin
possible!
Format:
commit
Possible values:
- commit : commit the OSWP
Format:
abort-download

optional parameter
download a software package

activate

(commit)

(abort-download)

2942

Released

optional parameter
activate an OSWP package

optional parameter
commit the OSWP
optional parameter
abort the download of an oswp

3HH-04416-EBAA-TCZZA

01

117 Software Management Commands

Parameter

Type

Description

Possible values:
- abort-download : abort the download of an oswp

3HH-04416-EBAA-TCZZA 01

Released

2943

117 Software Management Commands

117.4 Database Management Command


Command Description
This command allows the operator to manage the system database.
The database file name should be either dm.tar or dm_complete.tar.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt database
<SwMngt::DbUploadServerId> ]

download

<SwMngt::DbDownloadServerId>

upload

Command Parameters
Table 117.4-2 "Database Management Command" Command Parameters
Parameter

Type

Description

download

Parameter type: <SwMngt::DbDownloadServerId>


Format:
<Ip::V4Address> : <SwMngt::dbPath>
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::dbPath>
- path for the db (eg: /path_to_db/file_name); valid
file_names: [dm.tar|dm_complete.tar]
- range: [a-zA-Z0-9-_./():]
- length: 1<=x<=255
Parameter type: <SwMngt::DbUploadServerId>
Format:
( actual-active : <Ip::V4Address> : <SwMngt::dbPath>
| preferred-active : <Ip::V4Address> : <SwMngt::dbPath>
| previous-active : <Ip::V4Address> : <SwMngt::dbPath>
| failed-active : <Ip::V4Address> : <SwMngt::dbPath>
| actual-not-active : <Ip::V4Address> : <SwMngt::dbPath>
|
preferred-not-active
:
<Ip::V4Address>
:
<SwMngt::dbPath>
|
previous-not-active
:
<Ip::V4Address>
:
<SwMngt::dbPath>
| failed-not-active : <Ip::V4Address> : <SwMngt::dbPath> )
Possible values:
- actual-active : actual database for active OSWP
- preferred-active : preferable database for active OSWP
- previous-active : previous database for active OSWP

optional parameter
download the database

upload

2944

Released

optional parameter
upload the database

3HH-04416-EBAA-TCZZA

01

117 Software Management Commands

Parameter

Type

Description

- failed-active : failed databse for active OSWP


- actual-not-active : actual database for not-active OSWP
- preferred-not-active : preferable database for not-active
OSWP
- previous-not-active : previous database for not-active
OSWP
- failed-not-active : failed database for not-active OSWP
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::dbPath>
- path for the db (eg: /path_to_db/file_name); valid
file_names: [dm.tar|dm_complete.tar]
- range: [a-zA-Z0-9-_./():]
- length: 1<=x<=255

3HH-04416-EBAA-TCZZA 01

Released

2945

117 Software Management Commands

117.5 File Management Command


Command Description
This command manages disk and descriptor files.
A disk file contains information about the different software files and descriptor files that are stored on the file disk.
It also contains information such as the file name, file size, file type, file availability status, and file format.
The operator can remove a file from the disk in the following cases :
1. The file does not belong to the SWP.
2. The file is not a Sw descriptor file.
3. The file is not of a planned and/or detected board type(as well in the active as in the non active SWP).

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt disk-file (path) [ (remove) ]

Command Parameters
Table 117.5-1 "File Management Command" Resource Parameters
Resource Identifier

Type

Description

(path)

Format:
- an absolute file name
- range: [.-z]
- length: 1<=x<=256

an absolute file name

Table 117.5-2 "File Management Command" Command Parameters


Parameter

Type

Description

(remove)

Format:
remove
Possible values:
- remove : remove the file

optional parameter
remove the file

2946

Released

3HH-04416-EBAA-TCZZA

01

117 Software Management Commands

117.6 SHub Software Management Command


Command Description
This command allows the operator to manage the software on the SHub.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub

3HH-04416-EBAA-TCZZA 01

Released

2947

117 Software Management Commands

117.7 SHub Database Management Command


Command Description
This command allows the operator to manage the database on the SHub.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub database [ (save) ]

Command Parameters
Table 117.7-2 "SHub Database Management Command" Command Parameters
Parameter

Type

Description

(save)

Format:
save
Possible values:
- save : save the database

optional parameter
save the database

2948

Released

3HH-04416-EBAA-TCZZA

01

117 Software Management Commands

117.8 Update the SHub Boot ROM Command


Command Description
This command updates the SHub boot ROM.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub boot-rom (package)

Command Parameters
Table 117.8-2 "Update the SHub Boot ROM Command" Command Parameters
Parameter

Type

Description

(package)

Format:
<Ip::V4Address> : <Sys::FileName>
Field type <Ip::V4Address>
- IPv4-address
Field type <Sys::FileName>
- name
- length: 1<=x<=256

optional parameter
the identification of the bootrom
image

3HH-04416-EBAA-TCZZA 01

Released

2949

117 Software Management Commands

117.9 CDE Management Command


Command Description
This command allows the operator to download and manage the CDE profile.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt cdeprof [ download <SwMngt::DownloadServerId> ] [ activate <SwMngt::CDEFileName>
]

Command Parameters
Table 117.9-2 "CDE Management Command" Command Parameters
Parameter

Type

Description

download

Parameter type: <SwMngt::DownloadServerId>


Format:
<Ip::V4Address> : <SwMngt::path>
Field type <Ip::V4Address>
- IPv4-address
Field type <SwMngt::path>
path
for
the
db
or
cde(example:
/path_to_db_or_cde/file_name)
- range: [a-zA-Z0-9-_./():]
- length: 1<=x<=128
Parameter type: <SwMngt::CDEFileName>
Format:
- string representing the cde profile name
- length: 1<=x<=128

optional parameter
download the CDE file

activate

2950

Released

optional parameter
activate
the
CDE
previously downloaded

3HH-04416-EBAA-TCZZA

01

profile

118- OSPF Management Commands

118.1 OSPF Management Command Tree


118.2 OSPF Interface MD5 Key Management Command

3HH-04416-EBAA-TCZZA 01

118-2952
118-2953

Released

2951

118 OSPF Management Commands

118.1 OSPF Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "OSPF Management Commands".

Command Tree
----admin
----ospf
----interface
- (ip-addr)
- md5-key
- accept-expires
- generate-expires

2952

Released

3HH-04416-EBAA-TCZZA

01

118 OSPF Management Commands

118.2 OSPF Interface MD5 Key Management


Command
Command Description
This command allows the operator to configure an MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ospf interface (ip-addr) md5-key <Ospf::Md5KeyIndex> [ accept-expires <Ospf::MD5expiryDelay> ]
generate-expires <Ospf::MD5expiryDelay>

Command Parameters
Table 118.2-1 "OSPF Interface MD5 Key Management Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Parameter type: <Ospf::Md5KeyIndex>
Format:
- the number of the MD5 key
- range: [1...255]

ip address identifying
interface
the number of the md5 key

md5-key

the

Table 118.2-2 "OSPF Interface MD5 Key Management Command" Command Parameters
Parameter

Type

Description

accept-expires

Parameter type: <Ospf::MD5expiryDelay>


Format:
( now
| never
| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]
Parameter type: <Ospf::MD5expiryDelay>
Format:
( now
| never

optional parameter
set the delay before the key
expires for accepting

generate-expires

3HH-04416-EBAA-TCZZA 01

mandatory parameter
set the delay before the key
expires for generating

Released

2953

118 OSPF Management Commands

Parameter

Type

Description

| <Ospf::MD5expiryDelay> )
Possible values:
- now : the key will expire now
- never : the key will never expire
Field type <Ospf::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

2954

Released

3HH-04416-EBAA-TCZZA

01

119- RIP Management Commands

119.1 RIP Management Command Tree


119.2 RIP Interface MD5 Key Management Command

3HH-04416-EBAA-TCZZA 01

119-2956
119-2957

Released

2955

119 RIP Management Commands

119.1 RIP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "RIP Management Commands".

Command Tree
----admin
----rip
----interface
- (ip-addr)
- md5-key
- expires

2956

Released

3HH-04416-EBAA-TCZZA

01

119 RIP Management Commands

119.2 RIP Interface MD5 Key Management


Command
Command Description
This command allows the operator to manage a MD5 key for a RIP interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin rip interface (ip-addr) md5-key <Rip::Md5KeyIndex> expires <Rip::MD5expiryDelay>

Command Parameters
Table 119.2-1 "RIP Interface MD5 Key Management Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Parameter type: <Rip::Md5KeyIndex>
Format:
- the number of the MD5 key
- range: [0...255]

interface IP address

md5-key

the number of the md5 key

Table 119.2-2 "RIP Interface MD5 Key Management Command" Command Parameters
Parameter

Type

Description

expires

Parameter type: <Rip::MD5expiryDelay>


Format:
( never
| <Rip::MD5expiryDelay> )
Possible values:
- never : the key will never expire
Field type <Rip::MD5expiryDelay>
- the delay before the md5-key expires
- unit: sec
- range: [1...2147483647]

mandatory parameter
set the delay before the key
expires

3HH-04416-EBAA-TCZZA 01

Released

2957

120- SHDSL Management Commands

120.1 SHDSL Management Command Tree


120.2 SHDSL Segment Configuration Command

2958

Released

120-2959
120-2960

3HH-04416-EBAA-TCZZA

01

120 SHDSL Management Commands

120.1 SHDSL Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "SHDSL Management Commands".

Command Tree
----admin
----shdsl-seg
- (if-index)
- unit-id
- side
- [no] soft-restart

3HH-04416-EBAA-TCZZA 01

Released

2959

120 SHDSL Management Commands

120.2 SHDSL Segment Configuration Command


Command Description
This command allows the operator manage an SHDSL Segment.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> admin shdsl-seg (if-index) unit-id <Shdsl::UnitId> side <Shdsl::SegmentSide> [ [ no ] soft-restart ]

Command Parameters
Table 120.2-1 "SHDSL Segment Configuration Command" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
interface index of the port
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Parameter type: <Shdsl::UnitId>
unit identifier in an SHDSL span
Format:
( stu-c
| stu-r
| sru-1
| sru-2
| sru-3
| sru-4
| sru-5
| sru-6
| sru-7
| sru-8 )
Possible values:
- stu-c : the SHDSL unit is STU-C
- stu-r : the SHDSL unit is STU-R
- sru-1 : the SHDSL unit is SRU-1
- sru-2 : the SHDSL unit is SRU-2
- sru-3 : the SHDSL unit is SRU-3

unit-id

2960

Released

Description

3HH-04416-EBAA-TCZZA

01

120 SHDSL Management Commands

Resource Identifier

side

Type

Description

- sru-4 : the SHDSL unit is SRU-4


- sru-5 : the SHDSL unit is SRU-5
- sru-6 : the SHDSL unit is SRU-6
- sru-7 : the SHDSL unit is SRU-7
- sru-8 : the SHDSL unit is SRU-8
Parameter type: <Shdsl::SegmentSide>
Format:
( network
| customer )
Possible values:
- network : the network side
- customer : the customer side

the particular side of an SHDSL


unit in an SHDSL segment

Table 120.2-2 "SHDSL Segment Configuration Command" Command Parameters


Parameter

Type

Description

[no] soft-restart

Parameter type: boolean

optional parameter
soft restart for the associated side

3HH-04416-EBAA-TCZZA 01

Released

2961

121- Session Management Commands

121.1 Session Management Command Tree


121.2 Forced Disconnect Session Command

2962

Released

121-2963
121-2964

3HH-04416-EBAA-TCZZA

01

121 Session Management Commands

121.1 Session Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Session Management Commands".

Command Tree
----admin
----session
- (id)
- (disconnect)

3HH-04416-EBAA-TCZZA 01

Released

2963

121 Session Management Commands

121.2 Forced Disconnect Session Command


Command Description
This command allows the operator to discontinue (or forcely terminate) an existing CLI session.
The operator can learn about established CLI sessions using the "show session" command.

User Level
The command can be accessed and executed by an operator with admin privilege.

Command Syntax
The command has the following syntax:
> admin session (id) (disconnect)

Command Parameters
Table 121.2-1 "Forced Disconnect Session Command" Resource Parameters
Resource Identifier

Type

Description

(id)

Format:
- the session number
- range: [1...13]

the session number

Table 121.2-2 "Forced Disconnect Session Command" Command Parameters


Parameter

Type

Description

(disconnect)

Format:
disconnect : <Sec::DisconnectMessage>
Possible values:
- disconnect : disconnect the session
Field type <Sec::DisconnectMessage>
- disconnect msg to specify reason for forced termination
- length: x<=256

optional parameter
disconnect the session with a
given message

2964

Released

3HH-04416-EBAA-TCZZA

01

122- System Management Commands

122.1 System Management Command Tree


122.2 SYSLOG Management command
122.3 Secure Shell Server Key Regeneration Command
122.4 PM File Upload Management Command
122.5 PM File Upload Management Command
122.6 CPU Load Management Command

3HH-04416-EBAA-TCZZA 01

122-2966
122-2967
122-2968
122-2969
122-2970
122-2971

Released

2965

122 System Management Commands

122.1 System Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "System Management Commands".

Command Tree
----admin
----system
----syslog
----destination
- (name)
- (rotate)
----security
----ssh
- generate-key
----pmfile
----upload
- (upload-index)
- upl-interval-num
----cpu-load
- (index)
- monitor

2966

Released

3HH-04416-EBAA-TCZZA

01

122 System Management Commands

122.2 SYSLOG Management command


Command Description
This command allows the operator to rotate the log files explicitly.This is applicable if the destination type is
configured as file.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin system syslog destination (name) [ (rotate) ]

Command Parameters
Table 122.2-1 "SYSLOG Management command" Resource Parameters
Resource Identifier

Type

Description

(name)

Format:
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32

name of the syslog destination

Table 122.2-2 "SYSLOG Management command" Command Parameters


Parameter

Type

Description

(rotate)

Format:
rotate
Possible values:
- rotate : enforce the rotation of the log files

optional parameter
enforce the rotation of the log
files

3HH-04416-EBAA-TCZZA 01

Released

2967

122 System Management Commands

122.3 Secure Shell Server Key Regeneration


Command
Command Description
This command allows the operator to generate the public/private server key-pair.
The RSA key generation is not yet supported.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> admin system security ssh generate-key <SSH::RegenerateKey>

Command Parameters
Table 122.3-2 "Secure Shell Server Key Regeneration Command" Command Parameters
Parameter

Type

Description

generate-key

Parameter type: <SSH::RegenerateKey>


Format:
( dsa
| rsa )
Possible values:
- dsa : generate a dsa key-pair
- rsa : generate a rsa key-pair (not supported at present)

optional parameter
to generate ssh server key-pair

2968

Released

3HH-04416-EBAA-TCZZA

01

122 System Management Commands

122.4 PM File Upload Management Command


Command Description
This command allows the operator to manually upload PM file to external SFTP server

User Level
The command can be executed by operators with security privileges.

Command Syntax
The command has the following syntax:
> admin system security pmfile

3HH-04416-EBAA-TCZZA 01

Released

2969

122 System Management Commands

122.5 PM File Upload Management Command


Command Description
This command allows the operator to manually upload PM file to external SFTP server

User Level
The command can be executed by operators with security privileges.

Command Syntax
The command has the following syntax:
> admin system security pmfile upload (upload-index) upl-interval-num <SwMngt::pmFileUploadIntervalNum>

Command Parameters
Table 122.5-1 "PM File Upload Management Command" Resource Parameters
Resource Identifier

Type

(upload-index)

Format:
the unique internal identifier of
- the unique internal identifier of PM file upload entry PM file upload entry
(1-VOICE, 2-DSL)
- range: [1...2]

Description

Table 122.5-2 "PM File Upload Management Command" Command Parameters


Parameter

Type

upl-interval-num

Parameter type: <SwMngt::pmFileUploadIntervalNum>


optional parameter
Format:
identifies previous intervals,
- the interval number for which a PM file must be uploaded, value 1 as the latest interval
value 1 as the latest interval
- range: [1...96]

2970

Released

Description

3HH-04416-EBAA-TCZZA

01

122 System Management Commands

122.6 CPU Load Management Command


Command Description
This command allows the operator to inititate and terminate CPU load monitoring for a board.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin system cpu-load (index) [ monitor <Sys::operateStatusAdmin> ]

Command Parameters
Table 122.6-1 "CPU Load Management Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

the physical number of the slot

Table 122.6-2 "CPU Load Management Command" Command Parameters


Parameter

Type

Description

monitor

Parameter type: <Sys::operateStatusAdmin>


Format:
( start
| stop )
Possible values:
- start : start the cpu load monitoring activity

optional parameter
start/stop the cpu load monitoring
activity

3HH-04416-EBAA-TCZZA 01

Released

2971

122 System Management Commands

Parameter

Type

Description

- stop : stop the cpu load monitoring activity

2972

Released

3HH-04416-EBAA-TCZZA

01

123- UDP debug Management Commands

123.1 UDP debug Management Command Tree


123.2 Forced Disconnect UDP debug Command

3HH-04416-EBAA-TCZZA 01

123-2974
123-2975

Released

2973

123 UDP debug Management Commands

123.1 UDP debug Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "UDP debug Management Commands".

Command Tree
----admin
----system
----security
----kill-debug

2974

Released

3HH-04416-EBAA-TCZZA

01

123 UDP debug Management Commands

123.2 Forced Disconnect UDP debug Command


Command Description
This command allows the operator to discontinue (or forcely terminate) all UDP debug sesssions existing CLI
session.

User Level
The command can be accessed and executed by an operator with admin privilege.

Command Syntax
The command has the following syntax:
> admin system security kill-debug

3HH-04416-EBAA-TCZZA 01

Released

2975

124- Trouble-Shooting Management Commands

124.1 Trouble-Shooting Management Command Tree


124.2 Trouble-shooting Interface Management Commands

2976

Released

124-2977
124-2978

3HH-04416-EBAA-TCZZA

01

124 Trouble-Shooting Management Commands

124.1 Trouble-Shooting Management Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Trouble-Shooting Management Commands".

Command Tree
----admin
----trouble-shooting
----interface
- (if-index)
- (clr-trbt-stats)

3HH-04416-EBAA-TCZZA 01

Released

2977

124 Trouble-Shooting Management Commands

124.2 Trouble-shooting Interface Management


Commands
Command Description
This command allows the operator to reset summary and extensive dataplane trouble-shooting counters.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> admin trouble-shooting interface (if-index) (clr-trbt-stats)

Command Parameters
Table 124.2-1 "Trouble-shooting Interface Management Commands" Resource Parameters
Resource Identifier

Type

(if-index)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni

2978

Released

Description
interface index of the port
/
/
/
/
/

3HH-04416-EBAA-TCZZA

01

124 Trouble-Shooting Management Commands

Resource Identifier

Type

Description

- vuni : virtual uni identifier


Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier

Table 124.2-2 "Trouble-shooting Interface Management Commands" Command Parameters


Parameter

Type

Description

(clr-trbt-stats)

Format:
clear-statistics
Possible values:
- clear-statistics : reset trouble-shooting counters

optional parameter
optional parameter reset
trouble-shooting counters

3HH-04416-EBAA-TCZZA 01

Released

2979

all

125- Voice Management Commands

125.1 Voice Management Command Tree


125.2 Voice Megaco Database Management Command
125.3 Voice Megaco Termination Lock Management
Command
125.4 Voice Megaco Media Gateway Lock Management
Command

2980

Released

125-2981
125-2982
125-2983
125-2985

3HH-04416-EBAA-TCZZA

01

125 Voice Management Commands

125.1 Voice Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Voice Management Commands".

Command Tree
----admin
----voice
----cluster
- (cluster-id)
----database
- (save)
----equipment
- (equip-id)
- port-id
- lktype
----media-gateway
- (media-gateway-id)
- lktype
- trigger-esa-mgc
----sip

3HH-04416-EBAA-TCZZA 01

Released

2981

125 Voice Management Commands

125.2 Voice Megaco Database Management


Command
Command Description
This command allows the operator to manage the voice megaco xvps database.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> admin voice cluster (cluster-id) database [ (save) ]

Command Parameters
Table 125.2-1 "Voice Megaco Database Management Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]

uniquely identify of this xvps


cluster

Table 125.2-2 "Voice Megaco Database Management Command" Command Parameters


Parameter

Type

Description

(save)

Format:
save
Possible values:
- save : save the database

optional parameter
save the database

2982

Released

3HH-04416-EBAA-TCZZA

01

125 Voice Management Commands

125.3 Voice Megaco Termination Lock Management


Command
Command Description
This command allows the operator to manage the voice megaco termination lock type.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
> admin voice cluster (cluster-id) equipment
<MEGACO::accTerminationLockType> ]

(equip-id)

port-id

<Itf::MegacoPotsLine>

lktype

Command Parameters
Table 125.3-1 "Voice Megaco Termination Lock Management Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- id of equipment
- range: [1...32]
Parameter type: <Itf::MegacoPotsLine>
Format:
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::NewSlotId> /
<Eqpt::MegacoPortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::NewSlotId>
- the LT slot number
Field type <Eqpt::MegacoPortId>
- the port number of Megaco

uniquely identify of this xvps


cluster

(equip-id)
port-id

uniquely
identify
equipment

of

this

unique
identifier
termination port

of

this

Table 125.3-2 "Voice Megaco Termination Lock Management Command" Command Parameters
Parameter

Type

Description

lktype

Parameter type: <MEGACO::accTerminationLockType>


Format:
( force

optional parameter
the termination lock type and
delay time

3HH-04416-EBAA-TCZZA 01

Released

2983

125 Voice Management Commands

Parameter

Type

Description

| graceful : <MEGACO::accTerminationLockDelay> )
Possible values:
- force : The termination lock type is force
- graceful : The termination lock type is graceful
Field type <MEGACO::accTerminationLockDelay>
- the delay timer before lock access termination
- unit: 1 msec
- range: [0...3600000]

2984

Released

3HH-04416-EBAA-TCZZA

01

125 Voice Management Commands

125.4 Voice Megaco Media Gateway Lock


Management Command
Command Description
This command allows the operator to manage the voice megaco media gateway lock type.

User Level
The command can be accessed by operators with megaco privileges, and executed by operators with megaco
privileges.

Command Syntax
The command has the following syntax:
>
admin
voice
cluster
(cluster-id)
media-gateway
(media-gateway-id)
[
lktype
<MEGACO::mediaGatewayLockType> ] [ trigger-esa-mgc <MEGACO::mediaGatewayTriggerESAMgc> ]

Command Parameters
Table 125.4-1 "Voice Megaco Media Gateway Lock Management Command" Resource Parameters
Resource Identifier

Type

Description

(cluster-id)

Format:
- the xvps cluster id
- range: [1...8]
Format:
- the media gateway table index
- range: [1]

uniquely identify of this xvps


cluster

(media-gateway-id)

uniquely identify of this media


gateway

Table 125.4-2 "Voice Megaco Media Gateway Lock Management Command" Command
Parameters
Parameter

Type

Description

lktype

Parameter type: <MEGACO::mediaGatewayLockType>


Format:
( force
| graceful : <MEGACO::mediaGatewayLockDelay> )
Possible values:
- force : The media gateway lock type is force
- graceful : The media gateway lock type is graceful
Field type <MEGACO::mediaGatewayLockDelay>
- the timer of media gateway lock command
- unit: 1 msec
- range: [0...3600000]
Parameter
type:
<MEGACO::mediaGatewayTriggerESAMgc>
Format:

optional parameter
the media gateway lock type and
delay time

trigger-esa-mgc

3HH-04416-EBAA-TCZZA 01

optional parameter
failover to local ESA mgc or
failback to external normal mgc

Released

2985

125 Voice Management Commands

Parameter

Type

Description

( failover
| failback )
Possible values:
- failover : failover to local ESA mgc
- failback : failback to external normal mgc

2986

Released

3HH-04416-EBAA-TCZZA

01

126- MSTP Management Commands

126.1 MSTP Management Command Tree


126.2 MSTP Port Management Command

3HH-04416-EBAA-TCZZA 01

126-2988
126-2989

Released

2987

126 MSTP Management Commands

126.1 MSTP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "MSTP Management Commands".

Command Tree
----admin
----xstp
----port
- (port)
- (clear-protocols)

2988

Released

3HH-04416-EBAA-TCZZA

01

126 MSTP Management Commands

126.2 MSTP Port Management Command


Command Description
This command allows the operator to manage MSTP related to a port.

User Level
The command can be accessed by operators with mstp privileges, and executed by operators with mstp privileges.

Command Syntax
The command has the following syntax:
> admin xstp port (port) [ (clear-protocols) ]

Command Parameters
Table 126.2-1 "MSTP Port Management Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
interface index of the lag
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 126.2-2 "MSTP Port Management Command" Command Parameters


Parameter

Type

Description

(clear-protocols)

Format:
clear-protocols
Possible values:
- clear-protocols : clear the list of detected protocols

optional parameter
clear the list of detected protocols

3HH-04416-EBAA-TCZZA 01

Released

2989

127- Distributed Service Management Commands

127.1 Distributed Service Management Command Tree


127.2 APIPE-PVC Statistics Command

2990

Released

127-2991
127-2992

3HH-04416-EBAA-TCZZA

01

127 Distributed Service Management Commands

127.1 Distributed Service Management Command


Tree
Description
This chapter gives an overview of nodes that are handled by "Distributed Service Management Commands".

Command Tree
----admin
----dist-service
----statistics
----apipe-pvc
- (port-index)
- (clear)

3HH-04416-EBAA-TCZZA 01

Released

2991

127 Distributed Service Management Commands

127.2 APIPE-PVC Statistics Command


Command Description
This command is to reset the APIPE-PVC statistics counters.

User Level
The command can be executed by operators with drouter privileges.

Command Syntax
The command has the following syntax:
> admin dist-service statistics apipe-pvc (port-index) (clear)

Command Parameters
Table 127.2-1 "APIPE-PVC Statistics Command" Resource Parameters
Resource Identifier

Type

(port-index)

Format:
the ATM PVC
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
:
<Eqpt::VpiMandatoryId>
:
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI

Description

Table 127.2-2 "APIPE-PVC Statistics Command" Command Parameters


Parameter

Type

Description

(clear)

Format:
clear
Possible values:
- clear : reset statistics counters

optional parameter
optional
parameter
APIPE-PVC counters

2992

Released

3HH-04416-EBAA-TCZZA

01

reset

128- CFM Unicast Loopback Management


Command.

128.1 CFM Unicast Loopback Management Command.


Tree
128.2 Unicast Loopback message Management Command

3HH-04416-EBAA-TCZZA 01

128-2994
128-2995

Released

2993

128 CFM Unicast Loopback Management Command.

128.1 CFM Unicast Loopback Management


Command. Tree
Description
This chapter gives an overview of nodes that are handled by "CFM Unicast Loopback Management Command.".

Command Tree
----admin
----cfm
----uclbm
- domain
- association
- mep
- dest-mac
- [no] nbr-msgs
- [no] lbm-tlv-type
- [no] lbm-data-len
- [no] lbm-data
- [no] test-bit-pattern
- [no] vlan-priority
- [no] vlan-drop-enable
- [no] vlan-drop-pcp

2994

Released

3HH-04416-EBAA-TCZZA

01

128 CFM Unicast Loopback Management Command.

128.2 Unicast Loopback message Management


Command
Command Description
This command initiates the test of Unicast Loopback messages.
A number of Loopback messages can be requested to be send from a specified MEP towards a specified destination
MAC address.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin cfm uclbm domain <Cfm::CfmDomainIndexType> association <Cfm::CfmMaIndexType> mep
<Cfm::MepIdType> dest-mac <Vlan::MacAddr> [ no nbr-msgs | nbr-msgs <Cfm::UcLbmNbrMsgType> ] [ no
lbm-tlv-type | lbm-tlv-type <Cfm::TlvType> ] [ no lbm-data-len | lbm-data-len <Cfm::LbmDataLenType> ] [ no
lbm-data | lbm-data <Cfm::LbmDataType> ] [ no test-bit-pattern | test-bit-pattern <Cfm::TestBitPatternType> ] [
no vlan-priority | vlan-priority <Vlan::Priority> ] [ no vlan-drop-enable | vlan-drop-enable
<Cfm::VlanDropEnableType> ] [ no vlan-drop-pcp | vlan-drop-pcp <Cfm::VlanDropPcpType> ]

Command Parameters
Table 128.2-2 "Unicast Loopback message Management Command" Command Parameters
Parameter

Type

domain

Parameter type: <Cfm::CfmDomainIndexType>


mandatory parameter
Format:
Maintenance Domain Index.
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
mandatory parameter
Format:
Maintenance Association Index.
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
mandatory parameter
Format:
Maintenance Association End
- MA End Point (MEP) ID. Unique within an MA
Point (MEP) ID. Unique within
- range: [1...8191]
an MA.
Parameter type: <Vlan::MacAddr>
mandatory parameter
Format:
The MAC address for the OAM
- mac address (aa:bb:cc:a1:02:03)
target: a unicast destination MAC
- length: 6
address in the Unicast Loopback
message.

association

mep

dest-mac

3HH-04416-EBAA-TCZZA 01

Description

Released

2995

128 CFM Unicast Loopback Management Command.

Parameter

Type

[no] nbr-msgs

Parameter type: <Cfm::UcLbmNbrMsgType>


optional parameter with default
Format:
value: 1L
- The number of Unicast Loopback messages to be The number of Unicast Loopback
transmitted.For GPON LT, the range is [1..2]
messages to be transmitted.
- range: [1...5]
Parameter type: <Cfm::TlvType>
optional parameter with default
Format:
value: "tlv-none"
( tlv-none
Specifies which TLV type is to
| data-tlv
be used for LBM.
| test-tlv )
Possible values:
- tlv-none : no TLV
- data-tlv : data TLV
- test-tlv : test TLV
Parameter type: <Cfm::LbmDataLenType>
optional parameter with default
Format:
value: 64L
- the length of the Data TLV
The value specifies the length of
- range: [0...1488]
the TLV. Specifying length zero
implies no TLV will be included
in LBM. Default length = 64
octets.
Parameter type: <Cfm::LbmDataType>
optional parameter with default
Format:
value: "00 : 00 : 00 : 00 : 00 : 00
- a binary string
: 00 : 00"
- length: 8
This 64 bit pattern is used
repetitively to fillup Data TLV,if
the Data TLV is selected to be
sent. Most significant bits are
used first.
Parameter type: <Cfm::TestBitPatternType>
optional parameter with default
Format:
value: "all-zeros-no-crc"
( all-zeros-no-crc
To specify which bit pattern type
| all-zeros-crc
to use in the Test TLV within a
| prbs-no-crc
unicast
LBM.
Default
=
| prbs-crc
allZerosNoCrc
| all-ones-no-crc
| all-ones-crc
| <SignedInteger> )
Possible values:
- all-zeros-no-crc : A bit pattern with all zero's without CRC.
- all-zeros-crc : A bit pattern with all zero's with CRC.
- prbs-no-crc : A Pseudo Random Bit Sequence of type
(2^31)-1, according ITU-T O.150, without CRC.
- prbs-crc : A Pseudo Random Bit Sequence of type
(2^31)-1, according ITU-T O.150, with CRC.
- all-ones-no-crc : A bit pattern with all one's without CRC.
- all-ones-crc : A bit pattern with all one's with CRC.
Field type <SignedInteger>
- a signed integer
Parameter type: <Vlan::Priority>
optional parameter with default
Format:
value: 7L
- priority of ethernet frames
Priority. A 3 bit value to be used
- range: [0...7]
in the VLAN tag, if present in the
transmitted frame. Default = 7
decimal.
Parameter type: <Cfm::VlanDropEnableType>
optional parameter with default
Format:
value: "no-drop"

[no] lbm-tlv-type

[no] lbm-data-len

[no] lbm-data

[no] test-bit-pattern

[no] vlan-priority

[no] vlan-drop-enable

2996

Released

Description

3HH-04416-EBAA-TCZZA

01

128 CFM Unicast Loopback Management Command.

Parameter

[no] vlan-drop-pcp

Type

Description

( no-drop
Parameter indicating whether the
| pcp
packet must be marked as drop
| dei
eligible.
| <SignedInteger> )
Possible values:
- no-drop : Packet must not be marked as drop eligible.
- pcp : Priority Code Point encoding to be used.
- dei : Drop eligible indicator to be used. Can only be used
in context of an S-VLAN.
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::VlanDropPcpType>
optional parameter with default
Format:
value: "pcp8p0d"
( pcp8p0d
Defines the Priority Code Point
| pcp7p1d
encoding rule used.
| pcp6p2d
| pcp5p3d
| <SignedInteger> )
Possible values:
- pcp8p0d : Priority encoding rule to be applied.
- pcp7p1d : Priority encoding rule to be applied.
- pcp6p2d : Priority encoding rule to be applied.
- pcp5p3d : Priority encoding rule to be applied.
Field type <SignedInteger>
- a signed integer

Command Output
Table 128.2-3 "Unicast Loopback message Management Command" Display parameters
Specific Information
name
result

lbr-in

Type

Description

Parameter type: <Cfm::CfmOamResult>


( test-done
| test-in-progress
| internal-failure )
Possible values:
- test-done :
- test-in-progress :
- internal-failure :
Parameter type: <Counter>
- 32 bit counter

Result of the command.


This element is only shown in
detail mode.

lbr-in-ooo

Parameter type: <Counter>


- 32 bit counter

lbr-bad-msdu

Parameter type: <Counter>


- 32 bit counter

3HH-04416-EBAA-TCZZA 01

Total number of valid, in-order


Loopback Replies received.
This element is only shown in
detail mode.
The total number of valid,
out-of-order Loopback Replies
received.
This element is only shown in
detail mode.
The total number of LBRs
received
whose
mac_service_data_unit did not
match (except for the OpCode)
that of the corresponding LBM
This element is only shown in
detail mode.

Released

2997

128 CFM Unicast Loopback Management Command.

2998

Released

3HH-04416-EBAA-TCZZA

01

129- CFM Multicast Loopback Management


Command

129.1 CFM Multicast Loopback Management Command


Tree
129.2 Multicast Loopback message Management
Command

3HH-04416-EBAA-TCZZA 01

129-3000
129-3001

Released

2999

129 CFM Multicast Loopback Management Command

129.1 CFM Multicast Loopback Management


Command Tree
Description
This chapter gives an overview of nodes that are handled by "CFM Multicast Loopback Management Command".

Command Tree
----admin
----cfm
----mclbm
----domain
- (domain-index)
- association
- mep
- [no] vlan-priority
- [no] lbm-data-len
- [no] lbm-data

3000

Released

3HH-04416-EBAA-TCZZA

01

129 CFM Multicast Loopback Management Command

129.2 Multicast Loopback message Management


Command
Command Description
This command initiates the sending of a Multicast Loopback message.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin cfm mclbm domain (domain-index) association <Cfm::CfmMaIndexType> mep <Cfm::MepIdType> [ no
vlan-priority | vlan-priority <Vlan::Priority> ] [ no lbm-data-len | lbm-data-len <Cfm::LbmDataLenType> ] [ no
lbm-data | lbm-data <Cfm::LbmDataType> ]

Command Parameters
Table 129.2-1 "Multicast Loopback message Management Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]

Maintenance Domain Index.


Note: This is in fact not realy a
resourceId, but one of the
mandatory parameters.

Table 129.2-2 "Multicast Loopback message Management Command" Command Parameters


Parameter

Type

association

Parameter type: <Cfm::CfmMaIndexType>


mandatory parameter
Format:
Maintenance Association Index
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
mandatory parameter
Format:
Maintenance Association End
- MA End Point (MEP) ID. Unique within an MA
Point (MEP) ID. Unique within
- range: [1...8191]
an MA
Parameter type: <Vlan::Priority>
optional parameter with default
Format:
value: 7L
- priority of ethernet frames
Priority. A 3 bit value to be used
- range: [0...7]
in the VLAN tag, if present in the
transmitted frame. Default = 7
decimal.
Parameter type: <Cfm::LbmDataLenType>
optional parameter with default
Format:
value: 64L

mep

[no] vlan-priority

[no] lbm-data-len

3HH-04416-EBAA-TCZZA 01

Description

Released

3001

129 CFM Multicast Loopback Management Command

Parameter

[no] lbm-data

Type

Description

- the length of the Data TLV


- range: [0...1488]

The value specifies the length of


the Data TLV. Specifying length
zero implies no Data TLV will be
included in LBM.
optional parameter with default
value: "00 : 00 : 00 : 00 : 00 : 00
: 00 : 00"
This 64 bit pattern is used
repetitively to fillup Data TLV,if
the Data TLV is selected to be
sent. Most significant bits are
used first.

Parameter type: <Cfm::LbmDataType>


Format:
- a binary string
- length: 8

Command Output
Table 129.2-3 "Multicast Loopback message Management Command" Display parameters
Specific Information
name

Type

Description

reply-nr

Parameter type: <Counter>


- 32 bit counter

result

Parameter type: <Cfm::CfmOamResult>


( test-done
| test-in-progress
| internal-failure )
Possible values:
- test-done :
- test-in-progress :
- internal-failure :
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

ResultNbr. of the received LBR.


This element is only shown in
detail mode.
Result of the command.
This element is only shown in
detail mode.

mac

3002

Released

MAC address of the peer MEP


that sent the LBR message.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

130- CFM Linktrace management command

130.1 CFM Linktrace management command Tree


130.2 Linktrace message Management Command

3HH-04416-EBAA-TCZZA 01

130-3004
130-3005

Released

3003

130 CFM Linktrace management command

130.1 CFM Linktrace management command Tree


Description
This chapter gives an overview of nodes that are handled by "CFM Linktrace management command".

Command Tree
----admin
----cfm
----ltm
----domain
- (domain-index)
- association
- mep
- target-mac
- [no] vlan-priority
- [no] ttl
- [no] fdb-only-bit

3004

Released

3HH-04416-EBAA-TCZZA

01

130 CFM Linktrace management command

130.2 Linktrace message Management Command


Command Description
This command initiates the sending of a Linktrace message.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin cfm ltm domain (domain-index) association <Cfm::CfmMaIndexType> mep <Cfm::MepIdType>
target-mac <Vlan::MacAddr> [ no vlan-priority | vlan-priority <Vlan::Priority> ] [ no ttl | ttl <Cfm::TtlLtmType> ]
[ no fdb-only-bit | fdb-only-bit <Cfm::FdbOnlyType> ]

Command Parameters
Table 130.2-1 "Linktrace message Management Command" Resource Parameters
Resource Identifier

Type

Description

(domain-index)

Format:
- Maintenance Domain (MD) index
- range: [1...4294967295]

Maintenance Domain Index.


Note: This is in fact not realy a
resourceId, but one of the
mandatory parameters.

Table 130.2-2 "Linktrace message Management Command" Command Parameters


Parameter

Type

association

Parameter type: <Cfm::CfmMaIndexType>


mandatory parameter
Format:
Maintenance Association Index.
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
mandatory parameter
Format:
Maintenance Association End
- MA End Point (MEP) ID. Unique within an MA
Point (MEP) ID. Unique within
- range: [1...8191]
an MA.
Parameter type: <Vlan::MacAddr>
mandatory parameter
Format:
MAC address within the payload
- mac address (aa:bb:cc:a1:02:03)
of the LTM. The destination
- length: 6
MAC address is calculated by the
system.
Parameter type: <Vlan::Priority>
optional parameter with default
Format:
value: 7L
- priority of ethernet frames
Priority. A 3 bit value to be used
- range: [0...7]
in the VLAN tag, if present in the
transmitted frame. Default = 7
decimal.

mep

target-mac

[no] vlan-priority

3HH-04416-EBAA-TCZZA 01

Description

Released

3005

130 CFM Linktrace management command

Parameter

Type

Description

[no] ttl

Parameter type: <Cfm::TtlLtmType>


Format:
- Range of allowed ttl values.
- range: [0...255]

[no] fdb-only-bit

Parameter type: <Cfm::FdbOnlyType>


Format:
( true
| false )
Possible values:
- true : sets use-fdb-only bit within an LTM to true.
- false : sets use-fdb-only bit within an LTM to false.

optional parameter with default


value: 64L
The maximum number of hops
the LTM may pass. Default value
is 64.
optional parameter with default
value: "true"
Indication to use Filtering
Database.

Command Output
Table 130.2-3 "Linktrace message Management Command" Display parameters
Specific Information
name

Type

Description

receive-order-nbr

Parameter type: <Counter>


- 32 bit counter

result

Parameter type: <Cfm::CfmOamResult>


( test-done
| test-in-progress
| internal-failure )
Possible values:
- test-done :
- test-in-progress :
- internal-failure :
Parameter type: <Cfm::EgressIdType>
- a binary string
- length: 8

Order number of the received


LTR.
This element is only shown in
detail mode.
Result of the command.
This element is only shown in
detail mode.

orig-egress-id

ltm-seq-nbr

Parameter type: <Counter>


- 32 bit counter

nbr-unexp-ltr

Parameter type: <Counter>


- 32 bit counter

ttl-in-ltr

Parameter type: <Cfm::TtlLtrType>


- Range of allowed ttl values.
- range: [0...255]

ltr-forwarded

Parameter type: <Cfm::LtrFwdType>


( true
| false )

3006

Released

The MEP that is originating the


LTM. The low-order(highest
numbered) octets contain a 48-bit
IEEE MAC address unique to the
system in which the MEP resides.
The
high-order
(lowest
numbered) two octets are set to
zero.
This element is only shown in
detail mode.
The LTM Transaction Identifier
of the LTM sent.
This element is only shown in
detail mode.
The total number of unexpected
LTRs received during the
duration of the LTM test.
This element is only shown in
detail mode.
TTL value indicated in the
received LTR.
This element is only shown in
detail mode.
Indicates if a LTM was
forwarded by the responding
maintenance point.

3HH-04416-EBAA-TCZZA

01

130 CFM Linktrace management command

name

terminal-mep

last-egress-id

Type

Description

Possible values:
- true : FwdYes-flag within received LTR is true.
- false : FwdYes-flag within received LTR is false.
Parameter type: <Cfm::TermMepType>
( true
| false )
Possible values:
- true : TerminalMEP-flag within received LTR is true.
- false : TerminalMEP-flag within received LTR is false.
Parameter type: <Cfm::EgressIdType>
- a binary string
- length: 8

This element is only shown in


detail mode.

next-egress-id

Parameter type: <Cfm::EgressIdType>


- a binary string
- length: 8

ltr-relay

Parameter type: <Cfm::RelayActionFieldValueType>


( rly-hit
| rly-fdb
| rly-mpdb
| <SignedInteger> )
Possible values:
- rly-hit : The LTM reached an MP whose MAC address
matches the target MAC address.
- rly-fdb : The Egress port was determined by consulting the
Filtering DB.
- rly-mpdb : The Egress port was determined by consulting
the MIP CCM DB.
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::LldpChassisIdSubtype>
( not-applic
| chassis-component
| interface-alias
| port-component
| mac-address
| network-address
| interface-name
| local
| <SignedInteger> )
Possible values:
- not-applic : not applicable
- chassis-component : Reference IETF RFC 2737
- interface-alias : Reference IETF RFC 2863
- port-component : Reference IETF RFC 2737

chassis-id-format

3HH-04416-EBAA-TCZZA 01

Indicates if a LTM reached a


MEP enclosing its MA.
This element is only shown in
detail mode.
An octet field holding the Last
Egress Identifier returned in the
LTR Egress Identifier TLV of the
LTR. This identifier identifies the
MEP Linktrace Initiator that
originated, or the Linktrace
Responder that forwarded, the
LTM to which this LTR is the
response.
This element is only shown in
detail mode.
An octet field holding the Next
Egress Identifier returned in the
LTR Egress Identifier TLV of the
LTR. This identifier identifies the
Linktrace
Responder
that
transmitted this LTR.
This element is only shown in
detail mode.
Value returned in the Relay
Action field.
This element is only shown in
detail mode.

Specifies the format of the


Chassis ID returned in the Sender
ID TLV of the LTR, if present.
This element is only shown in
detail mode.

Released

3007

130 CFM Linktrace management command

name

Type

Description

- mac-address :
- network-address :
- interface-name : Reference IETF RFC 2863
- local : An alph-numeric string.
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::LldpChassisIdType>
- a variable length octet string 0..16
- length: x<=16

chassis-id

mgmt-addr-domain

Parameter type: <Object>


- an object identifier

mgmt-addr

Parameter type: <Cfm::MgmtAddrType>


- a variable length octet string 0..50
- length: x<=50
Parameter type: <Cfm::IngressActionFieldValueType>
( ingress-no-tlv
| ingress-ok
| ingress-down
| ingress-blocked
| ingress-vid
| <SignedInteger> )
Possible values:
- ingress-no-tlv : There is no Reply Ingress TLV.
- ingress-ok : The target data frame would be passed through
to the MAC Relay Entity.
- ingress-down : The bridge Port's MAC_Operational
parameter is false
- ingress-blocked : The target data frame would not be
forwarded if received on this port.
- ingress-vid : The ingress port is not in the member set of
the LTM's VID.
Field type <SignedInteger>
- a signed integer
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6

ltr-ingress

ingr-mac

ingr-portid-stype

3008

Parameter type: <Cfm::LldpPortIdSubtype>


( none
| interface-alias
| port-component
| mac-address
| network-address
| interface-name
| agent-circuit-id
| local
| <SignedInteger> )
Possible values:
- none :
- interface-alias :

Released

The Chassis ID returned in the


Sender ID TLV of the LTR, if
present.
This element is only shown in
detail mode.
The TDomain that identifies the
type and format of the address of
the SNMP agent of the system
transmitting the LTR.
This element is only shown in
detail mode.
This element is only shown in
detail mode.
The value returned in the Ingress
Action Field of the Reply Ingress
TLV of the LTR.
This element is only shown in
detail mode.

MAC address returned in the


ingress MAC address field of the
Reply ingress TLV of the LTR.
This element is only shown in
detail mode.
Format of the Ingress port ID.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

130 CFM Linktrace management command

name

ingr-portid
ltr-egress

egr-mac

egr-portid-stype

egr-portid

3HH-04416-EBAA-TCZZA 01

Type

Description

- port-component :
- mac-address :
- network-address :
- interface-name :
- agent-circuit-id :
- local :
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::LldpPortIdType>
- a variable length octet string 0..16
- length: x<=16
Parameter type: <Cfm::EgressActionFieldValueType>
( egress-no-tlv
| egress-ok
| egress-down
| egress-blocked
| egress-vid
| <SignedInteger> )
Possible values:
- egress-no-tlv : There is no Reply Egress TLV.
- egress-ok : The target data frame would be forwarded.
- egress-down : The egress port can be identified, but that
bridge Port's MAC_Operational parameter is false
- egress-blocked : The target data frame would not pass
through the egress port.
- egress-vid : The egress port can be identified, but the
bridge port is not in the LTM's VID member set.
Field type <SignedInteger>
- a signed integer
Parameter type: <Vlan::MacAddr>
- mac address (aa:bb:cc:a1:02:03)
- length: 6
Parameter type: <Cfm::LldpPortIdSubtype>
( none
| interface-alias
| port-component
| mac-address
| network-address
| interface-name
| agent-circuit-id
| local
| <SignedInteger> )
Possible values:
- none :
- interface-alias :
- port-component :
- mac-address :
- network-address :
- interface-name :
- agent-circuit-id :
- local :
Field type <SignedInteger>
- a signed integer
Parameter type: <Cfm::LldpPortIdType>
- a variable length octet string 0..16

The Ingress port ID.


This element is only shown in
detail mode.
The value returned in the Egress
Action Field of the Reply Egress
TLV of the LTR.
This element is only shown in
detail mode.

MAC address returned in the


egress MAC address field of the
Reply egress TLV of the LTR.
This element is only shown in
detail mode.
Format of the Egress port ID.
This element is only shown in
detail mode.

The Egress port ID.


This element is only shown in

Released

3009

130 CFM Linktrace management command

name
org-spec-tlv

3010

Released

Type

Description

- length: x<=16
Parameter type: <Cfm::OrgSpecTlvType>
- a variable length octet string 0..7
- length: x<=7

detail mode.
All Orginzation specific TLVs
returned in the LTR, if any.
This element is only shown in
detail mode.

3HH-04416-EBAA-TCZZA

01

131- CFM Single Ended Synthetic Loss


Measurement message Management Command

131.1 CFM Single Ended Synthetic Loss Measurement


message Management Command Tree
131.2 Single Ended Synthetic Loss Measurement message
Management Command

3HH-04416-EBAA-TCZZA 01

131-3012
131-3013

Released

3011

131 CFM Single Ended Synthetic Loss Measurement message Management Command

131.1 CFM Single Ended Synthetic Loss


Measurement message Management Command
Tree
Description
This chapter gives an overview of nodes that are handled by "CFM Single Ended Synthetic Loss Measurement
message Management Command".

Command Tree
----admin
----cfm
----single-ended-slm
----domain
- (domain)
- association
- mep
- target-mac
- [no] send-count
- [no] size
- [no] timeout
- [no] interval
- [no] priority

3012

Released

3HH-04416-EBAA-TCZZA

01

131 CFM Single Ended Synthetic Loss Measurement message Management Command

131.2 Single Ended Synthetic Loss Measurement


message Management Command
Command Description
This command initiates the test of Single Ended Synthetic Loss Measurement messages.
A number of Single Ended Synthetic Loss Measurement messages can be requested to be send from a specified
MEP towards a specified destination MAC address.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin cfm single-ended-slm domain (domain) association <Cfm::CfmMaIndexType> mep <Cfm::MepIdType>
target-mac <Vlan::MacAddr> [ no send-count | send-count <Cfm::SlmSendCountType> ] [ no size | size
<Cfm::SlmPacketSizeType> ] [ no timeout | timeout <Cfm::SlmTimeoutType> ] [ no interval | interval
<Cfm::SlmIntervalType> ] [ no priority | priority <Vlan::Priority> ]

Command Parameters
Table 131.2-1 "Single Ended Synthetic Loss Measurement message Management Command"
Resource Parameters
Resource Identifier

Type

(domain)

Format:
Maintenance Domain Index.
- Maintenance Domain (MD) index
- range: [1...4294967295]
Parameter type: <Cfm::CfmMaIndexType>
Maintenance Association Index.
Format:
- Maintenance Association (MA) index. Unique within an
MD
- range: [1...4294967295]
Parameter type: <Cfm::MepIdType>
Maintenance Association End
Format:
Point (MEP) ID. Unique within
- MA End Point (MEP) ID. Unique within an MA
an MA.
- range: [1...8191]
Parameter type: <Vlan::MacAddr>
The MAC address for the OAM
Format:
target: a unicast destination MAC
- mac address (aa:bb:cc:a1:02:03)
address used in the SLM.
- length: 6

association

mep

target-mac

Description

Table 131.2-2 "Single Ended Synthetic Loss Measurement message Management Command"
Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

3013

131 CFM Single Ended Synthetic Loss Measurement message Management Command

Parameter

Type

Description

[no] send-count

Parameter type: <Cfm::SlmSendCountType>


Format:
- The number of Synthetic Loss Measurement messages to
be transmitted.
- range: [1...100]
Parameter type: <Cfm::SlmPacketSizeType>
Format:
- The size of Synthetic Loss Measurement messages to be
transmitted.
- range: [0...1500]
Parameter type: <Cfm::SlmTimeoutType>
Format:
- The timeout for Synthetic Loss Measurement messages to
be transmitted.
- range: [5...10]
Parameter type: <Cfm::SlmIntervalType>
Format:
- The interval for Synthetic Loss Measurement messages to
be transmitted.
- range: [1...10]
Parameter type: <Vlan::Priority>
Format:
- priority of ethernet frames
- range: [0...7]

optional parameter with default


value: 1L
The number of SLM packets to
be sent. Allowed range : 1 to 100.

[no] size

[no] timeout

[no] interval

[no] priority

optional parameter with default


value: 0L
Size of data TLV. Allowed range
: 0 to 1500.
optional parameter with default
value: 5L
The timeout in seconds to wait
for each SLR. Allowed range : 5
to 10.
optional parameter with default
value: 5L
The interval in seconds between
each SLM packet to be sent.
Allowed range : 1 to 10.
optional parameter with default
value: 7L
Priority. A 3 bit value to be used
in the VLAN tag. Allowed range
: 0 to 7.

Command Output
Table 131.2-3 "Single Ended Synthetic Loss Measurement message Management Command"
Display parameters
Specific Information
name
remote-mep
slm-transmitted

Type

Description

Parameter type: <Cfm::MepIdType>


- MA End Point (MEP) ID. Unique within an MA
- range: [0,1...8191,65535]
Parameter type: <Counter>
- 32 bit counter

Remote Maintenance Association


End Point Id.
This element is always shown.
The total number of SLM
messages transmitted.
This element is always shown.
The total number of SLR
messages received.
This element is always shown.
The total number of Synthetic
Loss Reply messages transmitted
from the Remote MEP, but not
received at the Local MEP.
This element is always shown.
The total number of Synthetic
Loss Measurement messages
transmitted from the Local MEP,
but not received at the Remote
MEP.
This element is always shown.
The
total
number
of
unacknowledged Synthetic Loss
Measurement messages.
This element is always shown.

slr-received

Parameter type: <Counter>


- 32 bit counter

in-loss

Parameter type: <Cfm::SignedIntType>


- Signed Integer.
- range: [-2147483647...2147483647L]

out-loss

Parameter type: <Cfm::SignedIntType>


- Signed Integer.
- range: [-2147483647...2147483647L]

un-ack

Parameter type: <Cfm::SignedIntType>


- Signed Integer.
- range: [-2147483647...2147483647L]

3014

Released

3HH-04416-EBAA-TCZZA

01

131 CFM Single Ended Synthetic Loss Measurement message Management Command

name

Type

Description

test-id

Parameter type: <Cfm::SlmOnDemandTestIdType>


- The Test Id for On Demand Synthetic Loss Measurement
messages.
- range: [0...4294967295]

The Test Id for On Demand


Synthetic Loss Measurement
messages.
This element is always shown.

3HH-04416-EBAA-TCZZA 01

Released

3015

132- Efm Oam Management Command

132.1 Efm Oam Management Command Tree


132.2 Efm Oam Interface Management Command

3016

Released

132-3017
132-3018

3HH-04416-EBAA-TCZZA

01

132 Efm Oam Management Command

132.1 Efm Oam Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Efm Oam Management Command".

Command Tree
----admin
----efm-oam
----interface
- (interface)
- (loopback-action)
- (traffgen-action)

3HH-04416-EBAA-TCZZA 01

Released

3017

132 Efm Oam Management Command

132.2 Efm Oam Interface Management Command


Command Description
This management command allows next actions: - Enable / disable efm oam remote loopback on a peer device via
specified interface. - Start / stop internal traffic generator on specified interface in remote loopback.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> admin efm-oam interface (interface) [ (loopback-action) ] [ (traffgen-action) ]

Command Parameters
Table 132.2-1 "Efm Oam Interface Management Command" Resource Parameters
Resource Identifier

Type

(interface)

Format:
identification of EFM port /
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / Ethernet port
<Eqpt::PortId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 132.2-2 "Efm Oam Interface Management Command" Command Parameters


Parameter

Type

Description

(loopback-action)

Format:
( enable-loopback
| disable-loopback )
Possible values:
- enable-loopback : initiate loopback on specified itf
- disable-loopback : disable loopback on specified itf
Format:
( start-traff-gen
| stop-traff-gen )
Possible values:
- start-traff-gen : Starts the internal traffic generator on
specified itf
- stop-traff-gen : Stops the internal traffic generator on

optional parameter
enable or disable efm oam remote
loopback

(traffgen-action)

3018

Released

optional parameter
stop or start the internal traffic
generator

3HH-04416-EBAA-TCZZA

01

132 Efm Oam Management Command

Parameter

Type

Description

specified itf

3HH-04416-EBAA-TCZZA 01

Released

3019

133- Equipment Management Commands

133.1 Equipment Management Command Tree


133.2 Equipment Management Command
133.3 Slot Management Command
133.4 SHub Port Management Command

3020

Released

133-3021
133-3022
133-3023
133-3025

3HH-04416-EBAA-TCZZA

01

133 Equipment Management Commands

133.1 Equipment Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Equipment Management Commands".

Command Tree
----admin
----equipment
- (prepare-sys-shutdown)
- reboot-shub
- reboot-isam
----slot
- (index)
- reboot
- [no] overrule-sw
----port
- (port)
- copy-to-port

3HH-04416-EBAA-TCZZA 01

Released

3021

133 Equipment Management Commands

133.2 Equipment Management Command


Command Description
This command allows the operator to manage the node: prepare the system for shutdown, reset the node or reset
the SHub/IHub.
Note: An attempt to reset the SHub/IHub will be rejected.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment [ (prepare-sys-shutdown) ] [ reboot-shub <Sys::RestartValue> ] [ reboot-isam
<Equipm::SystemRestart> ]

Command Parameters
Table 133.2-2 "Equipment Management Command" Command Parameters
Parameter

Type

Description

(prepare-sys-shutdown)

Format:
prepare-sys-shutdown
Possible values:
- prepare-sys-shutdown : prepare the system for shutdown
Parameter type: <Sys::RestartValue>
Format:
( systemreset
| applicationreset )
Possible values:
- systemreset : restart the entire switch
- applicationreset : only restart the application modules,
excluding the BCM driver and VxWorks
Parameter type: <Equipm::SystemRestart>
Format:
( with-self-test
| without-self-test
| hot-restart )
Possible values:
- with-self-test : restart with selftest
- without-self-test : restart without selftest
- hot-restart : reboot, but don't touch the hardware

optional parameter
prepare the system for shutdown

reboot-shub

reboot-isam

3022

Released

optional parameter
reboot the shub

optional parameter
reboot the full isam (with xhub if
any)

3HH-04416-EBAA-TCZZA

01

133 Equipment Management Commands

133.3 Slot Management Command


Command Description
This command allows the operator to manage a slot and the units in the slot.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment slot (index) [ reboot <Equipm::BoardRestart> ] [ [ no ] overrule-sw ]

Command Parameters
Table 133.3-1 "Slot Management Command" Resource Parameters
Resource Identifier

Type

Description

(index)

Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| nt
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId>
| ctrl : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- nt : nt slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf
- acu : acu slot
- ctrl : ctrl-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::EqSlotId>
- the equipment slot number

the identification of the slot

3HH-04416-EBAA-TCZZA 01

Released

3023

133 Equipment Management Commands

Table 133.3-2 "Slot Management Command" Command Parameters


Parameter

Type

reboot

Parameter type: <Equipm::BoardRestart>


optional parameter
Format:
reboot the card in the slot
( with-selftest
| without-selftest
| hot-restart )
Possible values:
- with-selftest : reboot the board with self test
- without-selftest : reboot the board without self test
- hot-restart : reboot but don't touch the hardware (not for
LSM)
Parameter type: boolean
optional parameter

[no] overrule-sw

3024

Released

Description

3HH-04416-EBAA-TCZZA

01

133 Equipment Management Commands

133.4 SHub Port Management Command


Command Description
This command allows the operator to manage SHub ports.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment port (port) [ copy-to-port <Shub::NetworkPort> ]

Command Parameters
Table 133.4-1 "SHub Port Management Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

identification of a port

Table 133.4-2 "SHub Port Management Command" Command Parameters


Parameter

Type

Description

copy-to-port

Parameter type: <Shub::NetworkPort>


Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port

optional parameter
copy the port to another port

3HH-04416-EBAA-TCZZA 01

Released

3025

133 Equipment Management Commands

Parameter

Type

Description

- xfp : xfp port


- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub

3026

Released

3HH-04416-EBAA-TCZZA

01

134- Ethernet Management Commands

134.1 Ethernet Management Command Tree


134.2 Ethernet Management Command
134.3 Ethernet Statistics Commands

3HH-04416-EBAA-TCZZA 01

134-3028
134-3029
134-3030

Released

3027

134 Ethernet Management Commands

134.1 Ethernet Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Ethernet Management Commands".

Command Tree
----admin
----ethernet
----statistics
- (stats-index)
- (clear-stats)

3028

Released

3HH-04416-EBAA-TCZZA

01

134 Ethernet Management Commands

134.2 Ethernet Management Command


Command Description
This command allows the operator to manage the node: configure the ethernet parameters

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> admin ethernet

3HH-04416-EBAA-TCZZA 01

Released

3029

134 Ethernet Management Commands

134.3 Ethernet Statistics Commands


Command Description
This command allows the operator to reset the Ethernet counters.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> admin ethernet statistics (stats-index) (clear-stats)

Command Parameters
Table 134.3-1 "Ethernet Statistics Commands" Resource Parameters
Resource Identifier

Type

(stats-index)

Format:
index of the interface to an
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / ethernet-like medium
<Eqpt::PortId>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> )
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number

Description

Table 134.3-2 "Ethernet Statistics Commands" Command Parameters


Parameter

Type

Description

(clear-stats)

Format:
clear-stats
Possible values:
- clear-stats : clear all Ethernet counters

optional parameter
clear the ethernet counters

3030

Released

3HH-04416-EBAA-TCZZA

01

135- Bridge Management Commands

135.1 Bridge Management Command Tree


135.2 Learned Unicast MAC Address Management
Command
135.3 VLAN Management Command

3HH-04416-EBAA-TCZZA 01

135-3032
135-3033
135-3036

Released

3031

135 Bridge Management Commands

135.1 Bridge Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Bridge Management Commands".

Command Tree
----admin
----bridge
----learned-unicast-mac
- (vlan-port)
- unicast-mac-address
- (delete)
----vlan-id
- (id)
- (delete-member-ports)

3032

Released

3HH-04416-EBAA-TCZZA

01

135 Bridge Management Commands

135.2 Learned Unicast MAC Address Management


Command
Command Description
This command allows the operator to remove dynamically learned MAC addresses.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin bridge learned-unicast-mac (vlan-port) unicast-mac-address <Vlan::MacAddr> (delete)

Command Parameters
Table 135.2-1 "Learned Unicast MAC Address Management Command" Resource Parameters
Resource Identifier

Type

(vlan-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>

3HH-04416-EBAA-TCZZA 01

Description
vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:

Released

3033

135 Bridge Management Commands

Resource Identifier

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Parameter type: <Vlan::MacAddr>
unicast mac address
Format:
- mac address (aa:bb:cc:a1:02:03)
- length: 6

unicast-mac-address

Table 135.2-2 "Learned Unicast MAC Address Management Command" Command Parameters
Parameter

Type

Description

(delete)

Format:
delete

optional parameter
delete a learned unicast mac

3034

Released

3HH-04416-EBAA-TCZZA

01

135 Bridge Management Commands

Parameter

3HH-04416-EBAA-TCZZA 01

Type

Description

Possible values:
- delete : delete a unicast mac address

address

Released

3035

135 Bridge Management Commands

135.3 VLAN Management Command


Command Description
This command allows the operator to remove the association between a VLAN and all its member ports.
This command is the only means to remove dynamic associations.
Removal of the port VLAN association includes removal of all MAC addresses from the filtering database for these
port-VLAN associations.
Any outstanding duplicate MAC alarms for the port are cleared.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin bridge vlan-id (id) [ (delete-member-ports) ]

Command Parameters
Table 135.3-1 "VLAN Management Command" Resource Parameters
Resource Identifier

Type

Description

(id)

Format:
( <Vlan::UVlanIndex>
| stacked : <Vlan::SVlanIndex> : <Vlan::CVlanIndex> )
Possible values:
- stacked : stacked vlan identity
Field type <Vlan::UVlanIndex>
- unstacked vlan identity
- range: [1...4093,4096]
Field type <Vlan::SVlanIndex>
- service vlan identity
- range: [2...4093]
Field type <Vlan::CVlanIndex>
- customer vlan identity
- range: [0...4093,4096]

vlan id

Table 135.3-2 "VLAN Management Command" Command Parameters


Parameter

Type

Description

(delete-member-ports)

Format:
delete-member-ports
Possible values:
- delete-member-ports : remove associated bridge ports

optional parameter
remove association between a
vlan and all it's bridge ports

3036

Released

3HH-04416-EBAA-TCZZA

01

136- Trap Management Commands

136.1 Trap Management Command Tree


136.2 Trap Manager Management Command

3HH-04416-EBAA-TCZZA 01

136-3038
136-3039

Released

3037

136 Trap Management Commands

136.1 Trap Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Trap Management Commands".

Command Tree
----admin
----trap
----manager
- (address)
- (reset-trap-buffer)

3038

Released

3HH-04416-EBAA-TCZZA

01

136 Trap Management Commands

136.2 Trap Manager Management Command


Command Description
This command allows the operator to manage a trap manager.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin trap manager (address) [ (reset-trap-buffer) ]

Command Parameters
Table 136.2-1 "Trap Manager Management Command" Resource Parameters
Resource Identifier

Type

Description

(address)

Format:
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]

the IP address of the manager

Table 136.2-2 "Trap Manager Management Command" Command Parameters


Parameter

Type

Description

(reset-trap-buffer)

Format:
reset-trap-buffer
Possible values:
- reset-trap-buffer : reset the trap buffer

optional parameter
reset the trap buffer

3HH-04416-EBAA-TCZZA 01

Released

3039

137- Interface Management commands

137.1 Interface Management commands Tree


137.2 Interface Troubleshooting Ethernet Statistics
Commands
137.3 Shub Troubleshooting Statistics Management
Command
137.4 Interface Shub Ethernet Statistics Management
Command

3040

Released

137-3041
137-3042
137-3043
137-3045

3HH-04416-EBAA-TCZZA

01

137 Interface Management commands

137.1 Interface Management commands Tree


Description
This chapter gives an overview of nodes that are handled by "Interface Management commands".

Command Tree
----admin
----interface
----trouble-shooting
----ethernet
----statistics
- (slot-id)
- (clr-trbt-eth-stats)
----shub
----trouble-shooting
----statistics
- (port)
- (clr-trbt-stats)
----eth-frame
----statistics
- (port)
- [no] eth-stats

3HH-04416-EBAA-TCZZA 01

Released

3041

137 Interface Management commands

137.2 Interface Troubleshooting Ethernet Statistics


Commands
Command Description
This command allows the operator to reset the FD-REM trouble-shooting counters at the far-end side.This Clear
command is supported only for NDLT-G and NELT-B LT card, Error will be thrown for other LT cards.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin interface trouble-shooting ethernet statistics (slot-id) (clr-trbt-eth-stats)

Command Parameters
Table 137.2-1 "Interface Troubleshooting Ethernet Statistics Commands" Resource Parameters
Resource Identifier

Type

Description

(slot-id)

Format:
lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
Possible values:
- lt : lt-slot
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number

slot

Table 137.2-2 "Interface Troubleshooting Ethernet Statistics Commands" Command Parameters


Parameter

Type

Description

(clr-trbt-eth-stats)

Format:
clr-trbt-eth-stats
Possible values:
- clr-trbt-eth-stats : clear all trouble shooting counters

optional parameter
clear the trouble
counters

3042

Released

3HH-04416-EBAA-TCZZA

01

shooting

137 Interface Management commands

137.3 Shub Troubleshooting Statistics


Management Command
Command Description
This command allows the operator to reset the FD-REM trouble-shooting counters (applicable to only
NANT-A).Counters are reset only at the software level and will not have effect at the hardware.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin interface shub trouble-shooting statistics (port) (clr-trbt-stats)

Command Parameters
Table 137.3-1 "Shub Troubleshooting Statistics Management Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

port number

3HH-04416-EBAA-TCZZA 01

Released

3043

137 Interface Management commands

Table 137.3-2 "Shub Troubleshooting Statistics Management Command" Command Parameters


Parameter

Type

Description

(clr-trbt-stats)

Format:
clr-trbt-stats
Possible values:
- clr-trbt-stats : clear all trouble shooting counters

optional parameter
clear the trouble
counters

3044

Released

3HH-04416-EBAA-TCZZA

01

shooting

137 Interface Management commands

137.4 Interface Shub Ethernet Statistics


Management Command
Command Description
This command allows the operator to enable ethernet statistics counters per port. Default value is disable.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin interface shub eth-frame statistics (port) [ no eth-stats | eth-stats <Shub::CollectionStatus> ]

Command Parameters
Table 137.4-1 "Interface Shub Ethernet Statistics Management Command" Resource Parameters
Resource Identifier

Type

Description

(port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| <Shub::NetworkPort> )
Possible values:
- nt : active nt slot
- lt : port of the line board
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::NetworkPort>
- network port on Shub
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Shub::SlotId>
- the egress lt slot

shub uplink port number

Table 137.4-2 "Interface Shub Ethernet Statistics Management Command" Command Parameters

3HH-04416-EBAA-TCZZA 01

Released

3045

137 Interface Management commands

Parameter

Type

Description

[no] eth-stats

Parameter type: <Shub::CollectionStatus>


Format:
( disable
| enable )
Possible values:
- disable : disable ethernet frame statistics
- enable : enable ethernet frame statistics

optional parameter with default


value: "disable"
enable or disable ethernet frame
statistics collection

3046

Released

3HH-04416-EBAA-TCZZA

01

138- IP Management Commands

138.1 IP Management Command Tree


138.2 Slot-related VRF Management Command
138.3 IP VRF Interface Reset Management Command
138.4 IP VRF Interface bridgeport Reset Management
Command
138.5 Vlan Interface Delete Command
138.6 ARP statistics Management Command
138.7 SHub ARP Statistics Management Command

3HH-04416-EBAA-TCZZA 01

138-3048
138-3049
138-3050
138-3052
138-3054
138-3055
138-3057

Released

3047

138 IP Management Commands

138.1 IP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "IP Management Commands".

Command Tree
----admin
----ip
----vrf-media
- (vrf-slot)
- ip-address
- (remove)
----vrf-stats
- (vrf-id)
----interface
----user
----port
- (port-interface)
- reset
----X bridgeport
- (port-interface)
- reset
----vlan-itf-delete
- (vlanid)
----arp-proxy-stats
- (user-port)
- (clear-statistics)
----shub
----arp-stats
- (vrf-id)
- (clear-statistics)

3048

Released

3HH-04416-EBAA-TCZZA

01

138 IP Management Commands

138.2 Slot-related VRF Management Command


Command Description
This command allows the operator to manage the slot-related VRF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip vrf-media (vrf-slot) ip-address <Ip::V4AddressHex> (remove)

Command Parameters
Table 138.2-1 "Slot-related VRF Management Command" Resource Parameters
Resource Identifier

Type

(vrf-slot)

Format:
equipment slot ID.
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> :
<Eqpt::VrfId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::VrfId>
- VRF id
Parameter type: <Ip::V4AddressHex>
ip address
Format:
- IPv4-address

ip-address

Description

Table 138.2-2 "Slot-related VRF Management Command" Command Parameters


Parameter

Type

Description

(remove)

Format:
remove
Possible values:
- remove : remove the entry

optional parameter
remove the entry

3HH-04416-EBAA-TCZZA 01

Released

3049

138 IP Management Commands

138.3 IP VRF Interface Reset Management


Command
Command Description
This command allows the operator to reset the VRF interface counters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip vrf-stats (vrf-id) interface user port (port-interface) reset <Vrf::AdminCounter>

Command Parameters
Table 138.3-1 "IP VRF Interface Reset Management Command" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>

the vrf index

(port-interface)

3050

Released

identification of the port or


/ virtual channel
:
/
/
:
/
:
/
/
:
/
:
/
/

3HH-04416-EBAA-TCZZA

01

138 IP Management Commands

Resource Identifier

Type

Description

<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 138.3-2 "IP VRF Interface Reset Management Command" Command Parameters
Parameter

Type

Description

reset

Parameter type: <Vrf::AdminCounter>


Format:
counter
Possible values:
- counter : reset the vrf interface counter

optional parameter
reset the vrf interface counter

3HH-04416-EBAA-TCZZA 01

Released

3051

138 IP Management Commands

138.4 IP VRF Interface bridgeport Reset


Management Command
Command Description
Obsolete command, replaced by admin ip vrf-stats (vrf-id) interface user port.
This command allows the operator to reset VRF user interface bridge port counters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip vrf-stats (vrf-id) interface user bridgeport (port-interface) reset <Vrf::AdminCounter>
Obsolete command, replaced by admin ip vrf-stats (vrf-id) interface user port.

Command Parameters
Table 138.4-1 "IP VRF Interface bridgeport Reset Management Command" Resource Parameters
Resource Identifier

Type

(vrf-id)

Format:
the vrf index
- the VRF ID which uniquely identify a VRF
- range: [1...127]
Format:
identification of the port or
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / virtual channel
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

(port-interface)

Description

Table 138.4-2 "IP VRF Interface bridgeport Reset Management Command" Command Parameters

3052

Released

3HH-04416-EBAA-TCZZA

01

138 IP Management Commands

Parameter

Type

Description

reset

Parameter type: <Vrf::AdminCounter>


Format:
counter
Possible values:
- counter : reset the vrf interface counter

optional parameter
reset the vrf interface counter

3HH-04416-EBAA-TCZZA 01

Released

3053

138 IP Management Commands

138.5 Vlan Interface Delete Command


Command Description
This command is used only to delete an unassociated vlan interface with a vrf in router mode.
A vrf configured in router mode can be associated with only one vlan interface. If the user tries to associate
another vlan interface with the same vrf , CLI provides an error , but deletion of the unassociated vlan is not
possible directly. Please use this admin command only to remove the unassociated vlan interface.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin ip vlan-itf-delete (vlanid)

Command Parameters
Table 138.5-1 "Vlan Interface Delete Command" Resource Parameters
Resource Identifier

Type

Description

(vlanid)

Format:
- vlan id
- range: [1...4093]

vlan id

3054

Released

3HH-04416-EBAA-TCZZA

01

138 IP Management Commands

138.6 ARP statistics Management Command


Command Description
This command allows the operator to manage the ARP statistic commands.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip arp-proxy-stats (user-port) (clear-statistics)

Command Parameters
Table 138.6-1 "ARP statistics Management Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
( atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| atm-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| bridge-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> )
Possible values:
- atm-port : atm port
- bridge-port : bridge port

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
:
/
/
:
/
:
/
/
:
/
:
/
/
/

Released

3055

138 IP Management Commands

Resource Identifier

Type

Description

- vlan-port : vlan port


Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 138.6-2 "ARP statistics Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the IPoX counters

3056

Released

3HH-04416-EBAA-TCZZA

01

138 IP Management Commands

138.7 SHub ARP Statistics Management Command


Command Description
This command allows the operator to reset the arp counters of a particular VRF in the Shub.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip shub arp-stats (vrf-id) (clear-statistics)

Command Parameters
Table 138.7-1 "SHub ARP Statistics Management Command" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf index

Table 138.7-2 "SHub ARP Statistics Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the vrf arp statistics

optional parameter
reset the vrf arp counters for the
vrf

3HH-04416-EBAA-TCZZA 01

Released

3057

139- DHCP Management Command

139.1 DHCP Management Command Tree


139.2 DHCP Relay User Port Management Command
139.3 DHCP Relay User Port Management Command
139.4 SHub DHCP Relay Agent Statistics Management
Command

3058

Released

139-3059
139-3060
139-3063
139-3065

3HH-04416-EBAA-TCZZA

01

139 DHCP Management Command

139.1 DHCP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "DHCP Management Command".

Command Tree
----admin
----dhcp-relay
----port-stats
- (user-port)
- (clear-statistics)
----v6-port-stats
- (user-port)
- (clear-statistics)
----shub
----vrf-agent-stats
- (vrf-id)
- (clear-statistics)

3HH-04416-EBAA-TCZZA 01

Released

3059

139 DHCP Management Command

139.2 DHCP Relay User Port Management


Command
Command Description
This command allows the operator to manage the DHCP relay user port commands.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> admin dhcp-relay port-stats (user-port) (clear-statistics)

Command Parameters
Table 139.2-1 "DHCP Relay User Port Management Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
identification of the ip user
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / interface or vlan port
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> :
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PortId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : stacked : <Eqpt::SVlan> :
<Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId> : <Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId> /
<Eqpt::OntPortId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /

3060

Released

Description

3HH-04416-EBAA-TCZZA

01

139 DHCP Management Command

Resource Identifier

Type

Description

<Eqpt::PonId> / <Eqpt::OntId> / voip : stacked :


<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
voip
:
<Eqpt::UnstackedVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId>
/
<Eqpt::OntId>
/
vuni
:
<Eqpt::UnstackedVlan>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> : stacked :
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> /
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> :
<Eqpt::UnstackedVlan> )
Possible values:
- vlan : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id

3HH-04416-EBAA-TCZZA 01

Released

3061

139 DHCP Management Command

Resource Identifier

Type

Description

Field type <Eqpt::CVlan>


- customer vlan id

Table 139.2-2 "DHCP Relay User Port Management Command" Command Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the IPoX counters

3062

Released

3HH-04416-EBAA-TCZZA

01

139 DHCP Management Command

139.3 DHCP Relay User Port Management


Command
Command Description
This command allows the operator to manage the DHCP relay user port commands.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> admin dhcp-relay v6-port-stats (user-port) (clear-statistics)

Command Parameters
Table 139.3-1 "DHCP Relay User Port Management Command" Resource Parameters
Resource Identifier

Type

(user-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>

3HH-04416-EBAA-TCZZA 01

Description
identification of vlan port
/
:
/
/
:
/
:
/
/
:
/
/
:
/
:
/
:

Released

3063

139 DHCP Management Command

Resource Identifier

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 139.3-2 "DHCP Relay User Port Management Command" Command Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the statistics

optional parameter
clear the DHCP v6 counters

3064

Released

3HH-04416-EBAA-TCZZA

01

139 DHCP Management Command

139.4 SHub DHCP Relay Agent Statistics


Management Command
Command Description
This command allows the operator to reset the dhcp counters of a particular VRF in the Shub.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin dhcp-relay shub vrf-agent-stats (vrf-id) (clear-statistics)

Command Parameters
Table 139.4-1 "SHub DHCP Relay Agent Statistics Management Command" Resource Parameters
Resource Identifier

Type

Description

(vrf-id)

Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the vrf index

Table 139.4-2 "SHub DHCP Relay Agent Statistics Management Command" Command Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the dhcp statistics

optional parameter
reset the dhcp counters for the vrf

3HH-04416-EBAA-TCZZA 01

Released

3065

140- ARP-RELAY statistics Management


Commands

140.1 ARP-RELAY statistics Management Command Tree


140.2 Arp-relay statistics Management Command

3066

Released

140-3067
140-3068

3HH-04416-EBAA-TCZZA

01

140 ARP-RELAY statistics Management Commands

140.1 ARP-RELAY statistics Management


Command Tree
Description
This chapter gives an overview of nodes that are handled by "ARP-RELAY statistics Management Commands".

Command Tree
----admin
----arp-relay-stats
- (vlan-port)
- (clear-statistics)

3HH-04416-EBAA-TCZZA 01

Released

3067

140 ARP-RELAY statistics Management Commands

140.2 Arp-relay statistics Management Command


Command Description
This command allows the operator to reset the arp-relay statistics counters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin arp-relay-stats (vlan-port) [ (clear-statistics) ]

Command Parameters
Table 140.2-1 "Arp-relay statistics Management Command" Resource Parameters
Resource Identifier

Type

(vlan-port)

Format:
( vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::VpiId>
<Eqpt::VciId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : stacked : <Eqpt::SVlan>
<Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PortId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId> / <Eqpt::OntPortId> : stacked
<Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId>
<Eqpt::OntSlotId>
/
<Eqpt::OntPortId>
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni
stacked : <Eqpt::SVlan> : <Eqpt::CVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId>
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / voip
<Eqpt::UnstackedVlan>

3068

Released

Description
the vlan-port
/
:
/
:
/
:
/
/
/
:
/
/
:
/
:
/
:
/
:

3HH-04416-EBAA-TCZZA

01

140 ARP-RELAY statistics Management Commands

Resource Identifier

Type

Description

| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /


<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> / vuni :
<Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : <Eqpt::UnstackedVlan>
| vlan-port : <Eqpt::RackId> / <Eqpt::ShelfId> /
<Eqpt::SlotId> / <Eqpt::PonId> / <Eqpt::OntId> /
<Eqpt::LLId> : stacked : <Eqpt::SVlan> : <Eqpt::CVlan> )
Possible values:
- vlan-port : vlan port
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI
Field type <Eqpt::PonId>
- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE
Possible values:
- stacked : stacked vlan identity
Field type <Eqpt::UnstackedVlan>
- unstacked vlan id
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id

Table 140.2-2 "Arp-relay statistics Management Command" Command Parameters


Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear the arp-relay statistics

optional parameter
clear arp-relay summary and
detailed statistics

3HH-04416-EBAA-TCZZA 01

Released

3069

141- Transport Management Commands

141.1 Transport Management Command Tree


141.2 IP Net-to-media Management Command

3070

Released

141-3071
141-3072

3HH-04416-EBAA-TCZZA

01

141 Transport Management Commands

141.1 Transport Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Transport Management Commands".

Command Tree
----admin
----transport
----ip-net-to-media
- (interface-name)
- network-addr
- phy-addr
- (delete)

3HH-04416-EBAA-TCZZA 01

Released

3071

141 Transport Management Commands

141.2 IP Net-to-media Management Command


Command Description
This command allows the operator to delete the IP address out of the ARP table.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> admin transport ip-net-to-media (interface-name) network-addr <Ip::V4AddressHex> phy-addr <Sys::MacAddr>
[ (delete) ]

Command Parameters
Table 141.2-1 "IP Net-to-media Management Command" Resource Parameters
Resource Identifier

Type

Description

(interface-name)

Format:
eth1
Possible values:
- eth1 : control interface
Parameter type: <Ip::V4AddressHex>
Format:
- IPv4-address
Parameter type: <Sys::MacAddr>
Format:
- a mac-address (example : 01:02:03:04:05:06)
- length: 6

name of the interface

network-addr
phy-addr

ip
addr
corresponding
to
media-dependent physical addr
media-dependent physical addr

Table 141.2-2 "IP Net-to-media Management Command" Command Parameters


Parameter

Type

Description

(delete)

Format:
delete
Possible values:
- delete : delete a ip-net to media entry

optional parameter
delete a ip-net-to-media

3072

Released

3HH-04416-EBAA-TCZZA

01

142- SNTP Management Commands

142.1 SNTP Management Command Tree


142.2 SNTP Management Command

3HH-04416-EBAA-TCZZA 01

142-3074
142-3075

Released

3073

142 SNTP Management Commands

142.1 SNTP Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "SNTP Management Commands".

Command Tree
----admin
----sntp
- system-time

3074

Released

3HH-04416-EBAA-TCZZA

01

142 SNTP Management Commands

142.2 SNTP Management Command


Command Description
This command allows the operator to manage SNTP.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin sntp [ system-time <Sys::GaugeTimeInSecs> ]

Command Parameters
Table 142.2-2 "SNTP Management Command" Command Parameters
Parameter

Type

Description

system-time

Parameter type: <Sys::GaugeTimeInSecs>


Format:
- the time (yyyy-mm-dd:hour:minutes:secs)

optional parameter
Set the system time. The
configured time zone offset is
taken into account when setting
and retrieving the time

3HH-04416-EBAA-TCZZA 01

Released

3075

143- Transactions Management Commands

143.1 Transactions Management Command Tree


143.2 Transaction Configuration Management Command

3076

Released

143-3077
143-3078

3HH-04416-EBAA-TCZZA

01

143 Transactions Management Commands

143.1 Transactions Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Transactions Management Commands".

Command Tree
----admin
----transaction
- configure-lock

3HH-04416-EBAA-TCZZA 01

Released

3077

143 Transactions Management Commands

143.2 Transaction Configuration Management


Command
Command Description
This command allows the operator to manage transactions.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin transaction [ configure-lock <Trans::ownerIpAddr> ]

Command Parameters
Table 143.2-2 "Transaction Configuration Management Command" Command Parameters
Parameter

Type

Description

configure-lock

Parameter type: <Trans::ownerIpAddr>


Format:
( acquire
| release )
Possible values:
- acquire : prevents other managers from configuring
- release : allow other managers to configure

optional parameter
changes the status
configuration lock

3078

Released

3HH-04416-EBAA-TCZZA

01

of

the

144- Security Management Commands

144.1 Security Management Command Tree


144.2 Security 802.1x Port Authentication Management
Command

3HH-04416-EBAA-TCZZA 01

144-3080
144-3081

Released

3079

144 Security Management Commands

144.1 Security Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "Security Management Commands".

Command Tree
----admin
----security
----ext-authenticator
- (port)
- (clear-statistics)

3080

Released

3HH-04416-EBAA-TCZZA

01

144 Security Management Commands

144.2 Security 802.1x Port Authentication


Management Command
Command Description
This command allows the operator to manage a port or virtual channel in the scope of 802.1x authentication.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> admin security ext-authenticator (port) [ (clear-statistics) ]

Command Parameters
Table 144.2-1 "Security 802.1x Port Authentication Management Command" Resource Parameters
Resource Identifier

Type

(port)

Format:
( <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId> : <Eqpt::VpiId> : <Eqpt::VciId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::OntSlotId>
<Eqpt::OntPortId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / voip
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / vuni
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
<Eqpt::PonId> / <Eqpt::OntId> / <Eqpt::LLId> )
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Field type <Eqpt::SlotId>
- the LT slot number
Field type <Eqpt::PortId>
- the port number
Field type <Eqpt::VpiId>
- atm VPI
Field type <Eqpt::VciId>
- atm VCI

3HH-04416-EBAA-TCZZA 01

Description
identification of the port or
/ virtual channel
/
/
/
/
/
/

Released

3081

144 Security Management Commands

Resource Identifier

Type

Description

Field type <Eqpt::PonId>


- the PON identifier
Field type <Eqpt::OntId>
- the ONT identifier
Possible values:
- voip : virtual uni identifier
obsolete alternative replaced by vuni
- vuni : virtual uni identifier
Field type <Eqpt::OntSlotId>
- the ONT SLOT identifier
Field type <Eqpt::OntPortId>
- the ONT PORT identifier
Field type <Eqpt::LLId>
- the LLID identifier,range 1 for EPON,range 1-8 for DPOE

Table 144.2-2 "Security 802.1x Port Authentication Management Command" Command


Parameters
Parameter

Type

Description

(clear-statistics)

Format:
clear-statistics
Possible values:
- clear-statistics : clear non-accounting statistics

optional parameter
clear non-accounting statistics

3082

Released

3HH-04416-EBAA-TCZZA

01

145- MSTP Bridge Management Commands

145.1 MSTP Bridge Management Command Tree


145.2 Port-related MSTP Management Command

3HH-04416-EBAA-TCZZA 01

145-3084
145-3085

Released

3083

145 MSTP Bridge Management Commands

145.1 MSTP Bridge Management Command Tree


Description
This chapter gives an overview of nodes that are handled by "MSTP Bridge Management Commands".

Command Tree
----admin
----mstp
----port
- (network-port)
- (clear-protocols)

3084

Released

3HH-04416-EBAA-TCZZA

01

145 MSTP Bridge Management Commands

145.2 Port-related MSTP Management Command


Command Description
This command allows the operator to manage MSTP related to a port.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin mstp port (network-port) [ (clear-protocols) ]

Command Parameters
Table 145.2-1 "Port-related MSTP Management Command" Resource Parameters
Resource Identifier

Type

Description

(network-port)

Format:
( nt : sfp : <Eqpt::PortIndex>
| nt : xfp : <Eqpt::PortIndex>
| nt : eth : <Eqpt::PortIndex>
| <Shub::MstpNetworkPort> )
Possible values:
- nt : active nt slot
Possible values:
- sfp : sfp port
- xfp : xfp port
- eth : ethernet port (or lemi)
Field type <Eqpt::PortIndex>
- the faceplate port number
Field type <Shub::MstpNetworkPort>
- Network Port on Shub

the identification of a network


port

Table 145.2-2 "Port-related MSTP Management Command" Command Parameters


Parameter

Type

Description

(clear-protocols)

Format:
clear-protocols
Possible values:
- clear-protocols : clear the list of detected protocols

optional parameter
clear the list of detected protocols

3HH-04416-EBAA-TCZZA 01

Released

3085

146- Debug commands

146.1 Debug commands Tree


146.2 Debug commands

3086

Released

146-3087
146-3088

3HH-04416-EBAA-TCZZA

01

146 Debug commands

146.1 Debug commands Tree


Description
This chapter gives an overview of nodes that are handled by "Debug commands".

Command Tree
----debug-command

3HH-04416-EBAA-TCZZA 01

Released

3087

146 Debug commands

146.2 Debug commands


The commands of this node are to be used by Alcatel-Lucent certified personnel only.
Alcatel-Lucent can not be held responsible for any loss of data or revenue that occurs
when these commands are executed by non Alcatel-Lucent certified personnel.
This node contains some commands which are launched either towards the LT or NT Trace and Debug shell
or to the shub command shell.
The CLI commands as entered by the operator, will be translated in several Trace and Debug commands.
Those Trace and Debug commands will be executed by the Trace and Debug Shell of the specified LT or NT, or by
the shub.
The result of those Trace and Debug commands will be processed, a filtered output will be displayed.

3088

Released

3HH-04416-EBAA-TCZZA

01

147- Ping Commands

147.1 Ping Command Tree


147.2 Ping Command
147.3 Ping Per Vrf Command

3HH-04416-EBAA-TCZZA 01

147-3090
147-3091
147-3093

Released

3089

147 Ping Commands

147.1 Ping Command Tree


Description
This chapter gives an overview of nodes that are handled by "Ping Commands".

Command Tree
----ping
- (ip-addr)
- [no] timeout
- [no] tries
- [no] mtu-size
----vrf
- (vrf)
- [no] timeout
- [no] tries
- [no] mtu-size

3090

Released

3HH-04416-EBAA-TCZZA

01

147 Ping Commands

147.2 Ping Command


Command Description
This command allows the operator to ping another host.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> ping (ip-addr) [ no timeout | timeout <Ip::PingTimeout> ] [ no tries | tries <Ip::PingTries> ] [ no mtu-size |
mtu-size <Ip::PingMtu> ]

Command Parameters
Table 147.2-1 "Ping Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

the ip-address of the node to be


pinged

Table 147.2-2 "Ping Command" Command Parameters


Parameter

Type

Description

[no] timeout

Parameter type: <Ip::PingTimeout>


Format:
- the maximum time to wait for a response
- unit: millisec
- range: [100...100000]
Parameter type: <Ip::PingTries>
Format:
- the number of times the node must be pinged
- range: [1...100]
Parameter type: <Ip::PingMtu>
Format:
- the size of the data portion of the ping PDU
- unit: bytes
- range: [8...2080]

optional parameter with default


value: 5000L
the maximum time to wait for a
response

[no] tries

[no] mtu-size

optional parameter with default


value: 5L
the number of times the node
must be pinged
optional parameter with default
value: 500L
the size of the data portion of the
ping PDU

Command Output
Table 147.2-3 "Ping Command" Display parameters
Specific Information
name

Type

Description

received

Parameter type: <Counter>

total number of packets received

3HH-04416-EBAA-TCZZA 01

Released

3091

147 Ping Commands

name

Type

Description

sent

- 32 bit counter
Parameter type: <UnsignedSignedInteger>
- an unsigned integer

This element is always shown.


total number of packets sent to
the destination
This element is always shown.
percentage of lost packets
This element is always shown.
the average round trip delay
This element is always shown.

loss

Parameter type: <UnsignedSignedInteger>


- an unsigned integer
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec

mean-delay
max-delay
min-delay

3092

Released

the maximum round trip delay


This element is always shown.
the minimum round trip delay
This element is always shown.

3HH-04416-EBAA-TCZZA

01

147 Ping Commands

147.3 Ping Per Vrf Command


Command Description
This command allows the operator to ping another host in a given SHUB VRF.
If iSAM is in IP aware bridging mode and the SHUB is acting as a DHCP relay agent, a direct subnet route from
LT VRF to SHUB IP address is mandatory. Under these conditions pinging to a CPE WAN IP address through
SHUB VRF will be successful. Otherwise pinging to a CPE WAN IP address through SHUB VRF will fail.
Only one simultaneous ping to an IP address through an SHUB VRF is possible.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> ping (ip-addr) vrf (vrf) [ no timeout | timeout <Ip::PingTimeout> ] [ no tries | tries <Ip::PingTries> ] [ no mtu-size
| mtu-size <Ip::PingMtu> ]

Command Parameters
Table 147.3-1 "Ping Per Vrf Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the ip-address of the node to be


pinged
the vrf number

(vrf)

Table 147.3-2 "Ping Per Vrf Command" Command Parameters


Parameter

Type

Description

[no] timeout

Parameter type: <Ip::PingTimeout>


Format:
- the maximum time to wait for a response
- unit: millisec
- range: [100...100000]
Parameter type: <Ip::PingTries>
Format:
- the number of times the node must be pinged
- range: [1...100]
Parameter type: <Ip::PingMtu>
Format:
- the size of the data portion of the ping PDU
- unit: bytes
- range: [8...2080]

optional parameter with default


value: 5000L
the maximum time to wait for a
response

[no] tries

[no] mtu-size

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 5L
the number of times the node
must be pinged
optional parameter with default
value: 500L
the size of the data portion of the
ping PDU

Released

3093

147 Ping Commands

Command Output
Table 147.3-3 "Ping Per Vrf Command" Display parameters
Specific Information
name

Type

Description

received

Parameter type: <Counter>


- 32 bit counter

sent

Parameter type: <UnsignedSignedInteger>


- an unsigned integer

loss

Parameter type: <UnsignedSignedInteger>


- an unsigned integer
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec
Parameter type: <Ip::PingDelay>
- the average round trip delay
- unit: millisec

total number of packets received


back
This element is always shown.
total number of packets sent to
the destination
This element is always shown.
percentage of lost packets
This element is always shown.
the average round trip delay
This element is always shown.

mean-delay
max-delay
min-delay

3094

Released

the maximum round trip delay


This element is always shown.
the minimum round trip delay
This element is always shown.

3HH-04416-EBAA-TCZZA

01

148- Traceroute Commands

148.1 Traceroute Command Tree


148.2 Traceroute Command
148.3 Traceroute Per Vrf Command

3HH-04416-EBAA-TCZZA 01

148-3096
148-3097
148-3099

Released

3095

148 Traceroute Commands

148.1 Traceroute Command Tree


Description
This chapter gives an overview of nodes that are handled by "Traceroute Commands".

Command Tree
----traceroute
- (ip-addr)
- [no] first-hop
- [no] last-hop
- [no] timeout
- [no] mtu-size
----vrf
- (vrf)
- [no] first-hop
- [no] last-hop
- [no] timeout
- [no] mtu-size

3096

Released

3HH-04416-EBAA-TCZZA

01

148 Traceroute Commands

148.2 Traceroute Command


Command Description
This command allows the operator to determine the route to a destination address.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> traceroute (ip-addr) [ no first-hop | first-hop <Ip::TracerouteTTL> ] [ no last-hop | last-hop <Ip::TracerouteTTL>
] [ no timeout | timeout <Ip::TracerouteTimeout> ] [ no mtu-size | mtu-size <Ip::TracerouteMtu> ]

Command Parameters
Table 148.2-1 "Traceroute Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address

the ip-address of the destination


node

Table 148.2-2 "Traceroute Command" Command Parameters


Parameter

Type

Description

[no] first-hop

Parameter type: <Ip::TracerouteTTL>


Format:
- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::TracerouteTTL>
Format:
- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::TracerouteTimeout>
Format:
- the maximum time to wait for a response
- unit: sec
- range: [1...100]
Parameter type: <Ip::TracerouteMtu>
Format:
- the size of the data portion of the PDU
- unit: bytes
- range: [1...100]

optional parameter with default


value: 1L
the first hop to try

[no] last-hop

[no] timeout

[no] mtu-size

optional parameter with default


value: 99L
the last hop to try
optional parameter with default
value: 1L
the maximum time to wait for a
response
optional parameter with default
value: 64L
the size of the data portion of the
PDU

Command Output
Table 148.2-3 "Traceroute Command" Display parameters

3HH-04416-EBAA-TCZZA 01

Released

3097

148 Traceroute Commands

Specific Information
name
hop
hop-ip-addr

delay-1

delay-2

delay-3

3098

Released

Type

Description

Parameter type: <Ip::TracerouteTTL>


- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::V4AddressOrNotFound>
( not-found
| <Ip::V4Address> )
Possible values:
- not-found : ip-address was not found
Field type <Ip::V4Address>
- IPv4-address
Parameter type: <Ip::TraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Parameter type: <Ip::TraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Parameter type: <Ip::TraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]

the hop number in the route


towards the destination
This element is always shown.
the ip-address of the intermediate
node or hop
This element is always shown.

the time to receive the response


on the first request
This element is always shown.

the time to receive the response


on the second request
This element is always shown.

the time to receive the response


on the third request
This element is always shown.

3HH-04416-EBAA-TCZZA

01

148 Traceroute Commands

148.3 Traceroute Per Vrf Command


Command Description
This command allows the operator to determine the route to a destination address for a given SHUB VRF.
Note: If iSAM in IP aware bridging mode,SHUB acting as dhcp relay agent, a direct subnet route from LT vrf to
shub IP address is mandatory,then trace route to CPE WAN IP @ through shub vrf will be sucess else trace route
to CPE WAN IP @ through shub vrf will fail.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> traceroute (ip-addr) vrf (vrf) [ no first-hop | first-hop <Ip::TracerouteTTL> ] [ no last-hop | last-hop
<Ip::TracerouteTTL> ] [ no timeout | timeout <Ip::TracerouteTimeout> ] [ no mtu-size | mtu-size
<Ip::TracerouteMtu> ]

Command Parameters
Table 148.3-1 "Traceroute Per Vrf Command" Resource Parameters
Resource Identifier

Type

Description

(ip-addr)

Format:
- IPv4-address
Format:
- the vrf id which uniquely identify a vrf
- range: [0...127]

the ip-address of the destination


node
the vrf number

(vrf)

Table 148.3-2 "Traceroute Per Vrf Command" Command Parameters


Parameter

Type

Description

[no] first-hop

Parameter type: <Ip::TracerouteTTL>


Format:
- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::TracerouteTTL>
Format:
- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::TracerouteTimeout>
Format:
- the maximum time to wait for a response
- unit: sec
- range: [1...100]
Parameter type: <Ip::TracerouteMtu>
Format:

optional parameter with default


value: 1L
the first hop to try

[no] last-hop

[no] timeout

[no] mtu-size

3HH-04416-EBAA-TCZZA 01

optional parameter with default


value: 99L
the last hop to try
optional parameter with default
value: 1L
the maximum time to wait for a
response
optional parameter with default
value: 64L

Released

3099

148 Traceroute Commands

Parameter

Type

Description

- the size of the data portion of the PDU


- unit: bytes
- range: [1...100]

the size of the data portion of the


PDU

Command Output
Table 148.3-3 "Traceroute Per Vrf Command" Display parameters
Specific Information
name
hop
hop-ip-addr

delay-1

delay-2

delay-3

3100

Released

Type

Description

Parameter type: <Ip::TracerouteTTL>


- time-to-live value of IP-header
- range: [1...99]
Parameter type: <Ip::V4AddressOrNotFound>
( not-found
| <Ip::V4Address> )
Possible values:
- not-found : ip-address was not found
Field type <Ip::V4Address>
- IPv4-address
Parameter type: <Ip::VrfTraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Parameter type: <Ip::VrfTraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]
Parameter type: <Ip::VrfTraceReachTime>
( no-response
| unreachable
| <Ip::TraceReachTime> )
Possible values:
- no-response : no response
- unreachable : unreachable
Field type <Ip::TraceReachTime>
- the time to reach this node if at all successful
- unit: msec
- range: [-2...2147483647]

the hop number in the route


towards the destination
This element is always shown.
the ip-address of the intermediate
node or hop
This element is always shown.

the time to receive the response


on the first request
This element is always shown.

the time to receive the response


on the second request
This element is always shown.

the time to receive the response


on the third request
This element is always shown.

3HH-04416-EBAA-TCZZA

01

149- Global And Environmental Commands

149.1 History Command


149.2 Echo Command
149.3 Telnet Command
149.4 Telnet AI Command
149.5 Exec Command
149.6 Sleep Command
149.7 Tree Command
149.8 Write Command
149.9 Logout Command
149.10 Help Command
149.11 Info Command
149.12 Exit Command
149.13 Back Command
149.14 Delete Command
149.15 In Command
149.16 Configure Command
149.17 Action Command
149.18 Show Command
149.19 Recursive Show Command
149.20 Sample Command
149.21 Poll Command
149.22 Debug Command

3HH-04416-EBAA-TCZZA 01

149-3102
149-3103
149-3104
149-3105
149-3106
149-3108
149-3109
149-3110
149-3111
149-3112
149-3113
149-3116
149-3117
149-3118
149-3119
149-3120
149-3122
149-3123
149-3124
149-3125
149-3126
149-3127

Released

3101

149 Global And Environmental Commands

149.1 History Command


Command Description
This command displays the last commands entered at the terminal.
A maximum of 20 commands can be stored. A command that is identical to the previous command is not stored.
Commands containing syntax and semantic errors are also stored in the history buffer. This way a user can correct
a command without retyping the command completely.
Each command is preceeded by a sequence number.
The sequence number does not increment when a command is not stored because it is identical to the previous
command.
Example :
esam># history
1 : history
esam># echo "first command"
first command
esam># echo "second command"
second command
esam># echo "second command"
second command
esam># history
1 : history
2 : echo "first command"
3 : echo "second command"
4 : history
esam>#

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by all users.

Command Syntax
The command has the following syntax:
> history

3102

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.2 Echo Command


Command Description
This command echoes a string to the standard output.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be accessed by any user.

Command Syntax
The command has the following syntax:
> echo [ [ no ] message ]

Command Parameters
Table 149.2-2 "Echo Command" Command Parameters
Options

Type

Description

[no] (message)

Format:
- a long message
- length: x<=512

optional parameter with default


value: ""
the string to be echoed

3HH-04416-EBAA-TCZZA 01

Released

3103

149 Global And Environmental Commands

149.3 Telnet Command


Command Description
This command establishes a telnet session to another server.
The telnet session will last until the connection is closed by the telnet server or when the operator enters the
character Control-^.
The session inactivity-time protection will not put any messages on the screen when you are executing the telnet
command. Your connection will be broken without warning if the inactivity timeout expires.

User Level
The command can be accessed by operators with lanxAccess,lanxAccessext privileges.
This command can only be executed by users having read or write access to functions located in the SHub/IHub.
The command can only be executed from a telnet terminal, not from a craft terminal.

Command Syntax
The command has the following syntax:
> telnet (destination)

Command Parameters
Table 149.3-2 "Telnet Command" Command Parameters
Options

Type

Description

(destination)

Format:
shub
Possible values:
- shub : the service hub (shub or ihub)

optional parameter
identification of the telnet server

3104

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.4 Telnet AI Command


Command Description
This command establishes a telnet session to the Application Intelligence platform (core2&3 on NANT-E or
FANT-F).
The telnet session will last until the connection is closed by the telnet server or when the operator exits from the
telnet session.
The session inactivity-time protection will not put any messages on the screen when you are executing the telnet
command. Your connection will be broken without warning if the inactivity timeout expires.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
The command can be executed from a craft terminal or a telnet terminal.

Command Syntax
The command has the following syntax:
> telnet-ai (destination) [ virtualplatform <AI::VirtualPlatform> ]

Command Parameters
Table 149.4-2 "Telnet AI Command" Command Parameters
Options

Type

Description

(destination)

Format:
( nt-a
| nt-b )
Possible values:
- nt-a : the ai platform (core2-3) on NT-a
- nt-b : the ai platform (core2-3) on NT-b
Parameter type: <AI::VirtualPlatform>
Format:
- AI Virtual Platform Index within the Slot
- range: [1]

optional parameter
identification of the telnet server

virtualplatform

3HH-04416-EBAA-TCZZA 01

optional parameter
identification of the
platform

Released

3105

virtual

149 Global And Environmental Commands

149.5 Exec Command


Command Description
This command executes CLI commands found in a text file. A file containing CLI commands is called a script file.
A script file must follow the same syntax rules as commands entered interactively. Only the tab and the question
mark lose their special meaning in a script, so command expansion and single-line help are not available.
When initiating the execution of a script, the operator can choose how the system must behave in case of an error
in a CLI command. By default the script will be aborted. Other command-line options are: ignore the error and
proceed executing the script or prompt the operator. When prompted the operator can choose to either abort the
script or ignore the error and proceed. When prompted due to an error, the operator may wish to open a separate
CLI session to take some corrective action for the failed command and then revert to the session where the script is
running to continue with the next command.
A command may be preceded by a minus '-' to prevent the script from being aborted in case of a semantic error; for
example, when you try to delete a node instance that does not exist. In case a minus-sign precedes the command
and the error is a semantic error, then the operator will not be prompted.
By default, a command script does not interact with the user. The execution of the script will be aborted if a
command or filter requires interaction with the user. Interactivity can be enabled by specifying the interactive
option with the exec command.
The exec command may not be used in a command script, so command scripts may not be nested.
Script files are typically stored in the /var/cmd directory.
A script file can be used to restore a configuration. This can be done by reloading an initial and working
configuration script. Alternatively, the complete configuration of an existing system can be captured. A
configuration script is produced by means of the command info configure <configuration node> | tee <script
name> and the script is stored in file /var/cmd/<script name> . Subsequently, the retrieved file needs editing as the
output is not guaranteed to be in line with the CLI sequences required to configure a new system. The configuration
can then be restored on an empty system with the command exec /var/cmd/<script name> .
Warning: the /var/cmd is cleaned when the system resets, so the configuration file must be transferred to another
system with tftp before resetting the system.
Note: saving and restoring the configuration will not work for areas in which resource identifiers are assigned
dynamically by the system.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by all users. However, the execution of the script will be aborted when the CLI
parser tries to execute the first command in the script for which the user does not have authorization.

Command Syntax
The command has the following syntax:
> exec (filename) [ [ no ] interactive ] [ no at-replay | at-replay <Option::AtFailure> ]

Command Parameters
3106

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

Table 149.5-2 "Exec Command" Command Parameters


Options

Type

Description

(filename)

Format:
- an absolute or relative path name (example : /var/log)
- range: [.-z-]
- length: 1<=x<=128
Parameter type: boolean

optional parameter
the name of the file with the
script

[no] interactive
[no] at-replay

3HH-04416-EBAA-TCZZA 01

Parameter type: <Option::AtFailure>


Format:
( stop
| continue
| prompt )
Possible values:
- stop : stop execution of the script
- continue : continue with the execution of the script
- prompt : prompt the operator what to do

optional parameter
interaction with the operator is
allowed
optional parameter with default
value: "stop"
directs what to do if error is
encountered in the script

Released

3107

149 Global And Environmental Commands

149.6 Sleep Command


Command Description
This command pauses the execution for the specified number of seconds.
This command is typically used in scripts (see : the exec command).

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by any user.

Command Syntax
The command has the following syntax:
> sleep (time)

Command Parameters
Table 149.6-2 "Sleep Command" Command Parameters
Options

Type

Description

(time)

Format:
- the period to sleep
- unit: sec
- range: [1...100]

optional parameter
the period to sleep

3108

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.7 Tree Command


Command Description
This command displays the structure of a node and its subnodes.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by any user on a node to which he has read or write access.
The output does not contain any information related to subnodes to which the user has no access.

Command Syntax
The command has the following syntax:
> tree [ [ no ] detail ]

Command Parameters
Table 149.7-2 "Tree Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

optional parameter
show the details

3HH-04416-EBAA-TCZZA 01

Released

3109

149 Global And Environmental Commands

149.8 Write Command


Command Description
This command writes a message to the terminal of the addressee.
The message can be directed to a user, all user with the same user profile or to all users.
Messages are only delivered to users that are logged in. Users that are not logged in, will not receive the message.
The sender will also receive the message if it is one of the addressees.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be used by any user.

Command Syntax
The command has the following syntax:
> write to <Option::MessageDestination> (message)

Command Parameters
Table 149.8-2 "Write Command" Command Parameters
Options

Type

Description

to

Parameter type: <Option::MessageDestination>


Format:
( all
| operator : <Sec::OperatorName>
| profile : <Sec::ProfileName> )
Possible values:
- all : all active sessions
- operator : all sessions of the operator with that name
- profile : all sessions of operators with that profile name
Field type <Sec::OperatorName>
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11
Field type <Sec::ProfileName>
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11
Format:
- a message
- length: x<=256

optional parameter
the destination of the message

(message)

3110

Released

optional parameter
the message

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.9 Logout Command


Command Description
This command logs the user out.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by any user.

Command Syntax
The command has the following syntax:
> logout

3HH-04416-EBAA-TCZZA 01

Released

3111

149 Global And Environmental Commands

149.10 Help Command


Command Description
This command gives the user detailed information on a subject.
By default the command gives information on the current node.

User Level
The command can be accessed by operators with forHelp,forHelpext privileges.
This command can be executed by each user. A user will only be able to get help for nodes for which he has read or
write access.

Command Syntax
The command has the following syntax:
> help

3112

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.11 Info Command


Command Description
This command shows the configuration of the current node and all of its subnodes.
The user can select three different output formats:
The default is hierarchical command format.
An other format is the flat command format. The output in this format can be saved in a file with the tee filter
and can be executed with the exec command. This way a saved configuration can be restored on an empty
system.
The other format is XML. The output in this format is much more suited as input for tools because it is less
sensitive to further changes.
Example of the default format :
esam>configure>system>security# info profile
configure system security
#------------------------------------------------------------------------------------------echo "system"
#------------------------------------------------------------------------------------------profile admin
prompt "%n%d%c "
terminal-timeout 30
description "default administrator group"
aaa write
atm write
alarm write
dhcp write
equipment write
igmp write
ip write
ppoe write
qos write
software-management write
transport write
vlan write
xdsl write
security write
exit
profile read
prompt "%n%d%c "
security read
exit
#-------------------------------------------------------------------------------------------

Example of the flat command format :


esam>configure>system>security# info profile flat
configure system security profile admin prompt "%n%d%c " terminal-timeout 30
description "default administrator group" aaa write atm write alarm write dhcp write
equipment write igmp write ip write ppoe write qos write software-management write
transport write vlan write xdsl write security write
configure system security profile read prompt "%n%d%c " security read

Example of the XML format :


esam>configure>system>security# info profile read xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration-data display-level="normal">
<hierarchy name="configure" type="static">
<hierarchy name="system" type="static">
<hierarchy name="security" type="static">
<hierarchy name="profile" type="dynamic">
<hier-id name="name" is-named="no" value="read" is-default="no"
type="Sec::ProfileName"/>
<instance>
<parameter name="prompt" is-default="no" type="Sec::Prompt">"%n%d%c
"</parameter>
<parameter name="password-timeout" units="days" is-default="yes"
type="Sec::PasswordTimeout">0</parameter>
<parameter name="terminal-timeout" units="minutes" is-default="yes"
type="Sec::InactivityTimeout">0</parameter>

3HH-04416-EBAA-TCZZA 01

Released

3113

149 Global And Environmental Commands


<parameter name="description" is-default="yes"
type="Sec::ProfileDesc"></parameter>
<parameter name="aaa" is-default="yes" type="Sec::Aaa">none</parameter>
<parameter name="atm" is-default="yes" type="Sec::Atm">none</parameter>
<parameter name="alarm" is-default="yes"
type="Sec::Alarm">none</parameter>
<parameter name="dhcp" is-default="yes" type="Sec::Dhcp">none</parameter>
<parameter name="equipment" is-default="yes"
type="Sec::Equipment">none</parameter>
<parameter name="igmp" is-default="yes" type="Sec::Igmp">none</parameter>
<parameter name="ip" is-default="yes" type="Sec::Ip">none</parameter>
<parameter name="ppoe" is-default="yes" type="Sec::Ppoe">none</parameter>
<parameter name="qos" is-default="yes" type="Sec::Qos">none</parameter>
<parameter name="software-management" is-default="yes"
type="Sec::Sw">none</parameter>
<parameter name="transport" is-default="yes"
type="Sec::Transport">none</parameter>
<parameter name="vlan" is-default="yes" type="Sec::Vlan">none</parameter>
<parameter name="xdsl" is-default="yes" type="Sec::Xdsl">none</parameter>
<parameter name="cluster" is-default="yes"
type="Sec::Cluster">none</parameter>
<parameter name="security" is-default="no"
type="Sec::Security">read</parameter>
</instance>
</hierarchy>
</hierarchy>
</hierarchy>
</hierarchy>
</configuration-data>
esam>configure>system>security#

The user can select two different output levels :


The default is to show only the parameters which have not the default value. Static subnodes which contain
(recursively) only default values are not shown. The XML format shows always all parameters.
In the detail output level all nodes and all parameters shown. This output can not be used for replay.
Example of detailed information :
esam>configure>system>security# info profile read detail
configure system security
#------------------------------------------------------------------------------------------echo "system"
#------------------------------------------------------------------------------------------profile
prompt "%n%d%c "
no password-timeout
no terminal-timeout
no description
no aaa
no atm
no alarm
no dhcp
no equipment
no igmp
no ip
no ppoe
no qos
no software-management
no transport
no vlan
no xdsl
security read
exit
#------------------------------------------------------------------------------------------esam>configure>system>security#

User Level
The command can be accessed by operators with readAccess,readAccessext privileges.
This command can be accessed in all nodes to which the user has read access. It is not available in admin and
show nodes or their subnodes.
The output will only contain information for the nodes for which the user has read access.

Command Syntax

3114

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

The command has the following syntax:


> info [ [ no ] detail ] [ (format) ]

Command Parameters
Table 149.11-2 "Info Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

(format)

Format:
( hierarchical
| flat
| xml )
Possible values:
- hierarchical : show the output in hierarchical command
format
- flat : show the output in flat command format
- xml : show the output in XML format

optional parameter
show the details
optional parameter
the format in which the command
output is printed

3HH-04416-EBAA-TCZZA 01

Released

3115

149 Global And Environmental Commands

149.12 Exit Command


Command Description
This command changes the current position to the parent node of the current position. This command always
succeeds, even if the current position is the top node. The command has no effect in this case.
The option all changes the current position to the top node.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
This command can be executed by all users

Command Syntax
The command has the following syntax:
> exit [ [ no ] all ]

Command Parameters
Table 149.12-2 "Exit Command" Command Parameters
Options

Type

Description

[no] all

Parameter type: boolean

optional parameter
set the current position to the top
node

3116

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.13 Back Command


Command Description
This command changes the current position to the previous position.
The command will always succeed, even if the previous position no longer exists. The command changes the
current position to the top node in that case.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
The command can be executed by all users.

Command Syntax
The command has the following syntax:
> back

3HH-04416-EBAA-TCZZA 01

Released

3117

149 Global And Environmental Commands

149.14 Delete Command


Command Description
This command deletes a file from the directory /var/cmd. Such file is typically created with the tee filter.
The command will always succeed, even if the specified file does not exist.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
The command can be executed by all users.

Command Syntax
The command has the following syntax:
> delete-file (file)

Command Parameters
Table 149.14-2 "Delete Command" Command Parameters
Options

Type

Description

(file)

Format:
- a file name (example : errors.log)
- range: [.0-z-]
- length: 1<=x<=119

optional parameter
the name of the file to be deleted

3118

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.15 In Command
Command Description
This command can not be directly executed by the operator. It is the default command for all nodes when no node
attributes are specified, except for all subnodes of configure and the leaf nodes of show.
This command changes the position in the command tree to the current node instance.

User Level
The command can be accessed by operators with readAccess,readAccessext privileges.
This command can be executed by any user for the nodes to which he has read or write access.

3HH-04416-EBAA-TCZZA 01

Released

3119

149 Global And Environmental Commands

149.16 Configure Command


Command Description
This command can not be directly executed by the user. It is the default command for the configuration node and
most of its subnodes.
This command serves four purposes :
changing the current position in the command tree to a node instance.
creating a node instance. The current position will be changed to the newly created node instance.
modifying one or more attributes of a node instance. The current position in the command tree will be changed
to the modified node instance.
deleting a node instance.
The command changes the current position in the command tree to a node instance in case you specify an existing
node instance and no parameters. Example : configure equipment shelf 1/1. The last character in the default
prompt will be #.
The command creates a node instance in case the node is dynamic and the specified node instance does not exist.
Example : configure system security operator new_user password plain:"hallo#". Parameter values must be
supplied for all mandatory parameters. Parameter values may be supplied for optional parameters. The command
changes the current position in the command tree to the newly created node instance. The last character in the
default prompt will be $.
The command modifies the attributes of a node instance in case the node instance exists and if the user supplies
parameters. Example : configure system security operator existing_user description "a new description"
The command will delete a node instance when it is a dynamic node and the node name is preceed by no. Example
: configure system security no operator existing_user.
The command generates no output
Example 1 - change the current position to an existing static node :
esam# configure system security
esam>configure>system>security#

Example 2 - create a new dynamic node (note that one has to enter the mandatory parameters) :
esam>configure>system>security# operator new profile read password plain:&secret&
esam>configure>system>security>operator>new$

Example 3 - change an attribute :


esam>configure>system>security>operator>new$ description "just created"
esam>configure>system>security>operator>new$

Example 4 - change to an existing dynamic node (note that the prompt is different with example 2) :
esam>configure>system>security>operator>new$ back
esam>configure>system>security# operator new
esam>configure>system>security>operator>new#

Example 5 - delete a dynamic node


esam>configure>system>security>operator>new# back
esam>configure>system>security# no operator new
esam>configure>system>security#

Example 6 - go to the root


esam>configure>system>security# exit all
esam>#

3120

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

Example 7 - request help for a non-existing static node, no parameters or subnodes will be shown
esam>#configure igmp channel 1/1/6/1 ?
<CR>
: execute command
esam>#configure igmp channel 1/1/6/1

Example 8 - go to a non-existing static node


esam>#configure igmp channel 1/1/6/1
Error : port not available
esam>#

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
A user can change the current position to each node to which he has read access.
A user can create, modify and delete nodes to which he has write access.

3HH-04416-EBAA-TCZZA 01

Released

3121

149 Global And Environmental Commands

149.17 Action Command


Command Description
This command can not be directly executed by the user. It is the default command for the admin node and most of
its subnodes.
This command serves two purposes :
changing the current position in the command tree to a node instance.
executing an action.
The command changes the current position in the command tree to a node instance in case you specify an existing
node instance and no parameters. From the moment you specify a parameter it will try to execute the
corresponding action.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
A user can change the current position in the command tree to each node to which he has read access.
A user can execute the action in each node to which he has access.

3122

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.18 Show Command


Command Description
This command shows the runtime data and eventually some important configuration data.
This command can not be executed directly by the user. It is the default command for the leaf nodes of show. It
shows the runtime data.
When show data in no detail mode, if the length of parameter is too long for a table cell, an asterisk will be used to
omit some charactor to fit the table cell length.

User Level
The command can be accessed by operators with readAccess,readAccessext privileges.
The user can execute this command for all nodes to which he has read access.

Command Parameters
Table 149.18-2 "Show Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

[no] xml

Parameter type: boolean

optional parameter
show the details
optional parameter
show the output in XML format

3HH-04416-EBAA-TCZZA 01

Released

3123

149 Global And Environmental Commands

149.19 Recursive Show Command


Command Description
This command shows the runtime data and eventually some important configuration data.
This command can not be executed directly by the user. It is the default command for some leaf nodes of show. It
shows the runtime data in a recursive way (similar to info.

User Level
The command can be accessed by operators with readAccess,readAccessext privileges.
The user can execute this command for all nodes to which he has read access.

Command Parameters
Table 149.19-2 "Recursive Show Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

[no] xml

Parameter type: boolean

optional parameter
show the details
optional parameter
show the output in XML format

3124

Released

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.20 Sample Command


Command Description
This command executes a test and shows the test result.
This command can not be executed directly by the user. It is the default command for some leaf nodes of show. It
shows the final test results.

User Level
The command can be accessed by operators with readAccess,readAccessext privileges.
The user can execute this command for all nodes to which he has read access.

Command Parameters
Table 149.20-2 "Sample Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

[no] xml

Parameter type: boolean

optional parameter
show the details
optional parameter
show the output in XML format

3HH-04416-EBAA-TCZZA 01

Released

3125

149 Global And Environmental Commands

149.21 Poll Command


Command Description
This command can not be directly executed by the user. It is the default command for some leaf nodes in show.
This command starts a test and displays at regular time intervals during the specified time period the intermediate
results of the test.
The difference between poll and sample command is that, in poll command the intermediate results are shown
while in sample command only the final results are shown.

User Level
The command can be accessed by operators with writeAccess,writeAccessext privileges.

Command Parameters
Table 149.21-2 "Poll Command" Command Parameters
Options

Type

Description

[no] detail

Parameter type: boolean

[no] xml

Parameter type: boolean

[no] sample-interval

Parameter type: <Option::SampleInterval>


Format:
- the time between two samples
- unit: sec
- range: [1...60]
Parameter type: <Option::SampleCount>
Format:
( unlimited
| <Option::SampleCount> )
Possible values:
- unlimited : sampling continues until stopped by the user
Field type <Option::SampleCount>
- the number of samples to be taken
- range: [1...1000]

optional parameter
show the details
optional parameter
show the output in XML format
optional parameter with default
value: 1
the time between 2 samples

[no] number-of-samples

3126

Released

optional parameter with default


value: "unlimited"
the number of samples to be
taken

3HH-04416-EBAA-TCZZA

01

149 Global And Environmental Commands

149.22 Debug Command


Command Description
This command shows the runtime data and eventually some important configuration data.
This command can not be executed directly by the user. It is the default command for the leaf nodes of debug. It
shows the runtime data.

User Level
The command can be accessed by operators with allAccess,allAccessext privileges.
The user can execute this command for all nodes to which he has read access.

Command Parameters
Table 149.22-2 "Debug Command" Command Parameters
Options

Type

Description

[no] xml

Parameter type: boolean

optional parameter
show the output in XML format

3HH-04416-EBAA-TCZZA 01

Released

3127

150- CLI Filters

150.1 Count Filter


150.2 Match Filter
150.3 Tee Filter

3128

Released

150-3129
150-3130
150-3131

3HH-04416-EBAA-TCZZA

01

150 CLI Filters

150.1 Count Filter


Command Description
This filter counts the number of output characters, words or lines and adds this information at the end of the
output.

User Level
This filter can be used by any user.

Command Syntax
The command has the following syntax:
> count [ [ no ] lines ] [ [ no ] words ] [ [ no ] characters ] [ [ no ] summary ]

Command Parameters
Table 150.1-2 "Count Filter" Command Parameters
Parameter

Type

Description

[no] lines

Parameter type: boolean

[no] words

Parameter type: boolean

[no] characters

Parameter type: boolean

[no] summary

Parameter type: boolean

optional parameter
counts the number of lines
optional parameter
counts the number of words
optional parameter
counts the number of characters
optional parameter
only the lines with the count
summary are printed

3HH-04416-EBAA-TCZZA 01

Released

3129

150 CLI Filters

150.2 Match Filter


Command Description
This filter allows the user to filter selectively lines from the output based on the contents of these lines.
The user specifies a string with exact:.
He can then decide if a line that contains this string is kept (no skip) or discarded (skip) or he can use the filter to
keep all lines before the first match (before) or after (including) the first match (after).
The matching operation can be case-sensitive (no case-insensitive) or case-insensitive (case-insensitive).

User Level
This filter can be used by any user.

Command Syntax
The command has the following syntax:
> match (pattern) [ [ no ] case-insensitive ] [ [ no ] skip ]

Command Parameters
Table 150.2-2 "Match Filter" Command Parameters
Parameter

Type

(pattern)

Format:
optional parameter
exact : <PrintableString>
describes
what
Possible values:
needed(exact:|pattern:)<PrintableString>
- exact : exact:<PrintableString> the string must match
exactly
Field type <PrintableString>
- printable string
Parameter type: boolean
optional parameter
matching is case-insensitive
Format:
optional parameter with default
( skip
value: "match"
| match
matched lines are skipped
| before
| after )
Possible values:
- skip : matched lines are skipped
- match : matched lines are selected
- before : lines found before the first match are selected
- after : lines found after the first match are selected

[no] case-insensitive
[no] (skip)

3130

Released

Description

3HH-04416-EBAA-TCZZA

01

150 CLI Filters

150.3 Tee Filter


Command Description
This filter writes the output also to a file. The file will be placed in the directory /var/cmd.
The user can decide if the output must be appended to the file or not.

User Level
This filter can be used by any operator.

Command Syntax
The command has the following syntax:
> tee (file) [ [ no ] append ]

Command Parameters
Table 150.3-2 "Tee Filter" Command Parameters
Parameter

Type

Description

(file)

Format:
- a file name (example : info.log)
- range: [.0-z]
- length: 1<=x<=13
Parameter type: boolean

optional parameter
the name of the file

[no] append

3HH-04416-EBAA-TCZZA 01

optional parameter
append if the file exists

Released

3131

151- CLI Printers

151.1 More
151.2 No-More
151.3 Discard

3132

Released

151-3133
151-3134
151-3135

3HH-04416-EBAA-TCZZA

01

151 CLI Printers

151.1 More
Command Description
This printer allows the user to see the command output at the pace he wants.

User Level
This printer can be used by any user.

Command Syntax
The command has the following syntax:
> more

3HH-04416-EBAA-TCZZA 01

Released

3133

151 CLI Printers

151.2 No-More
Command Description
This printer prints all output directly to the screen.

User Level
This printer can be used by any user.

Command Syntax
The command has the following syntax:
> no-more

3134

Released

3HH-04416-EBAA-TCZZA

01

151 CLI Printers

151.3 Discard
Command Description
This printer discards all output. This can be usefull in some scripts.

User Level
This printer can be used by any operator.

Command Syntax
The command has the following syntax:
> discard

3HH-04416-EBAA-TCZZA 01

Released

3135

Index

Index
ABCDEFGHIJKLMNOPQRSTUVWXY
A
a43
a43c
aaa
aal5-encap-type
abr-type
accept-expires
accept-frame-type
accept-starts
access
access-held-time
accessontimeout
access-oper-id
accessport-svc
access-type
acc-interval
acc-server
acc-stats
ack
action
action-type
activate
activate-type
active-groups
active-heartbeat
active-streams
actor-key
actor-port-prio
actor-sys-prio
actual-tps-tc-mode
address
addrtype
admin-domain-name
admin-p2p
admin-state
admin-status
adsl2-plus
adsl-adsl2
adsl-band
advertise
ageing-time
agent
agent-ip-addr
aggregate-addr
aggregate-list
aggregation
aggregator-info

3136

198
198
385
272
800
2953
647
807
452
918
929
313
2844
928
424
420
2870
329
374
948
473
959
2418
965
749
653
653
653
2091
910
1062
910
662
468
130
185
180
191
811
629
782
786
810
1778
847
1773

Released

aggregator-port
aggr-reprt-shaper
aging-time
ais-sensitivity
ais-to-iwf
ais-to-liu
alarm
alarm-changes
alarmid
alarm-profile
alarm-table
alive-timer
ansi
ansi-t1.424
ansi-t1413
anti-tapping
apipe-pvc
apipe-sdp
applique
applique-profile
area
area-id
arp
arp-burst
arp-policy
arp-proxy-stats
arp-rate
arp-relay-stats
arp-stats
artificial-noise-down
asam-id
asbr-external
associate-vlan
association
assu-burst-size
assured-info-rate
atm
atm-based-dsl
atm-overhead-fact
atm-pvc
audible1
audible2
audible3
audible4
audible5
authentication
authenticator
authproto
auth-server

3HH-04416-EBAA-TCZZA

653
899
598
356
144
144
63
1549
93
126
1298
899
2258
2062
2062
929
1074
1073
128
128
802
2470
690
547
672
676
547
3068
1880
178
955
2472
661
998
542
542
385
321
497
283
88
88
88
88
88
405
428
772
418

01

Index

auth-stats
auto-backup-intvl
autofetch
auto-laser-shutdown
auto-server-fb
auto-server-fo
autoshape
auto-sos-fb
auto-sos-fo
auto-switch
auto-upload
aut-s-unreach-act
availability
avail-sess
awaiting-time

2866
476
473
374
940
940
540
940
940
375
445
417
2189
2788
918

B
b43
back
backup
band-control-dn
band-control-up
bandwidth
bandwidth-profile
bandwidth-sharing
bcast-vlan
bg-monitor-int
bg-monitor-method
bitrate
bits
board
board-id
board-perfinfo
bonding-group
bonding-mode
bonding-rate-mode
boot-rom
boot-rom-status
branch
bras-ip-address
bridge
bridgeport
bridge-port
bridge-port-fdb
buffer-occ-thresh
bundle
bundle-stats
bundle-to-src
burst-size
busyoverwrite
busy-overwrite
busy-status

198
3117
476
233
233
542
573
573
782
940
940
992
361
239
2619
2609
1204
247
882
2949
2264
747
899
629
678
2079
1712
552
728
2306
2308
501
929
1032
2816

C
cable-impedance

3HH-04416-EBAA-TCZZA 01

148

cac
cache-pending
cache-refresh
cache-retry-time
cache-timeout
cac-mode
cac-profile
cac-type
callconf-service
callhold-service
calltras-service
callwait-service
canonical-format
capab-profile
capacity
carrier-data-mode
carrier-mask-down
carrier-mask-up
ccm-admin-state
cc-max-age
ccm-interval
ccm-priority
cde-bitmap
cdeprof
cdr-export
cdr-file-aging
cdr-polling
cdr-type
cdr-validation
cfg-res-time
cfm
cfm-burst
cfm-rate
channel
chipsetdata-for-slot
chn
circuit-id
circuit-id-dhcp
circuit-id-pppoe
class
class-d-addr
clear-alarm
clear-stats
cli
client-hw-address
client-id
client-port
clip-mode
clock
clock-mgmt
clocksource
cluster
codepoint
co-inventory
coll-count
collection
color-mode
command

510
691
691
691
691
497
557
510
929
929
929
929
526
126
738
247
172
172
998
757
998
1001
2224
2950
715
715
715
718
715
738
1291
547
547
141
2815
742
782
598
598
124
2308
2905
2923
452
782
774
764
929
137
356
137
952
515
2001
2329
854
523
2933

Released

3137

Index

committed-burst-size
committed-info-rate
community
config-control
config-file
config-id-sel
configure
configure-lock
connect
connection
conn-policy
conn-profile
conn-profile-name
conseq-number
contact
contact-person
context
context-lifetime
controlled-port
copy-to-port
count
counter
coupling-flag
cpe
cpe-inventory
cpe-management
cpu-load
critical
crit-log-full-act
cross-connect
cs-psd-shape-dn
cs-psd-shape-up
ctc
ctrl-pkt-policer
cur-op-mode
curr-15min-stats
curr-1day-stats
curr-day-stats
curr-encap-type
current-15min
current-15min-stats
current-1day
current-day-stats
current-interval
curr-num-group
curr-preview-num
curr-uncfg-num
custom
customer-id
custom-ext-alarm
custom-profile
cust-psd-pt-down
cust-psd-pt-up
cust-psd-sc-down
cust-psd-sc-up
cust-psd-ty-down
cust-psd-ty-up
cust-rx-psd-pt-up

3138

523
523
400
2205
2262
658
3120
3078
2502
877
431
430
431
141
353
313
400
786
433
3025
3129
2274
523
274
1999
875
2222
1623
83
1696
205
205
882
589
2091
2458
2460
2764
2097
1820
1739
1826
1742
1965
2101
2101
2101
1210
283
1218
88
189
213
191
205
191
205
202

Released

cust-rx-psd-sc-up
cust-rx-psd-ty-up
cvlan4095passthru

191
191
598

D
d1p
d1p-alignment
d1p-dscp
d1p-dscp-contract
database
data-length
dead-interval
debug
debug-command
debug-mirror
default-dot1p
default-dscp
default-metric
default-priority
default-profile
default-ql
default-route
default-severity
default-ttl
definition
delay-opt-mode-ds
delay-tolerance
delete-file
delta-log
del-upd-threshold
desc
description
description1
description2
description3
description4
description5
descriptor-files
dest
destination
dest-ip-address
dest-mac
dest-proto
device
device-ip
dhcp
dhcp-authent-para
dhcp-burst
dhcp-customer-id
dhcp-fqdn
dhcp-linerate
dhcp-option82
dhcp-optreq-list
dhcp-rate
dhcp-session
dhcpv6-burst
dhcpv6-itf-id

3HH-04416-EBAA-TCZZA

512
519
518
516
476
992
418
385
3088
385
512
513
839
630
392
363
318
284
316
114
860
542
3118
83
940
670
123
88
88
88
88
88
2246
1878
415
1868
141
685
2500
291
385
948
547
924
924
598
918
915
547
1886
547
598

01

Index

dhcpv6-linerate
dhcpv6-rate
dhcpv6-remote-id
dhcpv6-trst-port
diagnostics
dial-long-timer
dialplan
dial-short-timer
dial-start-timer
digitmap
digitmap-mode
digit-send-mode
direction
directory-number
direct-uri
discard
dis-frame-th
disk-file
display-name
distance
dist-service
disturber-line
dldstatus
dmac
dmpm-intdgt-expid
dn-buf-thresh
dn-obc-thresh
dns-ini-retr-int
dns-max-retr-nbr
dnsname-type
dns-purge-timer
dns-redun-mode
dnsserver
domain
domain-name
dot1-p0-color
dot1-p0-tc
dot1-p1-color
dot1-p1-tc
dot1-p2-color
dot1-p2-tc
dot1-p3-color
dot1-p3-tc
dot1-p4-color
dot1-p4-tc
dot1-p5-color
dot1-p5-tc
dot1-p6-color
dot1-p6-tc
dot1-p7-color
dot1-p7-tc
dot1p-priority
dot1p-remark
dot1p-value
dot3-coll
dot3-control
dot3-pause
dot3stats

3HH-04416-EBAA-TCZZA 01

598
547
598
598
2883
918
926
918
918
928
926
918
133
929
929
3135
554
2946
929
148
1070
2048
2267
992
918
552
552
940
940
910
940
940
946
428
430
544
544
544
544
544
544
544
544
544
544
544
544
544
544
544
544
526
521
504
2329
2330
2332
2689

dot3-status
download
download-set
down-policer
down-policy
downstream
dpbo-profile
dpcolor
drop-rpt-network
drouter
dscp
dscp-contract
dscp-map-dot1p
dscp-pbit
dscp-pbit-prof
dscp-value
ds-dedicated-q
dsfld-shaper-prof
dslam-name
dsl-bandwidth
dsl-ctrl-pkt-policer
dsload-thresh
dsl-port
ds-num-queue
ds-num-rem-queue
ds-rem-queue
dst-ip-addr
dst-ipv6-addr
dst-mac-addr
dual-host-ip
dual-host-loc
dup-fdb-id
dup-mac
dup-mac-alarm
dup-port
dyn-auth-client
dyn-authclient-stats
dyn-pt-nego-type

2334
2942
473
535
539
2046
223
499
724
385
513
514
504
550
519
515
636
565
899
1807
501
552
557
565
565
577
323
528
526
126
126
1722
1722
1722
1758
422
2873
918

E
eapol-stats
echo
ecid-rx
ecid-tx
efm-based-dsl
efm-based-epon
efm-based-pon
efm-hs-sele
efm-oam
egress-port
egress-rate
egress-vc-label
egr-routemap-act
emulation
encap-type
end-ip-addr
end-time

2880
3103
141
141
321
321
321
882
1296
304
581
1072
840
2131
899
742
950

Released

3139

Index

engine
enterprise-number
entry
envbox
environment
eo-conversion
ephe-term-max
ephe-term-min
ephe-term-prefix
epsd-pt-down
eps-quenchfactor
eqpt-holder
eqpt-holder-ext
equal-fext
equipment
error
esa-mgc-service
es-cable-model-a
es-cable-model-b
es-cable-model-c
es-day-farend
es-day-nearend
es-elect-length
es-farend
es-nearend
eth-efm-fact
ether-dot3lt
ether-ifmault
ether-ifsfplt
ether-itf
ethernet
ethernet-bandwidth
ether-sfp
etherstats
ether-tca
ethertype
eth-int
eth-shub
eth-stats
eth-sus-bit-rate
etsi
etsi-dts
etsi-ts
event-req-id
exce-burst-size
except-cdr-rate
excess-burst-size
excess-info-rate
excessive-info-rate
exec
exit
expires
ext-authenticator
ext-bw
ext-cac
extensive
extern-aggr-addr
external

3140

759
598
65
152
58
1200
965
965
965
227
130
1145
1148
221
385
307
965
223
223
223
252
252
223
252
252
497
2349
2344
2342
1158
2700
1811
1275
2691
1272
526
2687
1647
3045
753
2259
2062
2062
965
542
715
523
523
542
3106
3116
843
436
573
565
1691
811
297

Released

external-device
external-link-assign
external-link-host
external-link-remote
extfwd
ext-redundancy-state
ext-shaper
ext-source
ext-vlan-id

1290
135
133
1100
291
2613
508
356
354

F
f5-loopback-ete
facility
fail-x-type
fanmode
fan-tray
far-end
fcs
fcs-day
fdb-board
fdbid
fdb-id
fdb-only-bit
fext-cancel-dn
fext-cancel-up
fg-monitor-int
fg-monitor-method
fifteen-min
file-board-type
file-name
filetransfer
filter
filterid
filter-type
first-hop
flow
fng-alarm-time
fng-reset-time
fo-hystersis
force-hold
force-reference
forking
forward-delay
forwarding
forward-port
frame-mode
frame-net-bw
framer
frequency
fullview-packages

2911
462
950
153
153
268
985
985
1709
1767
1709
3005
233
233
940
940
1669
2253
2253
442
93
93
528
3097
584
1001
1001
940
929
368
702
658
1654
605
144
2106
144
178
707

G
g992-1-a
g992-1-b
g992-2-a

2062
2062
2062

3HH-04416-EBAA-TCZZA

01

Index

g992-3-a
g992-3-aj
g992-3-am
g992-3-b
g992-3-l1
g992-3-l2
g992-5-a
g992-5-aj
g992-5-am
g992-5-b
g993-2-12a
g993-2-12b
g993-2-17a
g993-2-30a
g993-2-8a
g993-2-8b
g993-2-8c
g993-2-8d
gateway
gem-sharing
general
generate-expires
generate-key
generate-starts
ghstone-set-pwr-ctrl
ghstones-pwr-mode
glb-leave
global
global-fwd
global-ospf
global-rip
global-session
green-action
group
group-assembly-time
group-info
group-name
group-opt
group-profile
group-rtx-profile
group-rtx-profiles
group-sampling
grp-assembly-time
grp-index
grp-ip-addr
grp-membership
grp-to-package
gsmp-retry-time
gsmp-sub-version
gsmp-version
gw-ip
gw-ip-addr

2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
2062
1017
565
658
2953
2968
807
198
191
720
552
1659
1657
1656
757
523
294
859
2826
407
1032
860
863
2112
2048
860
895
2288
2427
2285
899
899
899
1015
1017

H
handshake
handshake-period
hello-interval

3HH-04416-EBAA-TCZZA 01

2076
436
805

hello-time
help
high-jbfl
history
hold-time
hop-delay
hops-threshold
host-address
host-id
host-ip-address
host-purge-intv
host-report-intv

658
3112
934
3102
853
854
786
400
597
316
720
715

I
icid
icmp
icmpv6-burst
icmpv6-rate
id
idle-timeout
ieee-802.3ah
igmp
igmp-burst
igmp-rate
igmp-version
igr-routemap-act
igs-stats
igs-system
igs-vlan-grp
ima-group
ima-link
impedance
imp-noise-prot-dn
imp-noise-prot-up
in
inactive-timer
inactivity-time
indeterminate
indet-log-full-action
index
info
ingress-hw-filter
ingress-port
ingress-profile
ingress-qos
ingress-vc-label
init-authreq-off
init-data-jitter
initialize
in-mapped-vci
in-mapped-vpi
inm-cluster-cont
inm-eq-inp-mode
inm-equiv-inp-histo
inm-iat-histo
inm-iat-offset
inm-iat-step

2591
288
547
547
313
450
2062
385
547
547
702
840
2300
720
2430
1266
1269
929
168
168
3119
1032
1005
1551
83
2342
3113
1805
303
565
544
1072
2076
918
2076
1074
1074
266
266
2018
2017
266
266

Released

3141

Index

inm-mode
in-port
in-qos-prof-name
ins-sensitivity
instance
int-arr-time-dn
int-arr-time-up
interface
interface-atm-pvc
interface-bandwidth
interface-port
internal
interval
interval-no
interval-num
interval-number
interval-type
int-no
int-traff-gen
intvl-number
inventory
ip
ip-addr
ip-address
ip-addr-policy
ip-bridge-port
ip-config-mode
ip-cross-connect
ip-net-to-media
ip-parameters
ip-prefix
ip-route
ip-statistics
ipv6-address
ipversion
isam
isdn-codec
isdn-suffix1
isdn-suffix2
isdn-term-format
itf-ip-addr
itf-type
itu-g993-1
ivps-ip
iwf-on-liu

266
326
598
266
660
229
229
565
2070
1813
2072
299
853
1969
1817
1733
445
2529
2366
1673
2507
287
289
320
915
2104
915
274
2321
2316
2413
2319
1859
644
772
151
959
965
965
965
2470
803
2062
953
144

J
jitter-buff-size
junk-collection

141
842

K
keep-alive-intvl
key
kill-debug

3142

992
451
2975

Released

L
l0-time
l2-agpow-red-tx
l2-agpw-to-red-tx
l2cp
l2-filter
l2forward
l2-time
l3-filter
la
label-map
lacp
lacp-mode
lanx-port
last-hop
last-max-resp-tim
last-memb-cnt
layer2-oam
layer2-terminated
layer3-itf
lbm-data
lbm-data-len
lbm-tlv-type
learned-unicast-mac
leave-rsp-timer
leftr-day-farend
leftr-day-nearend
leftr-farend
leftr-nearend
leftr-thresh-dn
leftr-thresh-up
level
liadmin
license
line
line-feed
lineid
line-id
lineid-ext-rept
lineid-syn-prof
line-num
linesig-remanswer
line-status
link
link-speed
link-state-trap
link-type
link-up-changes
link-updown-trap
linkup-record
liu
liu-on-liu
liuser
lktype
lm-init
lm-resp

3HH-04416-EBAA-TCZZA

172
172
172
898
526
1287
172
528
652
1064
385
653
957
3097
715
715
899
1706
669
2995
2995
2995
3033
722
252
252
252
252
229
229
996
385
2213
247
929
1025
929
2795
913
1021
929
1025
385
373
279
2470
2009
2072
2011
148
144
385
2983
1001
1001

01

Index

load-sharing-policy
load-thresh
local-oam-info
local-port
location
log
log-entry
log-full-action
logical-flow-type
login-banner
logout
log-sev-level
loop-attenuation
loopback
loopback-info
loopback-port
loopback-timeout
loop-diagnostic
loop-id-syntax
los
los-day
loss-duration
loss-thresh-alert
lower
low-jbfl
low-pri-defect
lsa-type
lsmredundancy
lsp-name
lt-expect
ltline
lt-ont-signaling
ltparm
ltsession

1047
554
2358
2328
313
385
2237
63
535
382
3111
63
887
889
2364
301
887
2937
321
985
985
745
745
2156
934
1001
831
1285
1067
245
1025
702
1027
1021

M
mac
mac-address
mac-filter
mac-infilter
mac-learn-ctrl
mac-learning
mac-learn-off
mac-stats
major
major-log-full-action
management
manager
map-user-group
margin-down-curr
margin-down-worst
margin-up-curr
margin-up-worst
marker
mask
match
mau

3HH-04416-EBAA-TCZZA 01

774
2893
447
485
636
649
2079
2353
1605
83
316
116
407
882
882
882
882
1791
2479
3130
987

max-active-port
max-age
max-agpowlev-down
max-agpowlev-up
max-arp-entries
max-band
max-bitrate
max-bitrate-down
max-bitrate-up
max-bw
max-cc
max-cells
max-committed-mac
max-data-jitter
max-delay
max-delay-dn
max-delay-down
max-delay-up
max-delay-var-dn
max-delay-var-up
max-dot1p
max-dst-port
max-exp-thrpt-dn
max-exp-thrpt-up
max-freq
max-frequency
max-hop-count
max-ingress-rate
max-instance-num
max-ip-antispoof
max-ipv6-antispf
max-line-rate
max-lt-link-speed
max-mcast-bandwidth
max-mcast-learn
max-msg-rate
max-nbr-pkts
max-net-rate-dn
max-net-rate-up
max-network-delay
max-noise-down
max-noise-up
max-no-rate-based
max-num-channel
max-num-group
max-num-uncfg
max-out-udp-size
max-pad-attempts
max-payload-tag
max-peer
max-per-window
max-psd-down
max-psd-up
max-queue-size
max-rate-link1
max-rate-link2
max-rate-link3
max-rate-link4

1047
658
180
180
690
191
735
168
168
749
764
1073
630
918
445
229
168
168
168
168
621
329
229
229
191
223
658
588
1052
636
636
882
373
510
720
702
487
229
229
965
172
172
749
728
702
738
938
757
759
838
116
180
180
116
882
882
882
882

Released

3143

Index

max-recv-power-up
max-reported-dist
max-req
max-retrans
max-retries
max-retry-itvl
max-routes
max-rsp-time
max-src-port
max-threshold
max-threshold2
max-transhandling
max-unicast-mac
max-up-qos-policy
max-waiting-delay
mcast-addr
m-cast-avail-bw
mcast-channel
mcast-chn
mcast-grp-addr
mcast-inc-shape
mcast-src
mcast-src-addr
mcast-stats
mcast-svc-context
m-cast-used-bw
mcast-vlan-id
mc-pbit-value
mc-pon-vlan-xlate
mc-vlan-xlate
md5-key
md5-password
md5-realm
mean-bit-rate
measurement-intvl
media-gateway
media-gateway-id
megaco
megaco-media-gw
megaco-plug-unit
megaco-sig-gw
megaco-sig-lt
megaco-term
member-port
memory-down
memory-usage
mem-query-int
mep
meter
metering-type
metric
metric-type
mgc-id
mgc-type
mg-domain-name
mg-mid-type
mgnt-vlan-id
mg-profile-name

3144

180
2042
433
965
691
691
683
715
329
1027
1027
965
630
636
965
750
2106
2917
2918
2418
508
2916
2418
2304
702
2106
702
702
730
702
807
929
929
735
1007
965
959
385
1250
1253
1252
1258
1255
2828
168
2220
715
1001
586
959
688
813
965
965
965
965
313
965

Released

mhf-creation
micpsd-pt-down
min-bitrate-down
min-bitrate-up
min-data-jitter
min-delay-dn
min-delay-up
min-dot1p
min-dst-port
min-exp-thrpt-dn
min-exp-thrpt-up
min-frequency
min-inp-rein-dn
min-inp-rein-up
min-inp-shine-dn
min-inp-shine-up
min-interval
min-l2-br-down
min-length
min-line-rate
min-noise-down
min-noise-up
min-num-numeric-char
min-num-special-char
minor
minor-log-full-action
min-rate-link1
min-rate-link2
min-rate-link3
min-rate-link4
min-rx-links
min-se-time
min-severity
min-src-port
min-threshold
min-threshold2
min-tx-links
min-usable-signal
mirror
mirror-mode
mirror-vlan
mirror-voice-traffic
misc
miscellaneous
mixed-case
mld-burst
mld-rate
mnemonic1
mnemonic2
mnemonic3
mnemonic4
mnemonic5
mode
modification
module
module-mcast-channel
module-mcast-src
module-status

3HH-04416-EBAA-TCZZA

998
225
168
168
918
229
229
621
329
229
229
223
229
229
229
229
116
168
440
882
172
172
440
440
1587
83
882
882
882
882
893
944
116
329
1027
1027
893
223
296
630
630
301
1178
2277
440
547
547
88
88
88
88
88
58
172
2920
2288
2286
467

01

Index

monitor
more
m-psd-level-down
m-psd-level-up
mru
msg-code
msg-type
mstp
mtu
mtu-size
muf-control
my-ipaddress

761
3133
191
191
772
323
323
385
286
3091
223
670

N
name
nas-id
nas-ip-address
nbr-changed-alarms
nbr-msgs
nd-burst
nd-rate
near-end
near-end-ima-id
neighbour
netmask
netw-igmp-version
network-addr
network-itf
network-port
network-port-info
network-vlan
new-broadcast
new-secure-fwd
next-free-index
nexthop
next-hop
next-hop-address
nexthopaddrtype
nni-ctrl-pkt-policer
noise-margin-down
noise-margin-up
noise-psd-mode-dn
noise-psd-mode-up
noise-psd-pt-down
noise-psd-pt-up
no-more
non-itf-rep-sev-level
notify-profile
notify-view
nssa-area
ntr-ssmout-vlan
nwvlan

168
424
424
1660
2995
547
547
266
893
853
953
715
2321
672
723
1780
636
598
598
2875
1065
274
1868
1065
503
2091
2091
255
255
262
264
3134
63
411
400
822
313
730

O
oam

3HH-04416-EBAA-TCZZA 01

385

oam-stats
offset
one-day
ont-active-groups
operation-mode
operator
operator-policy
oper-data
oper-rate
oper-state
oper-weight
op-mode
opr-state
opr-state/tx-rate-ds
optional-band
optional-endfreq
options-max-fwd
opt-startfreq
ospf
oswp
oswp-number
out-mapped-vci
out-mapped-vpi
out-port
output-ql-thresh
overflow-state-it
overlap-484-act
overrule-data
overrule-state
ownerid

2362
223
1671
2424
724
383
417
2014
565
2097
565
882
2700
2091
191
191
940
191
800
473
2244
1074
1074
327
358
800
918
255
2062
1021

P
package
packagemember
package-member
package-to-src
packet-length
pado-timeout
pads-timeout
pae
paired-port
param-a
param-b
part-buf-thresh
participant-port
partition
partition-id
partition-type
passive-heartbeat
password
password-timeout
path-cost
path-cost-type
pbit
pbit0
pbit1
pbit2

713
741
737
2284
141
757
757
432
156
204
204
552
1778
2637
899
898
965
383
385
662
658
774
624
624
624

Released

3145

Index

pbit3
pbit4
pbit5
pbit6
pbit7
pbit-scheduling
pbo
pbo-mode
pccp
peak-bit-rate
peer
peer-oam-info
perf-info
period
periph-mgnt-vlan
perm-pkg-bitmap
phy-addr
phy-itf-status
ping
ping-dest-ipaddr
ping-interval
pkg-memb-bitmap
pkg-mem-bitmap
pkt-fwd-state
plan-bitrate-down
plan-bitrate-up
plan-exp-thrpt-dn
plan-exp-thrpt-up
planned-resource
planned-type
plug-in-unit
plug-in-unit-ext
pme-stats
pmfile
pm-to-iwf
pm-to-liu
polarity1
polarity2
polarity3
polarity4
polarity5
policed-size-ctrl
policer
policer-color
policer-profile
policer-type
policy
policy-action
poll
polling-rate
poll-interval
pon-active-groups
ponvlan
port
port-15min-stats
port-accumu-stats
port-curr-15min-stats
port-curr-day-stats

3146

624
624
624
624
624
591
204
191
467
739
2479
2360
2577
718
313
702
3072
2140
3091
468
468
735
739
727
168
168
229
229
1112
124
1152
1234
2356
444
144
144
88
88
88
88
88
523
523
499
531
523
424
531
3126
319
805
2421
729
279
1733
1769
1727
1730

Released

port-delay
port-details
port-entry
port-event
port-filter
port-id
port-info
port-instance
port-num-in-proto
port-prev-day-stats
port-protection
port-protocol
port-rcv
port-reprt-shaper
ports-list
port-stats
port-type
pots-syntax
power
power_mgnt_mode
pppcc-engine-tca
pppoe
pppoe-burst
pppoe-linerate
pppoe-rate
pppoe-relay-tag
pppox-relay
ppp-profile
pre-activated
precedence
prefixandlength
prefix-length
prefix-match
prev-15min
prev-15min-stats
prev-1day
prev-1day-stats
prev-day-stats
preview-blackout
preview-duration
preview-number
preview-packages
preview-valid
previous-15min
previous-15min-stats
previous-1day
previous-interval
primary-dns
primary-file-server-id
primary-nbns
prim-asp-ip
prim-mgc-ip
prim-mgc-udp
prim-sctp-port
print
prio-regen-name
prio-regen-next
prio-regen-prof

3HH-04416-EBAA-TCZZA

854
2891
2231
1725
341
2502
2820
664
313
1736
156
610
938
899
470
779
292
913
987
172
1225
385
547
598
547
598
2085
772
926
533
2850
2413
845
1817
2462
1823
2464
2776
739
739
739
710
715
2529
1745
1972
1969
428
473
428
976
965
965
976
58
630
1721
630

01

Index

priority
priority-policy
priority-regen
priority-scheme
pri-server-addr
privacy
private-ip
private-netmask
private-vlan-id
privilege
probe
profile
profile-name
profiles
prompt
propr-feat-value
protection-element
protection-group
protocol
protocol-ctrl
protocol-filter
protocol-group
protocol-stats
protocol-trace
protocol-type
provider-name
prov-rpl-time
proxy-mode
psd
psd-mask-up
psd-pbo-e-len-up
psd-pbo-par-a-up
psd-pbo-par-b-up
psd-shape-down
psd-shape-up
pstn-term-format
public
push
pvc
pvid
pvid-tagging-flag
pwtdm

114
596
624
356
445
405
953
953
953
400
882
383
624
1918
58
180
131
130
341
501
598
610
2322
980
481
938
965
875
178
180
205
191
191
185
191
965
405
1065
272
630
630
141

Q
qos
qos-cvlan-list
qos-policy
qos-profile
qos-queue
qos-slot
quat-asp-ip
quat-mgc-ip
quat-mgc-udp
quat-sctp-port
querier
query-int
query-interval

3HH-04416-EBAA-TCZZA 01

385
1705
428
630
1281
1278
976
965
965
976
724
724
715

queue
queue0-weight
queue1-weight
queue-config
queue-profile
quiet-period

499
581
581
581
559
433

R
rack
radius
radius-client
rad-noise-down
rad-noise-up
rad-time-down
rad-time-up
rai-to-iwf
rai-to-liu
ra-mode-down
ra-mode-up
rate
rate-limit
rau-noise-down
rau-noise-up
rau-time-down
rau-time-up
re-adsl
read-view
reassem-timeout
re-auth-period
reboot
reboot-isam
reboot-shub
receive
red-action
red-bat-delay
redcy-ctrl-status
redistributed-route
redistribution
reduced-resp-int
redundancy
redundancy-cmd
redundancy-state
ref-order
reg-head-start
region-name
region-version
regi-set
register
register-intv
register-uri
reg-prev-ava-intv
reg-retry-intv
reg-start-min
reg-sub
rei-to-iwf
rei-to-liu
release-delay

123
417
2876
172
172
172
172
144
144
168
168
2340
487
172
172
172
172
183
400
670
433
3023
3022
3022
840
523
965
131
2481
834
720
940
950
2611
362
936
658
658
882
936
936
936
936
936
936
918
144
144
965

Released

3147

Index

release-mode
release-type
remark-value
remote
remote-id
remote-id-dhcp
remote-id-pppoe
remote-mep
remove-root-int
repeaters
res-data-bandwidth
reset
resource-id
response-intvl
response-timer
result-index
res-voice-bandwidth
retrans
retransmit-itvl
retry-count
retry-limit
retry-num
rf-band-list
rfc2833-pl-type
rfc2833-process
rip
robustness
role
route
route-age-out
route-dest
route-destination
route-map
router-id
router-ip
router-priority
router-purge-intv
route-type
routing-table
rs-elect-length
rshow
rssiprof
rst
rtp-delay-thres
rtp-dscp
rtp-gateway-ip
rtp-ip
rtp-jitter-thres
rtp-link-mtu
rtp-pbits
rtp-pktloss-thres
rtp-vlan-id
rtry-after-thrsh
rtx-max-delay-dn
rtx-max-delay-up
rtx-mode-dn
rtx-mode-up
rtx-profile

3148

918
965
522
135
782
598
598
1004
720
882
510
3050
1112
992
722
2795
510
965
805
724
418
445
172
918
918
838
715
852
462
842
681
835
685
800
953
803
720
687
2479
223
3124
1109
329
963
915
915
924
963
915
915
963
915
940
255
255
229
229
229

Released

rule
rx-drop-pkts
rx-gain
rx-octets
rx-octets-day
rx-pkts
rx-psd-shape-up

928
2104
929
985
985
2104
191

S
sample
scheduler-node
scheduler-profile
scope
sc-rb-dn
sc-rb-us
sc-xcon-dn
sc-xcon-us
sdp
sec-asp-ip
sec-mgc-ip
sec-mgc-udp
second-dns
second-file-server-id
second-nbns
secret
secret-id
sec-sctp-port
secs-threshold
security
security-level
security-pae
segment
segment-status
selection-policy
self-ip-addr
self-ip-addr-mode
send
send-count
sensor-id
server
server-ip-addr
server-name
server-port
server-profile
server-retries
server-role
servers
server-table
server-timeout
service
service-name
service-profile
service-type
ses-day-farend
ses-day-nearend
ses-farend
ses-nearend

3HH-04416-EBAA-TCZZA

3125
508
557
854
591
591
591
591
1067
976
965
965
428
473
428
418
948
976
786
382
402
2076
889
2518
653
720
720
840
3013
1110
443
319
785
319
450
450
910
426
2199
433
385
739
168
1070
252
252
252
252

01

Index

sess-ageout-15min
sess-ageout-1day
session
session-cmd
session-id
session-peers
session-stats
session-status
session-timer
sess-timeout
se-time
set-log-table
severity
severity1
severity2
severity3
severity4
severity5
sfp
sfpe1t1-clock
sfpe1t1-framer
sfprssi
sftp-user
sgi-mgi
sgi-user-label
shaper
shaper-profile
shdsl
shdsl-bandwidth
shdsl-isam
shdsl-port
shdsl-seg
shelf
shelf-summary
shine-ratio-dn
shine-ratio-up
show
shub
shub-dup-mac-alarm
shub-fdb
shub-filter-entry
shub-gen
shub-info
shub-nr-mcast-entries
shub-port-vlan-map
shub-vlan-name
side
signal-dscp
signal-gateway
signal-gateway-ip
signal-ip
signal-link-mtu
signal-pbits
signal-vlan-id
sip
sip-dial-plan
sip-plugin-unit
sip-server

3HH-04416-EBAA-TCZZA 01

762
762
535
1021
1007
2634
2636
2632
944
428
944
2235
65
88
88
88
88
88
1103
1227
1230
1220
454
976
976
540
508
1260
1809
1263
561
2960
124
1088
229
229
3123
613
1758
1754
1756
1645
1679
1760
1751
1753
889
915
976
915
924
915
915
915
385
1242
1243
1238

sip-termination
sip-vsp
site
size
sleep
slm
slm-initiator-mac
slm-initiator-mep
slot
slot-id
slot-numbering
smac
snap-shot
snmpproxy-statistics
snmp-version
snr-margin
sntp
software-mngt
source-mac
source-proto
span
span-status
spatial
spectral-profile
spectrum-profile
split-horizon
src
src-ip-addr
src-ip-address
src-ipv6-addr
src-mac-addr
ssh
ssm
ssmout-ceiling
ssmout-ltport
ssmout-synce
stable-obs-period
stack
stacked-qos-vlan
stacked-vlan
starts
start-time
state
static-lsp
static-prefix
static-suffix
statistics
stats-config
status
stub-area
sub-head-start
sub-index
sub-period
subtree
summary
support-redun
supp-timeout
sustained-rate

1245
1240
910
1007
3108
1005
2755
2755
126
924
385
992
2902
2435
411
887
319
385
141
685
882
2509
1170
882
172
840
745
323
715
528
526
2968
363
358
371
369
940
2156
1703
1701
843
950
2545
1065
926
926
696
951
93
813
918
848
918
398
1688
940
433
501

Released

3149

Index

svcreason-format
sw-error-log
switchover
switch-type
sw-mgmt
swp
swp-disk-file
sync
synce
sync-if-timing
syntax-pattern
syslog
system
system-mac
system-parameters
system-stats
system-time

965
2715
468
959
1159
2251
2253
1293
366
358
913
980
313
313
2326
2302
3075

T
t38-same-udp
ta4
table
t-acm-delta
tag
target-mac
target-ql
tc
tc-15min-int
tc-1day-int
tca
tca-enable
tca-line-threshold
tc-int
tc-map-dot1p
tcp
tc-pam-link1
tc-pam-link2
tc-pam-link3
tc-pam-link4
tc-pam-sele
tcp-idle-time
tcp-port
tcp-retry-time
tc-to-qmap
tdmintf
tee
telnet
telnet-ai
temperature
template-name
template-version
temporal
term-group
termid-type
terminal-timeout
termination
termination-id

3150

918
918
1138
918
636
1007
363
499
1673
1675
554
963
252
1667
499
329
882
882
882
882
882
938
899
899
1853
139
3131
3104
3105
1110
713
713
1162
2613
965
58
929
959

Released

tert-asp-ip
tert-mgc-ip
tert-mgc-udp
tert-sctp-port
test
testaccessstate
test-bit-pattern
test-id
test-mode
test-name(unit)
test-parm-num
tftp-rollovr
threshold
time
timeout
timeout-limit
timeout-period
time-out-value
timer-b
timer-f
timers
timer-t1
timer-t2
time-stamp-reply
timezone-offset
tinfo
tl1
topo-discovery
to-port
tos
total
total-burst
total-rate
traceroute
trace-selection
traffic-class
tran-ageout-15min
tran-ageout-1day
transaction
transceiver-inventory
transfer-mode
transit-delay
trans-itvl
translation
trans-max-age
transport
transproto
tree
trgt-noise-down
trgt-noise-up
tries
trigger-esa-mgc
ttir1
ttl
tx-gain
tx-hold-count
tx-octets
tx-octets-day

3HH-04416-EBAA-TCZZA

976
965
965
976
2151
929
2995
2755
1021
1027
1021
442
93
2293
3013
418
1021
457
918
918
805
918
918
355
319
918
452
899
296
329
1829
547
547
3097
720
580
762
762
457
1114
247
805
822
822
757
385
910
3109
172
172
3091
2985
918
3005
929
658
985
985

01

Index

tx-period
tx-pkts
tx-rate-ds
tx-rate-us
type
type-extend
type-high
type-low

433
2104
2091
2091
398
1021
1021
1021

U
uas-day-farend
uas-day-nearend
uas-farend
uas-nearend
uclbm
udp
udp-parameters
udp-port
uncfg-res-time
unicast-mac
unicast-mac-address
uni-interface
unit
unit-id
unit-status
unnumbered-as
unsolicit-rpt-int
untagged-ip
untag-port
upboaele-min-thrs
upbo-aele-mode
up-buf-thresh
update-timer
uplink-group
upl-interval-num
upload
upload-download
upload-password
upload-path
upload-username
up-marker
up-obc-thresh
up-policer
up-policy
upstream
upstream-queue
uri
uri-type
user
user2-comm
user2user-hairpin
user-agent
user-agent-ap
user-igmp-version
user-ip
username
user-name

3HH-04416-EBAA-TCZZA 01

252
252
252
252
2995
335
2327
965
738
605
3033
2731
505
887
2516
290
724
1890
618
205
205
552
842
1653
2970
445
2255
445
445
445
535
552
535
538
2044
573
929
918
279
614
313
915
924
715
1015
774
443

user-port
users
user-session
us-num-queue

902
2413
2859
565

V
v2-max-rsp-time
v3-max-num-rec
v3-max-rsp-time
v43
v6extensive
v6-port-stats
v6summary
value
value1
value2
value3
value4
value5
vbd-g711a-pl-type
vbd-g711u-pl-type
vbd-mode
vce-band-plan
vce-capacity-mode
vce-gain-mode
vce-hist-pcoder
vce-join-timeout
vce-min-par-join
vce-profile
vdsl
vdsl2
vdsl-band-plan
vect-board
vect-disturbers
vect-fallback
vect-feat-bitmap
vect-group
vect-leav-thresh
vect-line
vect-line-near-end
vect-profile
vect-qln-mode
version
vgr-link
view
visible1
visible2
visible3
visible4
visible5
vlan
vlan-bind
vlan-day-stats
vlan-drop-enable
vlan-drop-pcp
vlan-enhance-perf
vlan-filter

724
715
724
198
2400
794
2398
687
1027
1027
1027
1027
1027
918
918
918
236
239
236
236
236
236
236
191
205
191
1197
2042
242
233
2056
233
1194
1961
233
247
168
2048
398
88
88
88
88
88
317
669
1748
2995
2995
727
724

Released

3151

Index

vlanid
vlan-id
vlan-itf-delete
vlan-port
vlan-priority
vlan-router-port
vlan-scope
vmac-address-format
vmac-bridge-port-fdb
v-noise-psd-down
v-noise-psd-pt-down
v-noise-psd-pt-up
v-noise-psd-up
v-noise-snr-down
v-noise-snr-up
voiceoswp
vp-board
vp-link
vplt-autodiscover
vrf
vrf-agent-stats
vrf-id
vrf-index
vrf-index-acc
vrf-index-auth
vrf-mapping
vrf-media
vrf-next-index
vrf-route
vrf-routing
vrf-statistics
vsp

141
286
3054
607
2995
723
636
597
1761
205
217
219
205
205
205
313
245
245
239
670
2404
287
418
426
426
1874
1872
1875
1868
1885
1858
918

xdsl-line
xdsl-stepup-delay
xdsl-tca

2937
375
1188

Y
y1731pm
yellow-action

1006
523

W
wait-time
warmline-dl-timer
warmline-service
warning
warn-log-full-action
weight
welcome-banner
window
window-length
window-number
window-size
wire-mode
wire-pair
write
write-view
wt-rls-delay

358
918
929
1569
83
508
382
93
139
139
116
882
2518
3110
400
965

X
xdsl
xdsl-bonding
xdsl-int

3152

385
859
1920

Released

3HH-04416-EBAA-TCZZA

01

Alcatel-Lucent assumes no responsibility for the accuracy of the information presented, which is
subject to change without notice.
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All
other trademarks are the property of their respective owners.
Copyright 2014 Alcatel-Lucent.
All rights reserved.
Disclaimers

Alcatel-Lucent products are intended for commercial uses. Without the appropriate network design
engineering, they must not be sold, licensed or otherwise distributed for use in any hazardous
environments requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life-support machines, or weapons
systems, in which the failure of products could lead directly to death, personal injury, or severe physical
or environmental damage. The customer hereby agrees that the use, sale, license or other distribution
of the products for any such application without the prior written consent of Alcatel-Lucent, shall be at
the customer's sole risk. The customer hereby agrees to defend and hold Alcatel-Lucent harmless from
any claims for loss, cost, damage, expense or liability that may arise out of or in connection with the
use, sale, license or other distribution of the products in such applications.
This document may contain information regarding the use and installation of non-Alcatel-Lucent
products. Please note that this information is provided as a courtesy to assist you. While Alcatel-Lucent
tries to ensure that this information accurately reflects information provided by the supplier, please refer
to the materials provided with any non-Alcatel-Lucent product and contact the supplier for
confirmation. Alcatel-Lucent assumes no responsibility or liability for incorrect or incomplete
information provided about non-Alcatel-Lucent products.
However, this does not constitute a representation or warranty. The warranties provided for
Alcatel-Lucent products, if any, are set forth in contractual documentation entered into by
Alcatel-Lucent and its customers.
This document was originally written in English. If there is any conflict or inconsistency between the
English version and any other version of a document, the English version shall prevail.

When printed by Alcatel-Lucent, this document is printed on recycled paper.

Customer documentation and product support

Customer documentation
https://infoproducts.alcatel-lucent.com/cgi-bin/doc_welc.pl

Technical Support
http://support.alcatel-lucent.com

Documentation feedback
documentation.feedback@alcatel-lucent.com

2014 Alcatel-Lucent. All rights reserved.


3HH-04416-EBAA-TCZZA Edition 01 Released

Вам также может понравиться