Anda di halaman 1dari 1920

Alcatel-Lucent 7302

INTELLIGENT SERVICES ACCESS MANAGER


RELEASE 3.3.X | FEATURE GROUP 3.4

Alcatel-Lucent 7330
INTELLIGENT SERVICES ACCESS MANAGER FIBER TO THE NODE
RELEASE 3.3.X | FEATURE GROUP 3.4

CLI COMMANDS

3HH-04416-CDAA-TCZZA Edition 03
Status Released
Change Note
Short Title 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.

Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

Contents

1- ISAM CLI 1
1.1 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.3 CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.4 Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.6 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.7 Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.8 Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.9 The CLI Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.10 Entering CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.11 CLI Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

2- Environment Configuration Commands 39


2.1 Environment Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 40
2.2 Environment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

3- Alarm Configuration Commands 43


3.1 Alarm Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.2 Alarm Log Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.3 Alarm Entry Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.4 Alarm Delta Log Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.5 SHub Alarm Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.6 Customizable Alarm Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . 63

4- Trap Configuration Commands 68


4.1 Trap Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.2 Trap Definition Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.3 Trap Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.4 SHub Trap Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 75

5- Equipment Configuration Commands 77


5.1 Equipment Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.2 Slot Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.3 Applique Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.4 Protection Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
5.5 Protection Element Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5.6 External-link-host Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 86
5.7 Host Shelf SFP Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.8 NE Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.9 Rack Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.10 Shelf Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
5.11 Environment Monitoring Configuration Command . . . . . . . . . . . . . . . . . . . . . . 92

6- xDSL Configuration Commands 93


6.1 xDSL Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.2 xDSL Common Service Profile Configuration Command . . . . . . . . . . . . . . . . . . . 99
6.3 xDSL Common Spectrum Profile Configuration Command . . . . . . . . . . . . . . . . . . 102
6.4 xDSL Artificial Noise Downstream Configuration Command . . . . . . . . . . . . . . . . . . 108

3HH-04416-CDAA-TCZZA Edition 03 Released i


Contents

6.5 xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command . . . . . . . . . . . . . . 110


6.6 xDSL Spectrum Profile for RE-ADSL2 Configuration Command . . . . . . . . . . . . . . . 112
6.7 xDSL Spectrum Profile for ADSL2 Plus Configuration Command . . . . . . . . . . . . . . . 114
6.8 ADSL2-plus Custom PSD shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
6.9 xDSL Spectrum Profile for VDSL Configuration Command . . . . . . . . . . . . . . . . . . 118
6.10 VDSL Ghs Tones Transmission Power Control Configuration Command . . . . . . . . . . 125
6.11 VDSL Custom PSD shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
6.12 VDSL Custom PSD shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
6.13 xDSL Spectrum Profile for VDSL2 Configuration Command . . . . . . . . . . . . . . . . . 129
6.14 VDSL2 Custom PSD shape Downstream . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
6.15 VDSL2 Custom PSD shape Upstream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
6.16 VDSL2 Custom PSD shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
6.17 VDSL2 Virtual Noise Downstream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
6.18 VDSL2 Virtual Noise Upstream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
6.19 xDSL Line Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
6.20 xDSL Line TCA Threshold Configuration Command . . . . . . . . . . . . . . . . . . . . . 144
6.21 xDSL Local Loop Unbundling Configuration Command . . . . . . . . . . . . . . . . . . . 146

7- ATM Configuration Commands 148


7.1 ATM Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
7.2 ATM PVC Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
7.3 IPOA X-connect L2 interworking port Configuration Command . . . . . . . . . . . . . . . . 152

8- Interface Management Configuration Commands 154


8.1 Interface Management Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . 155
8.2 Network Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
8.3 Extend Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
8.4 Interface Alarm Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
8.5 SHub Management Interface Configuration Command . . . . . . . . . . . . . . . . . . . . 161
8.6 SHub IP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
8.7 SHub ICMP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
8.8 SHub Multi-Network Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 164
8.9 SHub Unnumbered Interface Configuration Command . . . . . . . . . . . . . . . . . . . . 165
8.10 SHub Port Control Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 166
8.11 SHub Interface Uplink Group Configuration Command . . . . . . . . . . . . . . . . . . . . 168
8.12 SHub Interface Uplink Group Portlist Configuration Command . . . . . . . . . . . . . . . . 169

9- Error Configuration Commands 170


9.1 Error Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
9.2 Error Log Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

10- System Configuration Commands 173


10.1 System Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
10.2 System Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
10.3 System Management Host IP Address Configuration Command . . . . . . . . . . . . . . 179
10.4 System Management Vlan Host IP-Address Configuration Command . . . . . . . . . . . . 180
10.5 System Management Default Route Configuration Command . . . . . . . . . . . . . . . . 181
10.6 System SNTP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
10.7 SHub System Loop ID Syntax Configuration Command . . . . . . . . . . . . . . . . . . . 183
10.8 SHub System ICMP Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 184
10.9 SHub System ICMP Filter In Port List Configuration Command . . . . . . . . . . . . . . . 187
10.10 SHub System ICMP Filter Out Port List Configuration Command . . . . . . . . . . . . . 188
10.11 SHub System TCP Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 189
10.12 SHub System TCP Filter In Port List Configuration Command . . . . . . . . . . . . . . . 192
10.13 SHub System TCP Filter Out Port List Configuration Command . . . . . . . . . . . . . . 193
10.14 SHub System UDP Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 194
10.15 SHub System UDP Filter In Port List Configuration Command . . . . . . . . . . . . . . . 197

ii Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

10.16 SHub System UDP Filter Out Port List Configuration Command . . . . . . . . . . . . . . 198
10.17 SHub System Other Protocol Filter Configuration Command . . . . . . . . . . . . . . . . 199
10.18 SHub System Other Protocol Filter Configuration Command . . . . . . . . . . . . . . . . 202
10.19 SHub System VLAN Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 205
10.20 SHub System IP Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 206
10.21 SHub System ID Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 207
10.22 SHub System VLAN Group Configuration Command . . . . . . . . . . . . . . . . . . . . 208
10.23 SHub System HTTP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 209
10.24 System Clock Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

11- Security Configuration Commands 211


11.1 Security Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
11.2 Security Banner Configuration Commmand . . . . . . . . . . . . . . . . . . . . . . . . . . 216
11.3 Operator Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
11.4 Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
11.5 Default Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
11.6 SNMP View Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
11.7 Security SNMP Community Configuration Command . . . . . . . . . . . . . . . . . . . . . 229
11.8 Security SNMPv3 Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 231
11.9 Security SNMPv3 User Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 233
11.10 Security SNMPv3 User-Group Configuration Command . . . . . . . . . . . . . . . . . . 235
11.11 SNMP Notify View Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 237
11.12 Security SNMP Notification Profile Configuration Command . . . . . . . . . . . . . . . . 239
11.13 Security SNMP Notification Profile Filter Configuration Command . . . . . . . . . . . . . 241
11.14 Security SNMP Element Manager Configuration Command . . . . . . . . . . . . . . . . 243
11.15 SHub Security SNMP Community Configuration Command . . . . . . . . . . . . . . . . 245
11.16 Security IP Address Pool Configuration Command . . . . . . . . . . . . . . . . . . . . . 247
11.17 Security IP Address Pool Reserve Configuration Command . . . . . . . . . . . . . . . . 249
11.18 Security RADIUS Client Configuration Command . . . . . . . . . . . . . . . . . . . . . . 250
11.19 Security RADIUS Authentication Server Configuration Command . . . . . . . . . . . . . 251
11.20 Security RADIUS Accounting Server Configuration Command . . . . . . . . . . . . . . . 253
11.21 Security RADIUS Dynamic Authorization Client Configuration Command . . . . . . . . . 255
11.22 Security RADIUS Policy Configuration Command . . . . . . . . . . . . . . . . . . . . . . 256
11.23 Security RADIUS Server Configuration Command . . . . . . . . . . . . . . . . . . . . . 258
11.24 Security Domain Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 260
11.25 Security Domain IP Pool Configuration Command . . . . . . . . . . . . . . . . . . . . . 262
11.26 Security Domain User Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 263
11.27 Security Connection Profile Configuration Command . . . . . . . . . . . . . . . . . . . . 264
11.28 Security Connection Policy Configuration Command . . . . . . . . . . . . . . . . . . . . 265
11.29 Security 802.1x PAE System Configuration Command . . . . . . . . . . . . . . . . . . . 266
11.30 Security 802.1x Port Authentication Configuration Command . . . . . . . . . . . . . . . 267
11.31 Security 802.1x Extension, Port Authentication Configuration Command . . . . . . . . . 269
11.32 Security 802.1x Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 271
11.33 Security Password Policy Configuration Commmand . . . . . . . . . . . . . . . . . . . . 272
11.34 File Transfer Configure Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
11.35 file Transfer server Configure Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 275

12- Secure Shell Configuration Commands 276


12.1 Secure Shell Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 277
12.2 SSH Server Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
12.3 Secure Shell User Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 279
12.4 Secure Shell Access Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 280
12.5 Secure Shell SFTP User Configuration Command . . . . . . . . . . . . . . . . . . . . . . 282

13- Transaction Configuration Commands 283


13.1 Transaction Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 284
13.2 Transaction Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

3HH-04416-CDAA-TCZZA Edition 03 Released iii


Contents

14- SYSLOG Configuration Commands 286


14.1 SYSLOG Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
14.2 SYSLOG Destination Configuration command . . . . . . . . . . . . . . . . . . . . . . . . 288
14.3 SYSLOG Route Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

15- Software Management Configuration Commands 293


15.1 Software Management Configuration Command Tree . . . . . . . . . . . . . . . . . . . . 294
15.2 Software Management Overall Software Package Configuration Command . . . . . . . . 295
15.3 Database Automatic Activation Configure Command . . . . . . . . . . . . . . . . . . . . . 298

16- Ethernet Configuration Commands 300


16.1 Ethernet Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
16.2 Ethernet IP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
16.3 SHub Ethernet MAC Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . 303
16.4 SHub Ethernet MAC Filter Port List Configuration Command . . . . . . . . . . . . . . . . 305
16.5 SHub Ethernet Rate Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 306

17- QoS Configuration Commands 307


17.1 QoS Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
17.2 QoS Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
17.3 QoS 802.1P Class-to-Queue Mapping Configuration Command . . . . . . . . . . . . . . . 315
17.4 QoS Dsl Control Pkt Policer Configuration Command . . . . . . . . . . . . . . . . . . . . 316
17.5 QoS DSCP-to-Dot1P Alignment for L3 Forwarded Traffic Configuration Command . . . . 317
17.6 QoS Queue Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 318
17.7 QoS Scheduler Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 319
17.8 QoS CAC Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 320
17.9 QoS Single Dot1P Marker Configuration Command . . . . . . . . . . . . . . . . . . . . . 322
17.10 QoS Single DSCP Marker Configuration Command . . . . . . . . . . . . . . . . . . . . . 323
17.11 QoS DSCP Contract Table Marker Configuration Command . . . . . . . . . . . . . . . . 324
17.12 QoS DSCP Contract Table Code-point Configuration Command For DSCP-contract . . . 325
17.13 QoS Dot1P and DSCP Contract Table Marker Configuration Command . . . . . . . . . . 326
17.14 DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract . . . . 327
17.15 QoS Dot1P and Single DSCP Marker Configuration Command . . . . . . . . . . . . . . 328
17.16 QoS Dot1P Alignment Marker Configuration Command . . . . . . . . . . . . . . . . . . . 329
17.17 QoS Policer Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 331
17.18 QoS L2 Filter Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 333
17.19 QoS L3 Filter Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 335
17.20 QoS Policy Action Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . 337
17.21 QoS Policy Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 339
17.22 QoS Session Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 341
17.23 QoS Session Upstream Policy List Configuration Command . . . . . . . . . . . . . . . . 344
17.24 QoS Session Downstream Policy List Configuration Command . . . . . . . . . . . . . . 345
17.25 QoS Board-Level Queue and Performance Configuration Command . . . . . . . . . . . 346
17.26 QoS Queue Threshold Crossing Alarm Configuration Command . . . . . . . . . . . . . . 348
17.27 QoS DSL Link Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
17.28 QoS LIM Queue Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 352
17.29 QoS ShdSL Link Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 354
17.30 QoS LIM Queue (SHDSL) Configuration Command . . . . . . . . . . . . . . . . . . . . . 356
17.31 QoS Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
17.32 QoS Interface Queue Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 360
17.33 SHub QoS Traffic Class Configuration Command . . . . . . . . . . . . . . . . . . . . . . 362
17.34 SHub QoS Queue Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 363
17.35 SHub QoS DSCP2P Map Configuration Command . . . . . . . . . . . . . . . . . . . . . 365
17.36 SHub QoS Flow Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 366
17.37 SHub QoS Policer Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 368
17.38 SHub QoS Ingress Policing on Port Configuration Command . . . . . . . . . . . . . . . 369

iv Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

18- VLAN Configuration Commands 370


18.1 VLAN Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
18.2 VLAN General Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
18.3 VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
18.4 VLAN Filtering Database Configuration Command . . . . . . . . . . . . . . . . . . . . . . 378
18.5 VLAN Protocol-based Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 380
18.6 SHub General VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 382
18.7 SHub VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
18.8 SHub Static Egress Port for VLAN Configuration Command . . . . . . . . . . . . . . . . . 385
18.9 SHub Static Untagged Egress Port for VLAN Configuration Command . . . . . . . . . . . 387
18.10 SHub Unicast MAC Filtering Database Configuration Command . . . . . . . . . . . . . . 388

19- Bridge Configuration Commands 390


19.1 Bridge Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
19.2 Bridge General Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
19.3 Bridge Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
19.4 Bridge Port to VLAN Association Configuration Command . . . . . . . . . . . . . . . . . . 397
19.5 SHub Bridge Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
19.6 SHub Bridge Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 402
19.7 Mac learning Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

20- Link Aggregation Configuration Commands 405


20.1 Link Aggregation Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . 406
20.2 Link Aggregation Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 407
20.3 Link Aggregation Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 408

21- Multiple Spanning Tree Configuration Commands 410


21.1 Multiple Spanning Tree Configuration Command Tree . . . . . . . . . . . . . . . . . . . . 411
21.2 SHub MSTP general configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 412
21.3 SHub MSTP Instance configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 414
21.4 SHub MSTP Vlan-Instance Mapping configuration Command . . . . . . . . . . . . . . . . 415
21.5 SHub MSTP Port configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 416
21.6 SHub MSTP Port-Instance configuration Command . . . . . . . . . . . . . . . . . . . . . 418

22- IP Configuration Commands 419


22.1 IP Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
22.2 VLAN Bundle Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
22.3 VRF Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
22.4 IP Interface Network Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 425
22.5 IP Interface Network Numbered Configuration Command . . . . . . . . . . . . . . . . . . 427
22.6 IP Interface User Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 428
22.7 IP Interface User Bridge Port Configuration Command . . . . . . . . . . . . . . . . . . . . 430
22.8 IP User Gateway Interface VRF Configuration Command . . . . . . . . . . . . . . . . . . 432
22.9 VRF Route Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
22.10 IP SHub VRF Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
22.11 IP SHub VRF Route Map Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
22.12 IP SHub VRF Route Preference Command . . . . . . . . . . . . . . . . . . . . . . . . . 438
22.13 IP SHub VRF Route Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 439
22.14 IP SHub ARP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
22.15 IP SHub ARP per VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . . . 442

23- IGMP Configuration Commands 443


23.1 IGMP Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
23.2 IGMP Channel Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
23.3 IGMP Channel Permission Package Members Configuration Command . . . . . . . . . . 448

3HH-04416-CDAA-TCZZA Edition 03 Released v


Contents

23.4 IGMP Channel Preview Package Members Configuration Command . . . . . . . . . . . . 450


23.5 IGMP Package Bitmaps Configuration Command . . . . . . . . . . . . . . . . . . . . . . 452
23.6 IGMP System Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
23.7 IGMP System CDR Type Configuration Command . . . . . . . . . . . . . . . . . . . . . . 457
23.8 IGMP Vlan System Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 458
23.9 SHub IGMP IGS System Configuration Command . . . . . . . . . . . . . . . . . . . . . . 459
23.10 SHub IGMP Response Timer Configuration Command . . . . . . . . . . . . . . . . . . . 461
23.11 SHub IGMP Router Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . 462
23.12 SHub IGMP VLAN Filter Configuration Command . . . . . . . . . . . . . . . . . . . . . . 463
23.13 Shub IGMP Vlan enhanced performance Configuration Command . . . . . . . . . . . . 466
23.14 Shub IGMP CAC BUNDLE TABLE Configuration Command . . . . . . . . . . . . . . . . 467

24- Multicast Configuration Commands 468


24.1 Multicast Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
24.2 Multicast General Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 471
24.3 General Multicast Package Members Configuration Command . . . . . . . . . . . . . . . 472
24.4 Multicast Capacity Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 473
24.5 Multicast Sources Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 474
24.6 Multicast Sources Package Members Configuration Command . . . . . . . . . . . . . . . 476
24.7 SHub Dynamic and Static-Dynamic Multicast Egress Port Show Command . . . . . . . . 477
24.8 SHub Static Multicast Streams Configuration Command . . . . . . . . . . . . . . . . . . . 478
24.9 SHub Static Multicast Egress Port Configuration Command . . . . . . . . . . . . . . . . . 479
24.10 SHub IGMP CAC Multicast Sources Configuration Command . . . . . . . . . . . . . . . 481

25- PPPoX-Relay Configuration Commands 483


25.1 PPPoX-Relay Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . 484
25.2 PPPoX Cross-connect Global Configuration Command . . . . . . . . . . . . . . . . . . . 485
25.3 PPPoX Cross-connect Engine Configuration Command . . . . . . . . . . . . . . . . . . . 487
25.4 PPPoX Cross-connect Engine Monitoring Configuration Command . . . . . . . . . . . . . 489
25.5 PPPoX Cross-connect Client Port Configuration Command . . . . . . . . . . . . . . . . . 490
25.6 PPPoX Cross-connect Client Port Monitoring Configuration Command . . . . . . . . . . . 492

26- PPPoE Configuration Commands 493


26.1 PPPoE Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
26.2 PPPoE Server Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
26.3 PPPoE Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
26.4 PPPoX Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 497

27- DHCP Relay Configuration Commands 499


27.1 DHCP Relay Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . 500
27.2 DHCP Relay Agent Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 501
27.3 DHCP Relay SHub Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 503
27.4 DHCP Relay SHub Server Configuration Command per VRF . . . . . . . . . . . . . . . . 504
27.5 DHCP Relay SHub Agent Configuration Command per VRF . . . . . . . . . . . . . . . . . 505

28- OSPF Configuration Commands 507


28.1 OSPF Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
28.2 OSPF Parameters Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 511
28.3 OSPF Area Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
28.4 OSPF Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
28.5 OSPF Interface Timers Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 516
28.6 OSPF Interface MD5 Key Configuration Command . . . . . . . . . . . . . . . . . . . . . . 518
28.7 OSPF Interface Metric Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 520
28.8 OSPF Aggregate Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 521
28.9 OSPF External Aggregate Configuration Command . . . . . . . . . . . . . . . . . . . . . 522
28.10 OSPF Stub Area Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 524

vi Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

28.11 OSPF Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 525


28.12 OSPF Interface Timers Configuration Command . . . . . . . . . . . . . . . . . . . . . . 527
28.13 OSPF Interface MD5 Key Configuration Command . . . . . . . . . . . . . . . . . . . . . 529
28.14 OSPF Interface Metric Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 531
28.15 OSPF Stub Aggregate Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 532
28.16 OSPF NSSA Area Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 533
28.17 OSPF Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 535
28.18 OSPF Interface Timers Configuration Command . . . . . . . . . . . . . . . . . . . . . . 537
28.19 OSPF Interface MD5 Key Configuration Command . . . . . . . . . . . . . . . . . . . . . 539
28.20 OSPF Interface Metric Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 541
28.21 OSPF NSSA Aggregate Configuration Command . . . . . . . . . . . . . . . . . . . . . . 542
28.22 OSPF External Aggregate Configuration Command . . . . . . . . . . . . . . . . . . . . . 543
28.23 OSPF Redistribution Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 545
28.24 OSPF Redistribution Route Configuration Command . . . . . . . . . . . . . . . . . . . . 546

29- RIP Configuration Commands 547


29.1 RIP Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
29.2 RIP Common Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
29.3 RIP Redistribution Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 550
29.4 RIP Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
29.5 RIP Interface Timers Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 553
29.6 RIP Interface MD5 Key Configuration Command . . . . . . . . . . . . . . . . . . . . . . . 554
29.7 RIP Route Aggregation Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
29.8 RIP Route Map Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557

30- Cluster Management Configure Commands 558


30.1 Cluster Management Configure Command Tree . . . . . . . . . . . . . . . . . . . . . . . 559
30.2 Cluster System Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
30.3 Cluster Neighbor Discovery Configuration Command . . . . . . . . . . . . . . . . . . . . 561
30.4 Cluster Topology Collection Configuration Command . . . . . . . . . . . . . . . . . . . . 562
30.5 Cluster Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

31- XDSL Bonding Configuration Commands 564


31.1 XDSL Bonding Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . 565
31.2 XDSL Bonding Assembly Timer Configuration Command . . . . . . . . . . . . . . . . . . 566
31.3 xDSL Bonding Group Profile Configuration Command . . . . . . . . . . . . . . . . . . . . 567
31.4 xDSL Bonding Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
31.5 xDSL Bonding Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572

32- CPE Remote Configuration Commands 573


32.1 CPE Remote Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . 574
32.2 CPE Remote Management System Configuration Commands . . . . . . . . . . . . . . . . 575
32.3 CPE Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
32.4 CPE IPProxy Session Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . 577
32.5 CPE IPProxy Shub Vlan Configuration Command . . . . . . . . . . . . . . . . . . . . . . 578

33- SHDSL Configuration Commands 579


33.1 SHDSL Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
33.2 SHDSL Span Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
33.3 SHDSL Unit Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
33.4 SHDSL Segment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 586

34- IMA Configuration Commands 588


34.1 IMA Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
34.2 IMA Group Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
34.3 IMA Link Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592

3HH-04416-CDAA-TCZZA Edition 03 Released vii


Contents

35- L2CP Configuration Commands 593


35.1 L2CP Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
35.2 L2CP Session Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

36- Voice Configuration Commands 598


36.1 Voice Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
36.2 Voice Sip Server Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 601
36.3 Voice Sip User Agent Configuration Commands by dhcp . . . . . . . . . . . . . . . . . . 603
36.4 Voice Sip User Agent Configuration Commands by Manual . . . . . . . . . . . . . . . . . 606
36.5 Voice Sip Dial Plan Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . . 609
36.6 Voice Sip Dial Plan Digitmap Configuration Commands . . . . . . . . . . . . . . . . . . . 610
36.7 Voice Sip Termination Configuration Commands . . . . . . . . . . . . . . . . . . . . . . . 611
36.8 voice sip Local Loop Unbundling Configuration Command . . . . . . . . . . . . . . . . . . 613

37- Debug Configuration Commands 614


37.1 Debug Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
37.2 Protocol Tracing Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 616

38- Ethernet User Ports Configuration Commands 618


38.1 Ethernet User Ports Configuration Command Tree . . . . . . . . . . . . . . . . . . . . . . 619
38.2 Ethernet Line Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
38.3 Ethernet Line TCA Threshold Configuration Command . . . . . . . . . . . . . . . . . . . 621

39- Equipment Status Commands 623


39.1 Equipment Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
39.2 Slot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
39.3 Profile Description Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
39.4 Applique Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
39.5 Shelf Summary Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
39.6 Protection Element Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
39.7 Protection Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
39.8 External-link-host Status Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
39.9 External-link-remote Status Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
39.10 NE Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
39.11 Rack Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
39.12 Shelf Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650

40- Trap Status Commands 653


40.1 Trap Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
40.2 Trap Manager Queue Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655

41- Alarm Log Status Commands 656


41.1 Alarm Log Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
41.2 Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
41.3 Equipment Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
41.4 Equipment Holder Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 665
41.5 Plug-in Unit Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
41.6 ATM Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
41.7 Ethernet Interface Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 675
41.8 Software Management Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . 676
41.9 xDSL Common Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 678
41.10 xDSL Near-end Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 680
41.11 xDSL Far-end Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 683
41.12 TCA xDSL Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 686

viii Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

41.13 Electrical-to-Optical Conversion Alarm Log Status Command . . . . . . . . . . . . . . . 691


41.14 Authentication Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 693
41.15 xDSL Bonding Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 696
41.16 IPoX Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
41.17 Redundancy Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 700
41.18 Custom Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
41.19 SFP Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
41.20 LLU Relay Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
41.21 Custom External Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 711
41.22 Plug In Unit Extended Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . 713
41.23 SIP User Agent Alarm Log Status Commands . . . . . . . . . . . . . . . . . . . . . . . . 716
41.24 SIP Slot Alarm Log Status Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
41.25 SIP Termination Alarm Log Status Commands . . . . . . . . . . . . . . . . . . . . . . . 720
41.26 Shdsl Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
41.27 Shdsl Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
41.28 Ima-Group Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
41.29 Ima-Link Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
41.30 Ether-Tca Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
41.31 Ether-Sfp Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
41.32 Alarm Qos Slot Log Status Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
41.33 Alarm Qos Queue Log Status Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 741
41.34 Log File Transfer Server Alarm Log Status Command . . . . . . . . . . . . . . . . . . . 743
41.35 Log L2 Forward Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 745
41.36 External Device Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 747

42- Current Alarm Status Commands 748


42.1 Current Alarm Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
42.2 Alarm Current Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
42.3 Equipment Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 754
42.4 Equipment Holder Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . 756
42.5 Plug-in Unit Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 759
42.6 ATM Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
42.7 Ethernet Interface Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . 764
42.8 Software Management Current Alarm Status Command . . . . . . . . . . . . . . . . . . . 765
42.9 xDSL Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
42.10 TCA xDSL Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 771
42.11 Electrical-to-Optical Conversion Current Alarm Status Command . . . . . . . . . . . . . 774
42.12 Authentication Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . 776
42.13 xDSL Bonding Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . 778
42.14 IPoX Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
42.15 Redundancy Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . 781
42.16 Custom Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 782
42.17 SFP Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
42.18 LLU Relay Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 787
42.19 Custom External Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . 788
42.20 Plug In Unit Extended Current Alarm Status Command . . . . . . . . . . . . . . . . . . . 790
42.21 SIP User Agent Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . 792
42.22 SIP Slot Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 794
42.23 SIP Termination Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . 795
42.24 Shdsl Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
42.25 Shdsl Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
42.26 Ima-Group Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 801
42.27 Ima-Link Current Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 803
42.28 Alarm Current Ether-Tca Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 805
42.29 Alarm Current Ether-Sfp Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 807
42.30 Alarm Current Qos Slot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 809
42.31 Alarm Current Qos Queue Status Command . . . . . . . . . . . . . . . . . . . . . . . . 811
42.32 Alarm File Transfer Server Status Command . . . . . . . . . . . . . . . . . . . . . . . . 813
42.33 Alarm L2 Forward Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814

3HH-04416-CDAA-TCZZA Edition 03 Released ix


Contents

42.34 Alarm Current External Device Status Command . . . . . . . . . . . . . . . . . . . . . . 816

43- Alarm Snap-shot Status Commands 817


43.1 Alarm Snap-shot Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
43.2 Alarm Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
43.3 Alarm Snapshot Equipment Status Command . . . . . . . . . . . . . . . . . . . . . . . . 823
43.4 Equipment Holder Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . 825
43.5 Plug-in Unit Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
43.6 ATM Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
43.7 Alarm Snapshot Ethernet Interface Status Command . . . . . . . . . . . . . . . . . . . . 833
43.8 Alarm Snapshot Software Management Status Command . . . . . . . . . . . . . . . . . . 834
43.9 Alarm xDSL Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
43.10 TCA xDSL Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
43.11 Alarm Electrical-to-Optical Conversion for Snapshot Status Command . . . . . . . . . . 843
43.12 Authentication Alarms for Snapshot Status Command . . . . . . . . . . . . . . . . . . . 844
43.13 Alarm xDSL Bonding Snap Shot Status Command . . . . . . . . . . . . . . . . . . . . . 846
43.14 Alarm IPoX Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
43.15 Alarm Redundancy Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . 849
43.16 Alarm Custom Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 850
43.17 Alarm SFP Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
43.18 Alarm Snapshot LLU Relay Status Command . . . . . . . . . . . . . . . . . . . . . . . . 855
43.19 Alarm Custom External Snap Shot Status Command . . . . . . . . . . . . . . . . . . . . 856
43.20 Alarm Plug In Unit Extended Snap Shot Status Command . . . . . . . . . . . . . . . . . 858
43.21 Alarm Snap-shot SIP User Agent Status Command . . . . . . . . . . . . . . . . . . . . . 860
43.22 Alarm Snap-shot SIP Slot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 862
43.23 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . . . . . . . . . . . . 863
43.24 Alarm Snap-shot Shdsl Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 865
43.25 Alarm Snap-shot Shdsl Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 867
43.26 Alarm Snap-shot Ima-Group Status Command . . . . . . . . . . . . . . . . . . . . . . . 869
43.27 Alarm Snap-shot Ima-Link Status Command . . . . . . . . . . . . . . . . . . . . . . . . 871
43.28 Alarm Snap-shot Ether-Tca Status Command . . . . . . . . . . . . . . . . . . . . . . . . 873
43.29 Alarm Snap-shot Ether-Sfp Status Command . . . . . . . . . . . . . . . . . . . . . . . . 875
43.30 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . . . . . . . . . . . . 877
43.31 Alarm Snap-shot SIP Termination Status Command . . . . . . . . . . . . . . . . . . . . 879
43.32 Alarm File Transfer Server Status Command . . . . . . . . . . . . . . . . . . . . . . . . 881
43.33 Alarm L2 Forward Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
43.34 Alarm Snap-shot External Device Status Command . . . . . . . . . . . . . . . . . . . . 884

44- Alarm Delta Log Status Commands 885


44.1 Alarm Delta Log Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
44.2 Alarm Generic Delta Alarm Log Status Command . . . . . . . . . . . . . . . . . . . . . . 887
44.3 Indeterminate Alarm Delta Log Status Command . . . . . . . . . . . . . . . . . . . . . . . 889
44.4 Warning Alarm Delta Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 900
44.5 Minor Alarm Delta Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
44.6 Major Alarm Delta Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
44.7 Critical Alarm Delta Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 933

45- SHub Alarm Status Command 944


45.1 SHub Alarm Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
45.2 SHub Alarm Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
45.3 SHub Alarm Equipment Snap-shot Status Command . . . . . . . . . . . . . . . . . . . . 948
45.4 SHub Alarm Snapshot Ethernet Interface Status Command . . . . . . . . . . . . . . . . . 950
45.5 SHub Alarm RIP Snapshot Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 952
45.6 SHub Alarm OSPF Snap-shot Status Command . . . . . . . . . . . . . . . . . . . . . . . 954
45.7 SHub Alarm Uplink Group Snapshot Status Command . . . . . . . . . . . . . . . . . . . . 956
45.8 SHub Alarm Delta Log Changes Status Command . . . . . . . . . . . . . . . . . . . . . . 957

x Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

46- ATM Status Commands 958


46.1 ATM Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
46.2 ATM Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
46.3 PVC Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
46.4 TC Adapter Protocol Interval Status Command . . . . . . . . . . . . . . . . . . . . . . . . 964
46.5 TC Adapter Protocol Current Quarter Performance Data Command . . . . . . . . . . . . . 966
46.6 TC Adapter Protocol Current Day Performance Data Command . . . . . . . . . . . . . . . 968
46.7 TC Adapter Protocol Performance Data for Previous Quarter Intervals Command . . . . . 970
46.8 TC Adapter Protocol Performance Data for Previous Day Intervals Command . . . . . . . 972

47- Bridge Status Commands 974


47.1 Bridge Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
47.2 Bridge Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
47.3 Bridge Port to ATM PVC Mapping Status Command . . . . . . . . . . . . . . . . . . . . . 978
47.4 SHub Bridge Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
47.5 SHub Bridge Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981

48- VLAN Status Commands 984


48.1 VLAN Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
48.2 Global VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
48.3 Residential Bridge VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 988
48.4 Cross-connect VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
48.5 Stacked VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
48.6 Stacked QoS VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
48.7 QoS C-VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
48.8 Layer-2 Terminated VLAN Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 997
48.9 VLAN Name Mapping Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
48.10 VLAN Filtering Database Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1000
48.11 Bridge Port Filtering Database Status Command . . . . . . . . . . . . . . . . . . . . . .1002
48.12 Port VLAN Association Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1004
48.13 VLAN Priority Regeneration Profile Status Command . . . . . . . . . . . . . . . . . . . .1006
48.14 Duplicate MAC Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
48.15 Port Event Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1011
48.16 Port Statistics for Current Quarter Status Command . . . . . . . . . . . . . . . . . . . .1013
48.17 Port Statistics for Current Day Status Command . . . . . . . . . . . . . . . . . . . . . .1015
48.18 Port Statistics for Previous Quarter Intervals Status Command . . . . . . . . . . . . . . .1017
48.19 Port Statistics for Previous Day Intervals Status Command . . . . . . . . . . . . . . . . .1020
48.20 VLAN Port Statistics for Current Quarter Status Command . . . . . . . . . . . . . . . . .1023
48.21 VLAN Port Statistics for Current Day Status Command . . . . . . . . . . . . . . . . . . .1026
48.22 VLAN Port Statistics for Previous Quarter Intervals Status Command . . . . . . . . . . .1029
48.23 VLAN Port Statistics for Previous Day Intervals Status Command . . . . . . . . . . . . .1032
48.24 SHub Port VLAN Association Status Command . . . . . . . . . . . . . . . . . . . . . . .1035
48.25 SHub VLAN Name Mapping Status Command . . . . . . . . . . . . . . . . . . . . . . .1036
48.26 SHub VLAN Filtering Database Status Command . . . . . . . . . . . . . . . . . . . . . .1037
48.27 SHub Filtering Database Entry Status Command . . . . . . . . . . . . . . . . . . . . . .1039
48.28 SHub Duplicate MAC Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . .1041
48.29 SHub Number Of Active Multicast Entries Status Command . . . . . . . . . . . . . . . .1043

49- Link Aggregation Status Commands 1044


49.1 Link Aggregation Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .1045
49.2 Link Aggregation Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1046
49.3 Link Aggregation Member List Status Command . . . . . . . . . . . . . . . . . . . . . . .1051
49.4 Link Aggregate Member Link Status Command . . . . . . . . . . . . . . . . . . . . . . . .1052

50- QOS Status Commands 1058

3HH-04416-CDAA-TCZZA Edition 03 Released xi


Contents

50.1 QOS Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1059


50.2 QoS Session Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1061
50.3 QoS Marker Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1062
50.4 QoS Policer Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1063
50.5 QoS Queue Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1064
50.6 QoS Scheduler Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1065
50.7 QoS CAC Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1066
50.8 QoS Policy Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1067
50.9 QoS L2 Filter Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1068
50.10 QoS L3 Filter Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1069
50.11 QoS Policy Action Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1070
50.12 QoS DSL Bandwidth Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1071
50.13 QoS Shdsl Bandwidth Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1073
50.14 QoS Ethernet Bandwidth Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1075
50.15 QoS Total Buffer Overflow Statistics for Previous Quarter . . . . . . . . . . . . . . . . .1077
50.16 QoS Total Buffer Overflow Statistics for Current Quarter . . . . . . . . . . . . . . . . . .1080
50.17 QoS Total Buffer Overflow Statistics for Previous Day Command . . . . . . . . . . . . .1083
50.18 QoS Total Buffer Overflow Statistics for Current Day . . . . . . . . . . . . . . . . . . . .1086
50.19 QoS Total Buffer Overflow Statistics Total Status Command . . . . . . . . . . . . . . . .1089
50.20 QoS Interface Buffer Overflow Statistics for Previous Quarter . . . . . . . . . . . . . . .1093
50.21 QoS Interface Buffer Overflow Statistics for Current Quarter . . . . . . . . . . . . . . . .1095
50.22 QoS Fan Out Statistics for Previous Quarter . . . . . . . . . . . . . . . . . . . . . . . . .1097
50.23 QoS Fan Out Statistics for Current 15 minutes . . . . . . . . . . . . . . . . . . . . . . .1099
50.24 QoS Fan Out Statistics for Previous Day . . . . . . . . . . . . . . . . . . . . . . . . . . .1101
50.25 QoS Fan Out Statistics for Current Day . . . . . . . . . . . . . . . . . . . . . . . . . . .1103
50.26 QoS SHub Meter Statistics Status Command . . . . . . . . . . . . . . . . . . . . . . . .1105
50.27 QoS SHub Flow Statistics Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1106

51- IP Status Commands 1107


51.1 IP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1108
51.2 IP VRF Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1109
51.3 IP Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1110
51.4 IP VRF Interface User Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1114
51.5 IP VRF Interface User Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1117
51.6 IP VRF Routes Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1119
51.7 IP VRF Net-to-Media Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1123
51.8 IP VRF Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1125
51.9 IP VRF Next Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1126
51.10 IP SHub VRF Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1127
51.11 IP SHub VRF Route Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1129
51.12 IP SHub ARP Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1131
51.13 IP SHub VRF Media Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1133
51.14 IP DHCP Session Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1135

52- xDSL Status Commands 1137


52.1 xDSL Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1138
52.2 xDSL Profiles Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1140
52.3 xDSL PM Interval Per Interface Status Command . . . . . . . . . . . . . . . . . . . . . .1141
52.4 xDSL Operational Data Near End Line Status Command . . . . . . . . . . . . . . . . . .1143
52.5 xDSL Operational Data Near End Channel Status Command . . . . . . . . . . . . . . . .1151
52.6 xDSL Operational Data Far End Line Status Command . . . . . . . . . . . . . . . . . . .1153
52.7 xDSL Operational Data Far End Channel Status Command . . . . . . . . . . . . . . . . .1159
52.8 xDSL Operational Data Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1161
52.9 xDSL Carrier Data Near End Status Command . . . . . . . . . . . . . . . . . . . . . . . .1165
52.10 xDSL Carrier Data Far End Status Command . . . . . . . . . . . . . . . . . . . . . . . .1168
52.11 xDSL Failure Status Near End Status Command . . . . . . . . . . . . . . . . . . . . . .1170
52.12 xDSL Failure Status Far End Status Command . . . . . . . . . . . . . . . . . . . . . . .1172
52.13 xDSL Counters Near End Line Current 15 Min . . . . . . . . . . . . . . . . . . . . . . .1174
52.14 xDSL Counters Near End Line Current Day . . . . . . . . . . . . . . . . . . . . . . . . .1176

xii Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

52.15 xDSL Counters Near End Line Previous 15 Min . . . . . . . . . . . . . . . . . . . . . . .1178


52.16 xDSL Counters Near End Of Line Previous Day . . . . . . . . . . . . . . . . . . . . . . .1180
52.17 xDSL Counters Near End Channel Current 15 Min . . . . . . . . . . . . . . . . . . . . .1182
52.18 xDSL Counters Near End Channel Current Day . . . . . . . . . . . . . . . . . . . . . . .1184
52.19 xDSL Counters Near End Channel Previous 15 Min . . . . . . . . . . . . . . . . . . . .1186
52.20 xDSL Counters Near End Channel Previous Day . . . . . . . . . . . . . . . . . . . . . .1188
52.21 xDSL Counters Far End Line Current 15 Min . . . . . . . . . . . . . . . . . . . . . . . .1190
52.22 xDSL Counters Far End Line Current Day . . . . . . . . . . . . . . . . . . . . . . . . . .1192
52.23 xDSL Counters Far End Line Previous 15 Min . . . . . . . . . . . . . . . . . . . . . . . .1194
52.24 xDSL Counters Far End Line Previous Day . . . . . . . . . . . . . . . . . . . . . . . . .1196
52.25 xDSL Counters Far End Channel Current 15 Min . . . . . . . . . . . . . . . . . . . . . .1198
52.26 xDSL Counters Far End Channel Current Day . . . . . . . . . . . . . . . . . . . . . . . .1200
52.27 xDSL Counters Far End Channel Previous 15 Min . . . . . . . . . . . . . . . . . . . . .1202
52.28 xDSL Counters Far End Channel Previous Day . . . . . . . . . . . . . . . . . . . . . . .1204
52.29 xDSL Inventory XT/RT Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1206
52.30 xDSL Board Capability Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1208
52.31 xDSL Low Rate Alarm Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1213
52.32 xDSL Low Rate Alarm Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1214
52.33 xDSL Low Rate Alarm Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1215

53- Configuration Data Status Commands 1217


53.1 Configuration Data Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .1218
53.2 xDSL Port Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1220
53.3 xDSL Port ATM Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . .1226
53.4 xDSL Port ATM Interface Configuration Status Command . . . . . . . . . . . . . . . . . .1228
53.5 xDSL Port Interface Configuration Status Command . . . . . . . . . . . . . . . . . . . . .1230
53.6 xDSL IGMP Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1232
53.7 xDSL Security PAE Configuration Status Command . . . . . . . . . . . . . . . . . . . . .1234
53.8 xDSL BridgePort Configuration Status Command . . . . . . . . . . . . . . . . . . . . . .1237
53.9 xDSL QoS Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1240
53.10 xDSL PPPoX Relay Configuration Status Command . . . . . . . . . . . . . . . . . . . .1242
53.11 xDSL PPPoE Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . .1244
53.12 xDSL Bonding Group Configuration Status Command . . . . . . . . . . . . . . . . . . .1246

54- Operational Data Status Commands 1248


54.1 Operational Data Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .1249
54.2 xDSL Port Operational Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1250
54.3 xDSL BridgePort Operational Status Command . . . . . . . . . . . . . . . . . . . . . . .1253
54.4 xDSL Port ATM Operational Status Command . . . . . . . . . . . . . . . . . . . . . . . .1255
54.5 xDSL Port Interface Configuration Status Command . . . . . . . . . . . . . . . . . . . . .1257
54.6 xDSL IGMP Operational Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1259
54.7 xDSL Port Ip Bridge Operational Status Command . . . . . . . . . . . . . . . . . . . . . .1261
54.8 xDSL QoS Opertaional Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1263

55- xDSL Bonding Status Commands 1265


55.1 xDSL Bonding Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1266
55.2 xDSL Bonding Profiles Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1267
55.3 xDSL Bonding Near End Operational Data Status Command . . . . . . . . . . . . . . . .1268
55.4 xDSL Bonding Far End Operational Data Status Command . . . . . . . . . . . . . . . . .1269
55.5 xDSL Bonding Group Operational Data Command . . . . . . . . . . . . . . . . . . . . . .1270
55.6 xDSL Bonding Near End Failure Status Command . . . . . . . . . . . . . . . . . . . . . .1271
55.7 xDSL Bonding Far End Failure Status Command . . . . . . . . . . . . . . . . . . . . . . .1273
55.8 xDSL Bonding Group Failure Status Command . . . . . . . . . . . . . . . . . . . . . . . .1275
55.9 xDSL Bonding Group Summary Info Command . . . . . . . . . . . . . . . . . . . . . . . .1277

56- PPPoE Status Commands 1278


56.1 PPPoE Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1279

3HH-04416-CDAA-TCZZA Edition 03 Released xiii


Contents

56.2 PPPoE Sessions Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1280


56.3 PPPoE Sessions/Connection Status Command . . . . . . . . . . . . . . . . . . . . . . .1282
56.4 PPPoE Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1285
56.5 PPPoX Interface Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1289
56.6 PPPoE Interface Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1291
56.7 PPPoE Interface Received Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1293
56.8 PPPoE Interface Transmitted Statistics Command . . . . . . . . . . . . . . . . . . . . . .1295
56.9 PPPoE Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1297
56.10 IP Address-related PPP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1299
56.11 MAC Address-related PPP Status Command . . . . . . . . . . . . . . . . . . . . . . . .1301

57- Interface Status Commands 1303


57.1 Interface Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1304
57.2 Interface Alarm Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1305
57.3 Physical Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1307
57.4 Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1308
57.5 Interface Test Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1315
57.6 Interface Stack Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1319
57.7 SHub Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1324
57.8 SHub Interface Port Control Status Command . . . . . . . . . . . . . . . . . . . . . . . .1326
57.9 SHub Interface Uplink Group Status Command . . . . . . . . . . . . . . . . . . . . . . . .1329
57.10 Interface Statistics Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1330
57.11 Interface Extensive Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1333

58- SNTP Status Commands 1335


58.1 SNTP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1336
58.2 SNTP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1337

59- System Status Commands 1338


59.1 System Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1339
59.2 SHub System IP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1340
59.3 SHub System Version Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1341
59.4 SHub System HTTP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1342
59.5 SHub System Common Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1343
59.6 SHub System Control Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1344
59.7 SHub IP Filter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1346
59.8 SHub System Manager Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1351
59.9 System Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1352
59.10 System Licenses Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1353
59.11 System Clock Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1355
59.12 Show syslog parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1357

60- Transaction Status Commands 1358


60.1 Transaction Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1359
60.2 Transaction Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1360
60.3 Transaction Log Entry Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1361

61- Error Status Command 1362


61.1 Error Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1363
61.2 Error Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1364

62- Software Status Commands 1366


62.1 Software Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1367
62.2 Database Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1368
62.3 Disk Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1370
62.4 Overall Software Package Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1372

xiv Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

62.5 Software Package Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1375


62.6 File Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1377
62.7 Upload/Download Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1379
62.8 SHub Software Management Status Command . . . . . . . . . . . . . . . . . . . . . . . .1382
62.9 SHub Configuration File Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1383
62.10 Status of the SHub Boot ROM Update Command . . . . . . . . . . . . . . . . . . . . . .1385

63- IGMP Status Commands 1386


63.1 IGMP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1387
63.2 IGMP System Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1388
63.3 IGMP Channel Sources Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1390
63.4 IGMP Channel Miscellaneous Status Command . . . . . . . . . . . . . . . . . . . . . . .1392
63.5 IGMP Channel Protocol Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1394
63.6 IGMP package to multicast source Command . . . . . . . . . . . . . . . . . . . . . . . .1396
63.7 IGMP Group to Package Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1397
63.8 Show Multicast Source Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . .1398
63.9 IGMP Module Counter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1400
63.10 IGMP Module Time Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1403
63.11 IGMP Module Miscellaneous Status Command . . . . . . . . . . . . . . . . . . . . . . .1405
63.12 SHub IGMP VLAN Router Port Status Command . . . . . . . . . . . . . . . . . . . . . .1407
63.13 Shub IGMP System Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1408
63.14 Shub IGMP CAC System Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1410
63.15 Shub IGMP CAC Multicast Sources Status Command . . . . . . . . . . . . . . . . . . .1412
63.16 Shub IGMP CAC Bundle Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1414
63.17 Shub IGMP CAC Bundle to Source Command . . . . . . . . . . . . . . . . . . . . . . .1416

64- Transport Status Commands 1417


64.1 Transport Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1418
64.2 ICMP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1419
64.3 IP Address Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1422
64.4 IP Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1424
64.5 IP Route Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1427
64.6 IP Net-to-media Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1429
64.7 SNMP Protocol Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1430
64.8 SNMP Engine Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1433
64.9 System Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1434
64.10 UDP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1435
64.11 UDP Listener Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1436
64.12 Ethernet Dot3 Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1437
64.13 Interface MAU Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1441
64.14 SFP status commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1444
64.15 SHub Ethernet Dot3 Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1446
64.16 SHub Dot3 Control Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1447
64.17 SHub Dot3 Pause Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1448
64.18 SHub Ethernet Dot3 Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1450
64.19 SHub L2 Filter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1454
64.20 SHub Rate Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1456
64.21 Interface MAU Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1458
64.22 Ethernet Lt Dot3 Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1462

65- DHCP Relay Status Commands 1464


65.1 DHCP Relay Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1465
65.2 DHCP Relay Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1466
65.3 DHCP Relay Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1468
65.4 SHub DHCP Relay Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1470

66- Multicast Status Commands 1471

3HH-04416-CDAA-TCZZA Edition 03 Released xv


Contents

66.1 Multicast Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1472


66.2 Multicast Active Groups Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1473
66.3 Multicast Group Membership Status Command . . . . . . . . . . . . . . . . . . . . . . . .1475
66.4 Dynamic and Static-Dynamic Multicast VLAN FWD Port Status Command . . . . . . . . .1477
66.5 SHub Multicast Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1479

67- CPE Management Status Commands 1480


67.1 CPE Management Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . .1481
67.2 CPE Management Show Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1482
67.3 CPE IPProxy Management Statistics Show Command . . . . . . . . . . . . . . . . . . . .1483

68- Session Status Commands 1485


68.1 Session Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1486
68.2 Session Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1487

69- PPPoX-Relay Status Commands 1489


69.1 PPPoX-Relay Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1490
69.2 PPPoX CC Engine Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1491
69.3 PPPoX CC Client Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1493
69.4 PPPoX CC Engine Monitor Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1495
69.5 PPPoX CC Client Port Monitor Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . .1497
69.6 PPPoX CC Session Engine Status Command . . . . . . . . . . . . . . . . . . . . . . . .1499
69.7 PPPoX CC Session Client Port Status Command . . . . . . . . . . . . . . . . . . . . . .1501

70- OSPF Status Commands 1503


70.1 OSPF Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1504
70.2 OSPF Area Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1505
70.3 OSPF LSA Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1507
70.4 OSPF External Link State Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1509
70.5 OSPF Interface Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1511
70.6 OSPF Neighbor Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1514
70.7 OSPF Routing Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1516
70.8 OSPF Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1518
70.9 OSPF Parameter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1519

71- RIP Status Commands 1521


71.1 RIP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1522
71.2 RIP Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1523
71.3 RIP Peer Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1524
71.4 RIP Routing Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1525
71.5 RIP Global Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1527

72- Cluster Status Commands 1528


72.1 Cluster Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1529
72.2 Cluster Port Counter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1530
72.3 Neighbor Device Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1532
72.4 Topology Device Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1534
72.5 Topology Connect Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1536

73- SHDSL Status Commands 1538


73.1 SHDSL Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1539
73.2 SHDSL Inventory Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1541
73.3 SHDSL Span Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1543
73.4 SHDSL Unit Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1550
73.5 SHDSL Segment Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1552

xvi Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

73.6 SHDSL Segment Counters Current Interval Status Command . . . . . . . . . . . . . . . .1556


73.7 SHDSL Segment Counters Current Day Status Command . . . . . . . . . . . . . . . . . .1558
73.8 SHDSL Segment Counters Previous Interval Status Command . . . . . . . . . . . . . . .1560
73.9 SHDSL Segment Counters Previous Day Status Command . . . . . . . . . . . . . . . . .1562
73.10 SHDSL Span Current Interval Performance Data Status Command . . . . . . . . . . . .1564
73.11 SHDSL Span Current Day Performance Data Status Command . . . . . . . . . . . . . .1566
73.12 SHDSL Span Previous Interval Performance Data Status Command . . . . . . . . . . .1568
73.13 SHDSL Span Previous Day Performance Data Status Command . . . . . . . . . . . . .1570

74- IMA Status Commands 1572


74.1 IMA Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1573
74.2 IMA Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1574
74.3 IMA Group Near-End Current Interval Performance Data Status Command . . . . . . . .1579
74.4 IMA Group Near-End Previous Interval Performance Data Status Command . . . . . . . .1581
74.5 IMA Group Far-End Current Interval Performance Data Status Command . . . . . . . . .1583
74.6 IMA Group Far-End Previous Interval Performance Data Status Command . . . . . . . . .1585
74.7 IMA Link Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1587
74.8 IMA Link Near-End Current Interval Performance Data Status Command . . . . . . . . . .1591
74.9 IMA Link Near-End Previous Interval Performance Data Status Command . . . . . . . . .1593
74.10 IMA Link Far-End Current Interval Performance Data Status Command . . . . . . . . . .1595
74.11 IMA Link Far-End Previous Interval Performance Data Status Command . . . . . . . . .1597

75- Voice Show Commands 1599


75.1 Voice Show Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1600
75.2 Voice Sip Server Show Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1601
75.3 Voice Sip server and associated user agent Show Commands . . . . . . . . . . . . . . .1602
75.4 Voice User Agent Show Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1603
75.5 Voice Dialplan Show Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1604
75.6 Voice Sip Termination Show Commands . . . . . . . . . . . . . . . . . . . . . . . . . . .1605
75.7 Voice Sip Dialplan and associated User Agent Show Commands . . . . . . . . . . . . . .1607
75.8 Voice termination and associated user agent Show Commands . . . . . . . . . . . . . . .1608

76- L2CP Status Commands 1609


76.1 L2CP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1610
76.2 L2CP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1611
76.3 L2CP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1613
76.4 L2CP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1615

77- MSTP Status Commands 1616


77.1 MSTP Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1617
77.2 SHub MSTP Bridge Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1618
77.3 SHub MSTP Instance Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1620
77.4 SHub MSTP Network Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1622
77.5 SHub MSTP Port Instance Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1625

78- Ethernet Lt Configuration Data Status Commands 1627


78.1 Ethernet Lt Configuration Data Status Command Tree . . . . . . . . . . . . . . . . . . . .1628
78.2 Ethernet Port Interface Configuration Status Command . . . . . . . . . . . . . . . . . . .1629
78.3 Ethernet IGMP Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . .1631
78.4 Ethernet Security PAE Configuration Status Command . . . . . . . . . . . . . . . . . . .1633
78.5 Ethernet BridgePort Configuration Status Command . . . . . . . . . . . . . . . . . . . . .1636
78.6 Ethernet QoS Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . . .1639
78.7 Ethernet PPPoE Configuration Status Command . . . . . . . . . . . . . . . . . . . . . . .1641

79- Ethernet Status Commands 1643


79.1 Ethernet Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1644

3HH-04416-CDAA-TCZZA Edition 03 Released xvii


Contents

79.2 Ethernet Counters Near End Line Current 15 Min . . . . . . . . . . . . . . . . . . . . . .1645


79.3 Ethernet Counters Near End Line Current Day . . . . . . . . . . . . . . . . . . . . . . . .1647
79.4 Ethernet Counters Near End Line Previous 15 Min . . . . . . . . . . . . . . . . . . . . . .1649
79.5 Ethernet Counters Near End Line Previous Day . . . . . . . . . . . . . . . . . . . . . . .1651
79.6 Ethernet PM Interval Per Interface Status Command . . . . . . . . . . . . . . . . . . . . .1653

80- Ethernet Lt Operational Data Status Commands 1655


80.1 Ethernet Lt Operational Data Status Command Tree . . . . . . . . . . . . . . . . . . . . .1656
80.2 Ethernet Port Operational Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1657
80.3 Ethernet BridgePort Operational Status Command . . . . . . . . . . . . . . . . . . . . . .1659
80.4 Ethernet Port Interface Operational Status Command . . . . . . . . . . . . . . . . . . . .1661
80.5 Ethernet IGMP Operational Status Command . . . . . . . . . . . . . . . . . . . . . . . .1663
80.6 Ethernet Port Ip Bridge Operational Status Command . . . . . . . . . . . . . . . . . . . .1665
80.7 Ethernet QoS Opertaional Status Command . . . . . . . . . . . . . . . . . . . . . . . . .1667

81- Security Status Commands 1669


81.1 Security Status Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1670
81.2 Operator Information Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1672
81.3 Domain Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1674
81.4 User Sessions Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1675
81.5 Connection Profile Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1679
81.6 Local IP Pool Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1680
81.7 IP Address Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1681
81.8 RADIUS Authentication Server Statistics Command . . . . . . . . . . . . . . . . . . . . .1682
81.9 RADIUS Authentication Server Status Command . . . . . . . . . . . . . . . . . . . . . . .1685
81.10 RADIUS Accounting Server Statistics Command . . . . . . . . . . . . . . . . . . . . . .1686
81.11 RADIUS Accounting Server Status Command . . . . . . . . . . . . . . . . . . . . . . . .1688
81.12 RADIUS Dynamic Authentication Client Status Command . . . . . . . . . . . . . . . . .1689
81.13 RADIUS Next Available Index Command . . . . . . . . . . . . . . . . . . . . . . . . . .1691
81.14 RADIUS Client Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1692
81.15 PAE Authenticator Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1693
81.16 EAPOL Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1696
81.17 Diagnostic Information Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .1698
81.18 Session Statistics Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1702
81.19 PAE Port System Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1704
81.20 MAC Address related EAPOL Status Command . . . . . . . . . . . . . . . . . . . . . .1706
81.21 SSH Server Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1708

82- Alarm Management Commands 1709


82.1 Alarm Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1710
82.2 Alarm Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1711
82.3 Snapshot Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1712
82.4 SHub Snapshot Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1713
82.5 Alarm Delta Log Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1714
82.6 Log Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1715

83- ATM Management Commands 1716


83.1 ATM Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1717
83.2 ATM Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1718

84- IGMP Management Commands 1719


84.1 IGMP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1720
84.2 IGMP Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1721
84.3 IGMP Multicast Sources Management Command . . . . . . . . . . . . . . . . . . . . . .1722
84.4 IGMP Slot Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1723
84.5 Shub IGMP CAC Bundle Management Command . . . . . . . . . . . . . . . . . . . . . .1724

xviii Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

84.6 Shub IGMP CAC Source Management Command . . . . . . . . . . . . . . . . . . . . . .1725


84.7 Shub IGMP CAC System Management Command . . . . . . . . . . . . . . . . . . . . . .1726
84.8 Shub IGMP VLAN System Management Command . . . . . . . . . . . . . . . . . . . . .1727
84.9 IGMP Channel Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1728

85- PPPoX Management Commands 1730


85.1 PPPoX Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1731
85.2 PPPoX Engine Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . .1732

86- xDSL Management Commands 1733


86.1 xDSL Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1734
86.2 xDSL Line Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1735

87- Software Management Commands 1737


87.1 Software Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .1738
87.2 Software Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1739
87.3 OSWP Software Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1740
87.4 Database Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1742
87.5 File Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1744
87.6 SHub Software Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1745
87.7 SHub Database Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1746
87.8 SHub Software Package Administration Command . . . . . . . . . . . . . . . . . . . . . .1747
87.9 Update the SHub Boot ROM Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1748

88- OSPF Management Commands 1749


88.1 OSPF Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1750
88.2 OSPF Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . . .1751

89- RIP Management Commands 1753


89.1 RIP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1754
89.2 RIP Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . . . .1755

90- SHDSL Management Commands 1756


90.1 SHDSL Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1757
90.2 SHDSL Segment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . .1758

91- Session Management Commands 1760


91.1 Session Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .1761
91.2 Forced Disconnect Session Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1762

92- System Management Commands 1763


92.1 System Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1764
92.2 SYSLOG Management command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1765
92.3 Secure Shell Server Key Regeneration Command . . . . . . . . . . . . . . . . . . . . . .1766

93- Equipment Management Commands 1767


93.1 Equipment Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . .1768
93.2 Equipment Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1769
93.3 Slot Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1770
93.4 SHub Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1772

94- Bridge Management Commands 1773


94.1 Bridge Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1774

3HH-04416-CDAA-TCZZA Edition 03 Released xix


Contents

94.2 Learned Unicast MAC Address Management Command . . . . . . . . . . . . . . . . . . .1775


94.3 VLAN Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1777

95- Trap Management Commands 1778


95.1 Trap Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1779
95.2 Trap Manager Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . .1780

96- IP Management Commands 1781


96.1 IP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1782
96.2 Slot-related VRF Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1783
96.3 IP VRF Interface Reset Management Command . . . . . . . . . . . . . . . . . . . . . . .1784
96.4 IP VRF Interface bridgeport Reset Management Command . . . . . . . . . . . . . . . . .1786
96.5 Vlan Interface Delete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1788

97- DHCP Management Command 1789


97.1 DHCP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1790
97.2 DHCP Relay User Port Management Command . . . . . . . . . . . . . . . . . . . . . . .1791

98- Transport Management Commands 1793


98.1 Transport Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .1794
98.2 IP Net-to-media Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . .1795

99- SNTP Management Commands 1796


99.1 SNTP Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1797
99.2 SNTP Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1798

100- Transactions Management Commands 1799


100.1 Transactions Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . .1800
100.2 Transaction Configuration Management Command . . . . . . . . . . . . . . . . . . . . .1801

101- Security Management Commands 1802


101.1 Security Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . .1803
101.2 Security 802.1x Port Authentication Management Command . . . . . . . . . . . . . . . .1804

102- MSTP Bridge Management Commands 1805


102.1 MSTP Bridge Management Command Tree . . . . . . . . . . . . . . . . . . . . . . . . .1806
102.2 Port-related MSTP Management Command . . . . . . . . . . . . . . . . . . . . . . . . .1807

103- Ping Commands 1808


103.1 Ping Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1809
103.2 Ping Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1810
103.3 Ping Per Vrf Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1812

104- Traceroute Commands 1814


104.1 Traceroute Command Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1815
104.2 Traceroute Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1816
104.3 Traceroute Per Vrf Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1818

105- Global And Environmental Commands 1820


105.1 History Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1821
105.2 Echo Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1822
105.3 Telnet Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1823

xx Released 3HH-04416-CDAA-TCZZA Edition 03


Contents

105.4 Exec Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1824


105.5 Sleep Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1826
105.6 Tree Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1827
105.7 Write Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1828
105.8 Logout Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1829
105.9 Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1830
105.10 Info Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1831
105.11 Exit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1834
105.12 Back Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1835
105.13 Delete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1836
105.14 In Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1837
105.15 Configure Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1838
105.16 Action Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1840
105.17 Show Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1841
105.18 Recursive Show Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1842
105.19 Sample Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1843
105.20 Poll Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1844

106- CLI Filters 1845


106.1 Count Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1846
106.2 Match Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1847
106.3 Tee Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1848

107- CLI Printers 1849


107.1 More . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1850
107.2 No-More . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1851
107.3 Discard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1852

Error List 1853

Abbreviations 1882

Index 1883

3HH-04416-CDAA-TCZZA Edition 03 Released xxi


Contents

xxii Released 3HH-04416-CDAA-TCZZA Edition 03


1- ISAM CLI

1.1 History 1-2


1.2 Preface 1-26
1.3 CLI Commands 1-27
1.4 Nodes 1-28
1.5 Parameters 1-29
1.6 Filters 1-32
1.7 Printers 1-33
1.8 Getting help 1-34
1.9 The CLI Prompt 1-35
1.10 Entering CLI Commands 1-36
1.11 CLI Backward Compatibility 1-37

3HH-04416-CDAA-TCZZA Edition 03 Released 1


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 R2.4 and R2.2.03, review the delta's of the releases R2.4
versus R2.3.02 and R2.3.02 versus R2.2.03. To know the difference between e.g. FGN 3.0.02 and FGN 3.0, review
the delta's of FGN 3.0.02 and all tables referencing FGN 3.0.

ISAM-FGN release cross reference


ISAM release FGN release
2.2.03 2.0.02
2.3.02 /
2.4 3.0
2.4.01 3.0.04
2.4.10 3.0.01
2.4.11 3.0.02
2.5 /
3.1/3.2 3.2
3.3 3.4
3.3.01 3.4.01
3.3.02 3.4.02

Command delta R3.3.02(FGN 3.4.02) versus R3.3.01(FGN 3.4.01)


Modified Commands
configure qos global (new parameter)
configure qos interface (removed eth-itf)
configure qos profiles (new ethernet-types)
configure system shub filter ip-filter (minor problem solving)
show rip routing-table (new parameters)

Command delta R3.3.01(FGN 3.4.01) versus R3.3(FGN 3.4)


Modified Commands
configure alarm entry(new alarm entries)
configure atm pvc(minor problem solving)
configure interface port(minor problem solving)

2 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

configure qos global(minor problem solving)


configure transport shub mac filter(minor problem solving)
configure xdsl spectrum-profile vdsl2(minor problem solving)
show atm pvc(minor problem solving)

Command delta R3.3(FGN 3.4) versus R3.1(FGN 3.2)/R3.2


Modified Commands
admin dhcp-relay user-port(multi-vlan feature)
admin igmp channel(multi-vlan feature)
admin ip vrf-stats interface user port(multi-vlan feature)
configure alarm entry(new alarm types)
configure bridge port vlan-id(multi-vlan feature)
configure equipment protection-element(redundancy support for
xVPS feature)
configure equipment shelf(remote shelves feature)
configure igmp channel(multi-vlan feature)
configure igmp shub vlan-router-port(multi-vlan feature)
configure igmp shub igs-system(igmpV3 feature)
configure igmp shub vlan-filter(igmpV3 feature)
configure igmp system(igmpV3 feature)
configure interface alarm(ethernet LT feature)
configure interface port(multi-vlan feature)
configure ip vrf route-dest(multi-vlan feature)
configure mcast shub mcast-addr vlan-id(SFPs for remote eqpt)
configure ip vrf user-itf(multi-vlan feature)
configure pppoe pppox-interface(multi-vlan feature)
configure qos(cac parameter added)
configure qos dsl-port(minor problem solving)
configure qos dsl-port queue(minor problem solving)
configure qos shdsl-port(minor problem solving)
configure qos shdsl-port queue(minor problem solving)
configure software-mngt oswp(auto-activation feature)
configure system security ssh access(auto-activation feature)
configure system shub ip-filter(SFPs for remote eqpt)
configure system syslog destination(syslog for video cdr feature)
configure system syslog route(syslog for video cdr,protocol tracing
features)

3HH-04416-CDAA-TCZZA Edition 03 Released 3


1 ISAM CLI

configure transport shub mac-filter(SFPs for remote eqpt)


configure vlan(multi-vlan feature)
configure vlan port-protocol(multi-vlan feature)
configure vlan shub id egress-port (SFPs for remote eqpt)
configure voice sip digitmap(VoIP-SIP feature)
configure voice sip server(VoIP-SIP feature)
configure voice sip termination(VoIP-SIP feature)
configure voice sip user-agent-dhcp(VoIP-SIP feature)
configure voice sip user-agent-manual(VoIP-SIP feature)
configure xdsl line service-profile spectrum-profile
configure xdsl spectrum-profile vdsl
configure xdsl spectrum-profile vdsl2
configure xdsl-bonding group

show equipment protection-element(redundancy support for xVPS


feature)
show dhcp-relay port(multi-vlan feature)
show igmp channel counter(multi-vlan feature)
show igmp channel miscellaneous(multi-vlan feature)
show interface alarm(ethernet LT feature)
show interface availability(ethernet LT feature)
show interface port(multi-vlan,ethernet LT features)
show interface stack(multi-vlan,ethernet LT features)
show interface test(multi-vlan,ethernet LT features)
show ip dhcp-session(multi-vlan feature)
show ip vrf-interface user port(multi-vlan feature)
show mcast active-groups(multi-vlan feature)
show mcast shub igs-vlan-grp(SFPs for remote eqpt)
show pppoe connection(multi-vlan feature)
show pppoe if-table(multi-vlan feature)
show pppoe ppp-statistics(multi-vlan feature)
show pppoe session(multi-vlan feature)
show pppoe statistics-pppoe-itf rx-pkt(multi-vlan feature)
show pppoe statistics-pppoe-itf stats(multi-vlan feature)
show pppoe statistics-pppoe-itf tx-pkt(multi-vlan feature)
show vlan port-vlan-map (abstract lower layer feature)
show voice sip server(VoIP-SIP feature)
show voice sip server-useragent(VoIP-SIP feature)

4 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

show vlan shub-dup-mac-alarm(SFPs for remote eqpt)


show vlan shub-port-vlan-map(SFPs for remote eqpt)
show xdsl config-data-port(all cmds in node)(multi-vlan feature)
show xdsl oper-data-port(all cmds in node)(multi-vlan feature)

New Commands
admin igmp shub cac clear-stats
admin igmp shub vlan clear-stats
admin ip vlan-itf-delete
admin mstp port(mstp feature)
configure debug protocol-trace(protocol tracing feature)
configure equipment envbox(environment monitoring feature)
configure equipment external-link-assign
configure ethernet line(ethernet LT feature)
configure igmp vlan(multi-vlan feature)
configure igmp shub vlan-enhance-perf(multi-vlan feature)
configure igmp system cdr-type(syslog video cdr feature)
configure interface shub ip unnumbered-as(mgmt via loop-back itf
feature)
configure mstp(all cmds in this node)(mstp feature)
configure qos interface eth-itf(ethernet LT feature)
configure software-mngt database(database automatic activation and
backup feature)
configure system security filetransfer(ftp for backup-restore and sw
download)
configure voice sip termination local-loop(VoIP-SIP feature)
configure xdsl spectrum-profile artificial-noise-down(xdsl artificial
noise feature)
ping vrf(ping per VRF feature)

show alarm current ether-sfp


show alarm current ether-tca
show alarm current external-device
show alarm current filetransfer
show alarm current l2forward
show alarm current qos-queue
show alarm current qos-slot
show alarm log ether-sfp
show alarm log ether-tca
show alarm log external-device

3HH-04416-CDAA-TCZZA Edition 03 Released 5


1 ISAM CLI

show alarm log filetransfer


show alarm log l2forward
show alarm log qos-queue
show alarm log qos-slot
show alarm snap-shot ether-sfp
show alarm snap-shot ether-tca
show alarm snap-shot external-device
show alarm snap-shot filetransfer
show alarm snap-shot l2forward
show alarm snap-shot qos-queue
show alarm snap-shot qos-slot
show config-data-port(all cmds in this node)(ethernet LT feature)
show ethernet(ethernet LT feature)
show igmp channel protocol(igmpV3 feature)
show igmp grp-to-package(igmpV3 feature)
show igmp shub igs-stats(igmpV3 feature)
show mcast grp-membership(igmpV3 feature)
show mstp(all cmds in node)(mstp feature)
show oper-data-port(all cmds in node)(ethernet LT feature)
show qos ethernet-bandwidth(ethernet LT feature)
show transport ether-dot3lt(ethernet LT feature)
show transport ether-ifsfplt(ethernet LT feature)
show transport ether-ifmault(ethernet LT feature)
traceroute vrf(traceroute per VRF feature)

Removed Commands
admin bridge rstp port(replaced by mstp cmd)
admin igmp shub clear-stats(replaced by admin igmp shub cac
clear-stats)
configure rstp(replaced by mstp cmds)
configure voice sip local-loop(replaced by configure voice sip
termination local-loop)
show alarm current sip-app-server(not applicable anymore)
show alarm log sip-app-server(not applicable anymore)
show alarm snap-shot sip-app-server(not applicable anymore)
show rstp(replaced by mstp cmds)

Command delta R3.1(FGN 3.2)/R3.2 versus R2.5

6 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

Modified Commands
admin alarm
admin equipment
admin equipment slot
admin ip vrf-media
admin shdsl-seg
configure alarm entry
configure cpe-management vlan-id proxy-mode
configure dhcp-relay agent
configure equipment shelf
configure equipment slot
configure mcast src (IGMP CAC for GE port,garanteed LT part)
configure mcast shub active-streams (IGMP CAC feature)
configure qos profiles session logical-flow-type
configure software-mngt oswp(autofetch obsolete parameter)
configure system id(feature config port nbr in protocol)
configure system security profile(numbering scheme feature)
configure system security default-profile(numbering scheme feature)
configure system security ssh access
configure system sntp(timezone feature)
configure trap definition
configure trap manager
configure vlan id (programmable ciruit-id dhcp,pppoe)
configure vlan shub unicast-mac
configure interface alarm
configure shdsl span
configure shdsl segment
configure shdsl unit
configure xdsl service profile(L2-L3 power modes)
configure xdsl spectrum profile(SRA fct added)
configure xdsl spectrum profile adsl2-plus((PSD functionality)
configure xdsl spectrum profile vdsl((PSD functionality)
configure xdsl spectrum profile vdsl2((PSD functionality)
configure xdsl line service-profile spectrum-profile
configure xdsl-bonding group-profile
environment
show atm pvc

3HH-04416-CDAA-TCZZA Edition 03 Released 7


1 ISAM CLI

show vlan bridge-port-fdb


show vlan cross-connect
show vlan residential-bridge
show vlan shub-dup-mac-alarm
show interface alarm
show interface port
show interface stack
show interface test
show ip ip-statistics
show transport ether-dot3
show shdsl inventory
show shdsl segment-counters
show shdsl segment-status
show shdsl unit-status

New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin session id disconnect
admin system syslog
admin system security ssh generate-key(see removed command
configure system security ssh key-regen)
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management manager
configure igmp shub bundle
configure mcast shub src vlan-id
configure qos-dsl-ctrl-pkt-policer
configure system id-syntax(atm/eth based id)
configure system syslog(security system log feature)
configure xdsl spectrum-profile adsl2-plus cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-down(PSD fct)

8 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-up(PSD fct)


configure xdsl-bonding group-assembly-time(bonding feature)
configure xdsl-bonding group link
show alarm current custom-ext-alarm
show alarm log custom-ext-alarm
show alarm snap-shot custom-ext-alarm
show alarm snap-shot plug-in-unit-ext
show cpe-management snmpproxy-statistics
show igmp shub bundle-stats
show igmp shub bundle-to-src
show igmp shub mcast-stats
show igmp shub system-stats
show ip dhcp-session
show ip shub vrf-media
show system syslog
show xdsl config-data-port
show xdsl oper-data-port
show xdsl bonding failure-status group
show xdsl bonding operational-data group
show xdsl bonding summary
traceroute

Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode(replaced by configure
cpe-management proxy-mode)
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show alarm entry(redundant with info configure alarm entry)
show alarm shub entry(redundant with info configure alarm shub
entry)
show cpeproxy
show ip traceroute(replaced by traceroute)
show alarm snap-shot plugin-unit-ext(replaced by show alarm
snap-shot plug-in-unit-ext)
configure system management vlan host-ip-address

Commands applicable from R3.2 on


configure shdsl(all cmds in node)

3HH-04416-CDAA-TCZZA Edition 03 Released 9


1 ISAM CLI

configure voice sip(VoIP-SIP feature)


configure ima(all cmds in node)
show shdsl(all cmds in node)
show ima(all cmds in node)
show alarm current ima-group
show alarm current ima-link
show alarm current shdsl
show alarm current shdsl-isam
show alarm log ima-group
show alarm log ima-link
show alarm log shdsl
show alarm log shdsl-isam
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show alarm current sip-app-server
show alarm current sip-plugin-unit
show alarm current sip-termination
show alarm current sip-user-agent
show alarm log sip-app-server
show alarm log sip-plugin-unit
show alarm log sip-termination
show alarm log sip-user-agent
show alarm snap-shot sip-app-server
show alarm snap-shot sip-plugin-unit
show alarm snap-shot sip-termination
show alarm snap-shot sip-user-agent
show voice
show voice sip

Command delta R3.1(FGN 3.2)/R3.2 versus R2.4.01(FGN 3.0.04)


Modified Commands
admin alarm
admin equipment
admin equipment slot
admin ip vrf-media

10 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

admin rip interface md5-key


admin software-mngt shub
configure alarm entry
configure dhcp-relay agent
configure equipment shelf
configure equipment slot
configure mcast src (IGMP CAC for GE port,garanteed LT part)
configure mcast shub active-streams (IGMP CAC feature)
configure qos profiles session logical-flow-type
configure software-mngt oswp(autofetch obsolete parameter)
configure system id(feature config port nbr in protocol)
configure system security profile(numbering scheme feature)
configure system security default-profile(numbering scheme feature)
configure system security ssh access
configure system sntp(timezone feature)
configure system transaction
configure trap definition
configure trap manager
configure vlan id (programmable ciruit-id dhcp,pppoe)
configure vlan shub unicast-mac
configure interface alarm
configure interface shub ip icmp
configure ip shub vrf
configure ppox-relay cross-connect engine
configure qos shub flow
configure rip interface md5-key
configure xdsl service profile(L2-L3 power modes)
configure xdsl spectrum profile(SRA fct added)
configure xdsl spectrum profile adsl2-plus((PSD functionality)
configure xdsl spectrum profile vdsl((PSD functionality)
configure xdsl spectrum profile vdsl2((PSD functionality)
configure xdsl line service-profile spectrum-profile
configure xdsl-bonding group-profile
environment
show atm pvc
show vlan bridge-port-fdb
show vlan cross-connect

3HH-04416-CDAA-TCZZA Edition 03 Released 11


1 ISAM CLI

show vlan residential-bridge


show vlan shub-dup-mac-alarm
show vlan fdb
show interface alarm
show interface port
show interface stack
show interface test
show ip ip-statistics
show transport ether-dot3

New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin ip vrf-stats interface user bridgeport
admin shdsl-seg unit-id
admin session id disconnect
admin system syslog
admin system security ssh generate-key
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management vlan-id proxy-mode
configure cpe-management manager
configure cpe-management session
configure cpe-management shub
configure igmp shub bundle
configure mcast shub src vlan-id
configure qos-dsl-ctrl-pkt-policer
configure qos shdsl-port
configure system id-syntax(atm/eth based id)
configure system syslog(security system log feature)
configure xdsl spectrum-profile adsl2-plus cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-down(PSD fct)

12 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-up(PSD fct)


configure xdsl-bonding group-assembly-time(bonding feature)
configure xdsl-bonding group link
show alarm current plugin-unit-ext
show alarm current custom-ext-alarm
show alarm current sip-user-agent
show alarm log plugin-unit-ext
show alarm log custom-ext-alarm
show alarm snap-shot plugin-unit-ext
show cpe-management
show equipment capab-profile
show qos shdsl-bandwidth
show igmp shub bundle-stats
show igmp shub bundle-to-src
show igmp shub mcast-stats
show igmp shub system-stats
show ip dhcp-session
show ip shub vrf-media
show system syslog
show xdsl config-data-port
show xdsl oper-data-port
show xdsl bonding failure-status group
show xdsl bonding operational-data group
show xdsl bonding summary
traceroute

Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show cpeproxy
show ip traceroute(replaced by traceroute)
configure system management vlan host-ip-address
show tech-support

Commands applicable from R3.2 on


configure shdsl

3HH-04416-CDAA-TCZZA Edition 03 Released 13


1 ISAM CLI

configure ima
configure voice sip
show shdsl
show ima
show alarm current ima-group
show alarm current ima-link
show alarm current shdsl
show alarm current shdsl-isam
show alarm current custom-ext-alarm
show alarm current sip-app-server
show alarm current sip-plugin-unit
show alarm current sip-termination
show alarm current sip-user-agent
show alarm log ima-group
show alarm log ima-link
show alarm log shdsl
show alarm log shdsl-isam
show alarm log sip-app-server
show alarm log sip-plugin-unit
show alarm log sip-termination
show alarm log sip-user-agent
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show alarm snap-shot sip-app-server
show alarm snap-shot sip-plugin-unit
show alarm snap-shot sip-termination
show alarm snap-shot sip-user-agent
show ima
show shdsl
show voice

Command delta R3.1(FGN 3.2)/R3.2 versus R2.4.11(FGN 3.0.02)


Modified Commands
admin alarm
admin equipment

14 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

admin equipment slot


admin ip vrf-media
admin rip interface md5-key
configure alarm entry
configure dhcp-relay agent
configure equipment shelf
configure equipment slot
configure igmp package
configure interface port
configure mcast src (IGMP CAC for GE port,garanteed LT part)
configure mcast shub active-streams (IGMP CAC feature)
configure qos profiles session logical-flow-type
configure rip route-map
configure system clock-mgmt
configure system shub filter ip-filter icmp
configure system shub filter ip-filter port-filter
configure system shub filter ip-filter tcp
configure system shub filter ip-filter udp
configure system id(feature config port nbr in protocol)
configure system radius
configure system security profile(numbering scheme feature)
configure system security default-profile(numbering scheme feature)
configure system security ssh access
configure system sntp(timezone feature)
configure system transaction
configure trap manager
configure trap definition
configure vlan broadcast-frames
configure vlan id (programmable ciruit-id dhcp,pppoe)
configure vlan shub unicast-mac
configure interface alarm
configure interface shub ip icmp
configure ip shub vrf
configure ppox-relay cross-connect engine
configure qos shub flow
configure rip interface md5-key
configure xdsl service profile(L2-L3 power modes)

3HH-04416-CDAA-TCZZA Edition 03 Released 15


1 ISAM CLI

configure xdsl spectrum profile(SRA fct added)


configure xdsl spectrum profile adsl2-plus((PSD functionality)
configure xdsl spectrum profile vdsl((PSD functionality)
configure xdsl spectrum profile vdsl2((PSD functionality)
configure xdsl line service-profile spectrum-profile
configure xdsl-bonding group-profile
environment
show atm pvc
show vlan bridge-port-fdb
show vlan cross-connect
show vlan residential-bridge
show vlan shub-dup-mac-alarm
show vlan fdb
show interface alarm
show interface port
show interface stack
show interface test
show ip ip-statistics
show transport ether-dot3

New Commands
admin igmp shub bundle(IGMP CAC feature)
admin igmp shub clear-stats
admin igmp shub mcast-src vlan-id(IGMP CAC feature)
admin ip vrf-stats interface user bridgeport
admin shdsl-seg unit-id
admin session id disconnect
admin system syslog
admin system security ssh generate-key
configure alarm custom-profile(REM feature)
configure bridge shub mac-learning
configure cpe-management vlan-id proxy-mode
configure cpe-management manager
configure cpe-management session
configure cpe-management shub
configure igmp shub bundle
configure l2cp
configure mcast shub src vlan-id

16 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

configure ospf area


configure ospf nssa-area
configure qos-dsl-ctrl-pkt-policer
configure qos shdsl-port
configure system id-syntax(atm/eth based id)
configure system syslog(security system log feature)
configure xdsl spectrum-profile adsl2-plus cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 cust-rx-psd-pt-up(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-down(PSD fct)
configure xdsl spectrum-profile vdsl2 v-noise-psd-pt-up(PSD fct)
configure xdsl-bonding group-assembly-time(bonding feature)
configure xdsl-bonding group link
show alarm current plugin-unit-ext
show alarm current custom-ext-alarm
show alarm current sip-user-agent
show alarm log plugin-unit-ext
show alarm log custom-ext-alarm
show alarm snap-shot plugin-unit-ext
show cpe-management
show equipment capab-profile
show dhcp-relay bridgeport
show qos shdsl-bandwidth
show igmp shub bundle-stats
show igmp shub bundle-to-src
show igmp shub mcast-stats
show igmp shub system-stats
show ip dhcp-session
show ip shub vrf-media
show interface shub statistics
show l2cp
show system syslog
show vlan qos-cvlan-list
show xdsl config-data-port

3HH-04416-CDAA-TCZZA Edition 03 Released 17


1 ISAM CLI

show xdsl link-up-changes


show xdsl linkup-record
show xdsl oper-data-port
show xdsl bonding failure-status group
show xdsl bonding operational-data group
show xdsl bonding summary
traceroute

Removed Commands
admin ip traceroute(replaced by traceroute)
configure cpeproxy proxy-mode
configure system security ssh key-regen(replaced by admin system
security ssh generate-key) not backward compatible
show alarm entry
show alarm shub entry
show cpeproxy
show ip traceroute(replaced by traceroute)
show tech-support

Commands applicable from R3.2 on


configure shdsl
configure ima
configure voice sip
show shdsl
show ima
show alarm current ima-group
show alarm current ima-link
show alarm current shdsl
show alarm current shdsl-isam
show alarm current custom-ext-alarm
show alarm current sip-app-server
show alarm current sip-plugin-unit
show alarm current sip-termination
show alarm current sip-user-agent
show alarm log ima-group
show alarm log ima-link
show alarm log shdsl
show alarm log shdsl-isam

18 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

show alarm log sip-app-server


show alarm log sip-plugin-unit
show alarm log sip-termination
show alarm log sip-user-agent
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show alarm snap-shot sip-app-server
show alarm snap-shot sip-plugin-unit
show alarm snap-shot sip-termination
show alarm snap-shot sip-user-agent
show ima
show shdsl
show voice

Command delta R2.5 versus R2.4.01(FGN 3.0.04)


Modified Commands
admin equipment slot
admin rip interface
admin software-mngt shub
configure alarm entry(new alarm types)
configure bridge port vlan-id
configure cpeproxy
configure equipment slot
configure interface port
configure interface shub ip icmp
configure ip vrf route-dest next-hop
configure pppox-relay cross-connect engine
configure qps shub flow
configure rip interface
configure system transaction
configure system security radius
show vlan fdb

New Commands
admin ip vrf-stats interface user bridgeport

3HH-04416-CDAA-TCZZA Edition 03 Released 19


1 ISAM CLI

admin shdsl-seg
configure cpe-management
configure cpe-management shub
configure ima
configure qos shdsl-port
configure shdsl segment
configure shdsl span
configure shdsl unit
show alarm current ima-group
show alarm current ima-link
show alarm current plugin-unit-ext
show alarm current shdsl
show alarm current shdsl-isam
show alarm log ima-group
show alarm log ima-link
show alarm log plugin-unit-ext
show alarm log shdsl
show alarm log shdsl-isam
show alarm snap-shot ima-group
show alarm snap-shot ima-link
show alarm snap-shot plugin-unit-ext
show alarm snap-shot shdsl
show alarm snap-shot shdsl-isam
show cpe-management
show cpe-management ipproxy-statistic
show equipment capab-profile
show ima group
show ima group counters
show ima group state
show ima link
show ima link counters
show ima link state
show qos shdsl-bandwidth
show shdsl
show shdsl inventory
show shdsl segment-counters
show shdsl segment-status

20 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

show shdsl span-counters


show shdsl span-status
show shdsl unit-status

Deleted Commands
show tech-support

Command delta R2.4.11 (FGN 3.0.02) versus R2.4 (FGN 3.0) and
Command delta R2.4.11 (FGN 3.0.02) versus R2.4.10 (FGN3.0.01)
Modified Commands
configure system shub entry ip
configure system shub filter ip-filter port-filter
configure system shub filter ip-filter icmp
configure system shub filter ip-filter tcp
configure system shub filter ip-filter udp
configure xdsl spectrum-profile vdsl
configure xdsl spectrum-profile vdsl2

Command delta R2.4.01(FGN 3.0.04) versus R2.4 (FGN 3.0)


Modified Commands
admin software-mngt shub select-config
configure equipment shelf
configure equipment slot
configure igmp package
configure rip route-map
configure software-mngt oswp
configure system clock-mgmt
configure system security radius
configure system shub entry ip
configure system shub filter ip-filter port-filter
configure system shub filter ip-filter icmp
configure system shub filter ip-filter tcp
configure system shub filter ip-filter udp
configure trap manager
configure vlan
configure vlan shub unicast-mac

3HH-04416-CDAA-TCZZA Edition 03 Released 21


1 ISAM CLI

configure xdsl spectrum-profile vdsl


configure xdsl spectrum-profile vdsl2
environment

New Commands
configure ospf area extern-aggr-addr
configure l2cp
show l2cp
configure system management vlan
show dhcp-relay bridgeport
show interface shub statistics
show xdsl link-up-changes
show xdsl linkup-record
show vlan qos-cvlan-list

Deleted Commands
show alarm entry
show alarm entry shub

Command delta R2.4 (FGN 3.0) versus R2.3.02


Modified Commands
admin igmp
configure dhcp-relay agent
configure igmp system src-ip-address
configure mcast src
configure system security snmp community
configure system security snmp group security level
configure system shub entry ip
configure vlan id
configure vlan shub unicast-mac
configure xdsl service-profile
configure xdsl spectrum-profile name
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 line

22 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

environment

New Commands
configure system clock-mgmt
configure system security default-profile
configure system security notify-profile filter
configure system security snmp view
configure system security snmp notify-view
show igmp package-to-src
show mcast active-groups
show system clock-mgmt
show tech-support

Deleted Commands
show vlan qos-cvlan-list
show dhcp-relay bridgeport

Command delta R2.3.02 versus R2.2.03 (FGN2.0.02)


Modified Commands
admin sntp
configure igmp shub igs-system
configure interface shub ip
configure ip vrf
configure igmp shub igs-system
configure la aggregator-port
configure qos
configure qos profiles marker
configure qos shub meter
configure qos shub flow
configure qos shub queue-config
configure system
configure system security profile
configure system security radius
configure system security snmp
configure system shub entry ip
configure trap

3HH-04416-CDAA-TCZZA Edition 03 Released 23


1 ISAM CLI

configure vlan
configure vlan shub
configure xdsl service-profile
configure xdsl spectrum-profile
configure xdsl line
environment
show mcast shub igs-vlan-grp
show security radius
show vlan fdb

New Commands
configure cluster
configure equipment external-link-host
configure mcast shub
configure cluster
configure qos shub dscp-map-dot1p
configure system security ssh
configure xdsl line (if-index) local-loop
show alarm current llu-relay
show alarm current sfp
show alarm log llu-relay
show alarm log sfp
show alarm snap-shot llu-relay
show alarm snap-shot sfp
show cluster
show dhcp-relay bridgeport
show equipment external-link-host
show equipment external-link-remote
show mcast shub active-streams
show qos profile-usage
show security ssh
show tranport snmp engine
show tranport snmp protocol-stats
show vlan shub-nr-mcast-entries

Deleted Commands
configure ip interface
configure system shub entry software

24 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

configure system shub sntp server-ip-addr

3HH-04416-CDAA-TCZZA Edition 03 Released 25


1 ISAM CLI

1.2 Preface

Scope
This user guide describes the Command Line Interface (CLI) commands supported by the Alcatel 7302 ISAM and
7330 ISAM FTTN. 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.

26 Released 3HH-04416-CDAA-TCZZA Edition 03


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.

3HH-04416-CDAA-TCZZA Edition 03 Released 27


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).

28 Released 3HH-04416-CDAA-TCZZA Edition 03


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)

3HH-04416-CDAA-TCZZA Edition 03 Released 29


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 cross #, a space, a tab, a carriage return, or a new line. The \ is 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:
03:06:ff:[h:aa...bd]

30 Released 3HH-04416-CDAA-TCZZA Edition 03


1 ISAM CLI

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]
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.

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.

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.

3HH-04416-CDAA-TCZZA Edition 03 Released 31


1 ISAM CLI

1.6 Filters
The language provides filters to manipulate the output of commands.
The available filters are discussed in detail in a separate chapter.
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.

32 Released 3HH-04416-CDAA-TCZZA Edition 03


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.

3HH-04416-CDAA-TCZZA Edition 03 Released 33


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.

34 Released 3HH-04416-CDAA-TCZZA Edition 03


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

3HH-04416-CDAA-TCZZA Edition 03 Released 35


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.

36 Released 3HH-04416-CDAA-TCZZA Edition 03


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.
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.
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.

3HH-04416-CDAA-TCZZA Edition 03 Released 37


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.

38 Released 3HH-04416-CDAA-TCZZA Edition 03


2- Environment Configuration Commands

2.1 Environment Configuration Command Tree 2-40


2.2 Environment Configuration Command 2-41

3HH-04416-CDAA-TCZZA Edition 03 Released 39


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

40 Released 3HH-04416-CDAA-TCZZA Edition 03


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> optional parameter with default
Format: value: ""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] terminal-timeout Parameter type: <Sec::EnvInactivityTimeout> optional parameter with default
Format: value: "timeout : 30"
( default specify the inactivity timeout of
| timeout : <Sec::InactivityTimeout> ) the terminal
Possible values:

3HH-04416-CDAA-TCZZA Edition 03 Released 41


2 Environment Configuration Commands

Parameter 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]
[no] print Parameter type: <Sec::EnvMore> optional parameter with default
Format: value: "default"
( more specifies the way the output is
| no-more printed on the terminal
| 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
[no] inhibit-alarms Parameter type: boolean optional parameter
disables the alarm reporting in
the current session
[no] mode Parameter type: <Cli::Mode> optional parameter with default
Format: value: "interactive"
( batch the mode in which the CLI
| interactive ) handles command input
Possible values:
- batch : non-interactive mode intended for scripting tools
- interactive : interactive mode intended for human operators

42 Released 3HH-04416-CDAA-TCZZA Edition 03


3- Alarm Configuration Commands

3.1 Alarm Configuration Command Tree 3-44


3.2 Alarm Log Configuration Command 3-46
3.3 Alarm Entry Configuration Command 3-48
3.4 Alarm Delta Log Configuration Command 3-59
3.5 SHub Alarm Configuration Command 3-61
3.6 Customizable Alarm Profile Configuration Command 3-63

3HH-04416-CDAA-TCZZA Edition 03 Released 43


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

44 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

- [no] visible4
- [no] audible4
- [no] polarity4
- [no] severity4
- [no] mnemonic5
- [no] description5
- [no] visible5
- [no] audible5
- [no] polarity5
- [no] severity5

3HH-04416-CDAA-TCZZA Edition 03 Released 45


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::alarmSeverity> log-full-action <Alarm::alarmLogFullAction>


non-itf-rep-sev-level <Alarm::alarmSeverity>

Command Parameters
Table 3.2-2 "Alarm Log Configuration Command" Command Parameters
Parameter Type Description
log-sev-level Parameter type: <Alarm::alarmSeverity> optional parameter
Format: set the lowest severity level to log
( indeterminate alarms
| 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
log-full-action Parameter type: <Alarm::alarmLogFullAction> optional parameter
Format: set the action if log buffer is full
( wrap
| halt )
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset
non-itf-rep-sev-level Parameter type: <Alarm::alarmSeverity> optional parameter
Format: set minimum severity level to
( indeterminate report non itf alarms
| warning
| minor
| major

46 Released 3HH-04416-CDAA-TCZZA Edition 03


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

3HH-04416-CDAA-TCZZA Edition 03 Released 47


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: alarm type
( 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
| 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

48 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Resource Identifier Type Description


| xdsl-fe-ese
| xdsl-act-comm
| xdsl-act-modem
| xdsl-do-br-reach
| xdsl-fe-ncd
| xdsl-fe-lcd
| sw-rollback
| db-rollback
| cell-discard-up
| cell-discard-down
| persist-data-loss
| mac-conflict
| sntp-comm-lost
| preferred-mode
| timing-reference
| nt-disk-90%full
| shub-loc
| back-pnl-inv
| shub-conf-loss
| rack-power
| rack-fan-unit1
| rack-fan-unit2
| shelf-mismatch
| ext-chain-instl
| shelf-missing
| shelf-install-missing
| door
| fuse
| single-fan-fail
| double-fan-fail
| ac-power-fail
| board-mismatch
| waiting-for-sw
| temp-exceeded
| temp-shutdown
| defense
| board-missing
| board-instl-missing
| board-init
| board-reset-prot
| sem-power-fail
| sem-ups-fail
| board-reset-cf
| shub-uplink
| vrf-assign-fail
| vlan-assign-fail
| ip-pool-assign-fail
| qos-assign-fail
| ip-addr-assign-fail
| missing-attributes
| ip-addr-preempt
| up-plan-bitrate
| up-min-bitrate
| up-config-not-feas
| down-plan-bitrate
| down-min-bitrate
| down-config-not-feas

3HH-04416-CDAA-TCZZA Edition 03 Released 49


3 Alarm Configuration Commands

Resource Identifier Type Description


| no-peer-cpe
| no-bonding-cpe
| 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
| llu-relay-status
| custom1
| custom2
| custom3
| custom4
| custom5
| he-custom1
| he-custom2
| he-custom3
| he-custom4
| he-custom5
| he-custom6
| loss-over-cap
| 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

50 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Resource Identifier Type Description


| 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
| ntr-a-loss
| ntr-b-loss
| ds-los-or-high-attn
| fileserv-unavail
| shdsl-n-loopback
| shdsl-c-loopback
| shdsl-conferr
| shdsl-atm-lcd
| shdsl-lpr
| shdsl-secu-err
| shdsl-dev-fault
| shdsl-atm-ncd
| shdsl-n-losw
| shdsl-c-losw

3HH-04416-CDAA-TCZZA Edition 03 Released 51


3 Alarm Configuration Commands

Resource Identifier Type Description


| shdsl-n-aten
| shdsl-c-aten
| shdsl-n-snr
| shdsl-c-snr
| shdsl-n-dccont
| shdsl-c-dccont
| 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
| dhcp-unreach
| proxy-srv-unreach
| reg-srv-unreach
| inval-cdefile
| short-res
| unknown-sub
| ground-key
| port-hightemp
| fanout
| up-overflow
| upobc-overflow
| dwobc-overflow
| dw-overflow
| lwpri-overflow
| queue-drop
| queue-load
| loss-env-mon
| etca-los
| etca-fcs
| etca-day-los
| etca-day-fcs
| user-sfp-los
| user-sfp-tx-fail
| user-sfp-not-prst
| user-sfp-inv-id )
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

52 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Resource Identifier Type Description


- 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-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
- sw-rollback : non active oswp,db cannot be operational -
will rollback
- db-rollback : selected oswp,db cannot be operational - will
rollback
- 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
- sntp-comm-lost : sntp server not responding
- preferred-mode : preferred mode not available
- timing-reference : timing reference failure
- nt-disk-90%full : nt disk 90% 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
- ext-chain-instl : consistancy problem for extension chain
installation
- shelf-missing : detected shelf no longer detected
- shelf-install-missing : shelf planned but not installed
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a certain shelf failed
- double-fan-fail : two or more fans of the main shelf failed
- 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

3HH-04416-CDAA-TCZZA Edition 03 Released 53


3 Alarm Configuration Commands

Resource Identifier Type Description


files
- temp-exceeded : temperature threshold exceeded on the
board
- temp-shutdown : board powered down itself - too high
temperature
- defense : plugin unit disconnected from system by defense
- board-missing : board detected after planning - now
missing
- board-instl-missing : board never detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets exceeded
- 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
- vrf-assign-fail : failure to assigna VRF for a user session
- vlan-assign-fail : failure to assign VLAN for a user session
- ip-pool-assign-fail : failure to assign an IP address pool
- qos-assign-fail : failure to assign a QoS for a user session
- ip-addr-assign-fail : failure to assign IP address for a user
session
- missing-attributes : radius should specify pool id when it
returns a VRF
- ip-addr-preempt : IP address preemption
- 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
- no-peer-cpe : no cpe modem is connected to the group
lines
- no-bonding-cpe : no bonding cpe modem is connected
- 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 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 : loss of signal
- exp-sfp-tx-fail : Tx failure
- exp-sfp-not-prst : not present
- exp-sfp-inv-id : no valid Alcatel ID
- exp-sfp-ctrl-fail : control failure
- llu-relay-status : LLU relay status
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5

54 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Resource Identifier Type Description


- 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
- 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
- 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

3HH-04416-CDAA-TCZZA Edition 03 Released 55


3 Alarm Configuration Commands

Resource Identifier Type Description


- 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
- ds-los-or-high-attn : LOS due to opt link removed, broken
or high attn
- fileserv-unavail : file transfer server unavailable
- shdsl-n-loopback : loopback active at the network side
- shdsl-c-loopback : loopback active at the custom 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
- 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
- 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

56 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Resource Identifier Type Description


- 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
- dhcp-unreach : The DHCP server is unreachable
- proxy-srv-unreach : The SIP proxy server is unreachable
- reg-srv-unreach : The SIP registrator server is unreachable
- inval-cdefile : The CDE file is invalid
- short-res : Short of resource for more calls
- 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.
- 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 exceed
threshold
- queue-load : The queue load exceed threshold
- 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 errors in 1 day
- user-sfp-los : user sfp loss of signal
- user-sfp-tx-fail : usesr sfp tx failure
- user-sfp-not-prst : user sfp not detected
- user-sfp-inv-id : user sfp invalid id
Table 3.3-2 "Alarm Entry Configuration Command" Command Parameters
Parameter Type Description
[no] severity Parameter type: <Alarm::alarmSeverity> optional parameter with default
Format: value: "minor"
( indeterminate assign a severity level to this
| warning alarm
| 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
[no] service-affecting Parameter type: boolean optional parameter
make this alarm service affecting
[no] reporting Parameter type: boolean optional parameter
enable reporting of this alarm
[no] logging Parameter type: boolean optional parameter

3HH-04416-CDAA-TCZZA Edition 03 Released 57


3 Alarm Configuration Commands

Parameter Type Description


enable logging of this alarm

Command Output
Table 3.3-3 "Alarm Entry Configuration Command" Display parameters
Specific Information
name Type Description
category Parameter type: <Alarm::category> category of an alarm
( communications This element is always shown.
| 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

58 Released 3HH-04416-CDAA-TCZZA Edition 03


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> optional parameter
Format: set the action when indeterminate
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
warn-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: action in case indeterminate delta
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
minor-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set the action when minor delta
( wrap log buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
major-log-full-action Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set action when major delta log
( wrap buffer is full

3HH-04416-CDAA-TCZZA Edition 03 Released 59


3 Alarm Configuration Commands

Parameter Type Description


| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full
crit-log-full-act Parameter type: <Alarm::alarmDeltaLogFullAction> optional parameter
Format: set action when critical delta log
( wrap buffer is full
| halt )
Possible values:
- wrap : wrap around when log is full
- halt : halt logging when log is full

60 Released 3HH-04416-CDAA-TCZZA Edition 03


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: alarm type
( fan
| power-fan
| db-restore
| reboot
| sntp-comm
| eth-link-down
| mac-conflict
| no-arp-reply
| ospf-itf-err
| ospf-auth-err
| ospf-rx-bad-err
| ospf-lsdb-oflow-90
| ospf-lsdb-oflow
| ospf-nhbr-statchg
| ospf-itf-statchg
| rip-config-err
| rip-auth-fail
| rip-rcv-bad-pkt
| uplink-down )
Possible values:
- fan : shub fan failure
- power-fan : shub power fan failure
- 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

3HH-04416-CDAA-TCZZA Edition 03 Released 61


3 Alarm Configuration Commands

Resource Identifier Type Description


- mac-conflict : MAC conflict
- no-arp-reply : no ARP reply
- 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-90 : external LSA database reached 90%
of the limit
- ospf-lsdb-oflow : external LSA database reached the
overflow limit
- ospf-nhbr-statchg : OSPF neighbor state change
- ospf-itf-statchg : OSPF interface state change
- rip-config-err : RIP interface configuration error
- rip-auth-fail : RIP interface authentication failure
- rip-rcv-bad-pkt : bad packet received on RIP interface
- uplink-down : uplink group down
Table 3.5-2 "SHub Alarm Configuration Command" Command Parameters
Parameter Type Description
severity Parameter type: <Alarm::alarmSeverity> optional parameter
Format: assign a severity level to this
( indeterminate alarm
| 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
[no] service-affecting Parameter type: boolean optional parameter
make this alarm service affecting
[no] reporting Parameter type: boolean optional parameter
enable reporting of this alarm

Command Output
Table 3.5-3 "SHub Alarm Configuration Command" Display parameters
Specific Information
name Type Description
category Parameter type: <Alarm::category> defines the category of an alarm.
( communications This element is always shown.
| 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

62 Released 3HH-04416-CDAA-TCZZA Edition 03


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.

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: custom profile name
- a profile name
- range: [a-zA-Z0-9-_.]

3HH-04416-CDAA-TCZZA Edition 03 Released 63


3 Alarm Configuration Commands

Resource Identifier Type Description


- length: 1<=x<=32
Table 3.6-2 "Customizable Alarm Profile Configuration Command" Command Parameters
Parameter Type Description
[no] mnemonic1 Parameter type: <Alarm::AlarmMnemonic> optional parameter with default
Format: value: "UNDEF"
- an octet string defining mnemonic of external alarm mnemonic identifying the
- range: [A-Z] customizable external alarm 1
- length: x<=16
[no] description1 Parameter type: <Alarm::AlarmDescription> optional parameter with default
Format: value: "Undefined"
- an octet string defining description of external alarm description of the customizable
- length: x<=40 external alarm 1
[no] visible1 Parameter type: <Alarm::VisibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a visible alarm for
| disable ) external alarm 1
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
[no] audible1 Parameter type: <Alarm::AudibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a audible alarm for
| disable ) external alarm 1
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
[no] polarity1 Parameter type: <Alarm::InversePolarity> optional parameter with default
Format: value: "normal"
( normal alarm polarity is normal or
| inverse ) inverse for external alarm 1
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
[no] severity1 Parameter type: <Alarm::AlarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate severity level of external alarm 1
| 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
[no] mnemonic2 Parameter type: <Alarm::AlarmMnemonic> optional parameter with default
Format: value: "UNDEF"
- an octet string defining mnemonic of external alarm mnemonic identifying the
- range: [A-Z] customizable external alarm 2
- length: x<=16
[no] description2 Parameter type: <Alarm::AlarmDescription> optional parameter with default
Format: value: "Undefined"
- an octet string defining description of external alarm description of the customizable
- length: x<=40 external alarm 2
[no] visible2 Parameter type: <Alarm::VisibleOutput> optional parameter with default

64 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Parameter Type Description


Format: value: "disable"
( enable trigger a visible alarm for
| disable ) external alarm 2
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
[no] audible2 Parameter type: <Alarm::AudibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a audible alarm for
| disable ) external alarm 2
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
[no] polarity2 Parameter type: <Alarm::InversePolarity> optional parameter with default
Format: value: "normal"
( normal alarm polarity is normal or
| inverse ) inverse for external alarm 2
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
[no] severity2 Parameter type: <Alarm::AlarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate severity level of external alarm 2
| 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
[no] mnemonic3 Parameter type: <Alarm::AlarmMnemonic> optional parameter with default
Format: value: "UNDEF"
- an octet string defining mnemonic of external alarm mnemonic identifying the
- range: [A-Z] customizable external alarm 3
- length: x<=16
[no] description3 Parameter type: <Alarm::AlarmDescription> optional parameter with default
Format: value: "Undefined"
- an octet string defining description of external alarm description of the customizable
- length: x<=40 external alarm 3
[no] visible3 Parameter type: <Alarm::VisibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a visible alarm for
| disable ) external alarm 3
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
[no] audible3 Parameter type: <Alarm::AudibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a audible alarm for
| disable ) external alarm 3
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
[no] polarity3 Parameter type: <Alarm::InversePolarity> optional parameter with default

3HH-04416-CDAA-TCZZA Edition 03 Released 65


3 Alarm Configuration Commands

Parameter Type Description


Format: value: "normal"
( normal alarm polarity is normal or
| inverse ) inverse for external alarm 3
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
[no] severity3 Parameter type: <Alarm::AlarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate severity level of external alarm 3
| 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
[no] mnemonic4 Parameter type: <Alarm::AlarmMnemonic> optional parameter with default
Format: value: "UNDEF"
- an octet string defining mnemonic of external alarm mnemonic identifying the
- range: [A-Z] customizable external alarm 4
- length: x<=16
[no] description4 Parameter type: <Alarm::AlarmDescription> optional parameter with default
Format: value: "Undefined"
- an octet string defining description of external alarm description of the customizable
- length: x<=40 external alarm 4
[no] visible4 Parameter type: <Alarm::VisibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a visible alarm for
| disable ) external alarm 4
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
[no] audible4 Parameter type: <Alarm::AudibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a audible alarm for
| disable ) external alarm 4
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
[no] polarity4 Parameter type: <Alarm::InversePolarity> optional parameter with default
Format: value: "normal"
( normal alarm polarity is normal or
| inverse ) inverse for external alarm 4
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
[no] severity4 Parameter type: <Alarm::AlarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate severity level of external alarm 4
| warning
| minor
| major
| critical )
Possible values:

66 Released 3HH-04416-CDAA-TCZZA Edition 03


3 Alarm Configuration Commands

Parameter Type Description


- 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
[no] mnemonic5 Parameter type: <Alarm::AlarmMnemonic> optional parameter with default
Format: value: "UNDEF"
- an octet string defining mnemonic of external alarm mnemonic identifying the
- range: [A-Z] customizable external alarm 5
- length: x<=16
[no] description5 Parameter type: <Alarm::AlarmDescription> optional parameter with default
Format: value: "Undefined"
- an octet string defining description of external alarm description of the customizable
- length: x<=40 external alarm 5
[no] visible5 Parameter type: <Alarm::VisibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a visible alarm for
| disable ) external alarm 5
Possible values:
- enable : external alarm output is visible
- disable : external alarm output is non-visible
[no] audible5 Parameter type: <Alarm::AudibleOutput> optional parameter with default
Format: value: "disable"
( enable trigger a audible alarm for
| disable ) external alarm 5
Possible values:
- enable : external alarm output is audible
- disable : external alarm output is non-audible
[no] polarity5 Parameter type: <Alarm::InversePolarity> optional parameter with default
Format: value: "normal"
( normal alarm polarity is normal or
| inverse ) inverse for external alarm 5
Possible values:
- normal : alarm polarity is normal
- inverse : alarm polarity is inverse
[no] severity5 Parameter type: <Alarm::AlarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate severity level of external alarm 5
| 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

3HH-04416-CDAA-TCZZA Edition 03 Released 67


4- Trap Configuration Commands

4.1 Trap Configuration Command Tree 4-69


4.2 Trap Definition Configuration Command 4-70
4.3 Trap Manager Configuration Command 4-72
4.4 SHub Trap Manager Configuration Command 4-75

68 Released 3HH-04416-CDAA-TCZZA Edition 03


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] init-started-trap
- [no] lic-key-chg-occr
- [no] topology-chg
- [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] max-per-window
- [no] window-size
- [no] max-queue-size
- [no] min-interval
- [no] min-severity
----shub
----[no] manager
- (address)
- [no] cold-start-trap
- [no] auth-fail-trap
- [no] change-trap
- [no] community-string
- [no] snmp-version
- [no] min-severity

3HH-04416-CDAA-TCZZA Edition 03 Released 69


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 Description
(name) Format: the name of the trap
( cold-start
| link-down
| link-up
| auth-failure
| change-occured
| init-started
| lic-key-chg-occr
| topology-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
- change-occured : a configuration or operational change
occurred
- 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)
Table 4.2-2 "Trap Definition Configuration Command" Command Parameters
Parameter Type Description
priority Parameter type: <Trap::Priority> optional parameter
Format: the trap priority

70 Released 3HH-04416-CDAA-TCZZA Edition 03


4 Trap Configuration Commands

Parameter Type Description


( 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

3HH-04416-CDAA-TCZZA Edition 03 Released 71


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,critica

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 ]
init-started-trap ] [ [ no ] lic-key-chg-occr ] [ [ no ] topology-chg ] [ [ 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 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::alarmSeverity> ] )

Command Parameters
Table 4.3-1 "Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) Format: the address of the manager
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]
Table 4.3-2 "Trap Manager Configuration Command" Command Parameters
Parameter Type Description
[no] priority Parameter type: <Trap::Priority> optional parameter with default
Format: value: "medium"

72 Released 3HH-04416-CDAA-TCZZA Edition 03


4 Trap Configuration Commands

Parameter Type Description


( urgent lowest priority a trap should have
| high to be reported
| medium
| low )
Possible values:
- urgent : urgent - needs to be informed immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap
[no] cold-start-trap Parameter type: boolean optional parameter
enable sending cold start trap
[no] link-down-trap Parameter type: boolean optional parameter
enable sending link down trap
[no] link-up-trap Parameter type: boolean optional parameter
enable sending of link up trap
[no] auth-fail-trap Parameter type: boolean optional parameter
enable sending authentication
failure trap
[no] change-trap Parameter type: boolean optional parameter
enable sending of change occured
trap
[no] init-started-trap Parameter type: boolean optional parameter
enable sending init started trap
[no] lic-key-chg-occr Parameter type: boolean optional parameter
enable sending licence key
changed occured trap
[no] topology-chg Parameter type: boolean optional parameter
enable sending topology changed
occured trap
[no] alarm-chg-trap Parameter type: boolean optional parameter
enable snd nbr alrm chg(part of
changeOccurredTrap)
[no] phys-line-trap Parameter type: boolean optional parameter
enable snd phys line chg(part of
changeOccurredTrap)
[no] eqpt-change-trap Parameter type: boolean optional parameter
enable snd eqpt nbr chg(part of
changeOccurredTrap)
[no] success-set-trap Parameter type: boolean optional parameter
enable snd nbr of sets chg(part of
changeOccurredTrap)
[no] other-alarm-trap Parameter type: boolean optional parameter
enable snd nbr indeterminate
chg(part of changeOccurredTrap)
[no] warning-trap Parameter type: boolean optional parameter
enable snd nbr warning chg(part
of changeOccurredTrap)
[no] minor-trap Parameter type: boolean optional parameter
enable snd nbr minor chg(part of
changeOccurredTrap)
[no] major-trap Parameter type: boolean optional parameter
enable snd nbr major chg(part of
changeOccurredTrap)
[no] critical-trap Parameter type: boolean optional parameter
enable snd nbr critical chg(part of
changeOccurredTrap)
[no] redundancy-trap Parameter type: boolean optional parameter

3HH-04416-CDAA-TCZZA Edition 03 Released 73


4 Trap Configuration Commands

Parameter Type Description


enable snd nbr redundancy
chg(part of changeOccurredTrap)
[no] eqpt-prot-trap Parameter type: boolean optional parameter
enable snd nbr eqpt prot chg(part
of changeOccurredTrap)
[no] craft-login-trap Parameter type: boolean optional parameter
enable snd craft login chg(part of
changeOccurredTrap)
[no] max-per-window Parameter type: <Trap::WindowCount> optional parameter with default
Format: value: 2
- maximum allowed number of traps per window maximum allowed number of
- unit: traps traps per window
- range: [1...20]
[no] window-size Parameter type: <Trap::WindowSize> optional parameter with default
Format: value: 60
- the size of a time window for traps the size of a time window for
- unit: s traps in seconds
- range: [0...3600]
[no] max-queue-size Parameter type: <Trap::QueueSize> optional parameter with default
Format: value: 10
- maximum number of traps that can be queued maximum number of traps that
- unit: traps can be queued
- range: [1...20]
[no] min-interval Parameter type: <Trap::Interval> optional parameter with default
Format: value: 30
- minimum time interval between two traps the minimum time between two
- unit: s traps
- range: [0...3600]
[no] min-severity Parameter type: <Alarm::alarmSeverity> optional parameter with default
Format: value: "major"
( indeterminate lowest severity an alarm must
| warning have, to be reported
| 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

74 Released 3HH-04416-CDAA-TCZZA Edition 03


4 Trap Configuration Commands

4.4 SHub Trap Manager Configuration Command

Command Description
This command allows the operator to configure an SNMP manager of the SHub.
Clarification regarding 'entry-status': If a failure occurs during the configuration of the SNMP manager of the
SHub, please check if the SNMP manager was created and if the corresponding entry-status is valid. If not, please
delete and re-create the SNMP 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:

> configure trap shub ( no manager (address) ) | ( manager (address) [ [ no ] cold-start-trap ] [ [ no ] auth-fail-trap ]
[ [ no ] change-trap ] [ no community-string | community-string <Snmp::SHubCommunityName> ] [ no
snmp-version | snmp-version <Snmp::SHubVersion> ] [ no min-severity | min-severity
<Snmp::SHubAlarmSeverity> ] )

Command Parameters
Table 4.4-1 "SHub Trap Manager Configuration Command" Resource Parameters
Resource Identifier Type Description
(address) Format: address of the manager
<Ip::V4Address> : <Trap::Port>
Field type <Ip::V4Address>
- IPv4-address
Field type <Trap::Port>
- trap port number
- range: [1...65535]
Table 4.4-2 "SHub Trap Manager Configuration Command" Command Parameters
Parameter Type Description
[no] cold-start-trap Parameter type: boolean optional parameter
enable sending cold start trap
[no] auth-fail-trap Parameter type: boolean optional parameter
enable sending authentication
failure trap
[no] change-trap Parameter type: boolean optional parameter
enable sending of change occured
trap
[no] community-string Parameter type: <Snmp::SHubCommunityName> optional parameter with default
Format: value: "public"
- a printable string the community string to be used

3HH-04416-CDAA-TCZZA Edition 03 Released 75


4 Trap Configuration Commands

Parameter Type Description


- length: x<=255
[no] snmp-version Parameter type: <Snmp::SHubVersion> optional parameter with default
Format: value: "v2"
( v1 manager type
| v2 )
Possible values:
- v1 : snmp V1 manager type
- v2 : snmp V2 manager type
[no] min-severity Parameter type: <Snmp::SHubAlarmSeverity> optional parameter with default
Format: value: "indeterminate"
( indeterminate lowest severity an alarm must
| warning have, to be reported
| minor
| major
| critical )
Possible values:
- indeterminate : indeterminate
- warning : warning
- minor : minor
- major : major
- critical : critical

Command Output
Table 4.4-3 "SHub Trap Manager Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Transport::WaitRowStatusTrapTable> the status of SNMP manager of
( valid the SHub
| corrupted This element is only shown in
| corrupted ) detail mode.
Possible values:
- valid : SNMP manager configuration is ok
- corrupted : SNMP manager configuration is not
operational(not-in-service)
- corrupted : SNMP manager configuration is not
operational(not-ready)

76 Released 3HH-04416-CDAA-TCZZA Edition 03


5- Equipment Configuration Commands

5.1 Equipment Configuration Command Tree 5-78


5.2 Slot Configuration Command 5-79
5.3 Applique Configuration Command 5-81
5.4 Protection Group Configuration Command 5-83
5.5 Protection Element Configuration Command 5-84
5.6 External-link-host Configuration Commands 5-86
5.7 Host Shelf SFP Configuration Commands 5-87
5.8 NE Configuration Command 5-88
5.9 Rack Configuration Command 5-89
5.10 Shelf Configuration Command 5-90
5.11 Environment Monitoring Configuration Command 5-92

3HH-04416-CDAA-TCZZA Edition 03 Released 77


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
----slot
- (index)
- [no] planned-type
- [no] power-down
- [no] unlock
- [no] alarm-profile
- capab-profile
----applique
- (index)
- [no] planned-type
----protection-group
- (index)
- [no] admin-status
- [no] eps-quenchfactor
----protection-element
- (index)
- [no] redcy-ctrl-status
----external-link-host
- (faceplate-number)
- [no] direction
----external-link-assign
- (sfp-index)
- [no] remote
----isam
- [no] description
----rack
- (index)
- [no] description
----shelf
- (index)
- [no] class
- [no] planned-type
- [no] unlock
- [no] lock
- [no] extended-lt-slots
- [no] description
----envbox
- [no] enable-supervise

78 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

5.2 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 thelocked 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.For BCM based boards default capab-profile is "default"
for Intel based 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> ]

Command Parameters
Table 5.2-1 "Slot Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical number of the slot
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId>
| nt-a
| nt-b
| acu : <Eqpt::RackId> / <Eqpt::ShelfId>
| <Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::EqSlotId>
| ext-a : <Eqpt::RackId> / <Eqpt::ShelfId>
| ext-b : <Eqpt::RackId> / <Eqpt::ShelfId> )
Possible values:
- lt : lt-slot
- nt-a : nt-a slot
- nt-b : nt-b slot
- ext-a : nt-a slot in an extension shelf
- ext-b : nt-b slot in an extension shelf

3HH-04416-CDAA-TCZZA Edition 03 Released 79


5 Equipment Configuration Commands

Resource Identifier Type Description


- acu : acu 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.2-2 "Slot Configuration Command" Command Parameters
Parameter Type Description
[no] planned-type Parameter type: <Equipm::BoardType> optional parameter with default
Format: value: "not-planned"
Data driven field type type of board intended to be in
Possible values are depending on the actual configuration this position
and software.
The currently allowed values can be shown with online-help.
[no] power-down Parameter type: boolean optional parameter
power down the board
[no] unlock Parameter type: boolean optional parameter
unlock the board
[no] alarm-profile Parameter type: <Equipm::AlarmProf> optional parameter with default
Format: value: "none"
( none customized alarm profile
| name : <PrintableString> ) assigned to this board
Possible values:
- none : no profile name to associate
- name : profile name
Field type <PrintableString>
- printable string
capab-profile Parameter type: <Equipm::CapabilityProfile> optional parameter
Format: capability profile assigned to a
Data driven field type line board
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.

80 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

5.3 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> ]

Command Parameters
Table 5.3-1 "Applique Configuration Command" Resource Parameters
Resource Identifier Type Description
(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::SlotId> )
Possible values:
- iont : an nt applique slot
- lp : an lt applique slot
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::SlotId>
- the LT slot number
Table 5.3-2 "Applique Configuration Command" Command Parameters
Parameter Type Description
[no] planned-type Parameter type: <Equipm::AppliqueType> optional parameter with default
Format: value: "not-planned"
Data driven field type type of applique intended to be in
Possible values are depending on the actual configuration this position

3HH-04416-CDAA-TCZZA Edition 03 Released 81


5 Equipment Configuration Commands

Parameter Type Description


and software.
The currently allowed values can be shown with online-help.

82 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

5.4 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. The value 1 is reserved for the extension chain
protection group which is always present and cannot be deleted.
The protection group is identified by an index, the value 1 is reserved for the extension chain protection
group,which is always present and cannot be deleted.

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 (index) [ no admin-status | admin-status


<Equipm::PortGroupAdminStatus> ] [ no eps-quenchfactor | eps-quenchfactor <Equipm::TimeTicks> ]

Command Parameters
Table 5.4-1 "Protection Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: Index in eqpt Prot Group Table
- index of protection group
Table 5.4-2 "Protection Group Configuration Command" Command Parameters
Parameter Type Description
[no] admin-status Parameter type: <Equipm::PortGroupAdminStatus> optional parameter with default
Format: value: "unlock"
( unlock changes the administrative-status
| lock ) to lock or unlock
Possible values:
- unlock : unlock
- lock : lock
[no] eps-quenchfactor Parameter type: <Equipm::TimeTicks> optional parameter with default
Format: value: "1440000"
- timer value for quench mechanish timervalue of quenching
- unit: 1/100 sec mechanism, 0 is valid value

3HH-04416-CDAA-TCZZA Edition 03 Released 83


5 Equipment Configuration Commands

5.5 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 (index) [ no redcy-ctrl-status | redcy-ctrl-status


<Equipm::ProtElementRedcyCtrlStatus> ]

Command Parameters
Table 5.5-1 "Protection Element Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: Index in eqpt Prot Element Table
( 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
Table 5.5-2 "Protection Element Configuration Command" Command Parameters

84 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

Parameter Type Description


[no] redcy-ctrl-status Parameter type: <Equipm::ProtElementRedcyCtrlStatus> optional parameter with default
Format: value: "normal"
( normal changes the redundancy control
| forced_active ) status
Possible values:
- normal : enables redundancy (active or standby)
- forced_active : forces the element to be active

3HH-04416-CDAA-TCZZA Edition 03 Released 85


5 Equipment Configuration Commands

5.6 External-link-host Configuration Commands

Command Description
This command allows the operator to configure the traffic direction of the two 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 (faceplate-number) [ no direction | direction


<Equipm::ExternalLinkConfigType> ]

Command Parameters
Table 5.6-1 "External-link-host Configuration Commands" Resource Parameters
Resource Identifier Type Description
(faceplate-number) Format: the faceplate number of the
- the faceplate number of the configurable external link configurable external-link
- range: [6...7]
Table 5.6-2 "External-link-host Configuration Commands" Command Parameters
Parameter Type Description
[no] direction Parameter type: <Equipm::ExternalLinkConfigType> optional parameter with default
Format: value: "network"
( network the external-link traffic direction
| remote-lt )
Possible values:
- network : the connection direction is from the network
- remote-lt : the connection direction is to the remote line
termination card

86 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

5.7 Host Shelf SFP Configuration Commands

Command Description
This command allows the operator to configure the association between a host shelf SFP 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 (sfp-index) [ no remote | remote <Equipm::ExpansionSlotIndex> ]

Command Parameters
Table 5.7-1 "Host Shelf SFP Configuration Commands" Resource Parameters
Resource Identifier Type Description
(sfp-index) Format: host shelf SFP number on the
- host SFP faceplate number faceplate
- range: [2...17]
Table 5.7-2 "Host Shelf SFP Configuration Commands" Command Parameters
Parameter Type Description
[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
Field type <Eqpt::ExpShelf>
- physical nbr of expansion shelf within expansion rack
Field type <Eqpt::ExpSlot>
- the physical number of the slot within expansion shelf

3HH-04416-CDAA-TCZZA Edition 03 Released 87


5 Equipment Configuration Commands

5.8 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.8-2 "NE Configuration Command" Command Parameters
Parameter Type Description
[no] description Parameter type: <Description-127> optional parameter with default
Format: value: ""
- description to help the operator to identify the object any description to be used by the
- length: x<=127 operator

88 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

5.9 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.9-1 "Rack Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physcial position of the rack
<Eqpt::RackId>
Field type <Eqpt::RackId>
- the rack number
Table 5.9-2 "Rack Configuration Command" Command Parameters
Parameter Type Description
[no] description Parameter type: <Description-127> optional parameter with default
Format: value: ""
- description to help the operator to identify the object any description to be used by the
- length: x<=127 operator

3HH-04416-CDAA-TCZZA Edition 03 Released 89


5 Equipment Configuration Commands

5.10 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 description | description
<Description-127> ]

Command Parameters
Table 5.10-1 "Shelf Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: the physical identification of the
<Eqpt::RackId> / <Eqpt::ShelfId> shelf
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>
- the shelf number
Table 5.10-2 "Shelf Configuration Command" Command Parameters
Parameter Type Description
[no] class Parameter type: <Equipm::ShelfClass> optional parameter with default
Format: value: "main-ethernet"
( main-ethernet the class to which the shelf
| ext-ethernet ) belongs
Possible values:
- main-ethernet : main shelf - supports ethernet-based traffic

90 Released 3HH-04416-CDAA-TCZZA Edition 03


5 Equipment Configuration Commands

Parameter Type Description


- ext-ethernet : extension shelf - supports ethernet-based
traffic
[no] planned-type Parameter type: <Equipm::ShelfType> optional parameter with default
Format: value: "not-planned"
Data driven field type the planned type of the shelf
Possible values are depending on the actual configuration
and software.
The currently allowed values can be shown with online-help.
[no] unlock Parameter type: boolean obsolete parameter replaced by
parameter "lock"
the holder is unlocked
[no] lock Parameter type: boolean optional parameter
the holder is locked
[no] extended-lt-slots Parameter type: boolean optional parameter
change to extended lt slots
[no] description Parameter type: <Description-127> optional parameter with default
Format: value: ""
- description to help the operator to identify the object any description to be used by the
- length: x<=127 operator

3HH-04416-CDAA-TCZZA Edition 03 Released 91


5 Equipment Configuration Commands

5.11 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.11-2 "Environment Monitoring Configuration Command" Command Parameters
Parameter Type Description
[no] enable-supervise Parameter type: boolean optional parameter
enable environment monitoring
relay

92 Released 3HH-04416-CDAA-TCZZA Edition 03


6- xDSL Configuration Commands

6.1 xDSL Configuration Command Tree 6-94


6.2 xDSL Common Service Profile Configuration 6-99
Command
6.3 xDSL Common Spectrum Profile Configuration 6-102
Command
6.4 xDSL Artificial Noise Downstream Configuration 6-108
Command
6.5 xDSL Spectrum Profile for ADSL/ADSL2 Configuration 6-110
Command
6.6 xDSL Spectrum Profile for RE-ADSL2 Configuration 6-112
Command
6.7 xDSL Spectrum Profile for ADSL2 Plus Configuration 6-114
Command
6.8 ADSL2-plus Custom PSD shape 6-117
6.9 xDSL Spectrum Profile for VDSL Configuration 6-118
Command
6.10 VDSL Ghs Tones Transmission Power Control 6-125
Configuration Command
6.11 VDSL Custom PSD shape 6-127
6.12 VDSL Custom PSD shape 6-128
6.13 xDSL Spectrum Profile for VDSL2 Configuration 6-129
Command
6.14 VDSL2 Custom PSD shape Downstream 6-135
6.15 VDSL2 Custom PSD shape Upstream 6-136
6.16 VDSL2 Custom PSD shape 6-137
6.17 VDSL2 Virtual Noise Downstream 6-138
6.18 VDSL2 Virtual Noise Upstream 6-139
6.19 xDSL Line Configuration Command 6-140
6.20 xDSL Line TCA Threshold Configuration Command 6-144
6.21 xDSL Local Loop Unbundling Configuration 6-146
Command

3HH-04416-CDAA-TCZZA Edition 03 Released 93


6 xDSL Configuration Commands

6.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
- (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] 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
- (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-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-am

94 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

- [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
- [no] proprietary-feat
- [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
----re-adsl
- [no] proprietary-feat
- [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
----adsl2-plus
- [no] proprietary-feat
- [no] max-agpowlev-down
- [no] max-agpowlev-up
- [no] max-psd-down
- [no] max-psd-up

3HH-04416-CDAA-TCZZA Edition 03 Released 95


6 xDSL Configuration Commands

- [no] psd-shape-down
- [no] pbo-mode-up
- [no] max-recv-power-up
----cust-psd-pt-down
- (psd-point)
- [no] frequency
- [no] psd
----vdsl
- [no] proprietary-feat
- [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
- [no] pbo-mode-down
- [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
----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
----vdsl2
- [no] proprietary-feat
- [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

96 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

- [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
----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
----line
- (if-index)
- [no] service-profile
- [no] spectrum-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-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-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

3HH-04416-CDAA-TCZZA Edition 03 Released 97


6 xDSL Configuration Commands

- [no] admin-up
- [no] bonding-mode
- [no] transfer-mode
----tca-line-threshold
- [no] enable
- [no] es-nearend
- [no] ses-nearend
- [no] uas-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
----local-loop
- [no] unbundle

98 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.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 ofwhat 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 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 6.2-1 "xDSL Common Service Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile
- a profile index value
- range: [1...256]
Table 6.2-2 "xDSL Common Service Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter

3HH-04416-CDAA-TCZZA Edition 03 Released 99


6 xDSL Configuration Commands

Parameter Type Description


Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(scope) Format: obsolete parameter that will be
local-profile ignored
Possible values: scope of the profile
- local-profile : the local profile
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
- a signed integer usually 1 for new profile
[no] ra-mode-down Parameter type: <Xdsl::RAModeDownType> optional parameter with default
Format: value: "automatic"
( operator-ctrld rate adaptation mode for down
| automatic stream
| dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode in
downstream
- automatic : automatic rate adaptive mode at startup in
downstream
- dynamic : dynamic rate adaptive mode at startup and at
showtime in downstream
[no] ra-mode-up Parameter type: <Xdsl::RAModeUpType> optional parameter with default
Format: value: "automatic"
( operator-ctrld rate adaptation mode for up
| automatic stream
| dynamic )
Possible values:
- operator-ctrld : operator controlled rate adaptive mode in
upstream
- automatic : automatic rate adaptive mode at startup in
upstream
- dynamic : dynamic rate adaptive mode at startup and at
showtime in upstream
[no] min-bitrate-down Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 1024
- a bit rate value minimum downstream bit rate to
- unit: kbps be maintained
- range: [0...262143]
[no] min-bitrate-up Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 64
- a bit rate value minimum upstream bit rate to be
- unit: kbps maintained
- range: [0...262143]
[no] plan-bitrate-down Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 1536
- a bit rate value planned bitrate in downstream
- unit: kbps
- range: [0...262143]
[no] plan-bitrate-up Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 128
- a bit rate value planned bitrate in upstream
- unit: kbps
- range: [0...262143]
[no] max-bitrate-down Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 6144

100 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- a bit rate value maximum bitrate in downstream
- unit: kbps
- range: [0...262143]
[no] max-bitrate-up Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 640
- a bit rate value maximum bitrate in upstream
- unit: kbps
- range: [0...262143]
[no] max-delay-down Parameter type: <Xdsl::InterleavingDelay> optional parameter with default
Format: value: 16
- a delay time period maximum delay for interleaving
- unit: msec function in downstream
- range: [1...63]
[no] max-delay-up Parameter type: <Xdsl::InterleavingDelay> optional parameter with default
Format: value: 16
- a delay time period maximum delay for interleaving
- unit: msec function in upstream
- range: [1...63]
[no] imp-noise-prot-dn Parameter type: <Xdsl::ImpNoiseProtection> optional parameter with default
Format: value: 0
- minimum impulse noise protection minimum impulse noise
- unit: 1/10 symbols protection in downstream
- range: [0...80]
[no] imp-noise-prot-up Parameter type: <Xdsl::ImpNoiseProtection> optional parameter with default
Format: value: 0
- minimum impulse noise protection minimum impulse noise
- unit: 1/10 symbols protection in upstream
- range: [0...80]
[no] inp-wo-erasure-dn Parameter type: boolean optional parameter
min-inp even without erasure
detection
[no] inp-wo-erasure-up Parameter type: boolean optional parameter
min-inp even without erasure
detection
[no] min-l2-br-down Parameter type: <Xdsl::BitRate> optional parameter with default
Format: value: 128
- a bit rate value minimum downstream bitrate to
- unit: kbps be maintained during L2
- range: [0...262143]
[no] active Parameter type: boolean optional parameter
The parameter is not visible
during creation.
to activate the profile

3HH-04416-CDAA-TCZZA Edition 03 Released 101


6 xDSL Configuration Commands

6.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 configure 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 ofwhat 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-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-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::RFBand> ] [ no
power_mgnt_mode | power_mgnt_mode <Xdsl::LinePowerMgtMode> ] [ no l0-time | l0-time
<Xdsl::LineL0Time> ] [ no l2-time | l2-time <Xdsl::LineL2Time> ] [ no l2-agpow-red-tx | l2-agpow-red-tx

102 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

<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 6.3-1 "xDSL Common Spectrum Profile Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.3-2 "xDSL Common Spectrum Profile Configuration Command" Command Parameters
Parameter Type Description
name Parameter type: <AsamProfileName> mandatory parameter
Format: profile name
- a profile name
- range: [a-zA-Z0-9-_.]
- length: 1<=x<=32
(scope) Format: obsolete parameter that will be
local-profile ignored
Possible values: scope of the profile
- local-profile : the local profile
version Parameter type: <SignedInteger> optional parameter
Format: version maintained by manager,
- a signed integer usually 1 for new profile
[no] dis-ansi-t1413 Parameter type: boolean optional parameter
disable ANSI T1.413-1998
[no] dis-etsi-dts Parameter type: boolean optional parameter
disable ETSI DTS/TM06006
[no] dis-g992-1-a Parameter type: boolean optional parameter
disable G.992.1 POTS
non-overlapped spectrum
[no] dis-g992-1-b Parameter type: boolean optional parameter
disable G.992.1 ISDN
non-overlapped spectrum
[no] dis-g992-2-a Parameter type: boolean optional parameter
disable G.992.2 POTS
non-overlapped spectrum
[no] dis-g992-3-a Parameter type: boolean optional parameter
disable G.992.3 POTS
non-overlapped spectrum
[no] dis-g992-3-b Parameter type: boolean optional parameter
disable G.992.3 ISDN
non-overlapped spectrum
[no] g992-3-l1 Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 1
[no] g992-3-l2 Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 2
[no] g992-3-am Parameter type: boolean optional parameter

3HH-04416-CDAA-TCZZA Edition 03 Released 103


6 xDSL Configuration Commands

Parameter Type Description


G.992.3 extended POTS with
non-overlapped spectrum
[no] g992-5-a Parameter type: boolean optional parameter
G.992.5 POTS non-overlapped
spectrum
[no] g992-5-b Parameter type: boolean optional parameter
G.992.5 ISDN non-overlapped
spectrum
[no] ansi-t1.424 Parameter type: boolean optional parameter
ANSI T1.424
[no] dis-etsi-ts Parameter type: boolean optional parameter
disable ETSI TS
[no] itu-g993-1 Parameter type: boolean optional parameter
ITU G993-1
[no] ieee-802.3ah Parameter type: boolean optional parameter
IEEE 802.3ah
[no] g992-5-am Parameter type: boolean optional parameter
G.992.5 extended POTS
non-overlapped spectrum
[no] g993-2-8a Parameter type: boolean optional parameter
G.993.2_8A VDSL-2 with profile
8A
[no] g993-2-8b Parameter type: boolean optional parameter
G.993.2_8B VDSL-2 with profile
8B
[no] g993-2-8c Parameter type: boolean optional parameter
G.993.2_8C VDSL-2 with profile
8C
[no] g993-2-8d Parameter type: boolean optional parameter
G.993.2_8D VDSL-2 with profile
8D
[no] g993-2-12a Parameter type: boolean optional parameter
G.993.2_12A VDSL-2 with
profile 12A
[no] g993-2-12b Parameter type: boolean optional parameter
G.993.2_12B VDSL-2 with
profile 12B
[no] g993-2-17a Parameter type: boolean optional parameter
G.993.2_17A VDSL-2 with
profile 17A
[no] g993-2-30a Parameter type: boolean optional parameter
G.993.2_30A VDSL-2 with
profile 30A
[no] min-noise-down Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 0
- a noise margin value minimum noise margin in
- unit: 1/10 db downstream
- range: [0...310]
[no] min-noise-up Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 0
- a noise margin value minimum noise margin in
- unit: 1/10 db upstream
- range: [0...310]
[no] trgt-noise-down Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 60
- a noise margin value target noise margin in
- unit: 1/10 db downstream

104 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- range: [0...310]
[no] trgt-noise-up Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 60
- a noise margin value target noise margin in upstream
- unit: 1/10 db
- range: [0...310]
[no] max-noise-down Parameter type: <Xdsl::NoiseMarginPlus> optional parameter with default
Format: value: 511
- a normal noise margin value plus special value maximum noise margin in
- unit: 1/10 db downstream
- range: [0...310,511]
[no] max-noise-up Parameter type: <Xdsl::NoiseMarginPlus> optional parameter with default
Format: value: 511
- a normal noise margin value plus special value maximum noise margin in
- unit: 1/10 db upstream
- range: [0...310,511]
[no] carrier-mask-down Parameter type: <Xdsl::CarrierMaskDown> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 : 00
- an octet string bitmask defining carrier mask : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
- length: 64 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
[no] carrier-mask-up Parameter type: <Xdsl::CarrierMaskUp> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 : 00
- an octet string bitmask defining carrier mask : 00 : 00"
- length: 8 the upstream carrier mask pattern
[no] rf-band-list Parameter type: <Xdsl::RFBand> optional parameter with default
Format: value: "07 : 12 : 07 : d0 : 19 : 0d
- a variable lenght octet string defining rf band list : ac : 0e : d8 : 19 : 1b : 58 : 1b :
- length: x<=80 bc : 19 : 27 : 74 : 27 : a6 : 19"
list of RF bands
[no] power_mgnt_mode Parameter type: <Xdsl::LinePowerMgtMode> optional parameter with default
Format: value: "none"
( none permission of power management
| l2 states
| l3
| l2-l3 )
Possible values:
- none : l2 or l3 not supported
- l2 : only l2 supported
- l3 : only l3 supported
- l2-l3 : l2 and l3 supported
[no] l0-time Parameter type: <Xdsl::LineL0Time> optional parameter with default
Format: value: 255
- min time in a state before transitting into another min time between exit from and
- unit: sec entry in l2 state
- range: [0...1800]
[no] l2-time Parameter type: <Xdsl::LineL2Time> optional parameter with default
Format: value: 60
- min time in a state before transitting into another min time between entry in l2 and

3HH-04416-CDAA-TCZZA Edition 03 Released 105


6 xDSL Configuration Commands

Parameter Type Description


- unit: sec first power trim
- range: [0...1800]
[no] l2-agpow-red-tx Parameter type: <Xdsl::LineL2Atpr> optional parameter with default
Format: value: 3
- the maximum aggregate transmit power reduction the maximum aggregate transmit
- unit: db power reduction for l2
- range: [0...31]
[no] modification Parameter type: <Xdsl::ModifyStatus> optional parameter with default
Format: value: "complete"
( start to modify the profile
| cancel
| complete )
Possible values:
- start : to start modifying the profile
- cancel : to cancel the modifications done
- complete : to complete the modifications
[no] active Parameter type: boolean optional parameter
The parameter is not visible
during creation.
to activate the profile
[no] rau-noise-down Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 70
- a noise margin value downstream upshift noise margin
- unit: 1/10 db for rate adaptation
- range: [0...310]
[no] rau-noise-up Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 70
- a noise margin value upstream upshift noise margin for
- unit: 1/10 db rate adaptation
- range: [0...310]
[no] rau-time-down Parameter type: <Xdsl::RaTime> optional parameter with default
Format: value: 300
- a data rate value downstream minimum upshift
- unit: sec rate adaptation interval
- range: [0...16383]
[no] rau-time-up Parameter type: <Xdsl::RaTime> optional parameter with default
Format: value: 300
- a data rate value upstream minimum upshift rate
- unit: sec adaptation interval
- range: [0...16383]
[no] rad-noise-down Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 20
- a noise margin value downstream downshift noise
- unit: 1/10 db margin for rate adaptation
- range: [0...310]
[no] rad-noise-up Parameter type: <Xdsl::NoiseMargin> optional parameter with default
Format: value: 20
- a noise margin value upstream downshift noise margin
- unit: 1/10 db for rate adaptation
- range: [0...310]
[no] rad-time-down Parameter type: <Xdsl::RaTime> optional parameter with default
Format: value: 30
- a data rate value downstream minimum downshift
- unit: sec rate adaptation interval
- range: [0...16383]
[no] rad-time-up Parameter type: <Xdsl::RaTime> optional parameter with default
Format: value: 30

106 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- a data rate value upstream minimum downshift
- unit: sec rate adaptation interval
- range: [0...16383]
[no] l2-agpw-to-red-tx Parameter type: <Xdsl::LineL2AtprT> optional parameter with default
Format: value: 31
- the total maximum aggregate transmit power reduction total maximum aggregate
- unit: db transmit power reduction for L2
- range: [0...31]

3HH-04416-CDAA-TCZZA Edition 03 Released 107


6 xDSL Configuration Commands

6.4 xDSL Artificial Noise Downstream


Configuration Command

Command Description
This node 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. A number of 2 to 32 Artificial Noise PSD points can be specified downstream.
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. If all PSD points
are configured with a frequency of 0 and an invalid PSD of -167,5 dBm/Hz (entered value: 255), no artificial noise
shall be used.
The successive PSD points must have increasing (>/=) frequencies. If one point is marked as unused, all successive
points will be marked as unused too. 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 6.4-1 "xDSL Artificial Noise Downstream Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: the name of the operator
- psd point
- range: [1...32]
Table 6.4-2 "xDSL Artificial Noise Downstream Configuration Command" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz

108 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustPsd> optional parameter with default
Format: value: 255
- psd level psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

3HH-04416-CDAA-TCZZA Edition 03 Released 109


6 xDSL Configuration Commands

6.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 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> ]

Command Parameters
Table 6.5-1 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.5-2 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255

110 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in downstream
- range: [0...255]
[no] max-agpowlev-up Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255
- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in upstream
- range: [0...255]
[no] max-psd-down Parameter type: <Xdsl::Adsl2PowerSpectralDensityDown> optional parameter with default
Format: value: -400
- a power spectral density value maximum power spectral density
- unit: 1/10 * dBm/Hz allowed in downstream
- range: [-600...-400]
[no] max-psd-up Parameter type: <Xdsl::Adsl2PowerSpectralDensityUp> optional parameter with default
Format: value: -380
- a power spectral density value maximum power spectral density
- unit: 1/10 * dBm/Hz allowed in upstream
- range: [-600...-380]
[no] pbo-mode-up Parameter type: boolean optional parameter
upstream power backoff mode
ON
[no] max-recv-power-up Parameter type: <Xdsl::RxPowerLevel> optional parameter with default
Format: value: 255
- a received power level value the maximum receive power
- unit: 1/10 * dBm allowed in upstream
- range: [-255...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 111


6 xDSL Configuration Commands

6.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 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 6.6-1 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.6-2 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255

112 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in downstream
- range: [0...255]
[no] max-agpowlev-up Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255
- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in upstream
- range: [0...255]
[no] max-psd-down Parameter type: optional parameter with default
<Xdsl::ReAdsl2PowerSpectralDensityDown> value: -370
Format: maximum power spectral density
- a power spectral density value allowed in downstream
- unit: 1/10 * dBm/Hz
- range: [-600...-370]
[no] max-psd-up Parameter type: <Xdsl::ReAdsl2PowerSpectralDensityUp> optional parameter with default
Format: value: -329
- a power spectral density value maximum power spectral density
- unit: 1/10 * dBm/Hz allowed in upstream
- range: [-600...-329]
[no] pbo-mode-up Parameter type: boolean optional parameter
upstream power backoff mode
ON
[no] max-recv-power-up Parameter type: <Xdsl::RxPowerLevel> optional parameter with default
Format: value: 255
- a received power level value the maximum receive power
- unit: 1/10 * dBm allowed in upstream
- range: [-255...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 113


6 xDSL Configuration Commands

6.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 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> ]

Command Parameters
Table 6.7-1 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.7-2 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::PowerLevel> optional parameter with default

114 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


Format: value: 255
- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in downstream
- range: [0...255]
[no] max-agpowlev-up Parameter type: <Xdsl::PowerLevel> optional parameter with default
Format: value: 255
- a power level value maximum aggregate power
- unit: 1/10 * dBm allowed in upstream
- range: [0...255]
[no] max-psd-down Parameter type: optional parameter with default
<Xdsl::Adsl2PlusPowerSpectralDensityDown> value: -400
Format: maximum power spectral density
- a power spectral density value allowed in downstream
- unit: 1/10 * dBm/Hz
- range: [-600...-400]
[no] max-psd-up Parameter type: <Xdsl::Adsl2PlusPowerSpectralDensityUp> optional parameter with default
Format: value: -380
- a power spectral density value maximum power spectral density
- unit: 1/10 * dBm/Hz allowed in upstream
- range: [-600...-380]
[no] psd-shape-down Parameter type: <Xdsl::Adsl2PlusPsdShapeDown> optional parameter with default
Format: value: "std-psd-down"
( custom-psd-down power spectral density shape in
| std-psd-down downstream
| 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
- 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

3HH-04416-CDAA-TCZZA Edition 03 Released 115


6 xDSL Configuration Commands

Parameter Type Description


- 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
[no] pbo-mode-up Parameter type: boolean optional parameter
upstream power backoff mode
ON
[no] max-recv-power-up Parameter type: <Xdsl::RxPowerLevel> optional parameter with default
Format: value: 255
- a received power level value the maximum receive power
- unit: 1/10 * dBm allowed in upstream
- range: [-255...255]

116 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.8 ADSL2-plus Custom PSD shape

Command Description
This node allows the operator to configure custom psd shape
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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.8-1 "ADSL2-plus Custom PSD shape" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 6.8-2 "ADSL2-plus Custom PSD shape" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFrqAdsl2> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...2208]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 117


6 xDSL Configuration Commands

6.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.

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 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 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> ]

Command Parameters
Table 6.9-1 "xDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.9-2 "xDSL Spectrum Profile for VDSL Configuration Command" Command Parameters

118 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] vdsl-band-plan Parameter type: <Xdsl::VdslBandPlan> optional parameter with default
Format: value: "band-plan-a4"
( band-plan-a4 the VDSL band plan
| 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
[no] optional-band Parameter type: <Xdsl::OptionalBandUsage> optional parameter with default
Format: value: "off"
( off optional band Usage
| up
| down )
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
[no] optional-endfreq Parameter type: <Xdsl::OptionalBandEndFreq> optional parameter with default
Format: value: 138
- an end frequency of the VDSL optional band optional band end frequency
- unit: KHz
- range: [138...276]
[no] adsl-band Parameter type: <Xdsl::AdslBandUsage> optional parameter with default
Format: value: "excl-adsl"

3HH-04416-CDAA-TCZZA Edition 03 Released 119


6 xDSL Configuration Commands

Parameter Type Description


( allow-adsl adsl band Usage
| 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]
[no] max-agpowlev-down Parameter type: <Xdsl::VdslPowerLevel> optional parameter with default
Format: value: 255
- a power level value max power allowed on the line in
- unit: 1/10 * dBm downstream
- range: [-310...255]
[no] max-agpowlev-up Parameter type: <Xdsl::VdslPowerLevel> optional parameter with default
Format: value: 255
- a power level value max power allowed on the line in
- unit: 1/10 * dBm upstream
- range: [-310...255]
[no] psd-shape-down Parameter type: <Xdsl::VdslPsdShapeDown> optional parameter with default
Format: value: "etsi-p-cab-m1"
( custom-psd-down power spectral density shape in
| ansi-ftt-ex-m1 downstream
| 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:
- 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

120 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


- 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
[no] psd-shape-up Parameter type: <Xdsl::VdslPsdShapeUp> optional parameter with default
Format: value: "etsi-p-m1"
( ansi-ftt-ex-m1 power spectral density shape in
| ansi-ftt-ex-m2 upstream
| 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
- 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
[no] pbo-mode-down Parameter type: boolean optional parameter
upstream power backoff mode
OFF
[no] rx-psd-shape-up 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

3HH-04416-CDAA-TCZZA Edition 03 Released 121


6 xDSL Configuration Commands

Parameter Type Description


| 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
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
[no] ghstones-pwr-mode Parameter type: <Xdsl::GhsTonesTxPwr> optional parameter with default
Format: value: "standard"
( standard the Tx power control of the G.hs
| auto tones
| 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
[no] max-band Parameter type: <Xdsl::VdslMaxBandNum> optional parameter with default
Format: value: "unrestricted"
( unrestricted max number of bands to be used
| <Xdsl::VdslMaxBandNum> ) from specified band plan
Possible values:
- unrestricted : unrestricted bands
Field type <Xdsl::VdslMaxBandNum>
- number of upstream and downstream bands
- range: [0,2...8]

122 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


[no] max-freq Parameter type: <Xdsl::VdslMaxFrequency> optional parameter with default
Format: value: "ulimited"
( ulimited max frequency that can be used
| <Xdsl::VdslMaxFrequency> ) during showtime
Possible values:
- ulimited : unlimited frequency
Field type <Xdsl::VdslMaxFrequency>
- maximum frequency that can be used during showtime
- unit: KHz
- range: [1104...30000]
[no] m-psd-level-down Parameter type: <Xdsl::MaxPsdDown> optional parameter with default
Format: value: "no-constraint"
( no-constraint max PSD level for downstream
| <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]
[no] m-psd-level-up Parameter type: <Xdsl::MaxPsdUp> optional parameter with default
Format: value: "no-constraint"
( no-constraint max PSD level for upstream
| <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]
[no] psd-pbo-par-a-up Parameter type: <Xdsl::ABParamType> optional parameter with default
Format: value: "0f : a0 : 12 : 7a : 15 : 18
- binary string : 15 : 18 : 15 : 18"
- length: 10 parmtr A val for each band to
compute PSD ref for US PBO
[no] psd-pbo-par-b-up Parameter type: <Xdsl::ABParamType> optional parameter with default
Format: value: "00 : 00 : 07 : b9 : 06 : 29
- binary string : 04 : 35 : 03 : af"
- length: 10 parmtr B val for each band to
compute PSD ref for US PBO
[no] cust-psd-sc-down Parameter type: <Xdsl::PsdScaleBit> optional parameter with default
Format: value: "linear"
( linear psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
[no] cust-psd-ty-down Parameter type: <Xdsl::PsdTypeBit> optional parameter with default
Format: value: "mask"
( mask psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
[no] cust-rx-psd-sc-up Parameter type: <Xdsl::PsdScaleBit> optional parameter with default
Format: value: "linear"
( linear psd scale

3HH-04416-CDAA-TCZZA Edition 03 Released 123


6 xDSL Configuration Commands

Parameter Type Description


| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
[no] cust-rx-psd-ty-up Parameter type: <Xdsl::PsdTypeBit> optional parameter with default
Format: value: "mask"
( mask psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template

124 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.10 VDSL Ghs Tones Transmission Power Control


Configuration Command

Command Description
This node 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 6.10-1 "VDSL Ghs Tones Transmission Power Control Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
Table 6.10-2 "VDSL Ghs Tones Transmission Power Control Configuration Command" Command
Parameters
Parameter Type Description
[no] a43 Parameter type: <Xdsl::GhsTonesTxPwrCtrl> optional parameter with default
Format: value: "standard"
( standard power control of the ghstones for
| auto tones set a43
| 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

3HH-04416-CDAA-TCZZA Edition 03 Released 125


6 xDSL Configuration Commands

Parameter Type Description


Field type <Xdsl::GhsTonesTxPwrLvl>
- power of each DS tone
- unit: 1/2 * dBm/Hz
- range: [-198...-80]
[no] b43 Parameter type: <Xdsl::GhsTonesTxPwrCtrl> optional parameter with default
Format: value: "standard"
( standard power control of the ghs tones for
| auto tones set b43
| 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]
[no] a43c Parameter type: <Xdsl::GhsTonesTxPwrCtrl> optional parameter with default
Format: value: "standard"
( standard power control of the ghs tones for
| auto tones set a43c
| 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]
[no] v43 Parameter type: <Xdsl::GhsTonesTxPwrCtrl> optional parameter with default
Format: value: "standard"
( standard power control of the ghs tones for
| auto tones set v43
| 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]

126 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.11 VDSL Custom PSD shape

Command Description
This node allows the operator to configure custom psd shape
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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.11-1 "VDSL Custom PSD shape" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 6.11-2 "VDSL Custom PSD shape" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 127


6 xDSL Configuration Commands

6.12 VDSL Custom PSD shape

Command Description
This node allows the operator to configure custom rx-psd shape
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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.12-1 "VDSL Custom PSD shape" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 6.12-2 "VDSL Custom PSD shape" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

128 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.13 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.

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 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::RxVdslPsdShapeUp> ] [ 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::SnrmMode> ] [ 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> ]

Command Parameters
Table 6.13-1 "xDSL Spectrum Profile for VDSL2 Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value

3HH-04416-CDAA-TCZZA Edition 03 Released 129


6 xDSL Configuration Commands

Resource Identifier Type Description


- range: [1...256]
Table 6.13-2 "xDSL Spectrum Profile for VDSL2 Configuration Command" Command Parameters
Parameter Type Description
[no] proprietary-feat Parameter type: boolean optional parameter
enable proprietary features of the
modem
[no] max-agpowlev-down Parameter type: <Xdsl::VdslPowerLevel> optional parameter with default
Format: value: 255
- a power level value maximum power allowed on the
- unit: 1/10 * dBm line in downstream
- range: [-310...255]
[no] max-agpowlev-up Parameter type: <Xdsl::VdslPowerLevel> optional parameter with default
Format: value: 255
- a power level value maximum power allowed on the
- unit: 1/10 * dBm line in upstream
- range: [-310...255]
[no] psd-shape-down Parameter type: <Xdsl::Vdsl2PsdShapeDown> optional parameter with default
Format: value: "regionbm1-psd-down"
( cust-psd-down power spectral density shape in
| regiona-psd-down downstream
| 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
[no] cs-psd-shape-dn Parameter type: <Xdsl::VdslCustPsdShapeDwnStream> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 : 00
- an octet string defining custom psd shape : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
- length: x<=97 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"
(deprecated)power spectral

130 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


density shape in downstream
[no] cs-psd-shape-up Parameter type: <Xdsl::Vdsl2CustPsdShape> optional parameter with default
Format: value: "00 : 00 : 00 : 00 : 00 : 00
- an octet string defining custom psd shape : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
- length: x<=61 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"
(deprecated)power spectral
density shape in upstream
[no] psd-shape-up Parameter type: <Xdsl::Vdsl2PsdShapeUp> optional parameter with default
Format: value: "regionbm1-psd-up"
( regiona-psd-up power spectral density shape in
| regionbm1-psd-up upstream
| 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
[no] rx-psd-shape-up 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

3HH-04416-CDAA-TCZZA Edition 03 Released 131


6 xDSL Configuration Commands

Parameter Type Description


- 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
Field type <Xdsl::VdslCustPsdShape>
- an octet string defining custom psd shape
- length: x<=61
[no] psd-pbo-e-len-up Parameter type: <Xdsl::PsdPboElectrLength> optional parameter with default
Format: value: "estimated"
( estimated the electrical length to be used
| <Xdsl::PsdPboLength> ) with the AB parameters
Possible values:
- estimated : estimated electrical length
Field type <Xdsl::PsdPboLength>
- electrical parameter AB range
- unit: 1/2 * dB
- range: [0...256]
[no] m-psd-level-down Parameter type: <Xdsl::MaxPsdDown> optional parameter with default
Format: value: "no-constraint"
( no-constraint maximum PSD level for
| <Xdsl::MaxPsdLevelType> ) downstream
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
[no] m-psd-level-up Parameter type: <Xdsl::MaxPsdUp> optional parameter with default
Format: value: "no-constraint"
( no-constraint maximum PSD level for
| <Xdsl::MaxPsdLevelType> ) upstream
Possible values:
- no-constraint : no constraint on psd level
Field type <Xdsl::MaxPsdLevelType>
- Max psd level
- unit: 1/10 * dBm/Hz
- range: [-955...0]
[no] psd-pbo-par-a-up Parameter type: <Xdsl::ABParamType> optional parameter with default
Format: value: "0f : a0 : 12 : 7a : 15 : 18
- binary string : 15 : 18 : 15 : 18"
- length: 10 par A value for computing the
PSD reference for US PBO
[no] psd-pbo-par-b-up Parameter type: <Xdsl::ABParamType> optional parameter with default
Format: value: "00 : 00 : 07 : b9 : 06 : 29
- binary string : 04 : 35 : 03 : af"
- length: 10 par B value for computing the
PSD reference for US PBO
[no] v-noise-snr-down Parameter type: <Xdsl::SnrmMode> optional parameter with default
Format: value: "mode-1"
( mode-1 downstream mode of virtual
| mode-2 noise SNR margin

132 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


| mode-3 )
Possible values:
- mode-1 : Mode-1 ratio
- mode-2 : Mode-2 ratio
- mode-3 : Mode-3 ratio (Not supported, for future use)
[no] v-noise-snr-up Parameter type: <Xdsl::SnrmMode> optional parameter with default
Format: value: "mode-1"
( mode-1 upstream mode of virtual noise
| mode-2 SNR Margin
| mode-3 )
Possible values:
- mode-1 : Mode-1 ratio
- mode-2 : Mode-2 ratio
- mode-3 : Mode-3 ratio (Not supported, for future use)
[no] v-noise-psd-down Parameter type: <Xdsl::VirtualNoisePsdDownType> optional parameter with default
Format: value: "00 : 00 : 00 : ff : 00 : 00 :
- binary string ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
- length: x<=97 00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff : 00 : 00 : ff : 00 : 00 :
ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff : 00 : 00 : ff : 00 : 00 :
ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff : 00 : 00 : ff : 00 : 00 :
ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff"
(deprecated)virtual noise level for
determining the SNR margin in
downstream bands
[no] v-noise-psd-up Parameter type: <Xdsl::VirtualNoisePsdUpType> optional parameter with default
Format: value: "00 : 00 : 00 : ff : 00 : 00 :
- binary string ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
- length: x<=49 00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff : 00 : 00 : ff : 00 : 00 :
ff : 00 : 00 : ff : 00 : 00 : ff : 00 :
00 : ff : 00 : 00 : ff : 00 : 00 : ff :
00 : 00 : ff"
(deprecated)virtual noise level for
determining the SNR margin in
upstream bands
[no] cust-psd-sc-down Parameter type: <Xdsl::PsdScaleBit> optional parameter with default
Format: value: "linear"
( linear psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
[no] cust-psd-ty-down Parameter type: <Xdsl::PsdTypeBit> optional parameter with default
Format: value: "mask"
( mask psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
[no] cust-psd-sc-up Parameter type: <Xdsl::PsdScaleBit> optional parameter with default

3HH-04416-CDAA-TCZZA Edition 03 Released 133


6 xDSL Configuration Commands

Parameter Type Description


Format: value: "linear"
( linear psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
[no] cust-psd-ty-up Parameter type: <Xdsl::PsdTypeBit> optional parameter with default
Format: value: "mask"
( mask psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template
[no] cust-rx-psd-sc-up Parameter type: <Xdsl::PsdScaleBit> optional parameter with default
Format: value: "linear"
( linear psd scale
| logarithmic )
Possible values:
- linear : linear scale
- logarithmic : logarithmic scale
[no] cust-rx-psd-ty-up Parameter type: <Xdsl::PsdTypeBit> optional parameter with default
Format: value: "mask"
( mask psd type
| template )
Possible values:
- mask : PSD mask
- template : PSD template

134 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.14 VDSL2 Custom PSD shape Downstream

Command Description
This node allows the operator to configure 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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.14-1 "VDSL2 Custom PSD shape Downstream" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 6.14-2 "VDSL2 Custom PSD shape Downstream" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 135


6 xDSL Configuration Commands

6.15 VDSL2 Custom PSD shape Upstream

Command Description
This node allows the operator to configure Custom PSD shape in Downstream
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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.15-1 "VDSL2 Custom PSD shape Upstream" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 6.15-2 "VDSL2 Custom PSD shape Upstream" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

136 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.16 VDSL2 Custom PSD shape

Command Description
This node allows the operator to configure custom rx-psd shape Upstream
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.

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::CustomAdsl2Psd> ]

Command Parameters
Table 6.16-1 "VDSL2 Custom PSD shape" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...20]
Table 6.16-2 "VDSL2 Custom PSD shape" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustomAdsl2Psd> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2 * (PSD level in dBm/Hz)
- range: [0...255]

3HH-04416-CDAA-TCZZA Edition 03 Released 137


6 xDSL Configuration Commands

6.17 VDSL2 Virtual Noise Downstream

Command Description
This node allows the operator to configure virtual noise in Downstream
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.

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 6.17-1 "VDSL2 Virtual Noise Downstream" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd point
- range: [1...32]
Table 6.17-2 "VDSL2 Virtual Noise Downstream" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

138 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

6.18 VDSL2 Virtual Noise Upstream

Command Description
This node allows the operator to configure virtual noise in Upstream
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.

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 6.18-1 "VDSL2 Virtual Noise Upstream" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the profile.
- a profile index value
- range: [1...256]
(psd-point) Format: psd point
- psd level
- range: [1...16]
Table 6.18-2 "VDSL2 Virtual Noise Upstream" Command Parameters
Parameter Type Description
[no] frequency Parameter type: <Xdsl::CustFreq> optional parameter with default
Format: value: 0
- frequency psd frequency
- unit: khz
- range: [0...30000]
[no] psd Parameter type: <Xdsl::CustPsdVdsl2VtNoise> optional parameter with default
Format: value: 0
- psd level psd level
- unit: -2*(40+PSD level in dBm/Hz)
- range: [0...200,255]

3HH-04416-CDAA-TCZZA Edition 03 Released 139


6 xDSL Configuration Commands

6.19 xDSL Line Configuration Command

Command Description
This command allows the operator to configure the xDSL line.
For the configuration one should associate a spectrum and a service profile to the line. The op-mode controls the
operational modes allowed on the line. It can be used to disable an operational mode that is enabled in the
spectrum profile but is not allowed on the line. It uses the same bitmap coding as op-mode in the xDSL
spectrum-profile.'0' is used as special value to indicate that all the modes supported by the line are allowed.
The modes which are not supported by the line must be disabled.
An operational mode is allowed on the line when it is enabled in the op-mode of the line configuration and the
op-mode in the xDSL spectrum-profile.
The configuration of the TCA line threshold is part of the XDSL line configuration. This can be configured by the
following command: configure xdsl line (if-index) tca-line-threshold.
To deconfigure a line the service-profile and spectrum-profile has to be put to 0.

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 ] 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-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-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 ] [ no bonding-mode |
bonding-mode <Xdsl::BondingMode> ] [ no transfer-mode | transfer-mode <Xdsl::TpsTcMode> ]

Command Parameters
Table 6.19-1 "xDSL Line Configuration Command" Resource Parameters
Resource Identifier Type Description
(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

140 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Resource Identifier Type Description


Field type <Eqpt::PortId>
- the port number
Table 6.19-2 "xDSL Line Configuration Command" Command Parameters
Parameter Type Description
[no] service-profile Parameter type: <Xdsl::LineServiceProfile> optional parameter with default
Format: value: "none"
( none service profile to be configured
| <Xdsl::ProfilePointer> on this port
| 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
[no] spectrum-profile Parameter type: <Xdsl::LineSpectrumProfile> optional parameter with default
Format: value: "none"
( none spectrum profile to be configured
| <Xdsl::ProfilePointer> on this port
| 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
[no] ansi-t1413 Parameter type: boolean optional parameter
ANSI T1.413-1998
[no] etsi-dts Parameter type: boolean optional parameter
ETSI DTS/TM06006
[no] g992-1-a Parameter type: boolean optional parameter
G.992.1 POTS non-overlapped
spectrum
[no] g992-1-b Parameter type: boolean optional parameter
G.992.1 ISDN non-overlapped
spectrum
[no] g992-2-a Parameter type: boolean optional parameter
G.992.2 POTS non-overlapped
spectrum
[no] g992-3-a Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum
[no] g992-3-b Parameter type: boolean optional parameter
G.992.3 ISDN non-overlapped
spectrum
[no] g992-3-l1 Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 1
[no] g992-3-l2 Parameter type: boolean optional parameter
G.992.3 POTS non-overlapped
spectrum US mask 2
[no] g992-3-am Parameter type: boolean optional parameter

3HH-04416-CDAA-TCZZA Edition 03 Released 141


6 xDSL Configuration Commands

Parameter Type Description


G.992.3 extended POTS with
non-overlapped spectrum
[no] g992-5-a Parameter type: boolean optional parameter
G.992.5 POTS non-overlapped
spectrum
[no] g992-5-b Parameter type: boolean optional parameter
G.992.5 ISDN non-overlapped
spectrum
[no] ansi-t1.424 Parameter type: boolean optional parameter
ANSI T1.424
[no] etsi-ts Parameter type: boolean optional parameter
ETSI TS
[no] itu-g993-1 Parameter type: boolean optional parameter
ITU G993-1
[no] ieee-802.3ah Parameter type: boolean optional parameter
IEEE 802.3ah
[no] g992-5-am Parameter type: boolean optional parameter
G.992.5 extended POTS
non-overlapped spectrum
[no] g993-2-8a Parameter type: boolean optional parameter
G.993.2_8A VDSL-2 with profile
8A
[no] g993-2-8b Parameter type: boolean optional parameter
G.993.2_8B VDSL-2 with profile
8B
[no] g993-2-8c Parameter type: boolean optional parameter
G.993.2_8C VDSL-2 with profile
8C
[no] g993-2-8d Parameter type: boolean optional parameter
G.993.2_8D VDSL-2 with profile
8D
[no] g993-2-12a Parameter type: boolean optional parameter
G.993.2_12A VDSL-2 with
profile 12A
[no] g993-2-12b Parameter type: boolean optional parameter
G.993.2_12B VDSL-2 with
profile 12B
[no] g993-2-17a Parameter type: boolean optional parameter
G.993.2_17A VDSL-2 with
profile 17A
[no] g993-2-30a Parameter type: boolean optional parameter
G.993.2_30A VDSL-2 with
profile 30A
[no] carrier-data-mode Parameter type: <Xdsl::CarrierDataMode> optional parameter with default
Format: value: "off"
( off carrier data measurement
| on collection
| on-init )
Possible values:
- off : disable the collection
- on : enable the collection
- on-init : enable and re-initialize the line
[no] admin-up Parameter type: boolean optional parameter
set the admin-state of the line to
up
[no] bonding-mode Parameter type: <Xdsl::BondingMode> optional parameter with default
Format: value: "native"

142 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


( native channel-1 bonding mode
| atm-bonding )
Possible values:
- native : (deprecated)native mode for channel-1
- atm-bonding : (deprecated)atm bonding mode for
channel-1
[no] transfer-mode Parameter type: <Xdsl::TpsTcMode> optional parameter with default
Format: value: "system-default"
( atm tps tc mode
| ptm
| system-default )
Possible values:
- atm : atm mode
- ptm : ptm mode
- system-default : determined by the system, based on board
type

Command Output
Table 6.19-3 "xDSL Line Configuration Command" Display parameters
Specific Information
name Type Description
service-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the service profile
- ignored printable string This element is only shown in
detail mode.
spectrum-profile-name Parameter type: <Xdsl::IgnoredPrintableString> name of the spectrum profile
- ignored printable string This element is only shown in
detail mode.

3HH-04416-CDAA-TCZZA Edition 03 Released 143


6 xDSL Configuration Commands

6.20 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 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> ]

Command Parameters
Table 6.20-1 "xDSL Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier Type Description
(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
Table 6.20-2 "xDSL Line TCA Threshold Configuration Command" Command Parameters
Parameter Type Description
[no] enable Parameter type: boolean optional parameter
enable the reporting of TCA's for
this XDSL line
[no] es-nearend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default

144 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Parameter Type Description


Format: value: 0
- the tca threshold for errored second, 0 - disable errored seconds at the near end
- range: [0...900]
[no] ses-nearend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable severely errored seconds at the
- range: [0...900] near end
[no] uas-nearend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable unavailable seconds at the near
- range: [0...900] end
[no] es-day-nearend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable errored seconds at the near end
- range: [0...86400] for a day
[no] ses-day-nearend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable severely errored seconds at the
- range: [0...86400] near end for a day
[no] uas-day-nearend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable unavailable seconds at the near
- range: [0...86400] end for a day
[no] es-farend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable errored seconds at the far end
- range: [0...900]
[no] ses-farend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable severely errored seconds at the
- range: [0...900] far end
[no] uas-farend Parameter type: <Xdsl::IntervalTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for errored second, 0 - disable unavailable seconds at the far end
- range: [0...900]
[no] es-day-farend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable errored seconds at the far end for
- range: [0...86400] a day
[no] ses-day-farend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable severely errored seconds at the
- range: [0...86400] far end for a day
[no] uas-day-farend Parameter type: <Xdsl::DayTcaThreshold> optional parameter with default
Format: value: 0
- the tca threshold for a day errored second, 0 - disable unavailable seconds at the far end
- range: [0...86400] for a day

3HH-04416-CDAA-TCZZA Edition 03 Released 145


6 xDSL Configuration Commands

6.21 xDSL Local Loop Unbundling Configuration


Command

Command Description
This command allows the operator to configure Local Loop Unbundling.
Local Loop Unbundling enables handing over narrowband (POTS) services or broadband (Data, High Speed
Internet, 3-Play) services to another operator. For an ILEC (Incumbent Local Exchange Carrier), Local Loop
Unbundling hands over the broadband services to a CLEC (Competitive Local Exchange Carrier). For a CLEC,
Local Loop Unbundling hands over the narrowband services to an ILEC. Two situations exist : 1) No Local Loop
Unbundling : In this case, both broadband and narrowband services are offered by one operator, ILEC or CLEC.
2) Local Loop Unbundling : In this case, the ILEC operator enables the CLEC to make use of the existing
infrastructure to provide broadband services to the customers, while the ILEC keeps the narrowband. The CLEC
operator enables the ILEC to make use of the existing infrastructure to provide narrowband services to the
customers, while the CLEC keeps the broadband.
The Local Loop Unbundling is a function introduced in the splitter of the XD combo 300 equipment practice (7302
ISAM Voice Package). For an ILEC, it allows to bypass the broadband circuits (DSL modem and low pass filter),
and connect the line to the broadband circuits (DSL modem and Low Pass Filter) of the CLEC. For a CLEC, it
allows to bypass the narrowband circuits (internal POTS), and connect the line to the narrowband circuits or local
exchanges of the ILEC.
In case of ILEC, the narrowband service remains accessible irrespective of whether Local Loop Unbundling is
enabled or disabled. In case of CLEC, the broadband service remains accessible irrespective of whether Local
Loop Unbundling is enabled or 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 line (if-index) local-loop [ [ no ] unbundle ]

Command Parameters
Table 6.21-1 "xDSL Local Loop Unbundling Configuration Command" Resource Parameters
Resource Identifier Type Description
(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>

146 Released 3HH-04416-CDAA-TCZZA Edition 03


6 xDSL Configuration Commands

Resource Identifier Type Description


- the LT slot number
Field type <Eqpt::PortId>
- the port number
Table 6.21-2 "xDSL Local Loop Unbundling Configuration Command" Command Parameters
Parameter Type Description
[no] unbundle Parameter type: boolean optional parameter
Enable LLU Relay

3HH-04416-CDAA-TCZZA Edition 03 Released 147


7- ATM Configuration Commands

7.1 ATM Configuration Command Tree 7-149


7.2 ATM PVC Configuration Command 7-150
7.3 IPOA X-connect L2 interworking port Configuration 7-152
Command

148 Released 3HH-04416-CDAA-TCZZA Edition 03


7 ATM Configuration Commands

7.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
----[no] ip-cross-connect
- (interworking-port)
- cpe
- next-hop

3HH-04416-CDAA-TCZZA Edition 03 Released 149


7 ATM Configuration Commands

7.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

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
automatic:ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid, and vc-mux-pppoa
automatic:pppoa is used for auto-detection between llc-nlpid and vc-mux-pppoa

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 7.2-1 "ATM PVC Configuration Command" Resource Parameters
Resource Identifier Type Description
(port-index) Format: the atm static Interface with vpi
<Eqpt::RackId> / <Eqpt::ShelfId> / <Eqpt::SlotId> / and vci
<Eqpt::PortId> : <Eqpt::VpiMandatoryId> :
<Eqpt::VciMandatoryId>
Field type <Eqpt::RackId>
- the rack number
Field type <Eqpt::ShelfId>

150 Released 3HH-04416-CDAA-TCZZA Edition 03


7 ATM 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::VpiMandatoryId>
- atm VPI
Field type <Eqpt::VciMandatoryId>
- atm VCI
Table 7.2-2 "ATM PVC Configuration Command" Command Parameters
Parameter Type Description
[no] admin-down Parameter type: boolean optional parameter
disable traffic flow
[no] aal5-encap-type Parameter type: <Atm::VccEncapType> optional parameter with default
Format: value: "llc-snap"
( llc-snap The parameter is not visible
| llc-snap-routed during modification.
| llc-nlpid encapsulation method for traffic
| vc-mux-bridged-8023 in an AAL5 container
| vc-mux-routed
| vc-mux-pppoa
| automatic : ip
| automatic : ppp
| automatic : pppoa )
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
Possible values:
- ip : autodetection of the used ip encapsulation
- ppp : autodetection of the used ppp encapsulation
- pppoa : autodetection of the used pppoa encapsulation
Field type <SignedInteger>
- a signed integer

3HH-04416-CDAA-TCZZA Edition 03 Released 151


7 ATM Configuration Commands

7.3 IPOA X-connect L2 interworking port


Configuration Command

Command Description
This node 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> )

Command Parameters
Table 7.3-1 "IPOA X-connect L2 interworking port Configuration Command" Resource
Parameters
Resource Identifier Type Description
(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
Table 7.3-2 "IPOA X-connect L2 interworking port Configuration Command" Command
Parameters
Parameter Type Description
cpe Parameter type: <Ip::V4AddressHex> optional parameter
Format: IP address for cpe
- IPv4-address

152 Released 3HH-04416-CDAA-TCZZA Edition 03


7 ATM Configuration Commands

Parameter Type Description


next-hop Parameter type: <Ip::V4AddressHex> mandatory parameter
Format: IP address for next hop
- IPv4-address

3HH-04416-CDAA-TCZZA Edition 03 Released 153


8- Interface Management Configuration Commands

8.1 Interface Management Configuration Command Tree 8-155


8.2 Network Interface Configuration Command 8-156
8.3 Extend Interface Configuration Command 8-159
8.4 Interface Alarm Configuration Command 8-160
8.5 SHub Management Interface Configuration Command 8-161
8.6 SHub IP Configuration Command 8-162
8.7 SHub ICMP Configuration Command 8-163
8.8 SHub Multi-Network Configuration Command 8-164
8.9 SHub Unnumbered Interface Configuration Command 8-165
8.10 SHub Port Control Configuration Command 8-166
8.11 SHub Interface Uplink Group Configuration Command 8-168
8.12 SHub Interface Uplink Group Portlist Configuration 8-169
Command

154 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.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
- [no] link-updown-trap
- [no] link-state-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] unnumbered-as
- (borrowed-index)
----port
- (network-port)
- [no] mode
- [no] port-type
- [no] admin-status
- [no] mc-flooding
----[no] group
- (group-id)
- [no] threshold
----[no] port
- (port)

3HH-04416-CDAA-TCZZA Edition 03 Released 155


8 Interface Management Configuration Commands

8.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-updown-trap ] [ no link-state-trap | link-state-trap


<Itf::ifLinkUpDownTrap> ] [ no user | user <Itf::asamIfExtCustomerId> ] [ no severity | severity
<Itf::asamIfExtAlmReportingSeverity> ]

Command Parameters
Table 8.2-1 "Network Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(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>
| 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>
| ima-group : <Eqpt::RackId> / <Eqpt::ShelfId> /

156 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

Resource Identifier Type Description


<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> )
Possible values:
- xdsl-line : a static xdsl line interface
- ethernet-line : a static ethernet line interface
- atm-bonding : atm 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
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
Field type <Eqpt::SVlan>
- service vlan id
Field type <Eqpt::CVlan>
- customer vlan id
Field type <Eqpt::VrfId>
- VRF id
Table 8.2-2 "Network Interface Configuration Command" Command Parameters
Parameter Type Description
[no] admin-up Parameter type: boolean optional parameter
admin status is up
[no] link-updown-trap Parameter type: boolean obsolete parameter replaced by
parameter "link-state-trap"
enable link-up/link-down traps
[no] link-state-trap Parameter type: <Itf::ifLinkUpDownTrap> optional parameter with default
Format: value: "disable"
( enable indicates if link-up/link-down
| disable traps should be generated

3HH-04416-CDAA-TCZZA Edition 03 Released 157


8 Interface Management Configuration Commands

Parameter Type Description


| no-value )
Possible values:
- enable : enable link-up/link-down traps
- disable : disable link-up/link-down traps
- no-value : no valid value
[no] user Parameter type: <Itf::asamIfExtCustomerId> optional parameter with default
Format: value: "available"
- a string identifying the customer or user description of the user connected
- length: x<=64 to this interface
[no] severity Parameter type: <Itf::asamIfExtAlmReportingSeverity> optional parameter with default
Format: value: "default"
( indeterminate set minimum severity for alarm
| warning to be reported
| 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 in
asamIfExtAlmReportingSeverityDefaultTable
- no-value : no entry in the table

158 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.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 8.3-1 "Extend Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(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
Table 8.3-2 "Extend Interface Configuration Command" Command Parameters
Parameter Type Description
[no] customer-id Parameter type: <Itf::asamIfExtCustomerId> optional parameter with default
Format: value: "available"
- a string identifying the customer or user Config the customerId per PVC
- length: x<=64

3HH-04416-CDAA-TCZZA Edition 03 Released 159


8 Interface Management Configuration Commands

8.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) [ no default-severity | default-severity


<Itf::asamIfExtAlmReportingSeverityDefault> ]

Command Parameters
Table 8.4-1 "Interface Alarm Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index of the IANA ifType
( xdsl-line
| ethernet-line
| shdsl-line )
Possible values:
- xdsl-line : xdsl line
- ethernet-line : ethernet line
- shdsl-line : shdsl line
Table 8.4-2 "Interface Alarm Configuration Command" Command Parameters
Parameter Type Description
[no] default-severity Parameter type: optional parameter with default
<Itf::asamIfExtAlmReportingSeverityDefault> value: "major"
Format: default severity to be reported
( 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

160 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.5 SHub Management Interface Configuration


Command

Command Description
This command allows the operator to configure parameters related to SHub interface management.

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 8.5-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.5-2 "SHub Management Interface Configuration Command" Command Parameters
Parameter Type Description
[no] mtu Parameter type: <Shub::ifMainMtu> optional parameter with default
Format: value: 1500
- MTU for interface as shown to higher interface sub-layer MTU for the vlan interface
- range: [90...9100]
[no] admin-status 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

3HH-04416-CDAA-TCZZA Edition 03 Released 161


8 Interface Management Configuration Commands

8.6 SHub IP Configuration Command

Command Description
This node 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 8.6-1 "SHub IP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.6-2 "SHub IP Configuration Command" Command Parameters
Parameter Type Description
[no] vrf-id Parameter type: <Vrf::ShubVrfID> optional parameter with default
Format: value: 0
- the vrf id which uniquely identify a vrf the VRF instance to which this
- range: [0...127] interface is associated

162 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.7 SHub ICMP Configuration Command

Command Description
This node 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 8.7-1 "SHub ICMP Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
Table 8.7-2 "SHub ICMP Configuration Command" Command Parameters
Parameter Type Description
[no] err-msg-suppress Parameter type: boolean optional parameter
suppress the sending of ICMP err
msgs
[no] ping-msg-suppress Parameter type: boolean optional parameter
suppress ping packets

3HH-04416-CDAA-TCZZA Edition 03 Released 163


8 Interface Management Configuration Commands

8.8 SHub Multi-Network Configuration Command

Command Description
This node 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) )

Command Parameters
Table 8.8-1 "SHub Multi-Network Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
(ip-addr) Format: ip-address
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]

164 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.9 SHub Unnumbered Interface Configuration


Command

Command Description
This node 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 8.9-1 "SHub Unnumbered Interface Configuration Command" Resource Parameters
Resource Identifier Type Description
(vlan-id) Format: vlan id
- vlan id
- range: [1...4093]
(borrowed-index) Format: vlan-id of the associated
- vlan id numbered interface
- range: [1...4093]

3HH-04416-CDAA-TCZZA Edition 03 Released 165


8 Interface Management Configuration Commands

8.10 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 all privileges, and executed by operators with all 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 8.10-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier Type Description
(network-port) Format: identifier of the port interface
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub
Table 8.10-2 "SHub Port Control Configuration Command" Command Parameters
Parameter Type Description
[no] mode Parameter type: <Sys::PortCtrlMode> optional parameter with default
Format: value: "automatic"
( automatic negotiation mode of the port
| 10mbps : full interface parameters
| 10mbps : half
| 100mbps : full
| 100mbps : half
| 1gbps : full
| 1gbps : half )
Possible values:
- automatic : determine the parameters of interface

166 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

Parameter Type Description


automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
Possible values:
- full : data transfer in full duplex
- half : data transfer in half duplex
[no] port-type Parameter type: <Sys::Type> optional parameter with default
Format: value: "unused"
( user the type of port interface
| 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
[no] admin-status Parameter type: <Shub::AdminStatus> optional parameter with default
Format: value: "down"
( up administrative state of the port
| down
| auto-up )
Possible values:
- up : up
- down : down
- auto-up : autoup
[no] mc-flooding Parameter type: boolean optional parameter
enable multicast flooding

3HH-04416-CDAA-TCZZA Edition 03 Released 167


8 Interface Management Configuration Commands

8.11 SHub Interface Uplink Group Configuration


Command

Command Description
This node allows the user to configure parameters related to uplink group configuration of an 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:

> configure interface shub ( no group (group-id) ) | ( group (group-id) [ no threshold | threshold <Itf::Threshold> ] )

Command Parameters
Table 8.11-1 "SHub Interface Uplink Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(group-id) Format: A unique number for each logical
- the number of uplink group uplink group
- range: [1...7]
Table 8.11-2 "SHub Interface Uplink Group Configuration Command" Command Parameters
Parameter Type Description
[no] threshold Parameter type: <Itf::Threshold> optional parameter with default
Format: value: 0L
- the min nbr of links to be operational UP in grp the min nbr of links to be
- range: [0...7] operational UP in grp

168 Released 3HH-04416-CDAA-TCZZA Edition 03


8 Interface Management Configuration Commands

8.12 SHub Interface Uplink Group Portlist


Configuration Command

Command Description
This node 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 all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:

> configure interface shub group (group-id) ( no port (port) ) | ( port (port) )

Command Parameters
Table 8.12-1 "SHub Interface Uplink Group Portlist Configuration Command" Resource
Parameters
Resource Identifier Type Description
(group-id) Format: A unique number for each logical
- the number of uplink group uplink group
- range: [1...7]
(port) Format: the port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-CDAA-TCZZA Edition 03 Released 169


9- Error Configuration Commands

9.1 Error Configuration Command Tree 9-171


9.2 Error Log Configuration Command 9-172

170 Released 3HH-04416-CDAA-TCZZA Edition 03


9 Error Configuration Commands

9.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

3HH-04416-CDAA-TCZZA Edition 03 Released 171


9 Error Configuration Commands

9.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 9.2-2 "Error Log Configuration Command" Command Parameters
Parameter Type Description
[no] log-full-action Parameter type: <Error::errorLogFullAction> optional parameter with default
Format: value: "wrap"
( wrap set the action when error log
| halt ) buffer is full
Possible values:
- wrap : older log records are overwritten by recent ones
- halt : logging is stopped until the log buffer is reset

172 Released 3HH-04416-CDAA-TCZZA Edition 03


10- System Configuration Commands

10.1 System Configuration Command Tree 10-174


10.2 System Configuration Command 10-177
10.3 System Management Host IP Address Configuration 10-179
Command
10.4 System Management Vlan Host IP-Address 10-180
Configuration Command
10.5 System Management Default Route Configuration 10-181
Command
10.6 System SNTP Configuration Command 10-182
10.7 SHub System Loop ID Syntax Configuration 10-183
Command
10.8 SHub System ICMP Filter Configuration Command 10-184
10.9 SHub System ICMP Filter In Port List Configuration 10-187
Command
10.10 SHub System ICMP Filter Out Port List Configuration 10-188
Command
10.11 SHub System TCP Filter Configuration Command 10-189
10.12 SHub System TCP Filter In Port List Configuration 10-192
Command
10.13 SHub System TCP Filter Out Port List Configuration 10-193
Command
10.14 SHub System UDP Filter Configuration Command 10-194
10.15 SHub System UDP Filter In Port List Configuration 10-197
Command
10.16 SHub System UDP Filter Out Port List Configuration 10-198
Command
10.17 SHub System Other Protocol Filter Configuration 10-199
Command
10.18 SHub System Other Protocol Filter Configuration 10-202
Command
10.19 SHub System VLAN Filter Configuration Command 10-205
10.20 SHub System IP Group Configuration Command 10-206
10.21 SHub System ID Configuration Command 10-207
10.22 SHub System VLAN Group Configuration Command 10-208
10.23 SHub System HTTP Configuration Command 10-209
10.24 System Clock Configuration Command 10-210

3HH-04416-CDAA-TCZZA Edition 03 Released 173


10 System Configuration Commands

10.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
- contact-person
- [no] en-snmp-auth-trap
- [no] ether-shape-rate
- mgnt-vlan-id
- system-mac
- [no] single-public-ip
- [no] port-num-in-proto
----management
- host-ip-address
----[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
----loop-id-syntax
- [no] atm-based-dsl
- [no] efm-based-dsl
----shub
----filter
----ip-filter
----[no] icmp
- (index-num)
- [no] action-drop
- [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

174 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

- (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)
----[no] in-port
- (filter-rule)
- port
- [no] protocol
- [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
----[no] shub-manager
- (index)
- src-ip-addr
----entry
----ip
- [no] ip-cfg-mode
----id
- [no] contact
- [no] location
----vlan
- ext-vlan-id

3HH-04416-CDAA-TCZZA Edition 03 Released 175


10 System Configuration Commands

----status
- [no] http-access
----clock-mgmt
- [no] priority-scheme
- [no] ext-source

176 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.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 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 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>


contact-person <Transport::sysContact> [ [ no ] en-snmp-auth-trap ] [ no ether-shape-rate | ether-shape-rate
<Sys::etherShapeRate> ] mgnt-vlan-id <Vlan::VlanId> system-mac <Sys::systemMac> [ [ no ] single-public-ip ] [
no port-num-in-proto | port-num-in-proto <Sys::PortNumberInprotocol> ]

Command Parameters
Table 10.2-2 "System Configuration Command" Command Parameters
Parameter Type Description
[no] id Parameter type: <Sys::systemId> optional parameter with default
Format: value: """"
- system ID the system ID of the NE
- range: [a-zA-Z0-9-_./]
- length: x<=64
name Parameter type: <Transport::sysName> optional parameter
Format: fully-qualified domain name of
- a printable string the system
- length: x<=255
location Parameter type: <Transport::sysLocation> optional parameter
Format: location of this system
- a printable string
- length: x<=255
contact-person Parameter type: <Transport::sysContact> optional parameter
Format: info about the contact person for

3HH-04416-CDAA-TCZZA Edition 03 Released 177


10 System Configuration Commands

Parameter Type Description


- a printable string this system
- length: x<=255
[no] en-snmp-auth-trap Parameter type: boolean optional parameter
enable the generation of
authentication-failure traps
[no] ether-shape-rate Parameter type: <Sys::etherShapeRate> optional parameter with default
Format: value: 128
- ethernet frame shaping rate outgoing ethernet frames shaping
- unit: kbps rate on management itf
- range: [128...2000]
mgnt-vlan-id Parameter type: <Vlan::VlanId> optional parameter
Format: configure management vlan id
- vlan id
- range: [1...4093]
system-mac Parameter type: <Sys::systemMac> optional parameter
Format: sys mac addr in
<Sys::MacAddr> / <Sys::MacAddr> / <Sys::Range> sysMacAddr/lanxBaseMacAddr/lanxRan
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Sys::MacAddr>
- a mac-address (example : 01:02:03:04:05:06)
- length: 6
Field type <Sys::Range>
- range of the shub
- range: [24]
[no] single-public-ip Parameter type: boolean optional parameter
enable single-ip on the shub
[no] port-num-in-proto Parameter type: <Sys::PortNumberInprotocol> optional parameter with default
Format: value: "log-slot-num"
( log-slot-num numbering scheme for the Line
| position-based ID field (all protocols)
| 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)

178 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.3 System Management Host IP Address


Configuration Command

Command Description
This command allows the operator to configure the IP address of the 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 system management [ host-ip-address <Ip::ExternalAddress> ]

Command Parameters
Table 10.3-2 "System Management Host IP Address Configuration Command" Command
Parameters
Parameter Type Description
host-ip-address Parameter type: <Ip::ExternalAddress> optional parameter
Format: the host ip-address specification
( 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]

3HH-04416-CDAA-TCZZA Edition 03 Released 179


10 System Configuration Commands

10.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 10.4-1 "System Management Vlan Host IP-Address Configuration Command" Resource
Parameters
Resource Identifier Type Description
(vlan) Format: the management vlan
- vlan id
- range: [6]
Table 10.4-2 "System Management Vlan Host IP-Address Configuration Command" Command
Parameters
Parameter Type Description
host-ip-address Parameter type: <Sys::ExternalAddress> mandatory parameter
Format: the host ip-address specification
( 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]

180 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.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 10.5-2 "System Management Default Route Configuration Command" Command Parameters
Parameter Type Description
(default-route) Format: mandatory parameter
- IPv4-address IP-address of the default-route

3HH-04416-CDAA-TCZZA Edition 03 Released 181


10 System Configuration Commands

10.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 10.6-2 "System SNTP Configuration Command" Command Parameters
Parameter Type Description
server-ip-addr Parameter type: <Ip::V4Address> optional parameter
Format: configure the ip address of the
- IPv4-address sntp server
[no] server-port Parameter type: <Sys::portNumber> optional parameter with default
Format: value: 123
- index number configure the port number of the
- range: [0...65535] sntp server
[no] polling-rate Parameter type: <Sys::pollingRate> optional parameter with default
Format: value: 3600
- polling rate in second configure polling rate for the sntp
- unit: seconds agent
- range: [60...864000]
[no] enable Parameter type: boolean optional parameter
sntp application in the NE is
enabled
[no] timezone-offset Parameter type: <Sys::timeZoneOffset> optional parameter with default
Format: value: 0
- specify the offset for timezone from GMT/UTC set the offset of the local
- unit: minutes timezone from GMT/UTC
- range: [-780...780]

182 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.7 SHub System Loop ID Syntax Configuration


Command

Command Description
This command allows the operator to configure the SHub 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".
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 :
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.
Port to specify the port number.
VPI to specify the vpi.
VCI to specify the vci.
Q-VID to specify the vlan identifier.

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 loop-id-syntax [ no atm-based-dsl | atm-based-dsl <PrintableString-0-64> ] [ no efm-based-dsl |


efm-based-dsl <PrintableString-0-64> ]

Command Parameters
Table 10.7-2 "SHub System Loop ID Syntax Configuration Command" Command Parameters
Parameter Type Description
[no] atm-based-dsl Parameter type: <PrintableString-0-64> optional parameter with default
Format: value: "Access_Node_ID atm
- a printable string Rack/Frame/Slot/Port : VPI.VCI"
- length: x<=64 define the syntax of loop Id for
atm based dsl lines
[no] efm-based-dsl Parameter type: <PrintableString-0-64> optional parameter with default
Format: value: "Access_Node_ID eth
- a printable string Rack/Frame/Slot/Port"
- length: x<=64 defines the syntax of loop Id for
efm based dsl lines

3HH-04416-CDAA-TCZZA Edition 03 Released 183


10 System Configuration Commands

10.8 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.
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::NetworkAddressAndIpMaskFull> ] [ no src-ip-addr | src-ip-addr
<Ip::NetworkAddressAndIpMaskFull> ] [ 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 10.8-1 "SHub System ICMP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 10.8-2 "SHub System ICMP Filter Configuration Command" Command Parameters
Parameter Type Description
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet

184 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

Parameter Type Description


- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] msg-type Parameter type: <Sys::MsgType> optional parameter with default
Format: value: "no-icmp-type"
( echo-reply message type to be checked
| dest-unreach against the packet
| 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
[no] msg-code Parameter type: <Sys::MsgCode> optional parameter with default
Format: value: "no-icmp-code"
( network-unreach message code to be checked
| host-unreach against the packet
| protocol-unreach
| port-unreach
| fragment-need
| src-route-fail
| dest-nwk-unknown
| dest-host-unknown
| src-host-isolated
| dest-nwk-prohibit
| dest-host-prohibit
| nwk-unreach-tos

3HH-04416-CDAA-TCZZA Edition 03 Released 185


10 System Configuration Commands

Parameter Type Description


| 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
[no] direction Parameter type: <Sys::Direction> optional parameter with default
Format: value: "in"
( in specifies in which direction the
| out ) filters are applied
Possible values:
- in : incoming packets
- out : outgoing packets
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4092]

Command Output
Table 10.8-3 "SHub System ICMP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusICMP> the status of L3 ICMP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : ICMP filter configuration is ok
- corrupted : ICMP filter configuration is not
operational(not-in-service)
- corrupted : ICMP filter configuration is not
operational(not-ready)

186 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.9 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 10.9-1 "SHub System ICMP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-CDAA-TCZZA Edition 03 Released 187


10 System Configuration Commands

10.10 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 10.10-1 "SHub System ICMP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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

188 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.11 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.
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 10.11-1 "SHub System TCP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 10.11-2 "SHub System TCP Filter Configuration Command" Command Parameters
Parameter Type Description
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default

3HH-04416-CDAA-TCZZA Edition 03 Released 189


10 System Configuration Commands

Parameter Type Description


Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] min-dst-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 0
- number(1...65535) min port in destination port
- range: [0...65535] range(TCP/UDP ports)
[no] max-dst-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 65535
- number(1...65535) maximum port in the destination
- range: [0...65535] port range
[no] min-src-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 0
- number(1...65535) minimum port in the source port
- range: [0...65535] range
[no] max-src-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 65535
- number(1...65535) maximum port in the source port
- range: [0...65535] range
[no] ack Parameter type: <Sys::AckBit> optional parameter with default
Format: value: "any"
( establish tcp ACK bit to be checked
| not-establish against the packet
| any )
Possible values:
- establish : establish the bit
- not-establish : not establish the bit
- any : default value
[no] rst Parameter type: <Sys::RstBit> optional parameter with default
Format: value: "any"
( set tcp RST bit to be checked against
| not-set the packet
| any )
Possible values:
- set : set the bit
- not-set : not set the bit
- any : default value
[no] tos Parameter type: <Sys::Tos> optional parameter with default
Format: value: "any"
( any IP TOS bit to be checked against
| high-reliable the packet
| high-throughput
| high-relia-thro
| low-delay
| low-delay-high-relai

190 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

Parameter Type Description


| low-delay-high-thro
| best-tos
| not-applicable )
Possible values:
- any : normal
- high-reliable : high reliable
- high-throughput : high throughput
- high-relia-thro : high reliable and throughput
- low-delay : low delay
- low-delay-high-relai : low delay and high reliability
- low-delay-high-thro : low delay and high throughput
- best-tos : low delay, high reliability and throughput
- not-applicable : tos is don't care
[no] direction Parameter type: <Sys::Direction> optional parameter with default
Format: value: "in"
( in specifies direction in which filters
| out ) are applied
Possible values:
- in : incoming packets
- out : outgoing packets
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4092]

Command Output
Table 10.11-3 "SHub System TCP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusTCP> the status of L3 TCP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : TCP filter configuration is ok
- corrupted : TCP filter configuration is not
operational(not-in-service)
- corrupted : TCP filter configuration is not
operational(not-ready)

3HH-04416-CDAA-TCZZA Edition 03 Released 191


10 System Configuration Commands

10.12 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 10.12-1 "SHub System TCP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub

192 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.13 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 10.13-1 "SHub System TCP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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

3HH-04416-CDAA-TCZZA Edition 03 Released 193


10 System Configuration Commands

10.14 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.
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 10.14-1 "SHub System UDP Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
Table 10.14-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
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"

194 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

Parameter Type Description


<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] min-dst-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 0
- number(1...65535) min port in the destination port
- range: [0...65535] range(TCP/UDP ports)
[no] max-dst-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 65535
- number(1...65535) maximum port in the destination
- range: [0...65535] port range
[no] min-src-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 0
- number(1...65535) minimum port in the source port
- range: [0...65535] range
[no] max-src-port Parameter type: <Sys::Port> optional parameter with default
Format: value: 65535
- number(1...65535) maximum port in the source port
- range: [0...65535] range
[no] direction Parameter type: <Sys::Direction> optional parameter with default
Format: value: "in"
( in specifies in which direction the
| out ) filters are applied
Possible values:
- in : incoming packets
- out : outgoing packets
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4092]

Command Output
Table 10.14-3 "SHub System UDP Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusUDP> the status of L3 UDP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )

3HH-04416-CDAA-TCZZA Edition 03 Released 195


10 System Configuration Commands

name Type Description


Possible values:
- valid : UDP filter configuration is ok
- corrupted : UDP filter configuration is not
operational(not-in-service)
- corrupted : UDP filter configuration is not
operational(not-ready)

196 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.15 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 10.15-1 "SHub System UDP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the network port
<Shub::NetworkPort>
Field type <Shub::NetworkPort>
- network port on Shub

3HH-04416-CDAA-TCZZA Edition 03 Released 197


10 System Configuration Commands

10.16 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 10.16-1 "SHub System UDP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier Type Description
(index-num) Format: L3 Filter rule number
- Filter rule number
- range: [1...65535]
(port) Format: the port
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink> )
Possible values:
- lt : port of the line board
- network : network port
- nt : port of the nt
- unassigned-link : unassigned external link
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

198 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.17 SHub System Other Protocol Filter


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.
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.

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 10.17-1 "SHub System Other Protocol Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
port Parameter type: <Shub::InNetworkPort> the network port
Format:
( network : <Shub::NetworkPort>
| all )
Possible values:
- network : network port
- all : apply to all ports
Field type <Shub::NetworkPort>
- network port on Shub
Table 10.17-2 "SHub System Other Protocol Filter Configuration Command" Command

3HH-04416-CDAA-TCZZA Edition 03 Released 199


10 System Configuration Commands

Parameters
Parameter Type Description
[no] protocol Parameter type: <Sys::RestrictedProtocol> optional parameter with default
Format: value: "any"
( igmp type of protocol to be checked
| ggp against the packet
| 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
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id

200 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

Parameter Type Description


- range: [0...4092]

Command Output
Table 10.17-3 "SHub System Other Protocol Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusPortList> the status of L3 IP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration is not
operational(not-in-service)
- corrupted : IP filter configuration is not
operational(not-ready)

3HH-04416-CDAA-TCZZA Edition 03 Released 201


10 System Configuration Commands

10.18 SHub System Other Protocol Filter


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.
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.

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 10.18-1 "SHub System Other Protocol Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(filter-rule) Format: L3 filter rule number
- Filter rule number
- range: [1...65535]
port Parameter type: <Shub::OutPort> the network port
Format:
( lt : <Eqpt::RackId> / <Eqpt::ShelfId> / <Shub::SlotId>
| network : <Shub::NetworkPort>
| nt
| unassigned-link : <Shub::NoExtLink>
| all )
Possible values:
- lt : port of the line board
- network : network port

202 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

Resource Identifier Type Description


- nt : port of the nt
- unassigned-link : unassigned external link
- all : apply to all ports
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
Table 10.18-2 "SHub System Other Protocol Filter Configuration Command" Command
Parameters
Parameter Type Description
[no] protocol Parameter type: <Sys::RestrictedProtocol> optional parameter with default
Format: value: "any"
( igmp type of protocol to be checked
| ggp against the packet
| 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
[no] action-drop Parameter type: boolean optional parameter
the packet will be discarded
[no] dst-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default
Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> destination IP address to be
Field type <Ip::V4Address> matched with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] src-ip-addr Parameter type: <Ip::NetworkAddressAndIpMaskFull> optional parameter with default

3HH-04416-CDAA-TCZZA Edition 03 Released 203


10 System Configuration Commands

Parameter Type Description


Format: value: "0.0.0.0/0"
<Ip::V4Address> / <Ip::PrefixLengthFull> source IP address to be matched
Field type <Ip::V4Address> with the packet
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
[no] vlan-id Parameter type: <Vlan::VlanFilterIndex> optional parameter with default
Format: value: "any"
( any vlan to be filtered, zero means
| <Vlan::VlanFilterIndex> ) wildcard for vlan
Possible values:
- any : defaul vlan-id
Field type <Vlan::VlanFilterIndex>
- vlan id
- range: [0...4092]

Command Output
Table 10.18-3 "SHub System Other Protocol Filter Configuration Command" Display parameters
Specific Information
name Type Description
entry-status Parameter type: <Sys::WaitRowStatusPortList> the status of L3 IP filter
( valid This element is only shown in
| corrupted detail mode.
| corrupted )
Possible values:
- valid : IP filter configuration is ok
- corrupted : IP filter configuration is not
operational(not-in-service)
- corrupted : IP filter configuration is not
operational(not-ready)

204 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.19 SHub System VLAN Filter Configuration


Command

Command Description
This command allows the operator to configure the management VLAN filter IP 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:

> configure system shub filter ( no shub-manager (index) ) | ( shub-manager (index) src-ip-addr <Ip::V4Address> )

Command Parameters
Table 10.19-1 "SHub System VLAN Filter Configuration Command" Resource Parameters
Resource Identifier Type Description
(index) Format: index number of the SrcIp
- index(1..100)
- range: [1...100]
Table 10.19-2 "SHub System VLAN Filter Configuration Command" Command Parameters
Parameter Type Description
src-ip-addr Parameter type: <Ip::V4Address> mandatory parameter
Format: MgmtVlan filter IP address to be
- IPv4-address matched with the packet

3HH-04416-CDAA-TCZZA Edition 03 Released 205


10 System Configuration Commands

10.20 SHub System IP Group Configuration


Command

Command Description
This command allows the operator to configure the IP related parameter.
The default IP address is used when manual mode is selected or when the system fails to obtain an IP address
dynamically. The default IP address, subnet mask and default gateway will only take effect when the configuration
is stored and restored.

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 ip [ no ip-cfg-mode | ip-cfg-mode <Sys::DefIpAddr> ]

Command Parameters
Table 10.20-2 "SHub System IP Group Configuration Command" Command Parameters
Parameter Type Description
[no] ip-cfg-mode Parameter type: <Sys::DefIpAddr> optional parameter with default
Format: value: "manual"
( manual specifies how the system get the
| dynamic ) IP address
Possible values:
- manual : ip address got from the system
- dynamic : ip address got through dynamic IP address

206 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.21 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 10.21-2 "SHub System ID Configuration Command" Command Parameters
Parameter Type Description
[no] contact Parameter type: <Sys::IssSysContact> optional parameter with default
Format: value: """"
- textual identification of the contact person textual identification of the
- length: x<=50 contact person
[no] location Parameter type: <Sys::IssSysLocation> optional parameter with default
Format: value: """"
- physical location of this node physical location of this node
- length: x<=50

3HH-04416-CDAA-TCZZA Edition 03 Released 207


10 System Configuration Commands

10.22 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 10.22-2 "SHub System VLAN Group Configuration Command" Command Parameters
Parameter Type Description
ext-vlan-id Parameter type: <Vlan::ExtVlanIndex> optional parameter
Format: External Vlan id
- external vlan id
- range: [2...4093]

208 Released 3HH-04416-CDAA-TCZZA Edition 03


10 System Configuration Commands

10.23 SHub System HTTP Configuration Command

Command Description
This command allows the operator to configure HTTP access to the SHub system.

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 status [ [ no ] http-access ]

Command Parameters
Table 10.23-2 "SHub System HTTP Configuration Command" Command Parameters
Parameter Type Description
[no] http-access Parameter type: boolean optional parameter
enable http access for the users

3HH-04416-CDAA-TCZZA Edition 03 Released 209


10 System Configuration Commands

10.24 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> ]

Command Parameters
Table 10.24-2 "System Clock Configuration Command" Command Parameters
Parameter Type Description
[no] priority-scheme Parameter type: <Sys::SysClkSrcPriorityScheme> optional parameter with default
Format: value: "autoselect"
( autoselect select the clock priority Scheme
| local
| external-local )
Possible values:
- autoselect : select based on location
- local : always select local clock
- external-local : external clock > local clock
[no] ext-source Parameter type: <Sys::SysClkExtSource> optional parameter with default
Format: value: "khz2048"
( e1 select the external clock type E1
| ds1 or DS1 or 2048Khz
| khz2048 )
Possible values:
- e1 : select ETSI Source
- ds1 : select DS1 Source
- khz2048 : select 2048KHz Source

210 Released 3HH-04416-CDAA-TCZZA Edition 03


11- Security Configuration Commands

11.1 Security Configuration Command Tree 11-212


11.2 Security Banner Configuration Commmand 11-216
11.3 Operator Configuration Command 11-217
11.4 Profile Configuration Command 11-219
11.5 Default Profile Configuration Command 11-223
11.6 SNMP View Configuration Command 11-227
11.7 Security SNMP Community Configuration Command 11-229
11.8 Security SNMPv3 Group Configuration Command 11-231
11.9 Security SNMPv3 User Configuration Command 11-233
11.10 Security SNMPv3 User-Group Configuration 11-235
Command
11.11 SNMP Notify View Configuration Command 11-237
11.12 Security SNMP Notification Profile Configuration 11-239
Command
11.13 Security SNMP Notification Profile Filter 11-241
Configuration Command
11.14 Security SNMP Element Manager Configuration 11-243
Command
11.15 SHub Security SNMP Community Configuration 11-245
Command
11.16 Security IP Address Pool Configuration Command 11-247
11.17 Security IP Address Pool Reserve Configuration 11-249
Command
11.18 Security RADIUS Client Configuration Command 11-250
11.19 Security RADIUS Authentication Server 11-251
Configuration Command
11.20 Security RADIUS Accounting Server Configuration 11-253
Command
11.21 Security RADIUS Dynamic Authorization Client 11-255
Configuration Command
11.22 Security RADIUS Policy Configuration Command 11-256
11.23 Security RADIUS Server Configuration Command 11-258
11.24 Security Domain Configuration Command 11-260
11.25 Security Domain IP Pool Configuration Command 11-262
11.26 Security Domain User Configuration Command 11-263
11.27 Security Connection Profile Configuration Command 11-264
11.28 Security Connection Policy Configuration Command 11-265
11.29 Security 802.1x PAE System Configuration 11-266
Command
11.30 Security 802.1x Port Authentication Configuration 11-267
Command
11.31 Security 802.1x Extension, Port Authentication 11-269
Configuration Command
11.32 Security 802.1x Port Configuration Command 11-271
11.33 Security Password Policy Configuration Commmand 11-272
11.34 File Transfer Configure Command 11-274
11.35 file Transfer server Configure Commands 11-275

3HH-04416-CDAA-TCZZA Edition 03 Released 211


11 Security Configuration Commands

11.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] security
----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

212 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

- [no] ip
- [no] pppoe
- [no] qos
- [no] software-mngt
- [no] transport
- [no] vlan
- [no] xdsl
- [no] security
----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
- [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
----shub
----[no] community
- (index)
- name
- [no] privilege
- [no] ip-addr
----[no] ip-addr-pool

3HH-04416-CDAA-TCZZA Edition 03 Released 213


11 Security Configuration Commands

- (name)
- vrf-index
- start-addr
- [no] size
- [no] admin-down
----[no] reserve-address
- (ip-address)
----radius
- [no] relay
- [no] auth-super-user
- [no] operator-policy
----[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
- [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

214 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

- [no] second-nbns
- [no] sess-timeout
- [no] qos-policy
- authenticator
- [no] admin-down
----[no] ip-pool
- (name)
- vrf-index
- priority
----[no] user
- (name)
- password
----[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
----ext-authenticator
- (port)
- [no] authentication
- [no] init-authreq-off
- [no] handshake
- [no] handshake-period
----port
- (port)
- [no] initialize
----password
- min-length
- min-num-numeric-char
- min-num-special-char
- [no] mixed-case
----filetransfer
- [no] protocol
----[no] server
- (serverid)
- user-name
- password

3HH-04416-CDAA-TCZZA Edition 03 Released 215


11 Security Configuration Commands

11.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 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 11.2-2 "Security Banner Configuration Commmand" Command Parameters
Parameter Type Description
[no] login-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
- a banner to be shown to the operator banner to be shown before the
- length: x<=480 operator enters its name
[no] welcome-banner Parameter type: <Sec::Banner> optional parameter with default
Format: value: ""
- a banner to be shown to the operator the banner to be shown when the
- length: x<=480 operator logged in

216 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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-CDAA-TCZZA Edition 03 Released 217


11 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 11.3-1 "Operator Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the operator
- the name of an operator
- range: [a-z0-9]
- length: 1<=x<=11
Table 11.3-2 "Operator Configuration Command" Command Parameters
Parameter Type Description
profile Parameter type: <Sec::ProfileName> mandatory parameter
Format: The parameter is not visible
- the name of an operator profile during modification.
- range: [a-z0-9] the name of an operator profile
- length: 1<=x<=11
password Parameter type: <Sec::Password> mandatory parameter
Format: the password needed to log in
( 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
- length: 6<=x<=20
Field type <Sec::EncryptedPassword>
- the encrypted password
- length: 20
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: ""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] description Parameter type: <Sec::OperatorDesc> optional parameter with default
Format: value: ""
- any description to be used by the operator any description to be used by the
- length: x<=31 operator
[no] more Parameter type: boolean optional parameter
the output is passed via the more
filter

218 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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 security | security <Sec::Security> ] )

Command Parameters

3HH-04416-CDAA-TCZZA Edition 03 Released 219


11 Security Configuration Commands

Table 11.4-1 "Profile Configuration Command" Resource Parameters


Resource Identifier Type Description
(name) Format: the name of the profile
- the name of an operator profile
- range: [a-z0-9]
- length: 1<=x<=11
Table 11.4-2 "Profile Configuration Command" Command Parameters
Parameter Type Description
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: "\"%s : %n%d%c \""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] password-timeout Parameter type: <Sec::PasswordTimeout> optional parameter with default
Format: value: 0
- the maximum time a password may be unchanged the maximum time a password
- unit: days may be unchanged
- range: [0...365]
[no] terminal-timeout Parameter type: <Sec::InactivityTimeout> optional parameter with default
Format: value: 30
- specify the inactivity timeout of the terminal specify the inactivity timeout of
- unit: minutes the terminal
- range: [0...120]
[no] slot-numbering Parameter type: <Sec::SlotDesc> optional parameter with default
Format: value: "legacy-based"
( type-based slot numbering scheme to be used
| position-based by the operator
| 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)
[no] description Parameter type: <Sec::ProfileDesc> optional parameter with default
Format: value: ""
- any description to be used by the operator any description to be used by the
- length: x<=31 operator
[no] aaa Parameter type: <Sec::Aaa> optional parameter with default
Format: value: "none"
( write the access rights to AAA related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] atm Parameter type: <Sec::Atm> optional parameter with default
Format: value: "none"
( write the access rights to ATM related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] alarm Parameter type: <Sec::Alarm> optional parameter with default
Format: value: "none"

220 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

Parameter Type Description


( write the access rights to alarm related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] dhcp Parameter type: <Sec::Dhcp> optional parameter with default
Format: value: "none"
( write the access rights to DHCP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] equipment Parameter type: <Sec::Equipment> optional parameter with default
Format: value: "none"
( write the access rights to equipment
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] igmp Parameter type: <Sec::Igmp> optional parameter with default
Format: value: "none"
( write the access rights to IGMP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] ip Parameter type: <Sec::Ip> optional parameter with default
Format: value: "none"
( write the access rights to IP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] pppoe Parameter type: <Sec::Pppoe> optional parameter with default
Format: value: "none"
( write the access rights to PPPOE
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] qos Parameter type: <Sec::Qos> optional parameter with default
Format: value: "none"
( write the access rights to qos related
| read commands
| none )

3HH-04416-CDAA-TCZZA Edition 03 Released 221


11 Security Configuration Commands

Parameter Type Description


Possible values:
- write : write and read access
- read : read access
- none : no access
[no] software-mngt Parameter type: <Sec::Sw> optional parameter with default
Format: value: "none"
( write access rights to software
| read management related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] transport Parameter type: <Sec::Transport> optional parameter with default
Format: value: "none"
( write the access rights to transport
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] vlan Parameter type: <Sec::Vlan> optional parameter with default
Format: value: "none"
( write the access rights to VLAN related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] xdsl Parameter type: <Sec::Xdsl> optional parameter with default
Format: value: "none"
( write the access rights to xDSL related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] security Parameter type: <Sec::Security> optional parameter with default
Format: value: "none"
( write the access rights to security
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

222 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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 security | security
<Sec::Security> ]

Command Parameters
Table 11.5-2 "Default Profile Configuration Command" Command Parameters
Parameter Type Description
[no] prompt Parameter type: <Sec::Prompt> optional parameter with default
Format: value: "\"%s : %n%d%c \""
- a specification of the prompt the specification of the prompt
- length: x<=28
[no] password-timeout Parameter type: <Sec::PasswordTimeout> optional parameter with default
Format: value: 0
- the maximum time a password may be unchanged the maximum time a password
- unit: days may be unchanged
- range: [0...365]
[no] terminal-timeout Parameter type: <Sec::InactivityTimeout> optional parameter with default
Format: value: 0
- specify the inactivity timeout of the terminal the maximum time a terminal
- unit: minutes may be inactive
- range: [0...120]
[no] slot-numbering Parameter type: <Sec::SlotDesc> optional parameter with default
Format: value: "legacy-based"

3HH-04416-CDAA-TCZZA Edition 03 Released 223


11 Security Configuration Commands

Parameter Type Description


( type-based slot description to be used by the
| position-based operator
| 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)
[no] description Parameter type: <Sec::ProfileDesc> optional parameter with default
Format: value: ""
- any description to be used by the operator any description to be used by the
- length: x<=31 operator
[no] aaa Parameter type: <Sec::Aaa> optional parameter with default
Format: value: "read"
( write the access rights to AAA related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] atm Parameter type: <Sec::Atm> optional parameter with default
Format: value: "write"
( write the access rights to ATM related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] alarm Parameter type: <Sec::Alarm> optional parameter with default
Format: value: "write"
( write the access rights to alarm related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] dhcp Parameter type: <Sec::Dhcp> optional parameter with default
Format: value: "write"
( write the access rights to DHCP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] equipment Parameter type: <Sec::Equipment> optional parameter with default
Format: value: "write"
( write the access rights to equipment
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

224 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

Parameter Type Description


[no] igmp Parameter type: <Sec::Igmp> optional parameter with default
Format: value: "write"
( write the access rights to IGMP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] ip Parameter type: <Sec::Ip> optional parameter with default
Format: value: "write"
( write the access rights to IP related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] pppoe Parameter type: <Sec::Pppoe> optional parameter with default
Format: value: "write"
( write the access rights to PPOE related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] qos Parameter type: <Sec::Qos> optional parameter with default
Format: value: "write"
( write the access rights to qos related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] software-mngt Parameter type: <Sec::Sw> optional parameter with default
Format: value: "write"
( write access rights to software
| read management related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] transport Parameter type: <Sec::Transport> optional parameter with default
Format: value: "write"
( write the access rights to transport
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] vlan Parameter type: <Sec::Vlan> optional parameter with default
Format: value: "write"
( write the access rights to VLAN related

3HH-04416-CDAA-TCZZA Edition 03 Released 225


11 Security Configuration Commands

Parameter Type Description


| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] xdsl Parameter type: <Sec::Xdsl> optional parameter with default
Format: value: "write"
( write the access rights to xDSL related
| read commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access
[no] security Parameter type: <Sec::Security> optional parameter with default
Format: value: "none"
( write the access rights to security
| read related commands
| none )
Possible values:
- write : write and read access
- read : read access
- none : no access

226 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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 11.6-1 "SNMP View Configuration Command" Resource Parameters
Resource Identifier Type Description
(notify-view) Format: the name of the view
- the name of a view
- length: x<=32
subtree Parameter type: <Snmp::ViewSubtree> the subtree
Format:

3HH-04416-CDAA-TCZZA Edition 03 Released 227


11 Security Configuration Commands

Resource Identifier Type Description


<Snmp::ViewSubtree>
Field type <Snmp::ViewSubtree>
- specification of view subtree. Eg(vacmAccessTable.*.7)
Table 11.6-2 "SNMP View Configuration Command" Command Parameters
Parameter Type Description
type Parameter type: <Snmp::FilterType> mandatory parameter
Format: the filter type
( include
| exclude )
Possible values:
- include : include the matching varbinds
- exclude : exclude the matching varbinds

Command Output
Table 11.6-3 "SNMP View Configuration Command" Display parameters
Specific Information
name Type Description
entry-status 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)

228 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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 11.7-1 "Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: the name of the community
- the community name
- length: x<=32
host-address Parameter type: <Ip::AddressAndIpMaskFull> the host IP address from where
Format: access is allowed
<Ip::V4Address> / <Ip::PrefixLengthFull>
Field type <Ip::V4Address>
- IPv4-address
Field type <Ip::PrefixLengthFull>
- IP address prefix length
- range: [0...32]
Table 11.7-2 "Security SNMP Community Configuration Command" Command Parameters
Parameter Type Description
[no] context Parameter type: <Transport::Context> optional parameter with default
Format: value: "nt"
( nt the context allowed for this

3HH-04416-CDAA-TCZZA Edition 03 Released 229


11 Security Configuration Commands

Parameter Type Description


| shub community
| epon )
Possible values:
- nt : nt context
- shub : shub context
- epon : epon context
[no] privilege Parameter type: <Snmp::CommunityPrivilege> optional parameter with default
Format: value: "read-write"
( read-only the access privileges we have
| read-write when we use this community
| write-only )
Possible values:
- read-only : only read privileges
- read-write : read and write privileges
- write-only : only write privileges
[no] read-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view to be used
- length: x<=32 for read accesses
[no] write-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view to be used
- length: x<=32 for write accesses
[no] notify-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view to filter
- length: x<=32 notifications

230 Released 3HH-04416-CDAA-TCZZA Edition 03


11 Security Configuration Commands

11.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::ViewName> ] [ no write-view | write-view <Snmp::ViewName> ] [ no notify-view |
notify-view <Snmp::ViewName> ] )

Command Parameters
Table 11.8-1 "Security SNMPv3 Group Configuration Command" Resource Parameters
Resource Identifier Type Description
(name) Format: name of snmpV3 group
- name of the snmpv3 group
- length: 1<=x<=32
security-level Parameter type: <Snmp::SecurityLevel> security level for the group
Format:
( none
| authentication
| privacy-and-auth )
Possible values:
- none : no authentication and no privacy
- authentication : authentication without privacy
- privacy-and-auth : authentication and privacy
context Parameter type: <Snmp::Context> context for the group
Format:
( single : nt
| single : shub
| single : epon
| all )

3HH-04416-CDAA-TCZZA Edition 03 Released 231


11 Security Configuration Commands

Resource Identifier Type Description


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
- : any context
Table 11.8-2 "Security SNMPv3 Group Configuration Command" Command Parameters
Parameter Type Description
[no] read-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view to be used
- length: x<=32 for read accesses
[no] write-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view used for
- length: x<=32 write accesses
[no] notify-view Parameter type: <Snmp::ViewName> optional parameter with default
Format: value: "everything"
- the name of a view the name of the view to filter
- length: x<=32 notifications

Command Output
Table 11.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
( 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)

232 Released