APC IP DSLAM User guide

User Guide
ADSL2+/G.SHDSL.bis
IP DSLAM
TABLE OF CONTENTS
1
About This Manual ............................................................................................... 1
2
What’s the difference between ATM based DSLAM and IP based DSLAM? ... 3
3
Introduction .......................................................................................................... 6
3.1
General .......................................................................................................................................... 6
3.2
ADSL2/2+ IP DSLAM Overview.................................................................................................... 7
3.3
ADSL2/2+ IP DSLAM Application .............................................................................................. 10
3.4
ADSL2/2+ IP DSLAM Features................................................................................................... 11
3.4.1
Cost Saving Solution for SMB ............................................................................................... 11
3.4.2
Excellent Management with Security .................................................................................... 11
3.4.3
Advanced Function for Broadband Service Offering............................................................. 11
3.5
4
ADSL2/2+ IP DSLAM Specifications ......................................................................................... 12
Getting Started.................................................................................................... 14
4.1
General ........................................................................................................................................ 14
4.2
Unpacking your ADSL2/2+ IP DSLAM ...................................................................................... 15
4.3
Hardware Installation ................................................................................................................. 16
4.3.1
Safety Instruction................................................................................................................... 16
4.3.2
ADSL2/2+ IP DSLAM Rear Panel Connection...................................................................... 17
4.3.3
ADSL2/2+ IP DSLAM Front Panel Connection ..................................................................... 18
4.4
Ways of Management Connection ............................................................................................ 19
4.4.1
EMS(Element Management System) .................................................................................... 19
4.4.2
Command Line Interface (CLI) .............................................................................................. 20
4.4.3
Telnet Client .......................................................................................................................... 20
5
EMS Configuration ............................................................................................. 21
5.1
EMS Functions............................................................................................................................ 21
5.1.1
Installation ............................................................................................................................. 22
5.1.2
Installing EMS........................................................................................................................ 23
5.1.3
Un-installation of EMS ........................................................................................................... 27
5.1.4
Starting the System ............................................................................................................... 29
5.1.5
Logging into the System........................................................................................................ 30
5.1.6
Terminating the System......................................................................................................... 31
5.1.7
Logging out the Current Session........................................................................................... 31
5.2
Windows Arrangement............................................................................................................... 32
5.2.1
Cascade ................................................................................................................................ 32
5.2.2
Next Window ......................................................................................................................... 32
5.2.3
Previous Window................................................................................................................... 32
5.2.4
Arrange Icons ........................................................................................................................ 33
5.3
Help .............................................................................................................................................. 33
5.4
Tools Menu Introduction............................................................................................................ 34
5.4.1
Environmental Options .......................................................................................................... 34
1
5.4.2
5.4.3
5.4.4
5.4.5
5.4.6
5.4.7
6
SNMP Configuration.............................................................................................................. 34
Territory manager configuration ............................................................................................ 37
Agent Manager Configuration ............................................................................................... 40
Telnet..................................................................................................................................... 45
Ping........................................................................................................................................ 46
User Manager window........................................................................................................... 47
Manage the ADSL2/2+ IP DSLAM...................................................................... 51
6.1
Activate Function Management Windows................................................................................ 51
6.1.1
Function management Windows ........................................................................................... 52
6.2
Default Setting ............................................................................................................................ 53
6.3
System Information .................................................................................................................... 54
6.4
Current Event .............................................................................................................................. 56
6.5
System ......................................................................................................................................... 59
6.5.1
Commit and Reboot............................................................................................................... 59
6.6
Configuration .............................................................................................................................. 59
6.6.1
VLAN Configuration............................................................................................................... 59
6.6.2
Ethernet Configuration........................................................................................................... 60
6.6.3
Static Multicast Configuration................................................................................................ 62
6.6.4
IGMP Snooping ..................................................................................................................... 63
6.6.5
SNTP Configuration............................................................................................................... 64
6.7
DSL............................................................................................................................................... 65
6.7.1
Profile Configuration .............................................................................................................. 65
6.7.2
Port Configuration.................................................................................................................. 68
6.8
DSL Performance Management ................................................................................................ 70
6.8.1
Physical Layer Info ................................................................................................................ 70
6.8.2
Channel Layer Info ................................................................................................................ 71
6.8.3
Physical Layer PM................................................................................................................. 72
6.8.4
Channel Layer PM................................................................................................................. 74
7
Application Note ................................................................................................. 77
7.1
Basic Configuration.................................................................................................................... 77
7.1.1
Create a new user ................................................................................................................. 77
7.1.2
FD.cfg Configuration.............................................................................................................. 77
7.1.3
How to create myconfig.cfg ................................................................................................... 82
7.1.4
Line Rate Configuration......................................................................................................... 85
7.1.5
Set System Time ................................................................................................................... 90
7.1.6
VLAN Configuration............................................................................................................... 92
7.1.7
Modify the Downstream/ Upstream Rate .............................................................................. 98
7.1.8
Enable SNMP function ........................................................................................................ 105
7.2
Advanced Configuration .......................................................................................................... 106
7.2.1
How to get QoS of uplink port ............................................................................................. 106
7.2.2
How to modify IRL /ORL...................................................................................................... 111
7.2.3
How to Stack 2 units............................................................................................................ 112
7.2.4
How to debug ADSL line ..................................................................................................... 114
7.2.5
LACP aggregation (Port Aggregation)................................................................................. 117
7.2.6
Multicast .............................................................................................................................. 121
7.2.7
IP Filter ................................................................................................................................ 122
7.2.8
DHCP filter........................................................................................................................... 124
7.2.9
FTP filter .............................................................................................................................. 126
7.2.10 HTTP filter ........................................................................................................................... 128
7.2.11 ACL Configuration ............................................................................................................... 130
7.2.12 TOS Priority Rearrangement............................................................................................... 132
2
7.2.13
8
IGMP Snooping ................................................................................................................... 134
System Administration with CLI...................................................................... 135
8.1
About CLI Administration ........................................................................................................ 135
8.1.1
Notation Conventions .......................................................................................................... 135
8.1.2
Command Structure ............................................................................................................ 135
8.1.3
Glossary of Terms and Acronyms ....................................................................................... 136
8.1.4
CLI Command Brief Description.......................................................................................... 138
8.1.5
Categories of the CLI commands........................................................................................ 138
8.2
802.1p Commands .................................................................................................................... 145
8.2.1
Bridge port accessprio Commands ..................................................................................... 145
8.2.2
Bridge port prioinfo Commands........................................................................................... 145
8.2.3
Bridge port trfclassmap Commands .................................................................................... 146
8.2.4
Bridge port priomap commands .......................................................................................... 147
8.3
ABOND Commands .................................................................................................................. 149
8.3.1
ABOND group intf Commands ............................................................................................ 149
8.3.2
ABOND group stats Commands ......................................................................................... 152
8.3.3
Abond link entry Commands ............................................................................................... 153
8.3.4
Abond link stats Commands................................................................................................ 155
8.4
Aggregation Commands .......................................................................................................... 157
8.4.1
Active Standby aggr info Commands .................................................................................. 157
8.4.2
Aggr intf Commands............................................................................................................ 158
8.4.3
LACP Aggr Commands ....................................................................................................... 160
8.4.4
LACP AGGRPort Info Commands ...................................................................................... 163
8.4.5
LACP AGGRPort List Command......................................................................................... 165
8.4.6
LACP AGGRPort Stats Commands .................................................................................... 166
8.4.7
Redundancy aggr info Commands...................................................................................... 167
8.4.8
Redundancy aggrport list Commands ................................................................................. 169
8.4.9
Redundancy aggr stats Commands .................................................................................... 170
8.5
ATM Commands ....................................................................................................................... 171
8.5.1
AAL5 VC Statistics Commands........................................................................................... 171
8.5.2
ATM OAM CC Commands .................................................................................................. 171
8.5.3
ATM OAM Loopback Commands........................................................................................ 173
8.5.4
ATM Port Commands .......................................................................................................... 173
8.5.5
ATM VC Commands............................................................................................................ 177
8.5.6
ATM VC Statistics Commands ............................................................................................ 183
8.6
Bridging Commands ................................................................................................................ 185
8.6.1
Bridge forwarding Commands............................................................................................. 185
8.6.2
Bridge Mode Commands..................................................................................................... 186
8.6.3
Bridge Port Cap Commands ............................................................................................... 187
8.6.4
Bridge port forwarding Commands...................................................................................... 187
8.6.5
Bridge Port Map Commands ............................................................................................... 189
8.6.6
Bridge Port Stats Table Commands.................................................................................... 190
8.6.7
Bridge Port Table Commands ............................................................................................. 191
8.6.8
Bridge static mcast Commands........................................................................................... 196
8.6.9
Bridge static ucast Commands............................................................................................ 198
8.6.10 Bridge tbg traps Commands................................................................................................ 199
8.6.11 GARP Port Info Commands ................................................................................................ 201
8.6.12 STP Group Commands ....................................................................................................... 202
8.6.13 STP Port Commands........................................................................................................... 204
8.6.14 Transparent Bridging Table Commands ............................................................................. 206
8.7
Bridge Multicast Commands ................................................................................................... 211
8.7.1
Bridge mcast forwarding Commands .................................................................................. 211
8.7.2
Bridge mcast forwarding Commands .................................................................................. 212
8.7.3
Bridge mcast fwdunreg Commands .................................................................................... 213
8.7.4
Bridge Static Multicast Commands ..................................................................................... 215
3
8.8
DHCP Commands ..................................................................................................................... 218
8.8.1
DHCP Client Commands..................................................................................................... 218
8.9
DSL Commands ........................................................................................................................ 220
8.9.1
ADSL Alarm Profile Commands .......................................................................................... 220
8.9.2
ADSL Alarm Profilext Commands ....................................................................................... 224
8.9.3
ADSL ATUC Channel Commands ...................................................................................... 229
8.9.4
ADSL ATUC Chanperf Commands ..................................................................................... 230
8.9.5
ADSL ATUC ChanIntvl Commands..................................................................................... 233
8.9.6
ADSL ATUC Interval Commands ........................................................................................ 234
8.9.7
ADSL ATUC Perf Commands ............................................................................................. 235
8.9.8
ADSL ATUC Physical Commands ...................................................................................... 237
8.9.9
ADSL ATUC Trap Commands ............................................................................................ 242
8.9.10 ADSL ATUC Trapsext Commands...................................................................................... 243
8.9.11 ADSL ATUR ChanIntrvl Commands ................................................................................... 244
8.9.12 ADSL ATUR Channel Commands ...................................................................................... 244
8.9.13 ADSL ATUR Chanperf Commands ..................................................................................... 246
8.9.14 ADSL ATUR Interval Commands ........................................................................................ 248
8.9.15 Adsl atur intervalext Commands ......................................................................................... 249
8.9.16 ADSL ATUR Perf Commands ............................................................................................. 250
8.9.17 Adsl atur perfext Commands............................................................................................... 251
8.9.18 ADSL ATUR Physical Commands ...................................................................................... 252
8.9.19 ADSL ATUR Traps Commands........................................................................................... 255
8.9.20 DSL ATUR Trapsext Commands ........................................................................................ 256
8.9.21 ADSL Cap Commands ........................................................................................................ 257
8.9.22 ADSL Line Intf Commands.................................................................................................. 257
8.9.23 ADSL Line Profile Commands............................................................................................. 261
8.9.24 Dsl chip Commands ............................................................................................................ 280
8.9.25 Dsl dsp chip Commands ..................................................................................................... 282
8.9.26 Dsl dsp port Commands ...................................................................................................... 283
8.9.27 Dsl system Commands........................................................................................................ 284
8.9.28 Shdsl cap Commands ......................................................................................................... 286
8.9.29 Shdsl endpoint alarmprofile Commands ............................................................................. 286
8.9.30 Shdsl endpoint currentry Commands .................................................................................. 288
8.9.31 Shdsl endpoint maint Commands ....................................................................................... 290
8.9.32 Modify shdsl endpoint maint................................................................................................ 290
8.9.33 Shdsl interval 15min Commands......................................................................................... 292
8.9.34 Shdsl interval 1day Commands........................................................................................... 293
8.9.35 Shdsl line intf Commands.................................................................................................... 295
8.9.36 Shdsl line status Commands............................................................................................... 305
8.9.37 Shdsl span conf Commands ............................................................................................... 310
8.9.38 Shdsl span confprofile Commands...................................................................................... 311
8.9.39 Shdsl span status Commands............................................................................................. 314
8.9.40 Shdsl unit inventory Commands.......................................................................................... 315
8.9.41 Shdsl unit maintinfo Commands.......................................................................................... 317
8.10
EHDLC Commands ............................................................................................................... 319
8.10.1 Ehdlc intf Commands .......................................................................................................... 319
8.11
Ethernet Commands ............................................................................................................. 321
8.11.1 Dot3 stats Commands ......................................................................................................... 321
8.11.2 Ethernet Commands............................................................................................................ 324
8.12
EOA Commands.................................................................................................................... 333
8.12.1 EOA Commands.................................................................................................................. 333
8.13
Filtering Commands ............................................................................................................. 336
8.13.1 ACL Global Macentry Commands....................................................................................... 336
8.13.2 Clfr list genentry commands................................................................................................ 337
8.13.3 ACL Port Macentry Commands........................................................................................... 338
8.13.4 Clfr namedlist genentry Commands .................................................................................... 339
8.13.5 Clfr namedlist info Commands ............................................................................................ 340
8.13.6 Clfr namedlist map Commands ........................................................................................... 341
8.13.7 Clfr profile branch Commands............................................................................................. 342
4
8.13.8 Clfr profile info Commands.................................................................................................. 344
8.13.9 Clfr profile node Commands................................................................................................ 345
8.13.10
Clfr tree branch Commands............................................................................................. 352
8.13.11
Clfr tree info Commands.................................................................................................. 353
8.13.12
Clfr tree map Commands................................................................................................. 355
8.13.13
Clfr tree node Commands................................................................................................ 356
8.13.14
Clfr tree profile Commands.............................................................................................. 360
8.13.15
Filter expr entry Commands ............................................................................................ 362
8.13.16
Filter list genentry Commands ......................................................................................... 363
8.13.17
Filter namedlist genentry Commands .............................................................................. 364
8.13.18
Filter namedlist info Commands ...................................................................................... 366
8.13.19
Filter namedlist map Commands ..................................................................................... 367
8.13.20
Create filter namedlist map.............................................................................................. 367
8.13.21
Filter rule actionmap Commands..................................................................................... 368
8.13.22
Filter rule entry Commands ............................................................................................. 371
8.13.23
Filter rule map Commands .............................................................................................. 376
8.13.24
Filter rule stats Commands.............................................................................................. 377
8.13.25
Filter seq entry Commands.............................................................................................. 378
8.13.26
Filter seq info Commands................................................................................................ 379
8.13.27
Filter subrule arp Commands .......................................................................................... 380
8.13.28
Filter subrule clfrtree Commands..................................................................................... 386
8.13.29
Filter subrule ether Commands ....................................................................................... 387
8.13.30
Filter subrule generic Commands.................................................................................... 395
8.13.31
Filter subrule ICMP Commands....................................................................................... 398
8.13.32
Filter subrule IGMP Commands ...................................................................................... 401
8.13.33
Filter subrule IP Commands ............................................................................................ 404
8.13.34
Filter subrule PPP Commands ........................................................................................ 409
8.13.35
Filter subrule TCP Commands ........................................................................................ 411
8.13.36
Filter subrule UDP Commands ........................................................................................ 413
8.14
IGMP Commands .................................................................................................................. 417
8.14.1 Igmpsnoop cfg info Commands........................................................................................... 417
8.14.2 Igmpsnoop mvlan config Commands .................................................................................. 420
8.14.3 Igmpsnoop port info Commands ......................................................................................... 423
8.14.4 Igmpsnoop port stats Commands ....................................................................................... 426
8.14.5 Igmpsnoop querier info Commands .................................................................................... 427
8.15
Interface Commands............................................................................................................. 430
8.15.1 Interface Commands ........................................................................................................... 430
8.16
IP Commands ........................................................................................................................ 433
8.16.1 IP Net to Media Table Commands ...................................................................................... 433
8.16.2 IP Route Commands ........................................................................................................... 435
8.16.3 Ipoa intf Commands ............................................................................................................ 437
8.16.4 ipoe intf Commands............................................................................................................. 439
8.16.5 Rid static Commands .......................................................................................................... 441
8.17
MacProfile Commands ......................................................................................................... 443
8.17.1 Macprofile global Commands.............................................................................................. 443
8.17.2 Resvdmac profile info Commands ...................................................................................... 443
8.17.3 Resvdmac profile param Commands .................................................................................. 444
8.18
Management Traffic Commands ......................................................................................... 446
8.18.1 Ctlpkt group info Commands............................................................................................... 446
8.18.2 Ctlpkt instance info Commands........................................................................................... 447
8.18.3 Ctlpkt profile info Commands .............................................................................................. 448
8.19
PPPoE Tunneling Commands ............................................................................................. 450
8.19.1 PPPoE Global ACprofile Commands .................................................................................. 450
8.19.2 PPPoE Global Config Commands....................................................................................... 451
8.19.3 PPPoE Global Serviceprofile Commands ........................................................................... 452
8.19.4 PPPoE Global Stats Commands......................................................................................... 453
8.19.5 Pppoe intf Commands ......................................................................................................... 454
8.19.6 PPPoE Session Stats Commands ...................................................................................... 456
5
8.19.7
PPPR Interface Commands ................................................................................................ 458
8.20
IA (Intermeida Agent) Commands ....................................................................................... 461
8.20.1 Dra global stats Commands ................................................................................................ 461
8.20.2 Dra instance entry Commands............................................................................................ 461
8.20.3 Dra stats entry Commands.................................................................................................. 466
8.20.4 Dra global config Commands .............................................................................................. 467
8.20.5 Ia profile entry Commands .................................................................................................. 468
8.20.6 Pia instance entry Commands ............................................................................................ 470
8.20.7 Pia stats entry Commands .................................................................................................. 475
8.20.8 Pia global config Commands............................................................................................... 476
8.21
QoS Commands .................................................................................................................... 477
8.21.1 IRL Map Commands............................................................................................................ 477
8.21.2 IRL Profile Commands ........................................................................................................ 477
8.21.3 IRL Stats Commands .......................................................................................................... 480
8.21.4 Bridge rlinstance map Commands ...................................................................................... 480
8.21.5 Rl actionprofile info Commands .......................................................................................... 482
8.21.6 Rl instance info Commands ................................................................................................ 485
8.21.7 Rl profile info Commands .................................................................................................... 486
8.21.8 Scheduling profile class Commands ................................................................................... 488
8.21.9 Scheduling profile info Commands...................................................................................... 490
8.21.10
Trfclass profile class Commands..................................................................................... 492
8.21.11
Trfclass profile info Commands ....................................................................................... 493
8.21.12
Trfclass stats Commands ................................................................................................ 494
8.22
RMON Commands................................................................................................................. 495
8.22.1 RMON Statistics Group Commands.................................................................................... 495
8.22.2 RMON Task Info Commands .............................................................................................. 496
8.22.3 RMON Memory Pool info Commands ................................................................................. 497
8.22.4 RMON Queue info Commands ........................................................................................... 502
8.22.5 RMON Net buffers info Commands..................................................................................... 505
8.22.6 RMON Semaphore info Commands.................................................................................... 507
8.22.7 RMON Event Group info Commands .................................................................................. 507
8.23
SNMP Commands ................................................................................................................. 509
8.23.1 SNMP Comm Commands ................................................................................................... 509
8.23.2 SNMP Host Commands ...................................................................................................... 510
8.23.3 SNMP Stats Commands ..................................................................................................... 511
8.23.4 SNMP Traphost Commands ............................................................................................... 513
8.24
SNTP Commands .................................................................................................................. 515
8.24.1 SNTP Cfg Commands ......................................................................................................... 515
8.24.2 SNTP servaddr Commands ................................................................................................ 515
8.24.3 SNTP Stats Commands ...................................................................................................... 516
8.25
System Commands............................................................................................................... 517
8.25.1 Cbuftrace cfg Commands.................................................................................................... 517
8.25.2 System Configuration Save and Restore Commands......................................................... 517
8.25.3 System Control Table Commands ...................................................................................... 519
8.25.4 System crash info commands ............................................................................................. 520
8.25.5 System Info Commands ...................................................................................................... 527
8.25.6 System manuf info Commands ........................................................................................... 530
8.25.7 System reboot info command.............................................................................................. 532
8.25.8 Nbize Commands ................................................................................................................ 533
8.25.9 System Stats Commands.................................................................................................... 540
8.25.10
System Traps Commands ............................................................................................... 541
8.25.11
System Trap Log Table Commands ................................................................................ 541
8.25.12
System version commands.............................................................................................. 549
8.25.13
Trace Log Configuration Commands............................................................................... 549
8.25.14
Trace Log Statistics Commands...................................................................................... 551
8.26
VC Aggregation Commands ................................................................................................ 552
8.26.1 Atm vcaggr intf Commands ................................................................................................. 552
6
8.26.2
Atm vcaggr map Commands............................................................................................... 553
8.27
VLAN Commands.................................................................................................................. 556
8.27.1 GVRP Info Commands ........................................................................................................ 556
8.27.2 GVRP Port Info Commands ................................................................................................ 556
8.27.3 GVRP Port Stats Commands .............................................................................................. 560
8.27.4 Vlan curr info Commands.................................................................................................... 561
8.27.5 VLAN mapprofile info Commands ....................................................................................... 562
8.27.6 Vlan mapprofile param Commands..................................................................................... 563
8.27.7 VLAN Static Commands...................................................................................................... 564
8.28
Miscelleneous Commands................................................................................................... 573
8.28.1 File Commands ................................................................................................................... 573
8.28.2 Other Commands ................................................................................................................ 583
9
10
FD.cfg in detail.................................................................................................. 588
Supported mibs ............................................................................................. 594
10.1
PropMib(Conexant):.............................................................................................................. 594
10.2
StdMib(Standard)::................................................................................................................ 594
7
1
About This Manual
Audience
This book is intended for anyone who installs, manages, and configures the
ADSL2/2+ IP DSLAM via CID/RS-232 or Telnet/Ethernet CLI command
interface. The ADSL2/2+ IP DSLAM is a standalone IP-based DSLAM which
can concentrate and manage 48 or 24 ADSL ports, according to different
model.
You must have a basic understanding of ADSL2/2+ and Layer 2
concentrator related technologies, be knowledgeable about data
communications, and familiar with VT-100 terminal emulation tools.
Purpose
This book describes how to install, manage, and configure the ADSL2/2+ IP
DSLAM system via CLI command Line interface through CID/RS-232
interface or Telnet/Ethernet interface.
Organization
This book provides task-based instructions for installing and using the CLI
interface to configure and administrate the ADSL2/2+ IP DSLAM System.
The manual is organized as follows:
Chapter
1
2
3
4
5
1
Title & Description
Introduction
Provides an overview of ADSL2/2+ IP DSLAM System, including
features, fucntions, and applications of the ADSL2/2+ IP DSLAM.
Getting Started
Presents platform and system requirements as well as procedures
and instructions for installing the ADSL2/2+ IP DSLAM.
EMS Configuration
Describes how to build up the EMS environment.
Manage the ADSL2/2+ IP DSLAM
Describes how to manage a specified ADSL2/2+ IP DSLAM via
EMS.
System Administration with CLI
Provides all the instructions and procedures necessary for you to
Administer your ADSL2/2+ IP DSLAM with CLI interface.
6
Frequently Used CLI Examples
help users to be familiar with frequently used CLI commands
Appendix A Describes the pin assignment for ADSL2/2+ IP DSLAM
Document Conventions
Commands descriptions use these conventions:
[ ]
<>
<x|y|z>
Elements in square brackets are optional
Essential values
Alternative keywords are grouped in < > and separated by
vertical bars
Others
Note
2
Means reader take note. Notes contain helpful suggestions.
ADSL2/2+ IP DSLAM
2
What’s the difference
between ATM based
DSLAM and IP based
DSLAM?
Fig 0-1 & Fig 0-2 display the differences between traditional ATM-based
DSLAM and ADSL2/2+ IP DSLAM in PPPoE application sample.
Figure 0-1 PPPoE application in Traditional ATM-based ADSL Network
As Fig 0-1 displays, in traditional ATM-based ADSL network, the user
application information is encapsulated by ADSL CPE into ATM cells in predefined VC(Virtual Channel, PVC), and then upstream the ATM cells to
DSLAM via ADSL link. (In this example, the user information (PPPoE
encapsulated) is encapsulated by ATU-R using RFC-1483 Bridge-mode
encapsulation format.)
All the ATM cells belong to the specified VC is concentrated by the DSLAM,
and switched in the ATM network clouds, to the defined destination (ISPs or
Offices), at there the ATM cells and PPPoE frames is resolved by the
3
ADSL2/2+ IP DSLAM
Broadband Access Server, and the user application information is serviced.
Figure 0-2 PPPoE application in ADSL2/2+ IP DSLAM with EthernetAll-The-Way Network
In addition to traditional ATM-based ADSL network. As Fig 0-2 displays, the
user application information is still encapsulated by ADSL CPE into ATM
cells in pre-defined VC (Virtual Channel, PVC), and then upstream the ATM
cells to DSLAM via ADSL link.
In the ADSL2/2+ IP DSLAM, all the ATM cells belong to the specified VC
are decapsulated back to the original PPPoE encapsulated Ethernet packet
(if VLAN-mode of the specified ADSL port is disabled), or mapped to the
pre-defined Ethernet-VLAN packets (if VLAN-mode of the specified ADSL
port is enabled). ADSL2/2+ IP DSLAM concentrates all Ethernetwith/without VLAN-tag packets from 48/24 ports’ ADSL and uplinks to ISP’s
Ethernet-All-The-Way network. The PPPoE frames will be resolved at
Broadband Access Server (BAS), and the user application information was
serviced.
The ADSL2/2+ IP DSLAM supports ADSL CPE Bridge-mode. For future FW
upgrade, the ADSL2/2+ IP DSLAM can act as BRAS to process user
application information directly.
4
ADSL2/2+ IP DSLAM
ADSL2/2+ IP DSLAM provides Ethernet-with/without VLAN tag to ATM-PVC
mapping feature for the ISP to isolate user’s data with security and to
provide lots of service enhancement capabilities. ADSL2/2+ IP DSLAM
supports 8 ATM PVC links for each ADSL/ADSL2/2+ CPE.
5
ADSL2/2+ IP DSLAM
3
Introduction
3.1
General
This chapter will help you understand the function and application of your
ADSL2/2+ IP DSLAM. It covers
„
ADSL2/2+ IP DSLAM Overview
This section describes the overview of your ADSL2/2+ IP DSLAM. The
ADSL2/2+ IP DSLAM is cost effective solution for you to complete immediate
implementation of multiple of services in private and public networks.
„
ADSL2/2+ IP DSLAM Application
ADSL2/2+ IP DSLAM can be applied in MTU/MDU/MHU and Ethernet-all-theway application.
„
ADSL2/2+ IP DSLAM Features
This section describes the features of ADSL2/2+ IP DSLAM and its
specification.
6
ADSL2/2+ IP DSLAM
3.2
ADSL2/2+ IP DSLAM Overview
Using the latest xDSL technology, ADSL2/2+ IP DSLAM offers Internet service
providers a very cost-effective solution for immediate implementation of multiple
services in private and public networks. Currently, according to different port
density, there are 2 models available: 48-port and 24-port. User can deploy
different ADSL2/2+ IP DSLAM to satisfy their application requirements.
ADSL2/2+ IP DSLAM it acts as a standalone IP-based DSLAM, which can
concentrate and manage up to 48/24 ADSL/ADSL2/2+ lines. User can use local
RS-232 CID and/or remote TELNET/SNMP to manage the ADSL2/2+ IP
DSLAM directly.
Since the ATM backbone coverage is not so general in the real broadband
network environment. Instead of traditional DSLAM system provides ATM
uplink interface, the ADSL2/2+ IP DSLAM concentrates 48/24 ports of the ATM
over ADSL traffic which is encapsulated by ADSL CPEs, and maps each user’s
ata encapsulated in ATM-PVC to Ethernet-with/without VLAN-tag packet
(depends on the VLAN was enabled or not for the specified ATM ports), and
then uplink to Telco or ISP directly, User can enable VLAN-PVC mapping
capability for each ADSL/ADSL2/2+ port independently. The ADSL2/2+ IP
DSLAM acts as bridge for the ADSL/ADSL2/2+ ports without enabling the
VLAN-PVC mapping feature. ADSL2/2+ IP DSLAM provides both EthernetVLAN and non-VLAN to ATM-PVC mapping feature and bridge mode for the
ISP to isolate user’s data with security and to provide lots of service
enhancement capabilities. ADSL2/2+ IP DSLAM supports 8 ATM PVC links for
each ADSL/ADSL2/2+ CPE. Following figures are front view of 48-port and 24port models.
Figure 1-1 48-port model front view
7
ADSL2/2+ IP DSLAM
Figure 1-2 24-port model front view
As Fig 1-1 and 1-2 display, in the front view of ADSL2/2+ IP DSLAM, there are
several LEDs to indicate current system and link status and one replaceable
uplink/downlink module with three Giga TX/LX Ethernet interfaces for uplink,
downlink, and local management.
Through the uplink Ethernet, the ADSL2/2+ IP DSLAM can be stacked and
managed via SNMP as one entity.
As Fig 1-3 and 1-4 displays, in the rear-panel, there is one power adaptor, both
-42V ~ -56V DC or 90V ~ 240V AC power module can be selected. For 48-port
model, there are two sets of DSL & POTS 50-pin Centronic connectors. Each
set provides 24-port with built-in POTS-splitter ADSL/ADSL2/2+ module, totally
48 ADSL/ADSL2/2+ CPE users supported in one ADSL2/2+ IP DSLAM.
AC power
module
24-port ADSL
module with built-in
POTS splitter
Figure 1-3 48-port model rear View
AC power
module
Figure 1-4 24-port model rear riew
24-port ADSL
module with
built-in POTS
Fig 1-5 displays the LED identification of ADSL2/2+ IP DSLAM, and Table-1
describes its color definition and status description.
8
ADSL2/2+ IP DSLAM
Figure 1-5 ADSL2/2+ IP DSLAM LED Identification
Table 1-1 ADSL2/2+ IP DSLAM LED Description
<LED ID>
Color
POWER
MAINT
ALARM
MASTER
Green
Yellow
Red
Green
100/Act
Green/
Blinking
Green/
Blinking
Green/
Blinking
Green/
Blinking
Green/
Orange/
1000/ACT
GIGA
ACT
ADSL1 –
ADSL48
No Light
Red
Description
Lit when power on.
Lit when maintance commands were issued.
Lit when MJ/MN events happen.
Lit when system was acted as management master
for stacking application (future feature).
Blink when information is transmitted through
100Mbps MGNT Ethernet interface.
Blink when information is transmitted through 1000
Mbps uplink Ethernet interface.
Blink when information is transmitted through
1000FX uplink Ethernet interface.
Giga uplink is activated.
Lit Solid Green when ADSL link is in active state;
when the specified ADSL link is in connection
training state;
LED off when ADSL link is not in service
Lit Red when loss of signal occurs.
Note: Do not power off your ADSL2/2+ IP DSLAM when LEDs “MAINT”,
“ALARM” and “FAULT” are blinking simultaneously.
The replaceable 10/100/1000BaseT or FX uplink/subtend module design
provides the flexibility of the network implementation. Up to 8 IP DSLAMs can
be cascaded and managed as one unit
LAN Side (Uplink or Extension Side)
1*1000BaseT-MGNT + 2*1000BaseT
1*1000BaseT-MGNT+1*1000BaseT+
1*1000Fx(SX/LX)
9
ADSL2/2+ IP DSLAM
3.3
ADSL2/2+ IP DSLAM Application
As the following figure shown, ADSL2/2+ IP DSLAM is equipped with 48 or 24
ADSL/ADSL2/2+ ports with built-in POTS splitters so that it provides broadband
data service over existing copper wires without affecting the conventional voice
service. ADSL2/2+ IP DSLAM, therefore, is a perfect solution for both central
office co-location and MTU/MHU markets.
TV
Video
Voice
Data
Splitter
ADSL2/2+ Router
ADSL2/2+ Router
Residential Access
Business Access
0M
10
ADSL2/2+ IP DSLAM
100M up
link
k
lin
up
Internet
10
ADSL2/2+ IP DSLAM
3.4
ADSL2/2+ IP DSLAM Features
3.4.1
Cost Saving Solution for SMB
48/24 ports ADSL/ADSL2/ADSL2+ Subscriber Interface
100/1000BaseT or Fx Uplink/Subtend Interface (module selectable)
Build in POTS Splitter
Subtending capability allows up to 8 units to be cascaded and managed as
one unit
3.4.2
Excellent Management with Security
Microsoft NT/SNMP-based GUI EMS
Local RS-232 CLI, and Ethernet SNMP/TELNET management
Remote in-band SNMP/TELNET management
3-level user priviledge for system management
SNMP v1, v2c, v3
Firmware upload/download via FTP or TFTP
3.4.3
Advanced Function for Broadband Service Offering
IGMP snooping
Support up to 8 VCs, 128 MAC address per xDSL ports
Support up to 64*128 MAC address & 2K Multicast MAC address per
ADSL2/2+ IP DSLAM system
Support 512 VLAN(any value in 4096)
Support Static VLAN and Port-based VLAN
Configurable packet size (64 to 1536)
Security : VLAN filtering, MAC Filtering, IP Filtering, Access Control List by
11
ADSL2/2+ IP DSLAM
MAC and IP address
Spanning Tree (802.1d) compliant
Traffic prioritization (802.1p)
Uplink Aggregation (802.3ad)
Future(SW upgrade) BRAS support 802.1x, DHCP Server & Relay, PPPoE,
MPLS, VLAN-based VPN, L3 router feature, L2TP
Input Rate Limiting (IRL) on a per-AAL5 interface
Output Rate Limiting (ORL) on a per ATM-port basis
Output Rate Limiting (ORL) on a per-Physical Ethernet Interface basis
3.5
ADSL2/2+ IP DSLAM Specifications
System Architecture
48/24 ports ADSL/ADSL2/ADS2+/SHDSL
subscriber interface with built-in POTS
Splitter
One 1000BaseT MGNT+ Two 1000BaseT
or one Giga LX Uplink/Subtend Interface
(module selectable)
Subtending capability allows up to 8 units
to be cascaded and managed as one unit
Telco-50 pin Centronic connector for
ADSL+POTS IN and POTS OUT
ADSL/ADSL2/ADSL2+ Interface
Downstream DMT data rate from 32
kb/s up to 25 Mb/s; Upstream DMT
data rate from 32 kb/s to 1 Mb/s
Comply with ITU G.992.1 (G.DMT),;
G.DMT.bis; ITU G.992.2 (G.Lite);
ANSI T1.413 issue 2; ITU G.994.1
(G.handshake) for ADSL, G.992.3 for
ADSL2, and G.992.5 for ADSL2+
Extended power management
capabilities to optimize power
consumption for each application
Maximum reach exceeding
20Kft(6.1Km)
Protocol Handling Capability
Management
8 VCs per xDSL ports
Microsoft NT/SNMP-based GUI
EMS
128 MAC address per xDSL ports
64*128 MAC address
Local RS-232 CLI, and Ethernet
SNMP/TELNET management
2K Multicast MAC address
512 VLAN(any value in 4096) support
Remote in-band SNMP/TELNET
management
Configurable packet size (64 to 1542)
Firmware upload/download via FTP
or TFTP
SNMP v1, v2c, v3
LAN Side (Uplink or Extension Side)
1* 1000BaseT-MGNT + 2*1000BaseT
1*1000BaseT-MGNT+1*1000BaseT+
1*1000Fx(SX/LX/LH/ZX)
12
ADSL2/2+ IP DSLAM
1*10/100BaseTMGNT+2*100FX(SM/MM)
1* 10/100BaseT-MGNT +
2*10/100BaseT-UPLINK
ATM MIBs
RFC 1514, 2515 DEFINITIONS OF
MANAGED OBJECTS FOR ATM
MANAGEMENT
Physical condition
Dimension:
400mm(D)x440mm(W)x44mm(H)
Weight: 6.8kg
Power
AC Power: auto ranging 90~240 VAC, 5060 Hz, IEC connector
DC Power: -42~-56 VDC
Power Consumption: 150 watts
13
Private MIBs
ANY SPECIFIC PRIVATE TRAPS
Protocol
STP; IGMP snooping; GMRP;
GVRP; LACP; LACP marker;
SNMP/UDP/IP/MAC/Ethernet
Operating Environment
Operating Temperature: 0°~50 °C,
32°~122 °F
Storage Temperature: -30c°~70 °C,
-22°~158 °F
Humidity: 5% to 90% RH noncondensing
ADSL2/2+ IP DSLAM
4
Getting Started
4.1
General
This chapter provides the installation instruction for the hardware installation
and system configuration of your ADSL2/2+ IP DSLAM so that you can start
up quickly. It includes the following sections:
Unpacking your ADSL2/2+ IP DSLAM
This section describes how to unpacking your ADSL2/2+ IP DSLAM, and
part number explanation.
Hardware Installation
This section describes the power connection, loop connection and CID
connection.
Ways of management connection
This section describes how to engage in management connection by CLI
and Telnet.
14
ADSL2/2+ IP DSLAM
4.2
Unpacking your ADSL2/2+ IP DSLAM
This section describes how to unpack your ADSL2/2+ IP DSLAM. For a box
of ADSL2/2+ IP DSLAM, there may contain the following materials:
1. ADSL2/2+ IP DSLAM
2. Mounting bracket package
3. RJ-45 Ethernet cable
4. Power cord (AC power module only)
5. RS 232 cable to facilitate the connection between CID and PC
6. CD including user manaul and Quick Start Guide
7. A copy of Quick Start Guide
8. Accessory package
Any other accessories requested at time of ordering.
Check the contents of the package and inspect the unit for any signs of
damage. Report any defect to vendor’s customer service representative.
Retain all packing materials for future shipment.
15
ADSL2/2+ IP DSLAM
4.3
Hardware Installation
The ADSL2/2+ IP DSLAM can be installed in a standard 19-inch rack, by
using the mounting brackets provided.
Mount the shelf on the rack using the large screws provided.
Follows the following procedures to connect and wire the system.
4.3.1
Safety Instruction
The following is the safety instructions for ADSL2/2+ IP DSLAM before
installation:
1. Read and follows all warning notices and instructions of this user manual.
2. The maximum recommended operating temperature for the ADSL2/2+ IP
DSLAM is 50ºC. Care must be taken to allow sufficient air circulation or
space between units when the ADSL2/2+ IP DSLAM is installed inside a
closed rack assembly and racks should safely support the combined weight
of all ADSL2/2+ IP DSLAM.
3. The connections and equipment that supply power to the ADSL2/2+ IP
DSLAM should be capable of operating safely with the maximum power
requirements of the ADSL2/2+ IP DSLAM. In the event of a power overload,
the supply circuits and supply wiring should not become hazardous.
4. The AC adapter must plug in to the right supply voltage. Make sure that
the supplied AC voltage is correct and stable. If the input AC voltage is over
10% lower than the standard may cause the ADSL2/2+ IP DSLAM to
malfunction.
5. Do not allow anything to rest on the power cord of the AC adapter, and do
not locate the product where anyone can walk on the power cord.
6. Generally, when installed after the final configuration, the product must
comply with the applicable safety standards and regulatory requirements of
the country in which it is installed. If necessary, consult for technical support.
7. A rare condition can create a voltage potential between the earth grounds
16
ADSL2/2+ IP DSLAM
of two or more buildings. If products installed in separate building are
interconnected, the voltage potential can cause a hazardous condition.
Consult a qualified electrical consultant to determine whether or not this
phenomenon exists and, if necessary, implement corrective action before
interconnecting the products. If the equipment is to be used with
telecommunications circuit, take the following precautions:
Never install telephone wiring during a lightning storm.
Never install telephone jacks in wet location unless the jack is specially
designed for wet location.
Never touch uninsulated telephone wires or terminals unless the telephone
line has been disconnected at the network interface.
Use caution when installing or modifying telephone lines (other than a
cordless telephone) during an electrical storm. There is a remote risk of
electric shock from lightning.
Do not use a telephone or other equipment connected to telephone lines to
report a gas leak in the vicinity of the leak.
4.3.2
ADSL2/2+ IP DSLAM Rear Panel Connection
The following figure shows the rear panel connection of ADSL2/2+ IP
DSLAM:
Figure 2-1 ADSL2/2+ IP DSLAM Rear Panel Connection
Step 1: Ground the ADSL2/2+ IP DSLAM by connecting a grounded wire
17
ADSL2/2+ IP DSLAM
(option).
Step 2: Connect the ADSL line connector, a 50-pin centronic connector, of
ADSL2/2+ IP DSLAM to CPE by using telco cable. Each line connector
supports 24 ports of ADSL/ADSL2/2+ for Data path from MDF(Main
Distribution Frame).
Step 3: Connect the phone connector, a 50-pin centronic connector, of
ADSL2/2+ IP DSLAM to Exchange/PBX by using telco cable. phone
connector is an optional module supporting Voice path to Exchange/PBX; it
must be along with Line Connector.
Step 4: Connect the power adapter and plug it into an outlet.
4.3.3
ADSL2/2+ IP DSLAM Front Panel Connection
Connect the uplink port of ADSL2/2+ IP DSLAM to internet or downlink to
the other ADSL2/2+ IP DSLAM for stacking by using the RJ-45 cable.
Furthermore, connect the CID port to the management station’s CID port
by using the RS-232 cable or connect the MGT port to the management
station’s Ethernet port by using RJ-45 in order to administer your
ADSL2/2+ IP DSLAM through CLI or GUI EMS.
Figure 2-2 ADSL2/2+ IP DSLAM Front Panel Connections
Note: Please refer to Appendix B: pin assignment of telco cable, RJ-45
and RS-232 cable for those connectors’ pin assignment.
18
ADSL2/2+ IP DSLAM
4.4
Ways of Management Connection
This section will tell you how to connect and manage your ADSL2/2+ IP
DSLAM through CLI and EMS.
4.4.1
EMS(Element Management System)
The Element Management System (EMS) is more user- friendly than CLI for
your configuring ADSL2/2+ IP DSLAM. The HTML files embedded in
ADSL2/2+ IP DSLAM are dynamically linked to the system’s functional
command sets. You can access a specified ADSL2/2+ IP DSLAM through
EMS.
Perform initial configuration procedures as follows:
1. Click the EMS icon on the screen of autorun to install EMS into your PC.
2. Before you start to connect to EMS, it is necessary that your PC’s IP and
ADSL2/2+ IP DSLAM’s IP are in the same group. Note: ADSL2/2+ IP
DSLAM’s default Uplink IP is 192.168.100.111
3. Create management IPs into the ADSL2/2+ IP DSLAM so that the
authorized IP agent can manage ADSL2/2+ IP DSLAM through EMS.
Connect to ADSL2/2+ IP DSLAM with RS-232 or Ethernet cable, and
then write the IPs into ADSL2/2+ IP DSLAM by telnet or CLI. Input the
following commands sequentially:
a. create snmp comm community public
b. create snmp host IP 192.168.100. xxx community public, where
192.168.100.xxx is the IP of your PC.
c. create snmp traphost ip 192.168.100.xxx community public version v1,
where 192.168.100.xxx is the IP of your PC.
Note: if to use CLI, bits per second, data bits, parity, and flow control should
be set as 9600, 8, none and 1 respectively.
4. Launch the EMS and then log in with the “Admin” for both user name
and password. Click on
19
to enter the EMS system. Log in as usual.
ADSL2/2+ IP DSLAM
(User account: Admin; Password: Admin)
4.4.2
Command Line Interface (CLI)
The Command Line Interface is the most primary character based
configuration interface. Some of configurations not provided in Baliff can be
configured through CLI. You can access CLI from the terminal emulation
software.
The procedure of connecting to the CLI is as follows:
Start up the terminal emulation software on the management station.
If necessary, reconfigure the terminal-emulation software to match the
switch console port settings.
Bits per second
Data bits
Parity
Stop bits
Flow control
9600
8
None
1
None
Enter Admin when prompted for a user name and password. The
ADSL2/2+ IP DSLAM prompt appears when you have logged in to the
management interface successfully.
4.4.3
Telnet Client
ADSL2/2+ IP DSLAM supports only one Telnet client that you can use to
connect with. Telnet provides a simple terminal emulation that allows you to
see and interact with the CLI of ADSL2/2+ IP DSLAM. As with any remote
connection, the network interface IP address for the ADSL2/2+ IP DSLAM
must be established.
20
ADSL2/2+ IP DSLAM
5
EMS Configuration
This Chapter describes how to install and set up the environment of EMS.
Once you finish it, a specified ADSL2/2+ IP DSLAM can be managed
remotely. Next chapter will introduce how to manage the ADSL2/2+ IP
DSLAM through EMS.
5.1
EMS Functions
EMS is divided into the task-oriented functional groups as follows, which are
further described in subsequent sections.
Session: Allow you to start and to terminate a session as well as to
shutdown the system.
Logout: Allow you to terminate current session without shutting down the
system.
Exit: Allow you to shut down the system.
Tools: Allow you to perform the following tools.
Evionmental options: alow you to define SNMP, Desktop and Surveilance.
Territory Manager: Used to define the territory.
Agent Manager: Used to define agent IP addresses.
Telnet: alow you to login the CID screen of a specific agent IP address.
Ping: used to check whether a particular ADSL2/2+ IP DSLAM is current
connected to the agent or not.
User manager: Allow you to define a user profile, including login ID and
security level.
Windows: allow users to manage daughter windows in the EMS.
Cascade: allow users to cadcade Windows.
Next Window: alow users to switch to next window.
21
ADSL2/2+ IP DSLAM
Previous Window: alow users to switch to previous window.
Arrang Icons: those minimized icons will be locatd in the bottom of EMS.
Help: allow users to view the software version.
About: software version is displayed.
5.1.1
5.1.1.1
Installation
Hardware and Software Requirements
The following checklist provides the minimum hardware and software
required to operate EMS.
1. Windows NT/2000/XP
2. Manual CD
3. 2GB Hard disk with a minimum of 650 MB of free space
4. An ethernet card.
5. Super VGA (800 x 600 resolution) or higher with 256 colors
6. CD-ROM drive
22
ADSL2/2+ IP DSLAM
5.1.2
Installing EMS
1. Insert Autorun CD into CD –ROM Drive.
2. From the autorun screen, double click the EMS icon to start the
installation process.
3. The welcome window of EMS Setup appears. Click on
to
continue.
4. When the user information input window appears, enter your name and
company name respectively, and then click on
23
to continue.
ADSL2/2+ IP DSLAM
Note: please uninstall previous version of EMS if you want to install a new
version.
5. When the Destination Location window appears, click the Browse button
to change the installation destination directory or simply use the default
setting “C:\Program Files\EMS\EMS-SD1. Then, click on
continue,
24
to
ADSL2/2+ IP DSLAM
6. When the Select Program Folder window appears, you may either
choose the default program folder, “EMS\EMS-SD1”, or enter the name
you prefer. Then, click on
to continue,
7. When the Start Copying Files window appears, you can confirm your
current settings, if you are satisfied with the settings, click on
to start copying files.
25
ADSL2/2+ IP DSLAM
8. When Setup Process Status window appears, the installation process is
now in progress. This window displays a bar indicating the percentage of
completion for the current installation. In addition, the names of the files
being installed appear above the bar until the installation is complete.
9. At the end of the installation process, the following “FINISH” window
presents. Simply click on
to complete setup. Now the
installation of EMS software is completed.
26
ADSL2/2+ IP DSLAM
10. After finishing the installation process, a shortcut of EMS is displayed on
the desktop. Click on
5.1.3
to activate EMS directly.
Un-installation of EMS
1. Double click the Add/Remove Programs icon in Control Panel to run the
un-installation procedure.
2. In Add/Remove Programs Properties dialogue box, selecting the “EMS-
27
ADSL2/2+ IP DSLAM
SD1” folder and then click on
3. After your clicking on
to remove EMS.
, the following dialogue box then
prompts to you for confirmation. Click on
to continue the
removal process.
4. The following window, “un-installation completion status” appears. Click
to complete the removal process when
enable, indicating that the process is completed.
28
become
ADSL2/2+ IP DSLAM
5.1.4
Starting the System
Users can activate the EMS either from Promgrame manger or clicking the
shortcut icon on the desktop. From Program Manager, choose the “EMS”
program group in the Program Manager window. Then, choose the “EMSSD1” program item to launch the program.
Note: before starting EMS, the SNMP comm command should be
configured as “rw” via CLI so that read-write permissions are given to
managers. For detailed instruction, refer to page 錯誤! 尚未定義書籤。.
29
ADSL2/2+ IP DSLAM
5.1.5
Logging into the System
1. Once the system is started, the Login window then prompts as follows.
2. Simply enter your user account ID and password respectively, and then
click on
to login.
Default Account
Default Password
Supervisor
(blank)
Note: For the security concern, it is very important for you to change
your password afterwards.
To terminate the login, simply click on
.
3. After launching EMS and logging in with a valid username and password,
the main window, EMS then prompts as shown in the following figure.
30
ADSL2/2+ IP DSLAM
5.1.6
Terminating the System
To terminate the system at any time, simply choose the Exit command from
Session Menu. The system then terminates.
5.1.7
Logging out the Current Session
To terminate the current session, choose Logout command from Session
Menu. The user account, then, is logged out and Login window prompts for
a new login. Normally, this is used when a user wants to re-login in order to
gain a higher level of authority for certain operations.
31
ADSL2/2+ IP DSLAM
5.2
Windows Arrangement
Users may open many daughter windows in the EMS. To benefit user’s
viewing every Window, Commands of the Windows manu is designed to
arrange daughter windows. Those commands will be inroduced seperately.
5.2.1
Cascade
Choose Cascade from Windows manu in the EMS manu bar.The cascade
command can cascade those opened windows as follows. User can select a
window to perform operations or view status simpliy by clicking on a
specified window.
5.2.2
Next Window
Next Window helps user to view next window so that it will bring the window
in the second layer to front.
5.2.3
Previous Window
Previous Window command can help user to bring the previous window to
front.
32
ADSL2/2+ IP DSLAM
5.2.4
Arrange Icons
By slecting Arrange Icons of Windows Manu in the manu bar, it will locate
those minimized daughter windows in the bottom left of EMS window as the
following figure shown. User can select a required icon to perform EMS
management.
5.3
Help
To view the version of NatBailiff, choose About command via Help menu,
as shown in the following figure. Click on
33
to exit the window.
ADSL2/2+ IP DSLAM
5.4
Tools Menu Introduction
This chapter describes how to use tools in the EMS, including
Environmental options, Territory manager, Agent manager, user nanager
and Telnet, which are detailed in the following sections.
5.4.1
Environmental Options
Choose Environmental Options from Tools Menu, this Environment
daughter window then appears. By this function, user can config SNMP,
Desktop and Surveillance respectively.
5.4.2
SNMP Configuration
The SNMP Time-out Period and Retransmission times can be configured as
shown in the following steps:
1. Click on the TabControl (SNMP/Desktop/Surveillance) of SNMP that
will bring SNMP dialogue box to front.
2. Click on
or
to change the Time-out Period seconds and
Retransmission times.
3. Click on
34
to submit your changes.
ADSL2/2+ IP DSLAM
5.4.2.1
Desktop configuration
The desktop is user for setting the map of a required territory.
1. Click on the tab of Desktop that will bring Desktop dialogue box to
front, as shown in the following figure.
2. Click on
to quick start territory manager in which
users can define a dersired territory. Please refer to page 37 for more
details.
35
ADSL2/2+ IP DSLAM
3. Click on
to load the map of a territory or click on
to clear a loaded map. Note: the format of map is limited to *.bmp,
*.emf and *.wmf.
to submit your setting, and then the map will apply
4. Click on
to the Mounted Agent.
5.4.2.2
Surveillance configuration
1. Click on the tab of Surveillance that will bring the Surveillance
dialogue box to front, as shown in the following figure.
2. Click on
or
to change the mornitoring period.
3. Select the checkbox of Save expired records to save surveillance
archive, which can be browsed by clicking on the tab of Archieved
in the Event Log window as shown in the following figure:
36
ADSL2/2+ IP DSLAM
4.
Clicking on
to choose the directory to record
surveillance data and press
5. Click on
5.4.3
or
to define expired period.
to submit your settings.
Territory manager configuration
Territoy manager help users to build up mornitoring territories and agents
could be categorized into different territories by users. That benefits users to
mornitor the status of PAMSPAN-2000 systems by territory. Territory
manager can be activated either from manu bar or from envoronmental
options.
5.4.3.1
Territory Manager window
Choose Territory Manager via Tools Menu, or Environmental option, and
then the Territory Management window appears.
37
ADSL2/2+ IP DSLAM
If to add a territory to the system,
Click on
, the Territory Name fields then cleared to blank for
entering the data.
Enter Territory Name and
Click on
then become enable.
to apply the territoy to the system. After that, you can
proceed to group management by Territory Management dialog box.
As the following figure shown, the agent, 192.168.100.176 is available in the
territory named ALL on the left. Users can shift the mornitoring territory from
ALL to Taipei simply by selecting Taipei in the Drop-down list on the right.
38
ADSL2/2+ IP DSLAM
Choose the agent, 192.168.100.176 on the left and then click on
The agent IP will appear on the right and will be mornitored under the
territory, Taipei.
Corresspondently, the Agent Desktop displays that Agent IP
192.168.100.176 has been moritored under the territroy, Taipei.
39
.
ADSL2/2+ IP DSLAM
If users want to move the agent IP from Taipei to other territory, select a
desired agent IP and click on
Click on
to shift it to the left.
to exit the window or continue to perform other
operations in the same window.
5.4.4
Agent Manager Configuration
All of the ADSL2/2+ IP DSLAM agents that are to be managed by the EMS
must be “registered” to the system. The “registeration” process is to make
the system aware of agent’s IP address and alias name. Once an agent is
registered, it is put into the “demount” agent pool, which is still “inactive” for
the network monitor. You then have to activate it if you want it to be
monitored. An active agent can also be deactivated from the monitor for
certain operational purpose when necessary. Agent Manager is designed
for you to perform these operations.
5.4.4.1
Agent Manager window
Choose Agent Manager from Tools Menu, this window then appears.
40
ADSL2/2+ IP DSLAM
As mentioned above, Agent Manager is used to define the ADSL2/2+ IP
DSLAM agent’s IP address and community string that are to be used in the
system, and to activate the system’s monitoring of an agent; to deactivate
an agent from the system’s monitoring.
If to add an agent to the system,
1. Select a territory that a new agent belongs to. Users can click on
to activate territory manager.
2. Click on
, the data fields then cleared to blank for entering
the data. Enter values in fields, IP Address, Alias Name and
Description. The Apply buttons to the left of these fields then become
enable.
3. Click on
to apply the agent to the system.
4. If to activate (so-called “Mount”) the system’s monitoring of an agent,
click on the required agent entry in the Demount agent list, then click
on
. The agent will appear on the Mount agent list on the
right.
5. Click on
to exit the window or continue to perform other
operations in the same window.
41
ADSL2/2+ IP DSLAM
If to remove an agent from the system,
1. Click the required agent in the Demount agent list, and then click
on
. The agent will disappear.
to exit the window or continue to perform other
2. Click on
operations in the same window.
If to change the information of an agent,
1. Select the required agent in the Demount agent list. The information of
the selected agent will then presented on the data fields.
to Change IP, Alias Name, and Description and then
2. Click on
becomes enable.
3. Click on
to apply the change to the system.
4. Click on
to exit the window.
Note: user can only change alias and description of the agent in the Mount
agent list and changing IP is prohibited.
If to activate the system’s monitoring of an agent,
1. Select the required agent in the Demount agent list, and then click on the
Mount button
. The agent will appear on the Mount agent list.
to exit the window or continue to perform other
2. Click on
operations in the same window.
If to de-activate the system’s monitoring of an agent,
1. Select the required agent in the Mount agent list, and then click on the
Demount button
. The agent will then disappears from the Mount
agent list and appears on the Demount agent list on the left.
2. Click on
to exit the window.
Table 3-1 Agent Management Field Definition
42
ADSL2/2+ IP DSLAM
Field
IP Address
Alias name
Description
5.4.4.2
Definition
***.***.***.***
Name of ADSL2/2+ IP DSLAM
Note
Agent Desktop (Network Monitor)
Agent Desktop (see below) is the main window for the network
administrators in performing their day-to-day network monitoring jobs. Like
the standard desktop of MS Windows, Agent Desktop appears at all time
once the system is started. First appears on the Agent Desktop is the
status of agents by an array of colors. By which you may monitor the status
of agents, and judge if they are normal or in situations of alarms. You may
then double click on the required agent IP to activate the event log window.
Similarly, the Mounted Agents Desktop can be started up by double clicking
on the icon of territory.
In the Agents Desktop, press
to refresh the status of all agents.
Overall status
of territory by
priority
5.4.4.2.1
Overall status
of Agents by
priority
Legends:
Gray icon indicates that the agent is disconnected.
Green icon indicates that the agent is in normal condition.
Red icon indicates that “Major Alarm” is occurred to the agent and
requires network administrator’s attention. Network administrator
43
ADSL2/2+ IP DSLAM
pays attention to alarms by looking into the alarms using Event
Log – Outstanding.
The red icon will turn into a yellow icon after the network
administrator has looked into the alarms. However, this does not
mean the situation is released. If any new alarm happens, yellow
will turn red.
Black icon indicated that the agent is demounted.
Note: the priority of colors: Gray>red>yellow>green>black
5.4.4.3
Mounted Agent Desktop
Mounted agent desktop provides users with flexibity in viewing your network
using graphical presentation of network elements. Mounted agent desktop
can be easily activated by double clicking the icon of territory in the agent
desktop and apprears promptly as shown in the the following figure. By the
mounted agent desktop, the location of agents and overall network status of
a specific territory is presented.
Legends:
: This icon can be moved to where the agent is located in the map.
In addition, its color also changes with the status of the agent. For example,
the icon in red means that alarm is occurred to the agent and requires
44
ADSL2/2+ IP DSLAM
network administrator’s attention.
5.4.5
Telnet
Users can use the Telnet to connect to a specific ADSL2/2+ IP DSLAM, and
then monitor and interact with the system.
How to activate Telnet from Agent Desktop?
1. Select an agent IP on the Agent desktop.
2. Click on the right bottun of mouse and then select Telnet or choose
Telnet from tool manu in the EMS window’s manu bar. Then Telnet screen
will come up immdeiately.
45
ADSL2/2+ IP DSLAM
3. Enter user name and password to access the CID screen.
Note: The default login and password are admin.
5.4.6
Ping
Ping is a command used to determine whether a particular ADSL2/2+ IP
DSLAM is currently connected to the agent. It works by sending a packet to
the specific IP address and waiting for reply.
How to activate Telnet from Agent Desktop?
1. Select an agent IP on the Agent desktop.
2. Click on the right bottun of mouse and then select Ping or choose it from
46
ADSL2/2+ IP DSLAM
tool manu in the EMS window’s manu bar. Ping screen will come up
immediately and then starts to send packets to check the connection with
the ADSL2/2+ IP DSLAM.
3. After showing the connection status, the screen will be closed
automatically.
5.4.7
User Manager window
The EMS uses user accounts, password as well as power level (system
privileges) to control access and log in. There are three types of privileges,
Supervisor, Constructor and Tester.
Supervisor: The highest level. User with this privilige can access ANY
functions and data;
Constructor: User can set and modify the configuration of network
equipments.
Tester: user can run maintenance test, such as loop back function.
To perform user manager, proceed as follows,
1. Choose User Manager from Tools Menu to access this window.
From the following window, User Manager, you can add and remove users
as well as change passwords, which are used to control the login.
47
ADSL2/2+ IP DSLAM
Table 3-2 User Manager Field Definition
Definition
Field
User Account
an ID to be used for login
User Name
The full name of a user
Description
Remarks for note purpose
Power Level
Privileges; Administrator and tester
If to add a user account to the system,
1. Click on
, the Security window then prompts.
2. Enter the account information as described in Security window below.
3. Click on
to exit the window or continue to perform other
operations in the same window.
If to remove a User Account from the system,
1. Select a user account by clicking on the desired entry in User Account
selection list. After selection, the designated one will be highlighted.
2. Click on
to delete it.
3. Click on
to exit the window or continue to perform other
operations in the same window.
48
ADSL2/2+ IP DSLAM
If to change User Account Information,
1. Select a user account by clicking on the desired entry in User Account
selection list. After selection, the designated one will be highlighted.
2. Click on
button, the Security window then prompts.
3. Change the account information as described in Security window below.
4. Click on Close button to exit the window or continue to perform other
operations in the same window. 2. Click on Add button, the Security
window then prompts.
User Manager window -- Security
This window is a daughter window of User Manager Window, and is used
when adding a user account or changing account information.
1. Either
or
is selected, this window appears.
2. Enter data in the fields, User Account, User Name, Description, Password
as required. Re-enter the password in field, Verify Password, for
purpose of verification.
3. If to force the user to change their password at the next login, click on the
checkbox to the left of the field, To Change Password When Login
49
ADSL2/2+ IP DSLAM
Next Time.
4. If to suspend a user account, click on the checkbox to the left of the field,
Account Suspended.
5. If to assign a new Power Level to the user, click on the desired entry in
the Demount list, then click on the Mount button,
. The
selected Power Level entry will then be added to the Mount list on the
right.
6. If to remove a Power Level from the user, click on the desired entry in the
Mount list on the right, then click on the Demount button,
.
The selected Power Level entry will then be removed.
to complete the operation or
7. Click on
to abort the
change. Either one is selected; the window is exited to User Manager
Window.
Table 3-3 Register-Security Field Definition
Field
50
Definition
User Account
An ID to be used for login
User Name
The full name of a user
Description
Remark for note purpose
Password
Any character string, including blank
Verify Password
Re-enter the password as a confirmation
To change password
when next login
If this is checked, the associated user needs to
change their password at the next login.
Account Suspended
Suspend the account.
Power Level
Privileges; Administrator and tester
6
Manage the ADSL2/2+ IP
DSLAM
After successfully setting up the environment of EMS, you can manage different
ADSL2/2+ IP DSLAM via your EMS remotely. This chapter will tell you how to
interact with a specified ADSL2/2+ IP DSLAM.
6.1
Activate Function Management Windows
Via EMS, users can remotely morniter the current status of a specified IP DSLAM,
and then proceed advanced configuration. To activate the function management
windows, choose a specified agent that you want to manage, and then double
click the agnet, or click the right button of the mouse to select Function List, as
shown in the following figure.,
After that, the function management windows, including Function window and
Front panel status window, will prompt as shown in the following figure.
51
Application Note
6.1.1
Function management Windows
The Function management windows, including function window and Front panel
ststus window, which are provided to mornitor the ADSL2/2+ IP DSLAM’s status
in real time and configure related settings. They will be introduced repectatively.
6.1.1.1
Function Window:
From the Function window, users can activate a
specified function immediately by double clicking a
specified item.
6.1.1.2
Front Panel Status Window
After choosing a speicified agent, the Freont Panel Status Window, together with
the Function Winddow, will come out immediately to present the current status of
front panel of the ADSL2/2+ IP DSLAM. As to the LED identification of front panel,
52
Application Note
refer to page 9 to get more information.
6.2
Default Setting
This section describes how to get the information of the default setting of the
ADSL2/2+ IP DSLAM.
1. Click on “Default Setting” from the Function List window.
The Default Setting window appears as follows:
In the default setting window, the status of, IP, System, VCC connection, DSL line
profile and Alarm profile are displayed clearly. How to modify them will be
introduced in the following sections.
53
Application Note
6.3
System Information
This section describes how to get and input the information of the ADSL2/2+ IP
DSLAM.
1. Double Click on “System Information” from the Function List Window.
The System Information window appears as follows:
Input necessary information on those fields.
Table 4-1 Sysinfo field definition
Field
54
Definition
Name
Alias name of the ADSL2/2+ IP DSLAM
Location
Location of the ADSL2/2+ IP DSLAM
Contact
The contact person of the ADSL2/2+ IP DSLAM
Vendor
The vendor of the ADSL2/2+ IP DSLAM
Object ID
Vendor ID
DST
This specifies if the Daylight Savings Time has been
enabled or not.
True:on
False: off
UpTime
System up time
HwVersion
Hardware version of the ADSL2/2+ IP DSLAM.
CPSwVersion
Control plant version
Log Threshold
This specifies the severity level of the trap equal to or
lower than that shall be logged. 0 represents log
threshold is diable. 1 is the lowest and represents
critical traps.
Valid values: 0-4
Time Zone
Time zone
Valid values: Given below, are the valid values,
followed by their descriptions.
IDLW - International Date Line West
NT - Nome
HST - Hawaii Standard
Application Note
CAT - Central Alaska
AHST- Alaska-Hawaii Standard
YST - Yukon Standard
PST- US Pacific Standard
MST- US Mountain Standard
CST- US Central Standard
EST- US Eastern Standard
AST- Atlantic Standard
NFST- Newfoundland Standard
NFT- Newfoundland
BRST-Brazil Standard
AT- Azores
WAT - West Africa
GMT - Greenwich Mean
UTC - Universal (Coordinated)
WET - Western European
CET - Central European
FWT - French Winter
MET - Middle European
MEWT - Middle European Winter
SWT - Swedish Winter
EET - Eastern Europe, Russia Zone 1
IST - Israeli Standard
BT - Baghdad, Russia Zone 2
IT - Iran
ZP4 - "Russia Zone 3"
ZP5 - "Russia Zone 4"
INST - "Indian Standard"
ZP6 - "Russia Zone 5"
NST - "North Sumatra"
WAST - West Australian Standard
SSMT - South Sumatra, Russia Zone 6
JT- Java
CCT - China Coast, Russia Zone 7
ROK - Korean Standard
KST - Korean Standard
JST - Japan Standard, Russia Zone 8
CAST - Central Australian Standard
EAST - Eastern Australian Standard
GST - Guam Standard, Russia Zone 9
IDLE - International Date Line East
NZST - New Zealand Standard
NZT - New Zealand
Example: IDLW , that stands for International Date
Line West
Current Time
3. Click on
55
This inicates the current time.
to submit your settings or
to close the window.
Application Note
6.4
Current Event
Describes the facility for the network administrators to track and trace the history
of events happened and released. Current Event window can be activated from
Function list window.
There are three daughter windows provided to accomplish above tasks:
Outstanding Event: Allow you to view the outstanding events or status and
system information.
Closed Event: Allow you to trace events or status that are already closed
and are still within the surveillance period as defined in Environment
Options. It also allows you to view the system information.
Archived: Allow you to browse the expired records.
Legends
Icons
6.4.1.1
The grade of
alarm
indicated
Major Alarm
Minor Alarm
Abbreviation
Icons after the alarm has
been viewed.
MJ
MN
Outstanding Event
This window allows you to view the outstanding events of specific agents.
If to view the event log of a specific agent,
1. Click “Current Event” from Function List window. The Event Log window
appears as follow:
56
Application Note
Table 4-2 Outstanding Event Window Field Definitions
Field
Description
Happen time
The date/time when the event is occurred.
Agent
The IP address of the agent associated
Grade
Severity level of event or status.
DSL
DSL Port
Site
Down stream or upstream
Description
The description of the event or status.
6.4.1.2
Closed Event
This window allows you to browse the closed alarms and events of specified
agents.
1. Click on the tab of Closed that will bring the Closed screen to front, as the
following figure shown:
2. Click on
3. Click on
57
to clear all records.
to exit the window.
Application Note
Table 4-3 Closed Event Window Field Definition
Field
Release Time
Others
6.4.1.3
Description
The date/time when the event is closed.
Rest of the fields is as same as described in “Outstanding
Events”.
Archived
This window allows you to browse the expired records, which can be configured
in the Evironment window.
1. Click on the tab of Archived that will bring the Archived screen to front as
follows:
2. Click on
58
to clear all records.
Application Note
3. Click on
6.5
to exit the window.
System
This section allows users to perform commit and reboot that will be introduced as
follows:
6.5.1
Commit and Reboot
This section describes how to commit the current configuration to falsh or reboot
the ADSL2/2+ IP DSLAM.
1. Double Click on “Commit and Reboot” from the Function List Window.
The System Information screen appears as follows:
2. If to commit the active configuration to the flash, click on
.
3. If to reboot the system and to set the boot configuration, click on
4. Click on
6.6
.
to close the System Configuration window.
Configuration
This section describes how to configure the ADSL2/2+ IP DSLAM by selecting
Configuration from Function List window. This section will cover those functions:
6.6.1
VLAN Configuration
Allow user to view and modify VLAN configuration. To configure VLAN, proceed
as follows:
1. Double Click on “VLAN configuration” from the Function List Window.
59
Application Note
The VLAN configuration window appears as follows:
2. Select the VLAN to view or modify by using the VLAN ID drop-down list.
3. Use Egress PVC and Unatagged PVC drop-down list to set the specified DSL
port’s Egress PVC and Untagged PVC.
to submit your settings or click on
4. Click on
to close the
VLAN Configuration window.
Table 4-4 VLAN Configuration Field Definitions
Field
Definition
VLAN ID
VLAN Name
Egress PVC
Untagged PVC
6.6.2
The VLAN id for this VLAN. In devices supporting "Shared
Vlan for multicast" capability, the information for a multicast
mac addr is shared across vlans hence vlan id is an
optional parameter. In devices supporting "Independent
Vlan for multicast" capability each vlan can have its own
information for a multicast mac addr hence vlanid is a
mandatory parameter in all the commands other than - get.
For No Vlan case vlan id is not required.
Name of the VLAN
The set of ports, which are permanently assigned to the
egress list for this VLAN by management.
The set of ports, which should transmit egress packets for
this VLAN, as untagged.
Ethernet Configuration
Allow user to view and modify Etherent configuration. To view or configure
Ethernet, proceed as follows:
1. Double Click on “Ethernet configuration” from the Function List Window. The
60
Application Note
Ethernet Configuration window appears.
2. To view the Ethernet Configuration of UPLINK1, UPLINK2, or UPLINK3 by
using the Slect Ethernet drop-down list.
3. If to modify the Ethernet Configuration, click on
first and then
proceed advanced configurations as shown in the following figure.
4. If to create a new Ethernet configuration, click on
and then select a
new Ethernet configuration by using Slect Ethernet drop-down list. After that,
users can set related peremeters as follows:
61
Application Note
5. Click on
to submit your settings or click on
to close the
Ethernet Configuration window.
Table 4-5 Ethernet Configuration Field Definitions
Field
DHCP
Type
Admin Status
Operation Status
IP address
Mask
Gateway
Mgmt Vlan Index
6.6.3
Definition
DHCP client enabled or disabled
Upstream or downstream
The desired state of UPLINK (enable/disable)
System is enabled or not.
IP address of the UPLINK
This specifies the network mask configured for the
UPLINK.
Gateway IP
VLAN for management traffic on this interface.
Nonzero value of this field is valid only if either 'ip'
field is non-zero or 'usedhcp' field is true. If no
Management Vlanid is specified (in the create
operation) or its value is set to zero (either in create
or modify operation) then the system shall use the
value of 'portvlanid' associated with the bridge port
created on this interface as the Management Vlan
Index. In case the management vlan (i.e.
'mgmtvlanid' or the associated 'portvlanid', if
'mgmtvlanid' is zero) doesn't exist on the system
then management shall not happen on this interface
till the corresponding VLAN is created with the Net
side port as its member.
Static Multicast Configuration
Allow user to view and modify Static Multicast configuration. To view or modify
Static Multicast configuration, proceed as follows:
1. Double Click on “Ethernet configuration” from the Function List Window. The
Static Multicast Configuration window appears.
62
Application Note
2. Select the VLAN ID to view or modify by using the VLAN ID drop-down list.
3. Use Egress PVC and Forbidden Egress PVC drop-down list to set the specified
DSL port’s Egress PVC and Forbidden Egress PVC.
to submit your settings or click on
4. Click on
to close the
VLAN Configuration window.
Table 4-6 VLAN Configuration Field Definitions
Field
Definition
VLAN ID
The VLAN id for this VLAN. In devices supporting "Shared
Vlan for multicast" capability, the information for a multicast
mac addr is shared across vlans hence vlan id is an
optional parameter. In devices supporting "Independent
Vlan for multicast" capability each vlan can have its own
information for a multicast mac addr hence vlanid is a
mandatory parameter in all the commands other than - get.
For No Vlan case vlan id is not required.
Multicast address
A multicast address is an address that designates a
group of entities within a domain.
Egress PVC
The set of ports, which are permanently assigned to the
egress list for this VLAN by managemen.
Forbidden Egress PVC The set of ports, which should transmit egress packets for
this VLAN, as untagged.
6.6.4
IGMP Snooping
IGMP snooping, as implied by the name, is a feature that allows an IP DSLAM to
"listen in" on the IGMP conversation between hosts and routers. To set IGMP
63
Application Note
Snooping status as Disabled or Enable, the procedure is as follows:
1. Choose a specified port to execute IGMP snooping function.
2. Double click on IGMP Configuration via Function window. Then the IGMP
Configuration window appears as follows:
Select Disabled or Enabled, and then click
6.6.5
to submit your setting.
SNTP Configuration
Allow you to view the SNTP client status and execute advanced configuration.
The procedure shows as follows:
1. Choose a specified port to execute SNTP configuration function.
2. Double click on SNTP configuration via Function window. Then the SNTP
configuration window appears as follows:
3. If to enable or disable current SNTP client, click on
64
.
Application Note
4. If to create a new SNTP client, click on
and then set SNTP Server
address and SNTP client status. After that, click on
to submit your
setting.
5. If to delete a certain SNTP client, select the SNTP server from the SNTP
server address drop-down list and then set the SNTP client status as Disable.
Finnaly, click on
to close the SNTP Configuration window.
6. Click on
6.7
.
DSL
This section describes how to configure DSL settings by selecting DSL from
Function List window. This section will cover those functions:
6.7.1
Profile Configuration
Allow users to configure Line Profile and alarm profile.
6.7.1.1
Line Profile Configuration
If to configure Line Profile, proceed as follows.
1. Double Click on “Line Profile configuration” from the Function List Window.
The Line Profile configuration window appears.
65
Application Note
To creat up a new line profile, click the DSL Name drop-down list and then select
the blank.
After that, the fields become enable. Input the values in those fields and then
name the new line profile.
Click on
to submit your setting or click on
to deliete a line
profile.
Table 4-7 Line Profile Field Definitions
Field
Line Type
Transmit Rate Adaption
Target SNR (dB/10)
Min Tx Rate(bps)
Down Shift SNR (dB/10)
IntCorrectionUP
66
Definition
The ADSL line type, Fast or Interleaved
Defines what form of transmitting rate to be
adaptated, fixed or adaptAtStartup
Target Signal / Noise Margin.(0-310)
The minimum transmitting rate of ATU-C side
or ATU-R side.
Configured Signal/ Noise Margin for rate
downshift. If the noise margin falls below this
level, the modem should attempt to decrease
its transmit rate. In the case that RADSL mode
is not present, the value will be 0.
Sets the correction time for the upstream
Application Note
Preferred Standard
Maximum Transmit Rate
Interleave Delay (ms)
UP Shift SNR (dB/10)
IntCorrectionDown
Annex Type
6.7.1.2
interleaved buffer. RS can also be disabled.
Value:125us | 250us | 500us |1ms | 2ms |
4ms | disable
Preferred standard compliance. Outcome is
dependent
upon standard support of the remote
unit.GlobespanVirata High Speed ADSL DMT
(ADSL+) applications only
Value: t1413 |gLite | gDmt | alctl14
|multimode | adi | alctl
|t1413Auto|adslPlus|GspanPlus
The maximum transmitting rate of ATU-C side
or ATU-R side.
The value of Interleave Delay for this channel.
Configured Signal/ Noise Margin for rate
upshift. If the noise margin rises above this
level, the modem should attempt to increase
its transmit rate. In the case that RADSL is not
present, the value will be 0.
This parameter sets the correction time for the
downstream interleaved buffer. RS can also
be disabled.
This parameter is set as per Annex
compliance of the code release.
GlobespanVirata High Speed ADSL DMT
(ADSL+) applications only.
Alarm Profile Configuration
If to configure Alarm Profile, proceed as follows.
1. Double Click on “Alarm Profile Configuration” from the Function List Window.
The Alarm Profile Configuration window appears.
2. To creat a new alarm profile, click the DSL Name drop-down list and then
select the blank.
67
Application Note
3. After that, the fields become enable. Input the values in those fields and then
name the new alarm profile.
to submit your setting or click on
4. Click on
to deliete a alarm
profile.
Table 4-8 Alarm Profile Field Definitions
Field
Loss of frame within 15
minutes
Loss of signal within 15
minutes
Loss of link within 15
minutes
Loss of power within 15
minutes
Errored seconds
6.7.2
Definition
The threshold of the number of “Loss of Frame
Seconds” within 15 minutes performance data
collection period.
The threshold of the number of “Loss of Signal
Seconds” within 15 minutes performance data
collection period.
The threshold of the number of “Loss of Link
Seconds” within 15 minutes performance data
collection period. (But only ATU-C side)
The threshold of the number of “Loss of Power
Seconds” within 15 minutes performance data
collection period.
The threshold of the number of “Errored Seconds”
within 15 minutes performance data collection
period.
Port Configuration
Allow users to proceed port configuration. The procedures are as follows:
1. Double Click on “Port Configuration” from the Function List Window. The Port
Configuration window appears.
2. Choose the port to configure from the DSL Port drop-down list.
3. Configure the Administration status as “Up” or “Down”.
4. Choose a Line Profile from the Line Profile Name drop-down list. If to configure
a Line Profile, Click on
68
to activate the Line Profile Configuration window.
Application Note
5. Choose an Alarm Profile from the Alarm Profile Name drop-down list. If to
configure an Alarm Profile, Click on
to activate the Alarm Profile Configuration
window.
If necessary, modify values of a specified PVC, including VPI, VCI, Admin Status,
Learning Status, Sticky Status, Pvid, Accepted Frame Type and Ingress Filter,
and prioriy.
6. Click on
to submit your settings or click on
to close the
fmBridgeport window.
7. If to create new PVC, click on
and then PVC2 appears and then
users can set peremeters via PVC2. after that, click on
to submit your
setting.
Table 4-9 Port Configuration Field Definitions
Field
DSL Port
VPI
VCI
Learning Status
Sticky Status
Pvid
Accepted Frame Type
69
Definition
Port No. of the ADSL2/2+ IP DSLAM
Virtual Path Identifier
Virtual Channel Identifier
The state of learning on this bridge port. The value
enable (1) indicates that unicast Mac address
learning is enabled and the value disable indicates
that unicast Mac address learning is disabled on this
bridge port.
Indicates if the port has been set as sticky. The value
enable (1) indicates that the entries learned on this
port will not be aged out. It also indicates that the
entries learned on this port shall not be learned on
any other port. The entries learned on this port can
only be removed by management action or by
making the value as disable (2), so that the entries
can be aged out.
Port VID
Used to up/down connection.
Application Note
Ingress Filter
When this is true, the device will discard incoming
frames for VLANs, which do not include this Port in
its Member set. When false, the port will accept all
incoming frames.
Optional Connection priority. No VLAN tag, no
priority.
Priority
6.8
DSL Performance Management
This section describes how to ultilize DSL Performance Management by selecting
DSL Performance Management from Function List window. This section will
cover those functions:
6.8.1
Physical Layer Info
Allow users to view the physical layer information of a specified DSL port from the
ADSL2/2+ IP DSLAM. The procedures are as follows:
Double Click on “Physical Layer Info” from the Function List Window. The
Physical Layer Info window appears.
Select the port ID from the DSL Port drop-down list to view a specified DSL’s
physical Layer Info.
to close the window.
Click on
Table 4-10 Physical Layer Info Field Definitions
Field
SNR margin
70
Definition
Noise margin value. (dB)
Application Note
Attenuation
Status
output power
attainable rate
ActualStandard
Bert Error
TxAtm CellCt
RxAtm CellCt
Start Progress
Idle Bert Error
Idle Bert Cells
Bert Sync
Select Information Valid
Select Loop Length
Select Loop End
Select Loop Gauge
6.8.2
Difference in the total power transmitted and the total
power received by the peer atu. (db)
Current status of the ATU line. The possible values
displayed are as follows:
No defect: there are no defect on the line
los: atu-r failure due to not receiving signal
lpr: atu-r failure due to loss of signal
Total output power transmitted by atu. (dBm)
The maximum currently attainable data rate by the
atu. (kbps)
Actual standard used for connection, based on the
outcome of the negotiation with the Remote Unit.
Provides the number of bit errors detected during
BERT.
Provides Tx ATM cell counter.
Provides Rx ATM cell counter.
Defines the current detailed start up state of Xcvr.
0x0 – startup not in progress; 0x0 – 0x0FFF
Handshake/Training/ Profile Management/ Fast
Retrain in progress; 0x8000 – 0x8FFF DSP firmware
Down- Load in progress; 0xF000 – 0xFFFF illegal
Parameter
Number of bit errors.
Number of idle cells.
Indicates whether the Signal is in Sync or not.
Indicates the information validity for the SELT
operation conducted on the Xcvr.
Indicates the LOOP Length in Feet once when the
SELT information is valid on the Xcvr.
Indicates whether the loop is short or open once
when the SELT information is valid on the Xcvr.
Indicates the LOOP wire gauge information once,
when the SELT information is valid on the Xcvr.
Channel Layer Info
Allow users to view the Channel layer information of a specified DSL port from the
ADSL2/2+ IP DSLAM. The procedures are as follows:
Double Click on “Channel Layer Info” from the Function List Window. The
Channel Layer Info window appears.
71
Application Note
Select the port ID from the DSL Port drop-down listo view a specified DSL’s
channel Layer Info.
to close the window.
Click on
Table 4-11 Channel Layer Information Field Definitions
Field
Interleave delay
Previous TX rate
Current TX rate
CRC block length
Current Atm Status
Rs Symbols
Rs Depth
Rs Redundency
6.8.3
Definition
Interleave delay for this channel. (milli-seconds)
Previous actual transmit rate on this channel if ADSL
loop retain. (kbps)
Actual transmit rate on this channel. (kbps)
The length of the channel data-block on which the
CRC operates.
Indicates the current ATM Status.
Indicates the number of DMT symbols per ReedSolomon code word (S), in the downstream direction.
Indicates interleaving depth (D), in the downstream
direction.
Indicates the number of redundant bytes (R), per
Reed-Solomon code in the downstream direction
Physical Layer PM
Allow users to view the Pysical layer performance of a specified DSL port from
the ADSL2/2+ IP DSLAM. The procedures are as follows:
Double Click on “Pysical Layer PM” from the Function List Window. The Physical
Layer PM window appears.
72
Application Note
Press Co or RT tab to view the Pysical Layer Performance data at down stream
or up stream.
Click on Current to activated Current page in which users can select Port No. to
view 15 minutes and 1 Day ES, SES and UAS record. If to retrieve the latest data,
press
.
Click on Previous to activate previous 15 minutes and 1 day performance data
page in which Period and Port No. are selectable. Note: refresh button is disable
in this page.
73
Application Note
Click on
to clear the physical layer data.
Click on
to close the window.
Table 4-12 Current Phy-Layer PM Information Field Definitions
Field
Definition
CO
RT
Lofs
Loss
Lols
Lprs
Ess
Inits
Current 15-min lofs
Current 15-min loss
Current 15-min lols
Current 15-min lprs
Current 15-min ess
Current 15-min inits
Current 1-day time
elapsed
Current 1-day lofs
Current 1-day loss
Current 1-day lols
Current 1-day lprs
Current 1-day ess
6.8.4
down stream
up stream
Number of lof failures since reset.
Number of los failures since reset.
Number of lol failures since reset.
Number of lpr failures since reset.
Number of error seconds since reset.
Number of initialization attempts since reset. It
includes both successful and failed attempts.
Number of seconds in the current 15-minute
interval during which lof was detected.
Number of seconds in the current 15-minute
interval during which los was detected.
Number of seconds in the current 15-minute
interval during which lol was detected.
Number of seconds in the current 15-minute
interval during which lpr was detected.
Number of error seconds in the current 15minute interval.
Number of inits in the current 15-minute
interval. It includes both successful and failed
attempts.
Number of seconds that have elapsed since
the beginning of the current 1-day interval.
Number of seconds in the current 1 day
interval during which lof was detected.
Number of seconds in the current 1 day
interval during which los was detected.
Number of seconds in the current 1 day
interval during which lol was detected.
Number of seconds in the current 1 day
interval during which lpr was detected.
Number of error seconds in the current 1 day
interval.
Channel Layer PM
Allow users to view the Channellayer performance of a specified DSL port from
the ADSL2/2+ IP DSLAM. The procedures are as follows:
Double Click on “Channel Layer PM” from the Function List Window. The
Channel Layer PM window appears.
74
Application Note
Press Co or RT tab to view the Channel Layer Performance data at down stream
or up stream.
Click on Current to activated Current page in which users can select Port No. to
view 15 minutes and 1 Day ES, SES and UAS record. If to retrieve the latest data,
press
.
Click on Previous to activate previous 15 minutes and 1 day performance data
page in which Period and Port No. are selectable. Note: refresh button is disable
in this page.
75
Application Note
Click on
to clear the channel layer data.
Click on
to close the window.
Table 4-13 Current Channel-Layer PM Information Field Definitions
Field
CO
RT
Received blocks
Definition
down stream
up stream
The total number of blocks of data received since the
last agent reset.
Transmitted blocks
The total number of blocks of data transmitted since
the last agent reset.
Corrected blocks
Number of corrected blocks of data transmitted since
the last agent reset.
Uncorrected blocks
Number of corrected blocks of data transmitted since
the last agent reset.
Current 15-min received Number of blocks of data received during the current
blocks
15-minute interval.
Current 15-min
Number of blocks of data transmitted during the
Transmitted blocks
current 15-minute interval.
Current 15-min corrected Number of corrected blocks of data transmitted during
blocks
the current 15-minute interval.
Current 15-min
Number of uncorrected blocks of data transmitted
Uncorrected blocks
during the current 15-minute interval.
current 1-day time
Number of seconds that have elapsed since the start
elapsed
of the current day interval.
Current 1-day received
Number of blocks of data received during the current
blocks
day interval.
Current 1-day transmitted Number of blocks of data transmitted during the
blocks
current day interval.
Current 1-day corrected Number of corrected blocks of data transmitted during
blocks
the current day interval.
Current 1-day uncorrected Number of uncorrected blocks of data transmitted
blocks
during the current day interval.
76
Application Note
7
Application Note
7.1
Basic Configuration
IPLM1/2 ADSL2/2+ IP DSLAM provide multiple services to users
according to the demand of application scenarios. To reduce time
consuming in deployment, this document provides simple and easy
configuration procedure according different applications.
7.1.1
Create a new user
Users can create a root user whose user name and password are
“admin” as follow:
$create user name admin passwd admin root
Entry Created
Privilege
UserName
----------------------------------admin
admin
Verbose Mode Off
Entry Created
Refer to 8.25.3.1 for detailed information.
7.1.2
FD.cfg Configuration
Fd.cfg is a useful tool that contains a set of default configuration
commands for IPLM. Using FD.cfg, you can
• restore the default configuration
• modify FD.cfg
• uploade FD.cfg
• create new services
7.1.2.1
Contents of FD.cfg
Use WordPad or Word to open FD.cfg. (See the following figure)
77
Application Note
The default configuration in FD.cfg summarized as follows:
• Default IP: 192.168.100.111
• SNTP: disable
• RFC-1483 Bridge mode only
• One PVC (8/81) for each ADSL port
• Bridge port numbering 1 to 48 mapping to PVC 8/81 for ADSL
port1 to port 48/24
• VLAN feature Disable
• Eth0 enable (for uplink), its bridge port number is 385
• Eth1 disable (for downlink)
• MGMT interface disable
To view the detailed contents, please refer to the
appendix1.
7.1.2.2
Download procedure
This section describes how to upload FD.cfg to IPLM by tftp server.
The configuration procedure is shown as follows:
Step1. Prepare FD.cfg and tftp server (Including file_id.diz,
tftpd32.exe;TFTPD32.HLP and uninst.exe)
Step2. Put the “FD.cfg” and “tftpd32” at the same folder on your PC.
Step3. Activate tftpd32 and then tftp32 window appears (see the
following figure)
78
Application Note
Step4. Click on
located.
to set the current directory where fd.cfg
Step5. Click Sever interface drop-down list to select the DHCP
Server ‘s IP.
Step6. Assign an IP pool starting address.
Step7. Rename the boot file as FD.cfg
Step8. Input the mask
Step9. Save the configuration.
79
Application Note
Step10. If needed, click the settings button to re-configure your
setting.
Step11. Activate Telnet and login IPLM.
Step12. Input ‘list’ to show the path and s/w information
$list
Name
Size
Ver
Acc
Time
State
----------------------------------------------------------------------------------------------------------------/nvram/bin/bootptftp/
TftpBootp.bin
111064
RO active
1
Wed Jun 30 14:12:36 2004
/nvram/bin/control/
CP.bin.gz
1280744
RW
1
Wed Jun 30 14:12:36 2004
1
Wed Jun 30 14:12:36 2004
active
/nvram/bin/dataplane/
DP.bin.gz
231572
RW
active
/nvram/bin/decompressor/
Decompressor.bin
RO active
1
Wed Jun 30 14:12:36 2004
81928
/nvram/bin/dslphy/
gsv_dsl_AD_DM_3C00000C.bin.gz
155220
RW active
/nvram/cfg/factorydef/
FD.cfg
19136
RW active
1
Wed Jun 30 14:12:36 2004
1
Wed Jun 30 14:12:36 2004
Step13. Input ‘remove fname /nvram/cfg/factorydef/FD.cfg version
1’ to remove the obsolete FD.cfg file.
$remove fname /nvram/cfg/factorydef/FD.cfg version 1
FLASH program starts at ADDR 20008
File Removed
$
Step14. Input ‘download src FD.cfg dest
/nvram/cfg/factorydef/FD.cfg ip 192.168.100.66’ to download config
file “fd.cfg” from Server PC to IPLM.
The file name to download could be different from FD.cfg
but do not change the path. dest
/nvram/cfg/factorydef/FD.cfg is the path of firmware file
located on IPLM
80
Application Note
$download src FD.cfg dest /nvram/cfg/factorydef/FD.cfg ip
192.168.100.66
Downloading the File...
......................................
Block 1 erase in progress
........Flash block 1 erase successful...
FLASH program starts at ADDR 20000
###############
Step15. Input ‘upgrade fname /nvram/cfg/factorydef/FD.cfg’ to
upgrade and activate the access state.
$upgrade fname /nvram/cfg/factorydef/FD.cfg version 2
FLASH program starts at ADDR 2000c
Step16. Input ‘commit’ to store your new configuration before
rebooting.
$commit
Step17. Input ‘reboot config default’ to let your new configuration
take effect
$reboot config default
81
Application Note
7.1.3
How to create myconfig.cfg
• Myconfig.cfg is a txt file that ensures all commands be
executed at once.
• 6.1.3.3 shows the format of myconfig.cfg.
• If there are many configurations you would like to
execute then you can write all commands into
myconfig.cfg and then execute it at once.
• Be note to save ($commit) to IPAM if this would be
executed after reboot
• Required of equipment: TFTP Server (Tftpd32)
7.1.3.1
Step
Image
TFTP Server configuration
Usage
1. Click “Browse” bottom to indicate current directory of
firmware.
2. Click down-arrow bottom to indicate IP of DHCP
Server.
3. Assign starting address for IP pool.
1
4. Input subnet mask
5. Save input parameters.
6. Press “Setting” bottom to configure more details
(option)
7. After assigned this parameter and reboot Tftpd32 that
“Current Directory” at previous step will follow it.
2
82
Application Note
7.1.3.2
myconfig.cfg configuration
Step
1
Image
Usage
1. Enable TFTP Server and direct the
myconfig.cfg path for it.
Enable TFTP server (tftpd32)
2.
$list
Name
Acc State
Ver
Time
Size
List the table and verify
myconfig.cfg had not created.
that
-----------------------------------------------------------------------------/nvram/bin/bootptftp/
TftpBootp.bin
111064
RO active
1
Fri Oct 08 09:46:22 2004
1
Fri Oct 08 09:46:22 2004
1
Fri Oct 08 09:46:22 2004
1
Fri Oct 08 09:46:22 2004
gsv_dsl_AD_DM_3C00000C.bin.gz1
155220
RW active
Fri Oct 08 09:46:22 2004
/nvram/bin/control/
CP.bin.gz
1293028
RW
2
active
/nvram/bin/dataplane/
DP.bin.gz
231572
RW
active
/nvram/bin/decompressor/
Decompressor.bin
RO active
81928
/nvram/bin/dslphy/
/nvram/cfg/factorydef/
FD.cfg
RW active
1
Fri Oct 08 09:46:22 2004
18973
$download src myconfig.cfg dest /nvram/user/myconfig.cfg ip
192.168.100.188
Downloading the File...
3. Download myconfig.cfg to NVRAM.
4. 192.168.100.188 is the PC of TFTP
Server..
....................................
Block 30 erase in progress
........Flash block 30 erase successful...
3
FLASH program starts at ADDR 3c0000
###############
FLASH program starts at ADDR 3c0000
Download session Completed,Bytes received 18180...
$
$apply fname /nvram/user/myconfig.cfg
5. Apply to execute the commands step
by step.
$create atm vc intf ifname aal5-71 lowif atm-23 vpi 8 vci 82
Entry Created
$create eoa intf ifname eoa-71 lowif aal5-71
:
:
4
$create atm vc intf ifname aal5-145 lowif atm-47 vpi 8 vci 83
Entry Created
$create eoa intf ifname eoa-145 lowif aal5-145
Entry Created
$create bridge port intf ifname eoa-145 portid 146 learning
enable status enable
Entry Created
$
$commit
5
6. If this myconfig.cfg will be running after
7. It will be disappear after “reboot config
default”.
83
Application Note
7.1.3.3
Format of myconfig.cfg
verbose off
create atm vc intf ifname aal5-48 lowif atm-0 vpi 8 vci 82
create eoa intf ifname eoa-48 lowif aal5-48
create bridge port intf ifname eoa-48 portid 49 learning enable status enable
create atm vc intf ifname aal5-49 lowif atm-1 vpi 8 vci 82
create eoa intf ifname eoa-49 lowif aal5-49
create bridge port intf ifname eoa-49 portid 50 learning enable status enable
:
:
create atm vc intf ifname aal5-94 lowif atm-46 vpi 8 vci 82
create eoa intf ifname eoa-94 lowif aal5-94
create bridge port intf ifname eoa-94 portid 95 learning enable status enable
create atm vc intf ifname aal5-95 lowif atm-47 vpi 8 vci 82
create eoa intf ifname eoa-95 lowif aal5-95
create bridge port intf ifname eoa-95 portid 96 learning enable status enable
create atm vc intf ifname aal5-96 lowif atm-0 vpi 8 vci 83
create eoa intf ifname eoa-96 lowif aal5-96
create bridge port intf ifname eoa-96 portid 97 learning enable status enable
create atm vc intf ifname aal5-97 lowif atm-1 vpi 8 vci 83
create eoa intf ifname eoa-97 lowif aal5-97
create bridge port intf ifname eoa-97 portid 98 learning enable status enable
:
:
create atm vc intf ifname aal5-145 lowif atm-47 vpi 8 vci 83
create eoa intf ifname eoa-145 lowif aal5-145
create bridge port intf ifname eoa-145 portid 146 learning enable status enable
84
Application Note
7.1.4
Line Rate Configuration
This section describes how to configure the transmission
rate manually via CLI. Before configuration, following
1. Input the line rate by using hexadecimal values.following
tables shows the hexadecimal values that are frequently
used.
Hexadecimal
0x1f38300
0x177000
0x109a00
0x7d000
0x1f400
0xfa00
0x7d00
Decimal
32M
1.5M
1M
512K
128K
64K
32K
2. Be noted that GsStandard, GsTxPowerAtten and
GsAnnexType must be modified at the same time.
3. frequesntly used commands are listed below for your
reference:
– aturintlmaxtxrate 0x7d000 atucgsannextype adsl2
atucgsstandard adsl2plus atucgstxpoweratten 0
atucmaxintldelay 1
– atucfastmintxrate 0xfa00 aturfastmintxrate 0x7d00
atucgsannextype annexa atucgsstandard glite
atucgstxpoweratten 0 type fastonly atucrateadaptation
fixed
7.1.4.1
ATUC
RATE
Fixed/ Adaptive
ATUR
Fixed/ Adaptive
type
Interleaved / fast
only
Interleaved / fast
only
Standard
Adsl2+ / G.dmt /
G.lite / T1.413
Adsl2+ / G.dmt /
G.lite / T1.413
Annex type
Adsl2 / annex A
Adsl2 / annex A
Configuration
Step1: disable the DSL port that you want to re-configure its
transmission rate.
$modify adsl line intf ifname dsl-0 disable
IfName
: dsl-0
Line Type
: interleavedOnly
Coding Type
: 0
GsUtopia L2RxAddr : 0
Gs Clock Type
: oscillator
Gs Action
: startup
Admin Status
: Up
Oper Status
: Down
GsUtopia
L2TxAddr
: dmt
Trans Atuc Cap
: ansit1413 q9921PotsNonOverlapped
q9921PotsOverlapped q9921IsdnNonOverlapped q9921isdnOverlapped
q9922potsOverlapped q9923Readsl2PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9925Adsl2PlusPotsOverlapped q9923Adsl2P
otsNonOverlapped
Trans Atuc Actual
: -
Trans Atuc Config
: q9921PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9923Adsl2PotsNonOverlapped
GsDmtTrellis
: trellisOn
Trans Atur Cap
: ansit1413
q9921PotsOverlapped
q9923Readsl2PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlappedq9925Adsl2PlusPotsOverlapped
q9923Adsl2PotsNonOverlapped
PM Conf PMSF
: -
Line DELT Conf LDSF : inhibit
Set Done
IfName
: dsl-0
Line Type
GsUtopia
L2TxAddr
Gs Clock Type
85
: interleavedOnly
Coding Type
: 0
GsUtopia L2RxAddr : 0
: dmt
: oscillator
Gs Action
: startup
Application Note
Admin Status
: Down
Oper Status
: Down
Trans Atuc Cap
: ansit1413 q9921PotsNonOverlapped
q9921PotsOverlapped q9921IsdnNonOverlapped q9921isdnOverlapped
q9922potsOverlapped q9923Readsl2PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9925Adsl2PlusPotsOverlapped q9923Adsl2P
otsNonOverlapped
Trans Atuc Actual
: -
Trans Atuc Config
: q9921PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9923Adsl2PotsNonOverlapped
GsDmtTrellis
: trellisOn
Trans Atur Cap
: -
PM Conf PMSF
: -
Line DELT Conf LDSF : inhibit
$
Thu Jan 01 00:01:49 1970 : STATUS ALARM : ADSL ATUC Up : Interface dsl-1
Step 2: set the line rate you need.
$modify adsl line profile ifname dsl-0 atucintlmaxtxrate 0x177000
aturintlmaxtxrate 0x7d000 atucgsannextype annexa atucgsstandard glite
atucgstxpoweratten 0 atucmaxintldelay 1
IfName
: dsl-0
ADSL ATUC Configuration :
---------------------------
86
Rate Adaptation
: adaptAtStartup
Target Snr Margin(dB/10)
310
: 60
Max Snr Margin(dB/10)
:
GsRsIntCorrectionUp
0
: 125us
Dnshift SnrMargin(dB/10)
:
Upshift SnrMargin(dB/10)
0
: 120
Min Upshift Time(sec)
:
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x1f38300
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
63
: 0x1f38300
Max Intl Delay(ms)
:
GsTxStartBin
0x1ff
: 0x6
GsTxEndBin
:
GsRxStartBin
0x1f
: 0x6
GsRxEndBin
:
GsMaxBitsPerBin
256
: 15
GsMaxDCo
:
GsRxBinAdjust
Disable
: Disable
GsEraseProfiles
:
GsAdi2x
adsl2PlusAuto
: standard
GsStandard
:
GsInitiate
0
: -
GsTxPowerAtten
:
GsCodingGain
Disable
: Auto
GsRsFastOvrhdDown
:
GsRsIntCorrectionDown
Disable
: 1Ms
GsRsFastOvrhdUp
:
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsFastRetrain
:
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: adsl2
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
:
GsPsdMaskType
ecMode
: Adsl2NonovlpFlatDmtConfMode
:
Application Note
GsExtRsMemory
0x2
: notpresent
ParamHybridLossTestStart
:
GsParamHybridLossTestEnd
on
: 0x40
GsDmtTrellis
:
GsAdvertisedCapabilities
: AnnexA
GslTriggerMode
: Disable
Type
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFF
ParametricTestInputFile
: -
Data Boost
Standard
: Enable
Conf PM Mode
:
Conf PML0 Time(sec)
: 180
Conf PML2 Time(sec)
30
: 60
Conf PML2 Min Rate(bps)
: 0xfa000
MSG Min Ds
0
: 4000
FrontEnd H/W Design
: El1508
H/W Pwr Reduction
: Disable
GsUsBitSwap
InpAuto
: Enable
Minimum INP
:
PML2 Entry Thresh Rate
0x7d000
: 0x3e800
PML2 Exit Thresh Rate
:
PML2 Entry Rate Min Time
: 1800
Upstream PSD
:
Conf PML2 ATPR (dB/10)
:
Minimum Snr Margin(dB/10) :
ADSL ATUR Configuration :
--------------------------Target Snr Margin(dB/10)
30
: 60
Dnshift SnrMargin(dB/10)
:
Upshift SnrMargin(dB/10)
30
: 90
Min Upshift Time(sec)
:
Min Dnshift Time(sec)
0x7d00
: 30
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
16
: 0x109a00
Max Intl Delay(ms)
:
MSG Min Us
310
: 4000
Minimum Snr Margin(dB/10) :
Maximum Snr Margin(dB/10) : 310
________________________________________________________________________
Set Done
IfName
: dsl-0
ADSL ATUC Configuration :
---------------------------
87
Rate Adaptation
: adaptAtStartup
Target Snr Margin(dB/10)
310
: 60
Max Snr Margin(dB/10)
:
GsRsIntCorrectionUp
0
: 125us
Dnshift SnrMargin(dB/10)
:
Upshift SnrMargin(dB/10)
0
: 120
Min Upshift Time(sec)
:
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x1f38300
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
1
: 0x177000
Max Intl Delay(ms)
:
GsTxStartBin
0x1ff
: 0x6
GsTxEndBin
:
Application Note
GsRxStartBin
0x1f
: 0x6
GsRxEndBin
:
GsMaxBitsPerBin
256
: 15
GsMaxDCo
:
GsRxBinAdjust
Disable
: Disable
GsEraseProfiles
:
GsAdi2x
gLite
: standard
GsStandard
:
GsInitiate
0
: -
GsTxPowerAtten
:
GsCodingGain
Disable
: Auto
GsRsFastOvrhdDown
:
GsRsIntCorrectionDown
Disable
: 1Ms
GsRsFastOvrhdUp
:
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsFastRetrain
:
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: AnnexA
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
:
GsPsdMaskType
ecMode
: Adsl2NonovlpFlatDmtConfMode
:
GsExtRsMemory
0x2
: notpresent
ParamHybridLossTestStart
:
GsParamHybridLossTestEnd
on
: 0x40
GsDmtTrellis
:
GsAdvertisedCapabilities
: AnnexA
GslTriggerMode
: Disable
Type
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFF
ParametricTestInputFile
: -
Data Boost
Standard
: Enable
Conf PM Mode
:
Conf PML0 Time(sec)
: 180
Conf PML2 Time(sec)
30
: 60
Conf PML2 Min Rate(bps)
: 0xfa000
MSG Min Ds
0
: 4000
FrontEnd H/W Design
: El1508
H/W Pwr Reduction
: Disable
GsUsBitSwap
InpAuto
: Enable
Minimum INP
:
PML2 Entry Thresh Rate
0x7d000
: 0x3e800
PML2 Exit Thresh Rate
:
PML2 Entry Rate Min Time
: 1800
Upstream PSD
:
Conf PML2 ATPR (dB/10)
:
Minimum Snr Margin(dB/10) :
ADSL ATUR Configuration :
---------------------------
88
Target Snr Margin(dB/10)
30
: 60
Dnshift SnrMargin(dB/10)
:
Upshift SnrMargin(dB/10)
30
: 90
Min Upshift Time(sec)
:
Min Dnshift Time(sec)
0x7d00
: 30
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Application Note
Intl Max Tx Rate(bps)
16
: 0x7d000
Max Intl Delay(ms)
:
MSG Min Us
310
: 4000
Minimum Snr Margin(dB/10) :
Maximum Snr Margin(dB/10) : 310
Step3: enable the port
$modify adsl line intf ifname dsl-0 enable
IfName
: dsl-0
Line Type
: interleavedOnly
Coding Type
: 0
GsUtopia L2RxAddr : 0
Gs Clock Type
: oscillator
Gs Action
: startup
Admin Status
: Down
Oper Status
: Down
GsUtopia
L2TxAddr
: dmt
Trans Atuc Cap
: ansit1413 q9921PotsNonOverlapped
q9921PotsOverlapped q9921IsdnNonOverlapped q9921isdnOverlapped
q9922potsOverlapped q9923Readsl2PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9925Adsl2PlusPotsOverlapped q9923Adsl2P
otsNonOverlapped
Trans Atuc Actual
: -
Trans Atuc Config
: q9921PotsNonOverlapped
q9925Adsl2PlusPotsOverlapped
GsDmtTrellis
: trellisOn
Trans Atur Cap
: -
PM Conf PMSF
: -
Line DELT Conf LDSF : inhibit
Set Done
IfName
: dsl-0
Line Type
: interleavedOnly
Coding Type
: 0
GsUtopia L2RxAddr : 0
Gs Clock Type
: oscillator
Gs Action
: startup
Admin Status
: Up
Oper Status
: Down
GsUtopia
L2TxAddr
: dmt
Trans Atuc Cap
: ansit1413 q9921PotsNonOverlapped
q9921PotsOverlapped q9921IsdnNonOverlapped q9921isdnOverlapped
q9922potsOverlapped q9923Readsl2PotsNonOverlapped
q9925Adsl2PlusPotsNonOverlapped q9925Adsl2PlusPotsOverlapped q9923Adsl2P
otsNonOverlapped
Trans Atuc Actual
: -
Trans Atuc Config
: q9921PotsNonOverlapped
q9925Adsl2PlusPotsOverlapped
GsDmtTrellis
: trellisOff
Trans Atur Cap
: -
PM Conf PMSF
: -
Line DELT Conf LDSF : inhibit
89
Application Note
7.1.5
Set System Time
IPLM supports SNTP (Simple Network Time Protocol), used
to synchronize its clocks in the Internet.IPLM will get the
system time via SNTP server while a SNTP sever is created.
7.1.5.1
Scenario
Ethernet
DSL
Ethernet
CPE
IPLM
PC 1
Internet
NTP/ SNTP Server
7.1.5.2
Configuration
Follow the steps below to set the SNTP server.
System time will lost while the system is powered
off.
Step 1: set the IPLM as the SNTP client
$create sntp?
Command
Description
-------
-----------
servaddr
SNTP Server address
$create sntp servaddr 192.168.100.253
Entry Created
Server Addr : 192.168.100.253 Status : active
Step 2: Enable SNTP client
$modify sntp cfg enable
Status : Disable
Set Done
Status : Enable
$
Step 3: confirm the status of SNTP client
$get sntp stats
Requests count
: 1
Invalid Response count : 0
Response count
: 1
Lost Response count : 0
Last Time Stamp [MM/DD/YYYY::HH:MM:SS] : Thu Apr 29 10:24:36 2004
90
Application Note
Option 2: Set up the system time manually.
Step1: view the system information
$get system info
Description
:
Name
:
Location
:
Contact
:
Vendor
:
LogThreshold
: 0
Object-id
: 1.3.6.1.4.1.3278.1.12
Up Time(HH:MM:SS) : 0:4:46
HwVersion
: ADSL-1.0
CPLDVersion
: 1.4
CPSwVersion
: COL2.6.1.0.040412
CPSwVersion(Build)
: 1.00.040407-ADSL
DPSwVersion
: DP_B02_06_22_05
System Time
: Thu Jan 01 00:04:46 1970
Time Zone
: GMT
DST
: off
Services
: physical datalink internet end-to-end end-to-end
end-to-end applications
$
Step2: get SNTP parameter definitions
$modify system info?
Parameter
Description
---------
-----------
[ contact "<name>" ]
Identification of the contact person
[ name "<name>" ]
Name of the system
[ location "<name>" ]
The physical location of this node
[ vendor "<name>" ]
Vendor-specific information
[ logthresh <decvalue> ]
The severity level of trap
[ systime "<sys-time>" ]
year
SysTime in format mon dd hh:mm:ss
[ dst <on | off> ]
Daylight Saving Time
[ timezone "<timezone>" ]
Time Zone
______________________________________________________________
Valid System Time Zone :
IDLW|NT|HST|CAT|AHST|YST|PST|MST|CST|EST|AST|NFST|
NFT|BRST|AT|WAT|GMT|UTC|WET|CET|FWT|MET|MEWT|SWT|
EET|IST|BT|IT|ZP4|ZP5|INST|ZP6|NST|WAST|SSMT|JT|
CCT|ROK|KST|JST|CAST|EAST|GST|IDLE|NZST|NZT
Step4: set up system time and time zone
$modify system info systime " May 10 10:17:00 2004" timezone "CCT"
Description
:
Name
:
Location
:
Contact
:
Vendor
:
LogThreshold
: 0
Object-id
: 1.3.6.1.4.1.3278.1.12
Up Time(HH:MM:SS) : 0:13:18
91
HwVersion
: ADSL-1.0
CPLDVersion
: 1.4
Application Note
CPSwVersion
: COL2.6.1.0.040412
CPSwVersion(Build): 1.00.040407-ADSL
DPSwVersion
: DP_B02_06_22_05
System Time
: Mon May 10 10:17:23 2004
Time Zone
: GMT
DST
: off
Services
: physical datalink internet end-to-end end-to-end
end-to-end applications
Set Done
Description
:
Name
:
Location
:
Contact
:
Vendor
:
LogThreshold
: 0
Object-id
: 1.3.6.1.4.1.3278.1.12
Up Time(HH:MM:SS) : 0:13:18
HwVersion
: ADSL-1.0
CPLDVersion
: 1.4
CPSwVersion
: COL2.6.1.0.040412
CPSwVersion(Build)
: 1.00.040407-ADSL
DPSwVersion
: DP_B02_06_22_05
System Time
: Mon May 10 10:17:00 2004
Time Zone
: CCT
DST
: off
Services
: physical datalink internet end-to-end end-to-end
end-to-end applications
Refer to SNTP series commands for detailed format
7.1.6
VLAN Configuration
IPLM supports port-based VLAN, and Group VLAN. This
section describes how to create two VLAN groups (VLAN ID
= 2, and 3). ADSL ports 1 & 2 (PVC 8/81) will join in VLAN
group 2, and create new PVC (8/82) for ADSL1, and assign
this PVC to VLAN group 3.
Besides, uplink interface ETH-0 will join VLAN group 2 & 3
as trunk interface.
7.1.6.1
Scenario
7.1.6.2
Configuration
Step 1: Create a VLAN group No.2, and assign to Bridge
port 1(ADSL port 1 PVC 8/81), and 385(Eth-0)
$create vlan static vlanname vlan2 vlanid 2 egressports 1 385
untaggedports 1
Entry Created
VLAN Name
VLAN Index
92
: vlan2
: 2
Application Note
Egress ports
: 1
Forbidden Egress Ports
385
: None
Untagged Ports
: 1
Bridging Mode
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
$
Step 2: Set Bridge port 1(ADSL port 1 PVC 8/81) as PVID 2
$modify gvrp port info portid 1 portvlanid 2 acceptframetypes all
ingressfilteri ng true
Port Id
: 1
Port VLAN Index
: 1
Accept Frame Types: All
Ingress Filtering
: False
Failed Registrations
00:00:00:00:00:00
: 0
Restricted Vlan Registration
Gvrp Status
: Disable
Last Pdu Origin
:
: False
Set Done
Port Id
: 1
Port VLAN Index
: 2
Accept Frame Types: All
Ingress Filtering
: True
Gvrp Status
: Disable
Failed Registrations
00:00:00:00:00:00
: 0
Last Pdu Origin
:
Restricted Vlan Registration
: False
$
Step 3: Show current VLAN status
$get vlan curr info
VLAN Index
: 1
VLAN Status
: Other
Egress ports
9
10
11
12
14
26
17
29
15
27
31
43
16
28
32
33
44
7
45
48
34
14
26
17
29
7
3
4
5
6
7
8
19
20
21
22
23
24
25
35
36
37
38
39
40
41
42
4
15
27
: 1
16
28
32
33
44
48
45
2
18
30
34
3
19
35
46
36
4
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
VLAN Index
: 2
VLAN Status
: permanent
Egress ports
: 1
Untagged Ports
: 1
Bridging Mode
385
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
VLAN Index
: 3
VLAN Status
: permanent
4
20
385
Bridging Mode
93
2
385
13
31
18
30
46
Untagged Ports
10
11
12
43
: 1
13
5
21
37
6
22
38
7
23
39
8
24
40
9
25
41
42
Application Note
Egress ports
: 2
Untagged Ports
: 2
Bridging Mode
385
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
Step 4: Create new PVC (8/82) in ADSL port 1
• Create atm vc and aal5 interface
$create atm vc intf ifname aal5-48 lowif atm-0 vpi 8 vci 82
Entry Created
VC IfName
: aal5-48
VPI
: 8
Admin Status
: Up
Aal5 Tx Size
: 1536
AAL Type
Low IfName
: 82
Oper Status
: Up
Aal5 Rx Size
: AAL5
Channel
: atm-0
VCI
AAL5 Encap
: Interleaved
: 1536
: LLC Mux
Last Change (sec)
MgmtMode
: Data
Row Status
VC Type
: PVC
VC Topology
: 0
: active
: Point to Point
$
• Create eoa interface
$create eoa intf ifname eoa-48 lowif aal5-48
Entry Created
IfName
: eoa-48
FCS
: False
Pkt Type
Oper Status
LowIfName
: aal5-48
: ALL
: Up
Admin Status
: Up
$
Step 4: Create a new bridge port 49, and maps to new
created PVC 8/82 in ADSL port 1
$create bridge port intf ifname eoa-48 portid 49 learning enable status
enable
Entry Created
Port Id
: 49
IfName
Max Unicast Addresses : 16
Learning Status
: eoa-48
: Enable
Port Oper Status
: Enable
Port Admin Status: Enable
Sticky Status
: Disable
FDB Modify
: Enable
Acl Global Deny Apply : Enable
Acl Global Track Apply: Enable
Step 5: Create a new VLAN group No.3, and assign to
Bridge port 49(ADSL port 1 PVC 8/82), and 385(Eth-0)
$create vlan static vlanname vlan3 vlanid 3 egressports 49 385
untaggedports 49
Entry Created
VLAN Name
VLAN Index
Egress ports
Forbidden Egress Ports
: 3
: 49
385
: None
Untagged Ports
: 49
Bridging Mode
: Residential
Flood support Status
94
: vlan3
: enable
Application Note
Broadcast support Status
: enable
Step 6: Set Bridge port 49(ADSL port 1 PVC 8/82) as PVID
3
$modify gvrp port info portid 49 portvlanid 3 acceptframetypes all
ingressfiltering true
Port Id
: 49
Port VLAN Index
: 1
Accept Frame Types: All
Ingress Filtering
: False
Failed Registrations
00:00:00:00:00:00
: 0
Gvrp Status
Last Pdu Origin
: Disable
:
Restricted Vlan Registration: False
Set Done
Port Id
: 49
Port VLAN Index
: 3
Accept Frame Types: All
Ingress Filtering
: True
Gvrp Status
: Disable
Failed Registrations
00:00:00:00:00:00
: 0
Last Pdu Origin
:
Restricted Vlan Registration: False
Step 7: Modify the VLAN group 2, and add Bridge port
2(ADSL port 2 PVC 8/81)
$modify vlan static vlanname vlan2 egressports 1 2 385 untaggedports 1 2
VLAN Name
: vlan2
VLAN Index
: 2
Egress ports
: 1
Forbidden Egress Ports
Untagged Ports
385
: None
: 1
Bridging Mode
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
Set Done
VLAN Name
: vlan2
VLAN Index
: 2
Egress ports
: 1
Forbidden Egress Ports
Untagged Ports
: 1
Bridging Mode
2
385
: None
2
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
Step 8: Add port3 to vlan2 use vlanid index
$modify vlan static vlanid 2 egressports 1 2 3 385 untaggedports 1 2 3
VLAN Name
VLAN Index
Egress ports
Forbidden Egress Ports
Untagged Ports
Bridging Mode
Flood support Status
Broadcast support Status
Set Done
95
: vlan2
: 2
: 1
2
: None
: 1
2
: Residential
: enable
: enable
385
Application Note
VLAN Name
: vlan2
VLAN Index
: 2
Egress ports
: 1
Forbidden Egress Ports
Untagged Ports
: 1
Bridging Mode
2
3
2
3
385
: None
: Residential
Flood support Status
: enable
Broadcast support Status
: enable
Step 9: Modify the VLAN from 8/81 to 0/35
• Set the AAL5 strat number is 0
$modify atm vc intf ifname aal5-1 disable
VC IfName
: aal5-1
VPI
: 8
Admin Status
: Up
Aal5 Tx Size
: 1536
AAL Type
Channel
Low IfName
: atm-1
VCI
: AAL5
: 81
Oper Status
: Down
Aal5 Rx Size
: 1536
AAL5 Encap
: Interleaved
: LLC Mux
Last Change (sec)
MgmtMode
: Data
Row Status
VC Type
: PVC
VC Topology
: 0
: active
: Point to Point
Set Done
VC IfName
: aal5-1
VPI
: 8
Admin Status
: Down
Aal5 Tx Size
: 1536
AAL Type
Channel
Low IfName
: atm-1
VCI
: AAL5
Oper Status
: Data
VC Type
: PVC
: Down
Aal5 Rx Size
AAL5 Encap
: Interleaved
MgmtMode
: 81
: 1536
: LLC Mux
Last Change (sec)
Row Status
VC Topology
: 0
: active
: Point to Point
• (Set VPI / VCI is 0 / 35)
$modify atm vc intf ifname aal5-1 vpi 0 vci 35
VC IfName
: aal5-1
VPI
: 8
Low IfName
: atm-1
VCI
: 81
Admin Status
: Down
Oper Status
Aal5 Tx Size
: 1536
Aal5 Rx Size
AAL5 Encap
: Down
: 1536
AAL Type
: AAL5
: LLC Mux
Channel
: Interleaved
MgmtMode
: Data
Row Status
: active
VC Type
: PVC
VC Topology
: Point to Point
Last Change (sec)
: 0
Set Done
VC IfName
: aal5-1
VPI
: 0
Low IfName
VCI
Admin Status
: Down
Aal5 Tx Size
: 1536
Oper Status
: Down
Aal5 Rx Size
AAL5 Encap
: 1536
AAL Type
: AAL5
Channel
: Interleaved
MgmtMode
: Data
Row Status
: LLC Mux
: active
VC Type
: PVC
VC Topology
: Point to Point
Last Change (sec)
Step 9: Set AAL5 as enable
$modify atm vc intf ifname aal5-1 enable
96
: atm-1
: 35
: 0
Application Note
VC IfName
: aal5-1
VPI
: 0
Admin Status
: Down
Aal5 Tx Size
: 1536
Low IfName
VCI
: atm-1
: 35
Oper Status
: Down
Aal5 Rx Size
AAL5 Encap
: 1536
AAL Type
: AAL5
: LLC Mux
Channel
: Interleaved
MgmtMode
: Data
Row Status
: active
VC Type
: PVC
VC Topology
: Point to Point
Last Change (sec)
: 0
Set Done
97
VC IfName
: aal5-1
VPI
: 0
Admin Status
: Up
Aal5 Tx Size
: 1536
Low IfName
VCI
: atm-1
: 35
Oper Status
: Down
Aal5 Rx Size
AAL5 Encap
: 1536
AAL Type
: AAL5
: LLC Mux
Channel
: Interleaved
MgmtMode
: Data
Row Status
: active
VC Type
: PVC
VC Topology
: Point to P
Last Change (sec)
: 0
Application Note
7.1.7
Modify the Downstream/ Upstream Rate
7.1.7.1
Scenario
7.1.7.2
Configuration
Step1: Set ADSL port12 disable
$modify adsl line intf disable ifname dsl-11
IfName
: dsl-11
Line Type
GsUtopia
: interleavedOnly
L2TxAddr : 26
Coding Type
GsUtopia L2RxAddr
Gs Clock Type
: oscillator
Gs Action
Admin Status
: Up
Oper Status
: dmt
: 26
: startup
: Up
Trans Atuc Cap
: ansit1413
q9921PotsNonOverlapped
q9921PotsOverlapped
q9921isdnOverlapped
q9921IsdnNonOverlapped
q9922potsOverlapped
q9922Adsl2PlusPotsNonOverlappedq9922Ads
l2PlusPotsOverlapped
q9922Adsl2PotsNonOverlapped
Trans Atuc Actual
: q9922Adsl2PlusPotsNonOverlapped
GsDmtTrellis
: trellisOn
Trans Atur Cap
:
q9922Adsl2PlusPotsNonOverlappedq9922Adsl2PlusPotsOverlappe
d
q9922Adsl2PotsNonOverlapped
PM Conf PMSF
: idleop
Line DELT Conf LDSF
: inhibit
Set Done
Thu Jan 01 07:19:36 1970 : MAJOR ALARM : ADSL ATUC Down : Interface dsl-11
IfName
: dsl-11
Line Type
GsUtopia
: interleavedOnly
L2TxAddr : 26
Coding Type
Gs Clock Type
: oscillator
Gs Action
: startup
Admin Status
: Down
Oper Status
: Down
Trans Atuc Cap
: ansit1413
q9921PotsNonOverlapped
q9921PotsOverlapped
q9921isdnOverlapped
q9921IsdnNonOverlapped
q9922potsOverlapped
q9922Adsl2PlusPotsNonOverlappedq9922Ads
l2PlusPotsOverlapped
Trans Atuc Actual
GsDmtTrellis
98
: dmt
GsUtopia L2RxAddr : 26
q9922Adsl2PotsNonOverlapped
: -
: trellisOn
Trans Atur Cap
: -
PM Conf PMSF
: idleop
Application Note
Line DELT Conf LDSF : inhibit
Step2: Set ADSL port 12 interleave mode Downstream 512K.
The value is hex so you must conversion to decimal.
$modify adsl line profile atucintlmaxtxrate 0x7d000 ifname dsl-11
IfName
: dsl-11
ADSL ATUC Configuration :
--------------------------Rate Adaptation
: adaptAtStartup
Target Snr Margin(dB/10)
310
GsRsIntCorrectionUp
: 60
: 125us
Upshift SnrMargin(dB/10) : 120
Max Snr Margin(dB/10)
:
Dnshift SnrMargin(dB/10): 0
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Intl Min Tx Rate(bps)
0x1f38300
: 0x7d00
Intl Max Tx Rate(bps)
: 0x1f38300
GsTxStartBin
0x1ff
: 0x20
GsTxEndBin
:
GsRxStartBin
: 0x6
GsRxEndBin
: 0x1f
GsMaxBitsPerBin
: 15
GsMaxDCo
: 256
GsRxBinAdjust
Disable
Fast Min Tx Rate(bps)
: Disable
GsAdi2x
adsl2Plus
: standard
GsInitiate
: -
:
Fast Max Tx Rate(bps)
:
Max Intl Delay(ms)
: 0
GsEraseProfiles
GsStandard
:
:
GsTxPowerAtten
: -
GsCodingGain
: Auto
GsRsFastOvrhdDown
: 1
GsRsIntCorrectionDown
: 1Ms
GsRsFastOvrhdUp
: 1
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsFastRetrain
:
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: adsl2
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
GsPsdMaskType
fdmMode
: -
DmtConfMode
GsExtRsMemory
0x2
: notpresent
GsParamHybridLossTestEnd
: 0x40
GsAdvertisedCapabilities
:
:
ParamHybridLossTestStart
GsDmtTrellis
:
: on
: AnnexA
GslTriggerMode
: Disable
Type
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFF
ParametricTestInputFile
Data Boost
Standard
Conf PM Mode
: : Enable
: pmstatel3enable
Conf PML0 Time(sec)
: 180
Conf PML2 Time(sec)
: 180
Conf PML2 Rate(bps)
: 0x10000
Conf GsREADSL2 Enable
: disable
ADSL ATUR Configuration :
99
Upstream PSD
:
pmstatel2enable
Conf PML2 ATPR (dB/10)
: 30
Application Note
--------------------------Target Snr Margin(dB/10): 60
Dnshift SnrMargin(dB/10): 0
Upshift SnrMargin(dB/10): 120
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
: 0x109a00
Max Intl Delay(ms)
: 16
______________________________________________________________
Set Done
IfName
: dsl-11
ADSL ATUC Configuration :
--------------------------Rate Adaptation
: adaptAtStartup
Target Snr Margin(dB/10): 60
GsRsIntCorrectionUp
Max Snr Margin(dB/10)
: 125us
: 310
Dnshift SnrMargin(dB/10) : 0
Upshift SnrMargin(dB/10): 120
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x1f38300
: 0x7d00
Intl Max Tx Rate(bps)
: 0x7d000
GsTxStartBin
0x1ff
: 0x20
GsTxEndBin
:
GsRxStartBin
: 0x6
GsRxEndBin
: 0x1f
GsMaxBitsPerBin
: 15
GsMaxDCo
: 256
GsRxBinAdjust
Disable
: Disable
GsEraseProfiles
:
GsAdi2x
adsl2Plus
: standard
GsStandard
:
GsInitiate
: -
GsCodingGain
: Auto
GsRsFastOvrhdDown
: 1
GsRsIntCorrectionDown
: 1Ms
GsRsFastOvrhdUp
: 1
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: adsl2
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
:
GsPsdMaskType
fdmMode
: -
DmtConfMode
:
GsExtRsMemory
0x2
: notpresent
GsParamHybridLossTestEnd
on
:
Max Intl Delay(ms)
: 0
GsTxPowerAtten
: 0x40
GsAdvertisedCapabilities
Fast Max Tx Rate(bps)
: -
GsFastRetrain
:
ParamHybridLossTestStart
GsDmtTrellis
:
:
: AnnexA
GslTriggerMode
: Disable
Type
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFF
ParametricTestInputFile : Data Boost
Standard
Conf PM Mode
Conf PML0 Time(sec)
100
: Enable
: pmstatel3enable
: 180
Upstream PSD
pmstatel2enable
:
Application Note
Conf PML2 Time(sec)
: 180
Conf PML2 Rate(bps)
: 0x10000
Conf GsREADSL2 Enable
Conf PML2 ATPR (dB/10)
: 30
: disable
ADSL ATUR Configuration :
--------------------------Target Snr Margin(dB/10) : 60
Dnshift SnrMargin(dB/10) : 0
Upshift SnrMargin(dB/10) : 120
Min Upshift Time(sec)
Fast Min Tx Rate(bps)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
: 0x109a00
Max Intl Delay(ms)
: 16
Step4: Set ADSL port12 interleave mode upstream 512K.
The value is hex so you must conversion to decimal.
$modify adsl line profile aturintlmaxtxrate 0x7d000 ifname dsl-11
IfName
: dsl-11
ADSL ATUC Configuration :
--------------------------Rate Adaptation
Target Snr Margin(dB/10)
310
GsRsIntCorrectionUp
Upshift SnrMargin(dB/10)
Min Dnshift Time(sec)
0x7d00
Intl Min Tx Rate(bps)
0x1f38300
Intl Max Tx Rate(bps)
: adaptAtStartup
: 60
: 125us
: 120
: 0
Max Snr Margin(dB/10)
Dnshift SnrMargin(dB/10)
: 0
Min Upshift Time(sec)
: 0
Fast Min Tx Rate(bps)
: 0x7d00
: 0x1f38300
:
Fast Max Tx Rate(bps)
:
Max Intl Delay(ms)
: 0
GsTxStartBin
0x1ff
: 0x20
GsTxEndBin
:
GsRxStartBin
: 0x6
GsRxEndBin
: 0x1f
GsMaxBitsPerBin
: 15
GsMaxDCo
: 256
GsRxBinAdjust
Disable
: Disable
GsEraseProfiles
GsAdi2x
adsl2Plus
: standard
GsStandard
GsInitiate
: -
:
:
GsTxPowerAtten
: -
GsCodingGain
: Auto
GsRsFastOvrhdDown
: 1
GsRsIntCorrectionDown
: 1Ms
GsRsFastOvrhdUp
: 1
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsFastRetrain
:
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: adsl2
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
GsPsdMaskType
fdmMode
: -
DmtConfMode
GsExtRsMemory
0x2
: notpresent
ParamHybridLossTestStart
GsParamHybridLossTestEnd
GsAdvertisedCapabilities
GslTriggerMode
Type
: 0x40
GsDmtTrellis
: AnnexA
: Disable
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
101
:
:
:
:
: on
Application Note
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFF
ParametricTestInputFile : Data Boost
Standard
: Enable
Conf PM Mode
: pmstatel3enable
Conf PML0 Time(sec)
: 180
Conf PML2 Time(sec)
: 180
Conf PML2 Rate(bps)
: 0x10000
Conf GsREADSL2 Enable
: disable
Upstream PSD
:
pmstatel2enable
Conf PML2 ATPR (dB/10)
: 30
ADSL ATUR Configuration :
--------------------------Target Snr Margin(dB/10): 60
Dnshift SnrMargin(dB/10): 0
Upshift SnrMargin(dB/10): 120
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
: 0x109a00
Max Intl Delay(ms)
: 16
______________________________________________________________
Set Done
IfName
: dsl-11
ADSL ATUC Configuration :
--------------------------Rate Adaptation
: adaptAtStartup
Target Snr Margin(dB/10): 60
Max Snr Margin(dB/10)
GsRsIntCorrectionUp
Dnshift SnrMargin(dB/10): 0
: 125us
Upshift SnrMargin(dB/10): 120
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x1f38300
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
: 0x1f38300
Max Intl Delay(ms)
: 0
GsTxStartBin
0x1ff
: 0x20
GsTxEndBin
:
GsRxStartBin
: 0x6
GsRxEndBin
: 0x1f
GsMaxBitsPerBin
: 15
GsMaxDCo
: 256
GsRxBinAdjust
Disable
: Disable
GsEraseProfiles
:
GsAdi2x
adsl2Plus
: standard
GsStandard
:
GsInitiate
: -
GsTxPowerAtten
: -
GsCodingGain
: Auto
GsRsFastOvrhdDown
: 1
GsRsIntCorrectionDown
: 1Ms
GsRsFastOvrhdUp
: 1
GsDrStby
Expanded
: Disable
GsExpandedExchange
:
GsEscapeFastRetrain
Disable
: Disable
GsFastRetrain
:
GsBitSwap
LocalOcs
: Enable
GsNtr
:
GsAnnexType
Unknown
: adsl2
GsAlctlUsVer
:
GsUseCustomBin
Enable
: Disable
GsFullRetrain
:
GsPsdMaskType
fdmMode
: -
DmtConfMode
:
GsExtRsMemory
: notpresent
ParamHybridLossTestStart: 0x2
GsParamHybridLossTestEnd: 0x40
GsAdvertisedCapabilities: AnnexA
GslTriggerMode
102
: 310
: Disable
GsDmtTrellis
: on
Application Note
Type
: interleavedOnly
GsDnBinUsage
:
0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
FFFF
ParametricTestInputFile : Data Boost
Standard
: Enable
Conf PM Mode
: pmstatel3enable
Conf PML0 Time(sec)
: 180
Conf PML2 Time(sec)
: 180
Conf PML2 Rate(bps)
: 0x10000
Conf GsREADSL2 Enable
: disable
Upstream PSD
:
pmstatel2enable
Conf PML2 ATPR (dB/10)
: 30
ADSL ATUR Configuration :
--------------------------Target Snr Margin(dB/10): 60
Dnshift SnrMargin(dB/10): 0
Upshift SnrMargin(dB/10): 120
Min Upshift Time(sec)
: 0
Min Dnshift Time(sec)
0x7d00
: 0
Fast Min Tx Rate(bps)
:
Intl Min Tx Rate(bps)
0x109a00
: 0x7d00
Fast Max Tx Rate(bps)
:
Intl Max Tx Rate(bps)
: 0x7d000
Max Intl Delay(ms)
: 16
Step5: Set ADSL port12 enable.
$modify adsl line intf enable ifname dsl-11
IfName
: dsl-11
Line Type
GsUtopia
: interleavedOnly
L2TxAddr : 26
Gs Clock Type
: oscillator
Admin Status
: Down
Coding Type
: dmt
GsUtopia L2RxAddr : 26
Gs Action
Oper Status
: startup
: Down
Trans Atuc Cap
: ansit1413
q9921PotsNonOverlapped
q9921PotsOverlapped
q9921isdnOverlapped
q9921IsdnNonOverlapped
q9922potsOverlapped
q9922Adsl2PlusPotsNonOverlappedq9922Ads
l2PlusPotsOverlapped
q9922Adsl2PotsNonOverlapped
Trans Atuc Actual
: -
GsDmtTrellis
: trellisOn
Trans Atur Cap
: -
PM Conf PMSF
: idleop
Line DELT Conf LDSF : inhibit
Set Done
IfName
: dsl-11
Line Type
GsUtopia
: interleavedOnly
L2TxAddr : 26
Gs Clock Type
: oscillator
Admin Status
: Up
Coding Type
Gs Action
Oper Status
Trans Atuc Cap
: ansit1413
q9921PotsNonOverlapped
q9921PotsOverlapped
q9921isdnOverlapped
q9921IsdnNonOverlapped
q9922potsOverlapped
q9922Adsl2PlusPotsNonOverlappedq9922Ads
l2PlusPotsOverlapped
103
q9922Adsl2PotsNonOverlapped
Trans Atuc Actual
: -
GsDmtTrellis
: trellisOn
: dmt
GsUtopia L2RxAddr : 26
: startup
: Down
Application Note
Trans Atur Cap
: -
PM Conf PMSF
: idleop
Line DELT Conf LDSF : inhibit
104
Application Note
7.1.8
Enable SNMP function
SNMP (Simple Network Management Protocol) is used
almost exclusively in TCP/IP networks. SNMP provides a
means to monitor and control network devices, and to
manage configurations, statistics collection, performance,
and security.
7.1.8.1
Scenario
Ethernet
Ethernet
DSL
CPE
PC 3
PC 1
IPLM
Ethernet
DSL
Ethernet
CPE
PC 2
7.1.8.2
Configuration
Step 1: Create SNMP community
$create snmp comm community public rw
Entry Created
Community
Access
------------------------public
RW
Setp 2: Create SNMP host
$create snmp host ip 192.168.100.55 community public
Entry Created
Host Address
Community
----------------------------------192.168.100.55
public
$
Setp 3: Create SNMP traphost
$create snmp traphost ip 192.168.100.55 community public
Entry Created
Ip Address : 192.168.100.55
105
Community
: public
Port
: 162
Version : v2c
Application Note
7.2
Advanced Configuration
Following sections describes how to execute advanced
configuration to meet the requirements of advanced
application scenarios.
7.2.1
7.2.1.1
How to get QoS of uplink port
Overview
The following template is provided for users with verify QOS
of uplink port of IPLM.
There are 3 PVCs will be created on bridge port by dsl 1 as
follows.
VPI/VCI
8/81
8/82
8/83
Bridge port ID Original priority
1
0
49
0
96
0
Redefined priority
2
3
4
All of upstream packets will be redefined priority by VLAN
packets; we can verify it by VLAN tag.
7.2.1.2
Goals
• Verify the relationship between priority of bridge port and
VLAN
• Verify the output packets of Uplink 1 will have the priority
of VLAN tag.
7.2.1.3
Requirements for test
Equipment
Smartbit 6000
IPLM
AGA
PC
7.2.1.4
Quantity
1
1
1
1
P.S
Configuration
IPLM
Reboot system configuration
• In order to clean all configuration so that I suggest you to
reboot system default as below command.
• $Reboot config default
Create 3 PVCs and mapping to bridge port 1, 49 and 97
respectively.
$create atm vc intf ifname aal5-48 lowif atm-0 vpi 8 vci 82
$create atm vc intf ifname aal5-96 lowif atm-0 vpi 8 vci 83
$create eoa intf ifname eoa-48 lowif aal5-48
$create eoa intf ifname eoa-96 lowif aal5-96
$create bridge port intf ifname eoa-48 portid 49 learning
enable status disable
$create bridge port intf ifname eoa-96 portid 97 learning
enable status disable
106
Application Note
Confirm priority info of bridge on dsl port 1, 49 and 97
$get bridge port prioinfo portid 1
PortId
:1
DefaultPriority : 0
NumTrafficClass : 4
$get bridge port prioinfo portid 49
PortId
: 49
DefaultPriority : 0
NumTrafficClass : 4
$get bridge port prioinfo portid 97
PortId
: 97
DefaultPriority : 0
NumTrafficClass : 4
Modify priority of bridge port as below:
Port ID Priority
1
2
49
3
97
4
$modify bridge port prioinfo portid 1 defPrio 2
$modify bridge port prioinfo portid 49 defPrio 3
$modify bridge port prioinfo portid 97 defPrio 4
$modify bridge port intf portid 1 status enable
$modify bridge port intf portid 49 status enable
$modify bridge port intf portid 97 status enable
Verify priority what we have created as below:
Create VLAN as below.
VLAN ID
1
49
97
Bridge port
(Untag)
1
2
3
Bridge port (tag)
385
385
385
$create vlan static vlanname vlan2 vlanid 2 egressports 1
385 untaggedports 1
$create vlan static vlanname vlan3 vlanid 3 egressports 49
385 untaggedports 49
$create vlan static vlanname vlan4 vlanid 4 egressports 97
385 untaggedports 97
$modify gvrp port info portid 2 portvlanid 2 acceptframetypes
all ingressfiltering true
107
Application Note
$modify gvrp port info portid 49 portvlanid 3
acceptframetypes all ingressfiltering true
$modify gvrp port info portid 97 portvlanid 4
acceptframetypes all ingressfiltering true
Create ACL (Access control list)
• To simulate different service applications, the CPEs with
athorized mac address can access the Internet.
$create acl port macentry macaddr 00:00:00:00:10:01 portid
1
$create acl port macentry macaddr 00:00:00:00:20:01 portid
1
$create acl port macentry macaddr 00:00:00:00:10:02 portid
49
$create acl port macentry macaddr 00:00:00:00:20:02 portid
49
$create acl port macentry macaddr 00:00:00:00:10:03 portid
97
$create acl port macentry macaddr 00:00:00:00:20:03 portid
97
7.2.1.5
AGA-100
Create 3 PVCs and mapping to 8/81, 8/82, 8/83
separately.
7.2.1.6
SmartBit 6000
Connect Port 05 to uplink 1 of IPLM.
Create 3 VTEs of this port with VLAN tag as below.
Connect Port 06 to Ethernet port of AGA-100.
Create 3 VTEs of this port without VLAN tag as below.
108
Application Note
7.2.1.7
Result
Send the packets from port-06 and capture the packets form
port-05 by PVC 1.
The priority is “2” by VLAN
tags
Send the packets from port-05 and capture the packets form
port-06 by PVC 1
.
Get the forwarding table form IPLM (Both upstream and
downstream)
Send the packets from port-06 and capture the The
packets
form
priority
is “3” by VLAN
port-05 by PVC 2.
tags
Send the packets from port-05 and capture the packets form
port-06 by PVC 2.
Get the forwarding table form 6696H (Both upstream and
downstream)
Send the packets from port-06 and capture the packets form
port-05 by PVC 3.
109
Application Note
The priority is “4” by VLAN
tags
Send the packets from port-05 and capture the packets form
port-06 by PVC 3.
Get the forwarding table form IPLM(Both upstream and
downstream)
110
Application Note
7.2.2
How to modify IRL /ORL
IRL (input rate limit)/ORL(output rate limit) which define the
maximum rate for input /output.
IRL is only for upstream direction by aal5-x (PVC X).
ORL is only for downlink direction by atm-x.
7.2.2.1
Scenario
DSL
CPE
IP L M
E th e r n e t
E th e r n e t
S m a r tb its 6 0 0 0
7.2.2.2
Configuration
IRL:
Example,
• Limit the maximum rate of input at 256k for aal5-0.
$ create irl profile profilename gold irltype sr2cm
cir 256 cbs 6000 conformaction colorgreen violateaction
drop
$ create irl map ifname aal5-0 profilename gold
ORL:
Example,
• Limit the maximum rate of input at 128k for atm-0.
$ modify atm port ifname atm-0 orl 128
111
Application Note
7.2.3
How to Stack 2 units
• Eth0 enable (for uplink), its bridge port number is 385
• Eth1 disable (for downlink)
• MGMT interface disable
7.2.3.1
Scenario
E th e rn e t
E th e rn e t
DSL
CPE
PC 3
U n it 1
PC 1
E th e rn e t
DSL
E th e rn e t
CPE
PC 2
7.2.3.2
U n it 2
Configuration
Step1:
Command
Description
( Master )
create ethernet intf ifname eth-0 ip 192.168.100.50 mask
255.255.255.0 enable
create bridge port intf portid 385 ifname eth-0 learning
disable status enable
create ethernet intf ifname eth-1 type downlink enable
create bridge port intf portid 386 ifname eth-1 learning enable
status enable
modify bridge mode enable
( Slave )
create ethernet intf ifname eth-0 ip 192.168.100.60 mask
255.255.255.0 enable
create bridge port intf portid 385 ifname eth-0 learning
disable status enable
create ethernet intf ifname eth-1 type downlink enable
create bridge port intf portid 386 ifname eth-1 learning enable
status enable
modify bridge mode enable
Master for unit 1
Slave for unit 2
IP is unnecessary for Downlink
port
Step2:
Command
Description
$get ethernet intf
Verify the configuration after
stacking.
Interface
: eth-0
Type
: Uplink
UseDhcp
: False
IP Address
: 192.168.100.50 Mask
:
255.255.255.0
Pkt Type
: ALL
Orl(mbps)
: 100
Configured Duplex : Auto
Duplex
: Full
Configured Speed : Auto
Class0thrshld
: 100
Class1thrshld: 100
112
Application Note
Class2thrshld
: 100
Class3thrshld: 100
Class4thrshld
: 100
Class5thrshld: 100
Class6thrshld
: 100
Class7thrshld: 100
ProfileName
: SPPROFILE
Mgmt VLAN Index : Tagged Mgmt PDU Prio: 0
Speed
: 100BT
Operational Status : Up
Admin Status : Up
Interface
: eth-1
Type
: Downlink
UseDhcp
: False
IP Address
: 0.0.0.0
Mask
: 0.0.0.0
Pkt Type
: ALL
Orl(mbps)
: 100
Configured Duplex : Auto
Duplex
: None
Configured Speed : Auto
Class0thrshld
: 100
Class1thrshld: 100
Class2thrshld
: 100
Class3thrshld: 100
Class4thrshld
: 100
Class5thrshld: 100
Class6thrshld
: 100
Class7thrshld: 100
ProfileName
: SPPROFILE
Mgmt VLAN Index : Tagged Mgmt PDU Prio: Speed
:Operational Status : Down
Admin Status : Up
Interface
: eth-2
Type
: Uplink
UseDhcp
: False
IP Address
: 10.90.91.91 Mask
: 255.255.255.0
Pkt Type
: ALL
Orl(mbps)
: 100
Configured Duplex : Auto
Duplex
: None
Configured Speed : Auto
Class0thrshld
: 100
Class1thrshld: 100
Class2thrshld
: 100
Class3thrshld: 100
Class4thrshld
: 100
Class5thrshld: 100
Class6thrshld
: 100
Class7thrshld: 100
ProfileName
: SPPROFILE
Mgmt VLAN Index : Tagged Mgmt PDU Prio: 0
Speed
:Operational Status : Down
Admin Status : Up
113
Application Note
7.2.4
How to debug ADSL line
The way to debug adsl line is shown as follows.
The command is different from others while loop start in
interleave mode. (dsli)
Command dsl-x, x means which port was connected.
7.2.4.1
Configuration
AGA (ADSL2+)
DSL-300G (G.dnt)
$get adsl atuc channel ifname dsli-0
Ifname
$get adsl atuc channel ifname dsli-4
: dsli-0
Ifname
Interleave Delay(ms): 6
Curr Tx Rate(bps)
: 21156200
: dsli-4
Interleave Delay(ms): 16
Curr Tx Rate(bps)
Prev Tx Rate(bps) : 21286100 Crc Block Length(byte)
: 46410
Prev Tx Rate(bps) : 8064000
Gs Curr Atm Status : OK
: 37
Gs Curr Atm Status : OK
GsRsDepth
: 64
GsSymbolsPerRsWord
GsRedundantBytesPerRsCode : 4
GsRsDepth
: 64
GsSymbolsPerRsWord
$
$
$get adsl atur channel ifname dsli-4
Ifname
: dsli-0
Interleave Delay(ms) : 13
Prev Tx Rate(bps)
Curr Tx Rate(bps)
: 1085200
Crc Block Length(byte)
Gs Curr Atm Status : OK
GsRsDepth
: 1085200
GsSymbolsPerRsWord
:8
Prev Tx Rate(bps)
: 695
Gs Curr Atm Status : OK
GsRsDepth
Curr Tx Rate(bps)
: 1088000
GsSymbolsPerRsWord
:8
$get adsl atuc physical ifname dsl-0
$get adsl atuc physical ifname dsl-4
Ifname
Ifname
: (co-0123456)
Vendor ID
Version Number
Curr Status
: C.12.1.2
Version Number
Curr Atn(dB/10)
CurrAttainable Rate(bps): 0
GsActualStandard
: 430
GsStartProgress
:0
: adsl2Plus
GsRxAtmCellCounter
: C.12.1.2
: NoDefect
Curr Snr Margin(dB/10) : 110
Curr Output Pwr(dB/10): 83
: Data
: FFB54753504E0000C.12.1.2
Curr Status
Curr Snr Margin(dB/10) : 110
GsTxAtmCellCounter
: (co-0123456)
Vendor ID
: NoDefect
GsOpState
: dsl-4
Serial Number
: FFB54753504E0000C.12.1.2
:0
:0
:0
GsBertSync
: BertOutOfSync
GsIdleBertCells
:0
GsOpState
: Data
GsTxAtmCellCounter
:0
GsBertSync
: BertInSync
GsIdleBertCells
GsBertError
GsSeltLoopEnd
GsSeltLoopEnd
DataBoost Status
GsSeltDownShannonCap (in bps) : 0
Chan Perf BE
:0
Chan Perf CD
:0
Chan Perf BE
:0
Delt HLOGMTus
:0
Delt HLINSCus
:0
Delt HLOGMTus
:0
DELT Last Tx State
: dmtatucg9941
Delt QLNMTus
:0
DELT Last Tx State
Chan Perf CD
: 785608
Delt HLINSCus
Delt QLNMTus
: dataop
Bin Number
: Disable
GsSeltUpShannonCap (in bps) : 0
GsSeltDownShannonCap (in bps) : 0
Extended PSD Status
:-
DataBoost Status
: Disable
GsSeltUpShannonCap (in bps) : 0
PM State
: unknown
GsSeltLoopGauge
:-
: 32728
: NotConnected
GsSeltLoopLen (in Feet) : 0
: unknown
Chan Perf Cu
:0
:0
GsSeltInfoValid
GsSeltLoopLen (in Feet) : 0
GsSeltLoopGauge
: GDmt
GsRxAtmCellCounter
GsIdleBertError
GsParametricTestResult : Ok
: NotConnected
: 25
: 140
GsBertError
GsSeltInfoValid
GsActualStandard
: 416
GsParametricTestResult : Ok
:0
Curr Atn(dB/10)
CurrAttainable Rate(bps): 10888000 Curr Output Pwr(dB/10): 95
GsStartProgress
GsIdleBertError
PM State
:0
: standard Chip Version
: 25
Number of bits/bin
: dataop
Extended PSD Status
Bin Number
Chan Perf Cu
:0
:0
: dmtatucg9941
:0
: standard Chip Version
: 25
Number of bits/bin
[0 ] 0 0 0 0 0 0 7 9 10 11 11 12 13 14 14 14
[0 ] 0 0 0 0 0 0 9 10 12 12 13 13 14 14 14 14
[16] 14 14 14 14 14 14 14 13 13 13 12 11 10 9 8 7
[16] 14 14 14 14 14 14 14 13 13 13 12 12 11 11 11 10
[32] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[32] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[48] 0 0 0 0 0 0 0 0 0 0 0 110 0 0 0 0
[48] 0 0 0 0 0 0 0 0 0 0 0 110 0 0 0 0
Parametric Info
Parametric Info
114
: 2312
:4
GsRedundantBytesPerRsCode : 16
$
: dsl-0
: 1088000
Crc Block Length(byte)
$
Serial Number
:1
: dsli-4
Interleave Delay(ms) : 8
: 2540
GsRedundantBytesPerRsCode : 16
: 17136
GsRedundantBytesPerRsCode : 2
$get adsl atur channel ifname dsli-0
Ifname
: 8064000
Crc Block Length(byte)
Application Note
$get adsl atur physical ifname dsl-0
$get adsl atur physical ifname dsl-04
Ifname
Ifname
: dsl-0
Serial Number
:-
Vendor ID
: FFB54753504E0007
Version Number
Curr Snr Margin(dB/10) : 60
Curr Atn(dB/10)
: 37
Curr Output
: 300027251 Chan Perf CU
Delt HLINSCds
Delt HLOGMTds
:0
DELT Last Tx State
: dmtaturg9941
Bin Number
: 10960
:0
Delt QLNMTds
:0
[32] 0 0 0 0 2 3 4 4 5 5 5 6 6 7 7 7
[48] 8 8 8 9 9 9 9 9 10 10 10 10 10 11 11 11
[64] 11 11 11 12 12 12 12 12 12 12 12 12 12 12 13 12
[80] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[96] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[112] 13 13 13 13 13 13 13 13 14 13 13 13 13 14 14 14
[128] 13 14 13 14 14 14 14 14 14 14 13 14 13 14 14 2
[144] 14 14 14 14 14 14 14 13 14 14 13 13 13 13 13 14
[160] 13 14 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[176] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[192] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[208] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[224] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[240] 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13 13
[256] 12 13 13 13 13 13 13 13 13 13 13 13 13 12 12 13
[272] 12 12 12 12 12 12 13 12 12 12 12 12 12 12 12 12
[288] 12 12 12 12 12 12 12 13 12 12 12 12 12 12 12 12
[304] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[320] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[336] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[352] 12 12 12 12 12 11 12 12 12 12 12 11 12 12 12 11
[368] 12 11 11 12 12 12 11 12 12 12 12 11 12 12 12 11
[384] 11 12 11 12 11 11 12 12 12 12 11 12 12 12 12 12
[400] 11 12 11 12 12 11 11 12 12 12 12 11 11 11 11 11
[416] 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11
[432] 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11
[448] 11 11 11 11 11 11 10 10 10 10 10 10 10 10 10 10
[464] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[480] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[496] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[512] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[528] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[544] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[560] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[576] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
: 15
Curr Output Pwr(dB/10) : 124
Chan Perf CD
:0
Chan Perf CU
:0
Chan Perf BE
:0
Delt HLINSCds
:0
Delt HLOGMTds
:0
Delt QLNMTds
DELT Last Tx State
: dmtaturg9941
:0
Number of bits/bin
[16] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[32] 0 0 0 0 0 0 0 2 2 3 4 5 6 7 7 8
[48] 8 9 9 9 10 10 10 10 11 11 11 11 11 11 11 11
[64] 0 11 11 11 11 11 10 11 11 11 11 11 11 11 11 11
[80] 11 11 11 11 11 11 11 12 12 12 12 12 12 12 12 12
[96] 12 12 12 12 12 11 11 11 11 11 11 11 11 11 11 11
[112] 11 11 11 11 11 11 11 11 11 11 11 10 10 10 11 10
[128] 10 10 10 10 10 10 10 11 11 10 11 11 11 11 11 11
[144] 11 11 11 11 11 11 11 11 11 11 11 11 11 11 10 10
[160] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[176] 10 10 10 10 10 9 10 10 10 10 10 9 10 10 10 10
[192] 10 10 10 10 10 10 10 10 10 10 9 10 9 10 9 9
[208] 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9
[224] 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9
[240] 9 9 9 9 9 9 9 9 9 9 9 8 8 8 8 8
[256]12 13 13 13 13 13 13 13 13 13 13 13 13 12 12 13
[272] 12 12 12 12 12 12 13 12 12 12 12 12 12 12 12 12
[288] 12 12 12 12 12 12 12 13 12 12 12 12 12 12 12 12
[304] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[320] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[336] 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12
[352] 12 12 12 12 12 11 12 12 12 12 12 11 12 12 12 11
[368] 12 11 11 12 12 12 11 12 12 12 12 11 12 12 12 11
[384] 11 12 11 12 11 11 12 12 12 12 11 12 12 12 12 12
[400] 11 12 11 12 12 11 11 12 12 12 12 11 11 11 11 11
[416] 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11
[432] 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11
[448] 11 11 11 11 11 11 10 10 10 10 10 10 10 10 10 10
[464] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[480]10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[496] 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
[512] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[528] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[544] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[560] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[576] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
:
:
:
:
:
[1008] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
:
[1008] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
------------0
0
0
Delt HLINpsds
-------------
Delt HLINpsds
0
0
0
0
[0 ]
0
0
0
0
[4 ]
0
0
0
0
:
0
:
:
:
:
[508]
:
[508]
Curr Atn(dB/10)
CurrAttainable Rate(bps) : 1388000
[0 ] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[16] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[4 ]
Curr Snr Margin(dB/10) : 140
Bin Number
Number of bits/bin
[0 ] 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
[0 ]
: NoDefect
AturGsConfig
:
0xFC0000000000000000000000000000000022000000000200400110000804
AturGsConfig
:
0x0000B60000000A0000008E00000003000000000000000000000000000000
:0
: T93.3.44
Curr Status
CurrAttainable Rate(bps) : 4632000
Pwr(dB/10) : 0
Chan Perf BE
: 00B54753504E0000T93.3.44
Version Number
: NoDefect
Chan Perf CD
:-
Vendor ID
:-
Curr Status
: dsl-4
Serial Number
0
115
0
0
0
0
Delt HLOGpsds
0
0
0
Application Note
-------------
Delt HLOGpsds
[0 ]
0
0
0
0
[0 ]
0
0
0
0
[4 ]
0
0
0
0
[4 ]
0
0
0
0
:
-------------
:
:
:
:
[252]
:
[252]
0
0
0
0
0
0
0
0
Delt QLNpsds
------------
Delt QLNpsds
[0 ]
0
0
0
0
[0 ]
0
0
0
0
[4 ]
0
0
0
0
[4 ]
0
0
0
0
[8 ]
0
0
0
0
[8 ]
0
0
0
0
:
------------
:
:
:
:
[252]
:
[252]
0
0
0
0
0
0
0
0
Delt DMT Bin SNR
----------------
Delt DMT Bin SNR
[0 ]
0
0
0
0
[0 ]
0
0
0
0
[4 ]
0
0
0
0
[4 ]
0
0
0
0
:
----------------
:
:
:
:
[252]
:
[252]
0
116
0
0
0
$
0
0
0
0
Application Note
7.2.5
LACP aggregation (Port Aggregation)
Link Aggregation Control Protocol (LACP) allows you to
bundle several physical ports together to form a single
logical channel. LACP allows a switch to negotiate an
automatic bundle by sending LACP packets to the
peer.LACP is a protocol implementation in layer 2 which
controls thru which physical links the traffic will be routed.
7.2.5.1
Scenario
U p lin k 1
E th e r n e t
E th e r n e t
DSL
E th e r n e t
CPE
U p lin k 2
PC 1
E th e r n e t
PC 2
7.2.5.2
Configuration
Step 1: Create Ethernet and Bridge port
$ create ethernet intf ifname eth-0
Entry Created
Interface
: eth-0
Type
: Uplink
UseDhcp
: False
IP Address
: 0.0.0.0
Mask
: 0.0.0.0
Pkt Type
: ALL
Orl(mbps)
: 300
Configured Duplex
: Auto
Duplex
: None
Configured Speed
: Auto
Class0thrshld
: 100
Class1thrshld: 100
Class2thrshld
: 100
Class3thrshld: 100
Class4thrshld
: 100
Class5thrshld: 100
Class6thrshld
: 100
Class7thrshld: 100
ProfileName
: SPPROFILE
Mgmt VLAN Index
: -
Tagged Mgmt PDU Prio: Speed
: -
Operational Status: Down
Admin Status: Up
$
Thu Jan 01 00:02:33 1970 : STATUS ALARM : ETHER Interface Up : Interface
- eth-0
Step 2: Create Aggregator interface
$ create ethernet intf ifname eth-1
Entry Created
117
Interface
: eth-1
Type
: Uplink
UseDhcp
: False
IP Address
: 0.0.0.0
Mask
: 0.0.0.0
Pkt Type
: ALL
Application Note
Orl(mbps)
: 300
Configured Duplex
: Auto
Configured Speed
: Auto
Class0thrshld
: 100
Class1thrshld: 100
Class2thrshld
: 100
Class3thrshld: 100
Class4thrshld
: 100
Class5thrshld: 100
Class6thrshld
: 100
Class7thrshld: 100
ProfileName
: SPPROFILE
Mgmt VLAN Index
: -
Duplex
: None
Tagged Mgmt PDU Prio: Speed
: -
Operational Status
: Down
Admin Status : Up
$modify bridge mode enable
Bridging Mode is Enabled
Set Done
Bridging Mode is Enabled
Step 3: Create LACP Aggregator
$ create aggr intf ifname aggr-0 ip 192.168.100.111 mask 255.255.255.0
enable
Entry Created
Interface Index
: aggr-0
IP Address
: 192.168.100.111
UseDhcp
: False
Mgmt VLAN Index
: -
Tagged Mgmt PDU Prio
: 0
Admin Status
: Up
Operational Status
: Up
Mask
: 255.255.255.0
$create bridge port intf portid 385 ifname aggr-0 status enable
Entry Created
Port Id
IfName
: aggr-0
Max Unicast Addresses : 256
: 385
Learning Status
: Enable
Port Oper Status
: Enable
Port Admin Status: Enable
Sticky Status
: Disable
FDB Modify
: Enable
Acl Global Deny Apply : Disable
Acl Global Track Apply: Disable
Sensed IfIndex
: -
$ create lacp aggr aggrifname aggr-0 aggrtype static
Entry Created
118
Aggr IfName
: aggr-0
Mac Address
: FF:FF:FF:FF:FF:FF
Aggregate
: True
Actor Sys Priority: 10
Partner Sys Priority: 0
Actor Sys ID
: 00:01:EB:08:05:B9
FF:FF:FF:FF:FF:FF
Partner Sys ID
:
Actor Oper Key
: -
Partner Oper Key
: -
Actor Admin Key
: -
Collector Max Delay : 0
Aggregation Type
: Static
Application Note
$ modify lacp aggrport info ifname eth-0 aggrstatus enable
Interface
Aggregate
: eth-0
Port Is
Actor Oper Key
Key
: -
: -
Partner Oper
Actor Admin Key
Key
: -
: -
Partner Admin
Actor Port Priority
Priority : -
: -
Partner Admin Port
Actor System Priority
Priority : -
: -
Partner Oper Port
Actor System ID
Priority : -
: -
Partner Admin Sys
Actor Port
Priority
: -
: -
Partner Oper Sys
Partner Admin Sys Id
Port
: -
: -
Partner Admin
Partner Oper Sys Id
Port
: -
: -
Partner Oper
Port Actor Admin State
: -
: -
Port Partner Admin State : Port Actor Oper State
: -
Port Partner Oper State
: -
Attached Agg ID
ID
: -
: -
Aggregation Status
: Disable
Selected Agg
Set Done
Interface
Aggregate
: eth-0
: True
Port Is
Actor Oper Key
Key
: 1000
: 20
Partner Oper
Actor Admin Key
Key
: 1000
: -
Partner Admin
Actor Port Priority
Priority : 9
: 10
Partner Admin Port
Actor System Priority
Priority : 10
: 10
Partner Oper Port
Actor System ID
Priority : 9
: 00:01:EB:08:05:B9
Partner Admin Sys
Actor Port
Priority
: 9
: 1
Partner Oper Sys
Partner Admin Sys Id
Port
: 1
: 01:02:03:04:05:06
Partner Admin
Partner Oper Sys Id
Port
: 1
: 01:02:03:04:05:06
Partner Oper
Port Actor Admin State
: activity
timeout
aggr
Port Partner Admin State : timeout
aggr
defaulted
Port Actor Oper State
: activity
timeout
aggr
Port Partner Oper State
: timeout
aggr
defaulted
Attached Agg ID
ID
: -
: -
Aggregation Status
: Enable
defaulted
defaulted
Selected Agg
$ modify lacp aggrport info ifname eth-1 aggrstatus enable
Interface
Aggregate
119
: eth-1
: -
Port Is
Application Note
Actor Oper Key
Key
: -
: -
Partner Oper
Actor Admin Key
Key
: -
: -
Partner Admin
Actor Port Priority
Priority : -
: -
Partner Admin Port
Actor System Priority
Priority : -
: -
Partner Oper Port
Actor System ID
Priority : -
: -
Partner Admin Sys
Actor Port
Priority
: -
: -
Partner Oper Sys
Partner Admin Sys Id
Port
: -
: -
Partner Admin
Partner Oper Sys Id
Port
: -
: -
Partner Oper
Port Actor Admin State
: -
Port Partner Admin State : Port Actor Oper State
: -
Port Partner Oper State
: -
Attached Agg ID
ID
: -
: -
Aggregation Status
: Disable
Selected Agg
Set Done
Interface
Aggregate
: eth-1
: True
Actor Oper Key
Key
: -
: -
Partner Oper
Actor Admin Key
Key
: 1000
: -
Partner Admin
Actor Port Priority
Priority : 9
: 10
Partner Admin Port
Actor System Priority
Priority : 0
: 10
Partner Oper Port
Actor System ID
Priority : 9
: 00:01:EB:08:05:B9
Partner Admin Sys
Actor Port
Priority
: 0
: 2
Partner Oper Sys
Partner Admin Sys Id
Port
: 1
: 01:02:03:04:05:06
Partner Admin
Partner Oper Sys Id
Port
: 0
: FF:FF:FF:FF:FF:FF
Partner Oper
Port Actor Admin State
: activity
timeout
aggr
Port Partner Admin State : timeout
aggr
defaulted
Port Actor Oper State
: activity
timeout
aggr
Port Partner Oper State
: timeout
aggr
defaulted
Attached Agg ID
: ID
: -Aggregation Status
120
Port Is
defaulted
defaulted
Selected Agg
: Enable
Application Note
7.2.6
Multicast
Multicate is the transmission of information over the Internet
to two or more users at the same time.
7.2.6.1
Scenario
CPE1
DSL
IP L M
DSL
CPE2
DSL
CPE3
DSL
CPE4
E th e rn e t
E the rn e t
E th e rn et
S m artb its 6 0 0 0
E th e rne t
7.2.6.2
E th e rn e t
Configuration
Step 1: Create static multicast group
$create bridge static mcast vlanid 3 egressports
forbidegressports 48 mcastaddr 01:00:5e:01:01:04
1
3
5
385
entry created
vlan index
: 3
egress ports
: 1
forbidden egress ports : 48
3
mcast address : 01:00:5e:01:01:04
5
385
$create bridge static mcast vlanid 5 egressports
forbidegressports 48 mcastaddr 01:00:5e:01:01:05
2
4
6
entry created
vlan index
: 5
egress ports
: 2
forbidden egress ports : 48
$
121
4
mcast address : 01:00:5e:01:01:05
6
385
385
Application Note
7.2.7
IP Filter
IP Filter is software that provides statefull packet filtering
capability. It can also be used to deliver NAT (Network
Address Translation) capabilities. IP Filter provides
protection to a single server or a network of servers and
clients.
7.2.7.1
Scenario
7.2.7.2
Configuration
Step 1: create the filer rule for IP filter
$create filter rule entry ruleid 2 action drop ruledir in
entry created
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
:
:
:
:
:
:
:
2
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
Step 2: create the subrule
$create filter subrule ip ruleid 2 subruleid 1 srcaddrcmp notingenlist
entry created
rule id
start src ip addr
start dest ip addr
start ip prot type
ip src addr mask
src ip addr comp
subrule priority
transport header
$
:
:
:
:
:
:
:
:
2
0xffffffff
not in gen list
asinrule
ethernet
subrule id
end src ip addr
end dest ip addr
end ip prot type
ip dest addr mask
dest ip addr comp
ip prot type comp
Step 3: enable the rule
$create filter rule map ifname eoa-0 stageid 1 ruleid 2
entry created
interface : eoa-0
rule id
: 2
$
stage id : 1
order id : 2
Step 4: create the port to map this filter
$create filter rule map ifname eoa-1 stageid 1 ruleid 2
entry created
interface : eoa-1
rule id
: 2
122
stage id : 1
order id : 2
:
:
:
:
:
:
:
1
any
any
Application Note
Step 5: create the IP you want to filter
$modify filter rule entry ruleid 2 status enable
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
:
:
:
:
:
:
:
2
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
:
:
:
:
:
:
:
2
disable
in
ucast
interface
rule action : drop
admin status : enable
rule priority : high
applywhenreq : disable
set done
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
$create
clfr
list
//192.168.100.200
genentry
ifname
eoa-0
value
entry created
if name : eoa-0
value
: 0xc0a864c8
value type : u32
$
$
$create clfr list genentry ifname eoa-0 value 0xc0a864ca
//192.168.100.202
entry created
if name : eoa-0
value
: 0xc0a864ca
value type : u32
$
123
0xc0a864c8
Application Note
7.2.8
DHCP filter
7.2.8.1
Scenario
7.2.8.2
Confighuration
Step 1: create the filter rule for DHCP filter
$create filter rule entry ruleid 3 action drop ruledir in
Entry Created
Rule Id
: 3
Rule Action
Set Priority
: -
Admin status : disable
: drop
Stats admin status
: disable
Rule Priority
Rule Direction
: IN
ApplyWhenReq
Pkt Type
: Ucast
: High
: disable
Application Description : Snoop Level
: interface
$
Step 2: create the subrule
$create filter subrule udp ruleid 3 subruleid 1 dstportfrom 67 dstportto
68 srcportcmp any dstportcmp inrange subruleprio high
Entry Created
Rule Id
: 3
Subrule Id
Start source port
: -
End source port
: 1
: -
Start destination port : 67
End destination port
Source port comparison : Any
InRange
Destination port comparison :
Subrule Priority
: high
Transport Header
: Ethernet
Step 3: enable the rule
$modify filter rule entry ruleid 3 status enable
Rule Id
: 3
Rule Action
Set Priority
: -
Admin status : disable
: drop
Stats admin status
: disable
Rule Priority
Rule Direction
: IN
ApplyWhenReq
Pkt Type
: Ucast
: High
: disable
Application Description : Snoop Level
: interface
Set Done
Rule Id
: 3
Rule Action
Set Priority
: -
Admin status : enable
Stats admin status
: disable
Rule Priority
Rule Direction
: IN
ApplyWhenReq
Pkt Type
: Ucast
Application Description : -
124
: drop
: High
: disable
: 69
Application Note
Snoop Level
: interface
$
Step 4: create the port to map this filter
$create filter rule map ifname eoa-0 stageid 1 ruleid 3
Entry Created
Interface : eoa-0
Stage Id : 1
Rule Id
Order Id : 3
: 3
$
$
$create filter rule map ifname eth-0 stageid 1 ruleid 3
Entry Created
Interface : eth-0
Stage Id : 1
Rule Id
Order Id : 3
$
125
: 3
Application Note
7.2.9
FTP filter
FTP rules can be applied to restrict access to FTP servers
on the Internet. Access can be restricted to file transfers
between the permitted FTP server and the client.
7.2.9.1
Scenario
7.2.9.2
Configuration
Step 1: create the filter rule for FTP filter
$create filter rule entry ruleid 4 action drop ruledir in
entry created
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
:
:
:
:
:
:
:
4
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
Step 2: create the subrule
$create filter subrule tcp ruleid 4 subruleid 1 dstportfrom 21 dstportto
23 srcp ortcmp any dstportcmp inrange subruleprio high
entry created
rule id
: 4
start source port
: start destination port : 21
source port comparison : any
inrange
subrule priority
: high
transport header
: ethernet
$
subrule id
: 1
end source port
: end destination port
: 23
destination port comparison :
Step 3: enable the rule
$modify filter rule entry ruleid 4 status enable
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
:
:
:
:
:
:
:
4
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
:
:
:
:
:
:
:
4
disable
in
ucast
interface
rule action : drop
admin status : enable
rule priority : high
applywhenreq : disable
set done
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
126
Application Note
Step 4: create the port to map this filter
$create filter rule map ifname eoa-0 stageid 1 ruleid 4
entry created
interface : eoa-0
rule id
: 4
$
stage id : 1
order id : 4
$create filter rule map ifname eoa-0 stageid 1 ruleid 4
entry created
interface : eoa-1
rule id
: 4
127
stage id : 1
order id : 4
Application Note
7.2.10
HTTP filter
7.2.10.1
Scenario
7.2.10.2
Configuration
Step 1: create the filter rule for HTTP filter
$create filter rule entry ruleid 5 action drop ruledir in
$
entry created
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
:
:
:
:
:
:
:
5
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
Step 2: create the subrule
$create filter subrule tcp ruleid 5 subruleid
srcportcmp any ds tportcmp inrange subruleprio high
1
dstportfrom
80
entry created
rule id
: 5
start source port
: start destination port : 80
source port comparison : any
inrange
subrule priority
: high
transport header
: ethernet
$
subrule id
: 1
end source port
: end destination port
: 65535
destination port comparison :
Step 3: enable the rule
$modify filter rule entry ruleid 5 status enable
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
:
:
:
:
:
:
:
5
disable
in
ucast
interface
rule action : drop
admin status : disable
rule priority : high
applywhenreq : disable
:
:
:
:
:
:
:
5
disable
in
ucast
interface
rule action : drop
admin status : enable
rule priority : high
applywhenreq : disable
set done
rule id
set priority
stats admin status
rule direction
pkt type
application description
snoop level
$
Step 4: create the port to map this filter
$create filter rule map ifname eoa-0 stageid 1 ruleid 5
entry created
interface : eoa-0
rule id
: 5
128
stage id : 1
order id : 5
Application Note
129
7.2.11
ACL Configuration
Most network security sustems operate by allowing selective use of
services. An ACL (Acess Control List) is the usual means by which
access to, and denial of, services are controlled. It is simply a list of the
services available, each with a list of the hosts permitted to use the
service.
7.2.11.1
Scenario
7.2.11.2
Process of handling incoming packets
7.2.11.3
Configuration
Step 1: create ACL global
$create acl global macentry macaddr 00:01:eb:00:23:23 deny enable track enable
entry created
mac address
: 00:01:eb:00:23:23
deny
: enable track : enable
number of times port changed : 0
$
Step 2: create ACL port
$create acl port macentry portid 1 macaddr 00:01:23:23:23:34
entry created
portid
:1
mac address : 00:01:23:23:23:34
130
Application Note
$
$create acl port macentry portid 2 macaddr 00:01:32:23:35:43
entry created
portid
:2
mac address : 00:01:32:23:35:43
131
Application Note
7.2.12
TOS Priority Rearrangement
Most of traditional broadband service, there is only one PVC was
offered to the users. In such kind of service scenario, using the TOS
field in the IP header to differentiate the applications is one of the
solutions for ISPs to provide QoS service to its users.
The CPE (or router) shall have the capability to differentiate the service
priority, and indicated in the TOS field, so that the DSLAM can classify
the packets into different priority queues based upon the TOS field.
Following is an example to modify the priority of the packet based on IP
TOS field. In this example, the packets with IP TOS precedence
value as 3 would be tagged as ethernet priority value 2.
Step 1:
$ create filter rule entry ruleid 2 action retagprio priority 2 statsstatus
enable description QOS
Entry Created
Rule Id
Set Priority
Stats admin status
Rule Direction
Pkt Type
Application Description
Snoop Level
:
:
:
:
:
:
:
2
2
disable
in
Ucast
QoS
interface
Rule Action :
Admin status :
Rule Priority:
ApplyWhenReq :
retagprio
disable
high
disable
Expression Id: 0
Step 2:
$ create filter subrule generic ruleid 2 subruleid 1 offsethdr ip offset 0
mask 0x00ff0000 valuefrom 0x600000 gencmp eq
Entry Created
Rule Id
Offset header
Generic header comparison
Subrule Priority
End value
Transport Header
NamedList Id
:
:
:
:
:
:
:
2
ip
eq
asinrule
ethernet
-
Subrule Id
Offset
Mask
Start value
:
:
:
:
1
0
0x00ff0000
0x00600000
Step 3:
$ modify filter rule entry ruleid 2 status enable
Rule Id
Set Priority
Stats admin status
Rule Direction
Pkt Type
Application Description
Snoop Level
:
:
:
:
:
:
:
2
2
disable
in
Ucast
QoS
interface
Rule Action :
Admin status :
Rule Priority:
ApplyWhenReq :
:
:
:
:
:
:
:
2
2
disable
in
Ucast
QoS
interface
Rule Action :
Admin status :
Rule Priority:
ApplyWhenReq :
retagprio
disable
high
disable
Expression Id: 0
Set Done
Rule Id
Set Priority
Stats admin status
Rule Direction
Pkt Type
Application Description
Snoop Level
retagprio
enable
high
disable
Expression Id: 0
Step 4:
$ create filter rule map ruleid 2 ifname eoa-0 stageid 1
Entry Created
Interface : eoa-2
Rule Id
: 2
Stage Id : 1
Order Id : 2
Step 5:
132
Application Note
To view the priority-to-class mapping associated with an egress bridge
port, use –
$ get bridge port trfclassmap [portid portid] [regenprio regenprio]
You can modify the priority to traffic class mapping to define which
priority value would be mapped to which outgoing Queue for a port.
PortId
: 3
TrafficClass : 1
regenPrio : 0
PortId
: 3
TrafficClass : 0
regenPrio : 1
PortId
: 3
TrafficClass : 0
regenPrio : 2
PortId
: 3
TrafficClass : 1
regenPrio : 3
PortId
: 3
TrafficClass : 2
regenPrio : 4
PortId
: 3
TrafficClass : 2
regenPrio : 5
PortId
: 3
TrafficClass : 3
regenPrio : 6
PortId
: 3
TrafficClass : 3
regenPrio : 7
Step 6:
$ modify bridge port intf portid 3 status disable
Port Id
Max Unicast Addresses
Port Oper Status
Sticky Status
Acl Global Deny Apply
Acl Global Track Apply
ProxyArpStatus
:
:
:
:
:
:
:
3
16
Enable
Disable
Enable
Enable
disable
IfName
Learning Status
Port Admin Status
FDB Modify
:
:
:
:
eoa-2
Enable
Enable
Enable
Sensed IfIndex
: -
:
:
:
:
:
:
3
16
Disable
Disable
Enable
Enable
IfName
Learning Status
Port Admin Status
FDB Modify
:
:
:
:
Set Done
Port Id
Max Unicast Addresses
Port Oper Status
Sticky Status
Acl Global Deny Apply
Acl Global Track Apply
ProxyArpStatus
:
disable
eoa-2
Enable
Disable
Enable
Sensed
IfIndex
:
-
Step 7:
To re-configure the mapping, use –
$ modify bridge port trfclassmap portid portid regenprio regenprio
[trfclass
trfclass]
modify bridge port trfclassmap portid 3 regenprio
PortId
: 3
TrafficClass : 0
2 trfclass 3
regenPrio : 2
Set Done
PortId
TrafficClass
133
:
3
regenPrio
:
2
Application Note
7.2.13
IGMP Snooping
IGMP snooping, as implied by the name, is a feature that allows an
Ethernet switch to "listen in" on the IGMP conversation between hosts
and routers. When a Switch hears an IGMP report from a host for a
given multicast group, the switch adds the host's port number to the
IGMP list for that group. And, when the switch hears an IGMP leave, it
removes the host's port from the IGMP list.
7.2.13.1
Scenario
7.2.13.2
Configuration
Step 1: create IGMP rule and map to the eoa ports
$ create
$ create
eq
$ modify
$ create
$ create
$ create
$ create
$ create
filter rule entry ruleid 1 action sendtocontrol description IGMP
filter subrule ip ruleid 1 subruleid 1 prototypefrom 2 prototypecmp
filter
filter
filter
filter
filter
filter
rule
rule
rule
rule
rule
rule
entry ruleid
map ruleid 1
map ruleid 1
map ruleid 1
map ruleid 1
map ruleid 1
1 status enable
ifname eoa-0 stageid
ifname eoa-1 stageid
ifname eoa-2 stageid
ifname eoa-3 stageid
ifname eth-0 stageid
1
1
1
1
1
Setp 2: enable the igmpsnoop on bridge ports
$
$
$
$
$
modify
modify
modify
modify
modify
igmpsnoop
igmpsnoop
igmpsnoop
igmpsnoop
igmpsnoop
cfg info status enable
port info portid 1 status
port info portid 2 status
port info portid 3 status
port info portid 4 status
enable
enable
enable
enable
Step 3: Create multicast group on media server (IGMP version 2)
Add publish points on the specified media server.
Step 4: Join user1 to IGMP multicast group
Step 5: Join user2 to IGMP multicast group
Step 6: Join user3 to IGMP multicast group
Step 7: Join user4 to IGMP multicast group
134
8
System Administration with
CLI
8.1
About CLI Administration
Command Line Interface (CLI) is the primary user interface to
administrate the system. CLI can be accessed either from the CID port
or telnet session. All CLI commands are simple strings designed for the
Administrator to manage your IPLM easily. This chapter contains the
whole CLI commands. If to understand primary CLI commands, refer to
chapter 6 in which frequently used CLI commands are summarized.
8.1.1
Notation Conventions
• Keywords in a command that you must enter exactly as shown are
presented in bold.
• User specified values in a command are presented in regular
typeface, i.e., not bold or italic.
• Parameter values enclosed in < > must be specified.
• Parameters enclosed in [ ] are optional. All modify parameters are
shown as optional in CLI commands even if there exists only a
single parameter.
• Parameter values are separated by a vertical bar ì|î only when one
of the specified values can be used.
• Parameter values are enclosed in { } when you must use one of the
values specified.
• Parameters are enclosed in [ ] + when you can specify the
parameter one or more times, in the command line.
8.1.2
Command Structure
CLI commands conform to the following structure except for some basic
service com-mands such as ping, traceroute etc.
<Action><Group><Sub group><Sub sub group> <tag1 value1>Ö<tagN valueN>
<Action>: This is the first keyword of a CLI command. It indicates the
type of operation to be performed. "create" is an example of this
keyword. However, if no action is specified it will mean ìmodifyî. For
example, modify bridge port intf portid portid status enable and bridge
port intf portid portid status enable ì mean the same.
<Group>: This is the second keyword of a CLI command. It indicates
the group of a CLI command. "Bridge" is an example of this keyword.
<Sub group>: This is the third keyword of a CLI command. It indicates
the sub group of a CLI command. "Port" is an example of this keyword.
<Sub sub group>: This is the fourth keyword of a CLI command. It
indicates the sub group of a CLI command. "intf" is an example of this
keyword.
<tag1 value1> <tagN valueN>: These are <tag value> pairs and can
vary from 0 to N. They indicate the parameter values passed to a CLI
command. "ifname aal5-0", "portid 20", are examples of tag value pairs.
135
8.1.3
Glossary of Terms and Acronyms
This section contains a brief list of selected acronyms.
136
Abbreviation
Description
AAL5
ATM Adaptation Layer 5
ACL
Access Control list
ADSL
Asymmetric Digital Subscriber Line
Attribute
An element of an MO
ATM
Asynchronous Transmission Mode
CLI
Command Line Interface
CP
Control Plane
DHCP
Dynamic Host Configuration Protocol
DP
Data Plane
DRA
DHCP Relay Agent
DSL
Digital Subscriber Line
EOA
Ethernet over ATM
GARP
Generic Attribute Registration Protocol
GMRP
GARP Multicast Registration Protocol
GVRP
GARP VLAN Regenration Protocol
IGMP
InternetGroup Management Protocol
Index
An element of a tabular MO that uniquely identifies an
entry
IP
Internet protocol
IRL
Input Rate Limiting
IVL
Individual VLAN Learning
IVM
Individual VLAN for Multicast
LACP
Link Aggregation Control Protocol
LAN
Local Area Network
ME - Management Entity
The entity, modified, controlled and monitored through
MOs.
MO ID - MO Identifier
A unique number that identifies an MO. Interpretation of
the information passed to GenAg for an MO depends upon
this identifier
MO - Managed Object
Logical unit of manageable information. It is similar to a
MIB. An ME is visible to the outside world in the form of
one or more MOs that constitute it.
Operations
GAG supports five operations - Create, Delete, Modify,
Get, Get-Next
ORL
Output Rate Limiting
OAM
Operations Administration and Management
PIA
PPPoE Intermediate Agent
RMON
Remote Monitoring
STP
Spanning Tree Protocol
SNTP
Simple Network Time Protocol
SVL
Shared VLAN Learning
SVM
Shared VLAN for Multicast
Specific Agent
Entities that use GenAg interfaces to manage the system
TEA
Target Engine Agent
VC
Virtual Channel
VLAN
Virtual LAN
137
8.1.4
CLI Command Brief Description
CLI Command - Action List
<action>
Description
alias
apply
climode
commit
Used to create an alias for any CLI command.
Used to apply a configuration file stored on the system
Modes of cli/Prio change of CLI task
Used to commit the active configuration to the flash.
Used to create configuration of objects corresponding to the identifier
and parameters.
Used to delete configuration of objects corresponding to the identifier and
parameters. If the delete action is confirmed, the configuration of objects
will no longer exist.
Defragment the compact blocks in flash
Used to download a binary, configuration or user specific file from
theremote host.
Used to view information of the selected identifier and parameters.
Used to view the detailed usage of CLI commands.
Used to list the Configuration or binary files stored on the unit
Used to terminate the CLI.
Specify the length of memory set
Used to set or modify existing configuration of objects corresponding to
the identifier and parameters.
Used to change the password associated with a user login.
Use this command to change the permission of the files stored on
flash
Used to send one or more ICMP messages to another host for a
reply.
Used to set the new CLI prompt.
Used to read Flash
Used to read Memory
Used to restart the system.
Used to remove a configuration or binary file stored on the unit
Used to reset a port of system.
Used to save the configuration to Flash RAM.
Used to Sync
Used to trace the route to the specified destination.
Used to delete an alias.
Used to upgrade a configuration or binary file stored on the system.
Using this command, a user can view the status of entries before and
after the execution of a command (create, delete, modify, get).
Used to write Memory
Create
delete
defragment
download
get
help
list
logout
memset
modify
passwd
permission
Ping
prompt
rdf
rdm
reboot
remove
reset
save
Sync
traceroute
unalias
upgrade
verbose
wrm
• Note: the actions in grey background are for KM support personal
only and should not be used by end custumor.
8.1.5
Categories of the CLI commands
Command
Implemented by
Recommend for end-users
Bridge port accessprio Commands
Conexant
Yes
Bridge port prioinfo Commands
Conexant
Yes
Bridge port trfclassmap Commands
Conexant
Yes
Bridge port priomap commands
Conexant
Yes
Conexant
Yes, but this is a legacy
command and you should
802.1p Commands
ABOND
ABOND group intf Commands
138
contact KEYMILE support
personal when you plan to
use.
ABOND group stats Commands
Conexant
Yes
Abond link entry Commands
Conexant
Yes
Abond link stats Commands
Conexant
Yes
Active Standby aggr info
Commands
Conexant
Yes
Aggr intf Commands
Conexant
Yes
LACP Aggr Commands
Conexant
Yes
Aggregation Commands
LACP AGGRPort Info Commands
Conexant
Yes
LACP AGGRPort List Command
Conexant
Yes
LACP AGGRPort Stats Commands
Conexant
Yes
Redundancy aggr info Commands
Conexant
Yes
Redundancy aggrport list
Commands
Conexant
Yes
Redundancy aggr stats Commands
Conexant
Yes
AAL5 VC Statistics Commands
Conexant
Yes
ATM OAM CC Commands
Conexant
Yes
ATM Commands
ATM OAM Loopback Commands
Conexant
Yes
ATM Port Commands
Conexant
Yes
ATM VC Commands
Conexant
Yes
ATM VC Statistics Commands
Conexant
Yes
Bridging Commands
Bridge forwarding Commands
Conexant
Yes
Bridge Mode Commands
Conexant
Yes
Bridge Port Cap Commands
Conexant
Yes
Bridge port forwarding Commands
Conexant
Yes
Bridge Port Map Commands
Conexant
Yes
Bridge Port Stats Table Commands
Conexant
Yes
Bridge Port Table Commands
Conexant
Yes
Bridge static mcast Commands
Conexant
Yes
Bridge static ucast Commands
Conexant
Yes
Bridge tbg traps Commands
Conexant
Yes
GARP Port Info Commands
Conexant
Yes
STP Group Commands
Conexant
Yes
STP Port Commands
Conexant
Yes
Transparent Bridging Table
Commands
Conexant
Yes
Bridge mcast forwarding
Commands
Conexant
Yes
Bridge mcast forwarding
Commands
Conexant
Yes
Bridge mcast fwdunreg Commands
Conexant
Yes
Bridge Static Multicast Commands
Conexant
Yes
Conexant
Yes
ADSL Alarm Profile Commands
Conexant
Yes
ADSL Alarm Profilext Commands
Conexant
Yes
Bridge Multicast Commands
DHCP Commands
DHCP Client Commands
DSL Commands
139
ADSL ATUC Channel Commands
Conexant
Yes
ADSL ATUC Chanperf Commands
Conexant
Yes
ADSL ATUC ChanIntvl Commands
Conexant
Yes
ADSL ATUC Interval Commands
Conexant
Yes
ADSL ATUC Perf Commands
Conexant
Yes
ADSL ATUC Physical Commands
Conexant
Yes
ADSL ATUC Trap Commands
Conexant
Yes
ADSL ATUC Trapsext Commands
Conexant
Yes
ADSL ATUR ChanIntrvl Commands
Conexant
Yes
ADSL ATUR Channel Commands
Conexant
Yes
ADSL ATUR Chanperf Commands
Conexant
Yes
ADSL ATUR Interval Commands
Conexant
Yes
Adsl atur intervalext Commands
Conexant
Yes
ADSL ATUR Perf Commands
Conexant
Yes
Adsl atur perfext Commands
Conexant
Yes
ADSL ATUR Physical Commands
Conexant
Yes
ADSL ATUR Traps Commands
Conexant
Yes
DSL ATUR Trapsext Commands
Conexant
Yes
ADSL Cap Commands
Conexant
Yes
ADSL Line Intf Commands
Conexant
Yes
ADSL Line Profile Commands
Conexant
Yes
Dsl chip Commands
Conexant
Yes
Dsl dsp chip Commands
Conexant
Yes
Dsl dsp port Commands
Conexant
Yes
Dsl system Commands
Conexant
Yes
Shdsl cap Commands
Conexant
Yes
Shdsl endpoint alarmprofile
Commands
Conexant
Yes
Shdsl endpoint currentry
Commands
Conexant
Yes
Shdsl endpoint maint Commands
Conexant
Yes
Shdsl interval 15min Commands
Conexant
Yes
Shdsl interval 1day Commands
Conexant
Yes
Shdsl line intf Commands
Conexant
Yes
Shdsl line status Commands
Conexant
Yes
Shdsl span conf Commands
Conexant
Yes
Shdsl span confprofile Commands
Conexant
Yes
Shdsl span status Commands
Conexant
Yes
Shdsl unit inventory Commands
Conexant
Yes
Shdsl unit maintinfo Commands
Conexant
Yes
Conexant
Yes
Dot3 stats Commands
Conexant
Yes
Ethernet Commands
Conexant
Yes
EHDLC Commands
Ehdlc intf Commands
Ethernet Commands
Filtering Commands
140
ACL Global Macentry Commands
Conexant
Yes
Clfr list genentry commands
Conexant
Yes
ACL Port Macentry Commands
Conexant
Yes
Clfr namedlist genentry Commands
Conexant
Yes
Clfr namedlist info Commands
Conexant
Yes
Clfr namedlist map Commands
Conexant
Yes
Clfr profile branch Commands
Conexant
Yes
Clfr profile info Commands
Conexant
Yes
Clfr profile node Commands
Conexant
Yes
Clfr tree branch Commands
Conexant
Yes
Clfr tree info Commands
Conexant
Yes
Clfr tree map Commands
Conexant
Yes
Clfr tree node Commands
Conexant
Yes
Clfr tree profile Commands
Conexant
Yes
Filter expr entry Commands
Conexant
Yes
Filter list genentry Commands
Conexant
Yes
Filter namedlist genentry
Commands
Conexant
Yes
Filter namedlist info Commands
Conexant
Yes
Clfr tree node Commands
Conexant
Yes
Clfr tree profile Commands
Conexant
Yes
Filter expr entry Commands
Conexant
Yes
Filter list genentry Commands
Conexant
Yes
Filter namedlist genentry
Commands
Conexant
Yes
Filter namedlist info Commands
Conexant
Yes
Filter namedlist map
Commands
Conexant
Yes
Create filter namedlist map
Conexant
Yes
Filter rule actionmap
Commands
Conexant
Yes
Filter rule entry Commands
Conexant
Yes
Filter rule map Commands
Conexant
Yes
Filter rule stats Commands
Conexant
Yes
Filter seq entry Commands
Conexant
Yes
Filter seq info Commands
Conexant
Yes
Filter subrule arp Commands
Conexant
Yes
Filter subrule clfrtree
Commands
Conexant
Yes
Filter subrule ether Commands
Conexant
Yes
Filter subrule generic
Commands
Conexant
Yes
Filter subrule ICMP Commands
Conexant
Yes
Filter subrule IGMP Commands
Conexant
Yes
Filter subrule IP Commands
Conexant
Yes
Filter subrule PPP Commands
Conexant
Yes
Filter subrule TCP Commands
Conexant
Yes
Filter subrule UDP Commands
Conexant
Yes
Conexant
Yes
Igmpsnoop cfg info Commands
Conexant
Yes
Igmpsnoop cfg info Commands
Conexant
Yes
Igmpsnoop mvlan config
Commands
Conexant
Yes
Igmpsnoop port info Commands
Conexant
Yes
EOA Commands
EOA Commands
IGMP Commands
141
Igmpsnoop port stats Commands
Conexant
Yes
Igmpsnoop querier info Commands
Conexant
Yes
Conexant
Yes
IP Net to Media Table Commands
Conexant
Yes
IP Route Commands
Conexant
Yes
Ipoa intf Commands
Conexant
Yes
ipoe intf Commands
Conexant
Yes
Rid static Commands
Conexant
Yes
Conexant
Yes
Interface Commands
Interface Commands
IP Commands
MacProfile Commands
Macprofile global Commands
Resvdmac profile info Commands
Conexant
Yes
Resvdmac profile param
Commands
Conexant
Yes
Ctlpkt group info Commands
Conexant
Yes
Ctlpkt instance info Commands
Conexant
Yes
Ctlpkt profile info Commands
Conexant
Yes
Management Traffic Commands
PPPoE Tunneling Commands
PPPoE Global ACprofile
Commands
PPPoE Global Config Commands
PPPoE Global Serviceprofile
Commands
PPPoE Global Stats Commands
Pppoe intf Commands
PPPoE Session Stats Commands
PPPR Interface Commands
IA (Intermeida Agent) Commands
Dra global stats Commands
Dra instance entry Commands
Dra stats entry Commands
Dra global config Commands
Ia profile entry Commands
Pia instance entry Commands
Pia stats entry Commands
Pia global config Commands
QoS Commands
IRL Map Commands
IRL Profile Commands
IRL Stats Commands
Bridge rlinstance map Commands
Rl actionprofile info Commands
Rl instance info Commands
Rl profile info Commands
Scheduling profile class
Commands
Scheduling profile info Commands
Trfclass profile class Commands
Trfclass profile info Commands
Trfclass stats Commands
142
RMON Commands
RMON Statistics Group Commands
RMON Task Info Commands
RMON Memory Pool info
Commands
RMON Queue info Commands
RMON Net buffers info Commands
RMON Semaphore info Commands
RMON Event Group info
Commands
SNMP Commands
SNMP Comm Commands
SNMP Host Commands
SNMP Stats Commands
SNMP Traphost Commands
SNTP Commands
SNTP Cfg Commands
SNTP servaddr Commands
SNTP Stats Commands
System Commands
Cbuftrace cfg Commands
System Configuration Save and
Restore Commands
System Control Table Commands
System crash info commands
System Info Commands
System manuf info Commands
System reboot info command
Nbize Commands
System Stats Commands
System Traps Commands
System Trap Log Table Commands
System version commands
Trace Log Configuration
Commands
Trace Log Statistics Commands
VC Aggregation Commands
Atm vcaggr intf Commands
Atm vcaggr map Commands
VLAN Commands
GVRP Info Commands
GVRP Port Info Commands
GVRP Port Stats Commands
Vlan curr info Commands
VLAN mapprofile info Commands
Vlan mapprofile param Commands
VLAN Static Commands
Miscelleneous Commands
File Commands
Other Commands
C-COM CLI Commands
System ADSL Port Operation
143
Status Commands
System Alarm Commands
System Control Commands
System Hardware Inventory
Commands
System ivmconfig Commands
System SFP Commands
System Version Commands
System Debug Commands
Configuration FD Commands
Configuration USER Commands
Temperature Configuration
Commands
Temperature State Commands
Temperature Supervision
Commands
Temperature Configuration
Commands Temperature State
Commands
Temperature Supervision
Commands
System Commands
144
System Hardware Inventory
Commands
C-COM
Yes
System ivmconfig Commands
C-COM
Yes
System Debug Commands
C-COM
No, for KEYMILE and C-COM
support personal only
8.2
8.2.1
8.2.1.1
802.1p Commands
Bridge port accessprio Commands
Get bridge port accessprio
Description: Use this command to get.
Command Syntax: get bridge port accessprio [portid <portid-val>]
[regenprio <regenprio-val >]
Parameters
Name
Description
portid <portid-val >
Port number of the port for which this entry contains bridge
management information.
Type : Get-—Optional
Valid values: 1-386
Regenerated user priority from which the access priority is
mapped.
Type : Get —Optional
Valid values: 0 - 7
regenprio <regenprioval >
Example
$ get bridge port accessprio portid 1 regenPrio 1
Output
PortId
: 1
regenPrio : 1
AcessPriority : 0
Output field
Field
Description
PortId
Port number of the port for which this entry contains bridge
management information.
Regenerated user priority from which the access priority is
mapped.
The Outbound Access Priority the received frame is
mapped to.
regenPrio
AcessPriority
References
• Bridge port commands
8.2.2
8.2.2.1
Bridge port prioinfo Commands
Get bridge port prioinfo
Description Use this command to get.
Command Syntax get bridge port prioinfo [portid <portid-val >]
8.2.2.2
Modify bridge port prioinfo
Description: Use this command to modify.
Command Syntax: modify bridge port prioinfo portid portid [defprio
<defprio-val>] [numtrfclass <numtrfclass-val>] [defsvprio <defsvprioval>]
Parameters:
145
Name
Description
portid <portid>
Port number of the port for which this entry contains bridge
management information.
Type: Modify -- Mandatory
defprio <defprio-val>
numtrfclass
<numtrfclass-val>
defsvprio <defsvprioval>
Get -- Optional
Valid values: 1 - 386
The default ingress User Priority which can be configured
by the user.
Type: Modify - Optional
Valid values: 0 - 7
The number of egress traffic classes supported on this
port.
Type: Modify - Optional
Valid values: 1 - 8
Not supported
Type: Modify Optional
Valid values: 0 - 7
Example
$ get bridge port prioinfo portid 1
Output
PortId
: 1
DefaultPriority
: 1
NumTrafficClass : 3
DefaultSVPriority : 1
Output field
Field
Description
PortId
Port number of the port for which this entry contains bridge
management information.
The default ingress User Priority which can be configured
by the user. The default value of this attribute can be 0 or 0
depending on interface over which the bridge port is
created. The default value is 0 for bridge port created over
ethernet or aggregator interface. And the default value is 0
if the interface over which the bridge port has been created
is one of EOA, PPPoE and IPoE.
The number of egress traffic classes supported on this
port. It depends on whether bridge port is over EOA, in
which case, the max number of queues is value of
maxnumeoaprioQs in gsvSystemSizingGroup and default
value is also value of maxnumeoaprioQs in nbsize or over
Ethernet / aggregated interface, in which case, the max
number of queues is value of MaxNumEthPrioQs in nbsize
and default value is also value of MaxNumEthPrioQs in
nbsize. It is modifiable only when the bridge port is in
disabled state.
Not supported
DefaultPriority
NumTrafficClass
DefaultSVPriority
References
• Bridge port commands
8.2.3
8.2.3.1
Bridge port trfclassmap Commands
Get bridge port trfclassmap
Description: Use this command to get.
Command Syntax: get bridge port trfclassmap [portid <portid-val >]
[regenprio <regenprio-val >]
8.2.3.2
Modify bridge port trfclassmap
Description: Use this command to modify.
Command Syntax: modify bridge port trfclassmap portid <portidval > regenprio <regenprio-val > [trfclass <trfclass-val>]
146
Parameters
Name
Description
portid <portid-val >
Port number of the port for which this entry contains
bridge management information.
Type: Modify - Mandatory
Get - Optional
Valid values: 1-386
The Priority value evaluated for the received frame. In
our case, it is the regenerated user priority. This
regenerated priority is mapped from user priority
determined by a) packet classifier rule indicating user
priority for that port b) user priority received in the tag
header and c) default source priority of the port, in that
order. It lies in the range 0-7
Type: Modify - Mandatory
Get - Optional
Valid values: 0 - 7
The Traffic Class the received frame is mapped to. The
maximum value of trafficClass is defined by numTrfClass
parameter of Bridge Port PrioInfo. The default value of
this field shall be determined according to table 7-2
described in ANSI/IEEE Std 802.1d 1998 Edition
Document. This mapping is modifiable only when the
bridge port is in disabled state.
Type: Modify - Optional
regenprio <regenprioval >
trfclass <trfclass-val >
Example
$ get bridge port trfclassmap portid 1 regenPrio 1
Output
PortId
: 1
regenPrio : 1
TrafficClass : 2
Output field
Field
Description
PortId
Port number of the port for which this entry contains
bridge management information.
The Priority value evaluated for the received frame. In
our case, it is the regenerated user priority. This
regenerated priority is mapped from user priority
determined by a) packet classifier rule indicating user
priority for that port b) user priority received in the tag
header and c) default source priority of the port, in that
order. It lies in the range 0-7
The Traffic Class the received frame is mapped to. The
maximum value of trafficClass is defined by numTrfClass
parameter of Bridge Port PrioInfo. The default value of
this field shall be determined according to table 7-2
described in ANSI/IEEE Std 802.1d 1998 Edition
Document. This mapping is modifiable only when the
bridge port is in disabled state.
regenPrio
TrafficClass
References
8.2.4
8.2.4.1
Bridge port priomap commands
Get bridge port priomap
Description: Use this command to get.
Command Syntax: get bridge port priomap [portid <portid-val >]
[usrprio <usrprio-val >]
8.2.4.2
Modify bridge port priomap
Description: Use this command to modify.
147
Command Syntax: modify bridge port priomap portid <portid-val >
usrprio <usrprio-val> [regenprio <regenprio-val >]
Parameters
Name
Description
portid <portid-val >
Port number of the port for which this entry contains bridge
management information.
Type: Modify -- Mandatory
Get --Optional
Valid values: 1-386
The User Priority for a frame received on this port. Since it
can arrive in a tag header, it can have range 0-7.
Type: Modify -- Mandatory
Get --Optional
Valid values: 0 - 7
The priority to which the incoming User priority is mapped
for this port.
Type: Modify --Optional
alid values: 0 - 7
usrprio <usrprio-val >
regenprio <regenprioval >
Example
$ get bridge port priomap portid 1 usrPrio 1
Output
PortId
: 1
UserPriority : 1
RegenUserPrio : 1
Output field
Field
PortId
UserPriority
RegenUserPrio
Description
Port number of the port for which this entry contains bridge
management information.
The User Priority for a frame received on this port. Since it
can arrive in a tag header, it can have range 0-7.
The priority to which the incoming User priority is mapped
for this port.
References
• Bridge port commands
148
8.3
8.3.1
8.3.1.1
ABOND Commands
ABOND group intf Commands
Get abond group intf
Description: Use this command to get.
Command Syntax: get abond group intf [ifname <interface-name>]
8.3.1.2
Create abond group intf
Description: Use this command to create.
Command Syntax: create abond group intf ifname<interface-name>
groupid <groupid-val> [ minaggrrateupstrm <minaggrrateupstrmval> ] [ minaggrratednstrm <minaggrratednstrm-val> ]
[ diffdelaytolupstrm <diffdelaytolupstrm-val> ] [ diffdelaytoldnstrm
<diffdelaytoldnstrm-val> ] [ asmprotocol Enable | Disable ]
[ sidformat EightBitSid | TwelveBitSid ] [ maxrxbitrateratio
<maxrxbitrateratio-val> ] [ linkhecthrshld <linkhecthrshld-val> ]
[ numoflinksupforgrpup One | All ] [ asmirlthreshold
<asmirlthreshold-val> ] [ maxatmportusrate <maxatmportusrate-val> ]
8.3.1.3
Delete abond group intf
Description: Use this command to delete.
Command Syntax: delete abond group intf ifname <interfacename>
8.3.1.4
Modify abond group intf
Description: Use this command to modify.
Command Syntax: modify abond group intf ifname <interfacename> [ groupid <groupid-val> ] [ minaggrrateupstrm
<minaggrrateupstrm-val> ] [ minaggrratednstrm <minaggrratednstrmval> ] [ diffdelaytolupstrm <diffdelaytolupstrm-val> ]
[ diffdelaytoldnstrm <diffdelaytoldnstrm-val> ] [ asmprotocol Enable |
Disable ] [ sidformat EightBitSid | TwelveBitSid ]
[ maxrxbitrateratio <maxrxbitrateratio-val> ] [ linkhecthrshld
<linkhecthrshld-val> ] [ numoflinksupforgrpup One | All ]
[ asmirlthreshold <asmirlthreshold-val> ] [ maxatmportusrate
<maxatmportusrate-val> ] [ enable | disable ]
Parameters
Name
Description
ifname <interfacename>
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces. Valid Value
is abond-X. Modification and deletion is not possible if
interface is enabled
Type: Create- Mandatory
Delete ---Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0 - 31
This specifies the group id configured for this interface.
This field is configured statically when the bonded group
is provisioned and must not be changed while the group
is in service. These fields may be used by an operator to
help identify mis-configuration or to assist in
management or debugging of the link.
Type: Create - Mandatory
Modify - Optional
groupid <groupid-val>
149
minaggrrateupstrm
<minaggrrateupstrmval>
minaggrratednstrm
<minaggrratednstrmval>
diffdelaytolupstrm
<diffdelaytolupstrm-val>
diffdelaytoldnstrm
<diffdelaytoldnstrm-val>
asmprotocol Enable
|Disable
sidformat EightBitSid
|TwelveBitSid
maxrxbitrateratio
<maxrxbitrateratio-val>
linkhecthrshld
<linkhecthrshld-val>
numoflinksupforgrpup
One | All
asmirlthreshold
<asmirlthreshold-val>
maxatmportusrate
<maxatmportusrateval>
enable | disable
150
Minimum Aggregate Data Rate in bits per second in
Upstream direction.
Type: Create - Optional
Modify - Optional
Default value: 0
Minimum Aggregate Data Rate in bits per second in
Downstream direction.
Type: Create - Optional
Modify - Optional
Default value: 0
The maximum differential delay among member links in a
bonding group in Upstream direction. Type: Create -
Optional
Modify - Optional
Valid values: 0 -4
Default value: 4
The maximum differential delay among member links in a
bonding group in downstream direction. Type: Create -
Optional
Modify - Optional
Valid values: 0 -24
Default value: 4
This parameter specifies whether Autonomous Status
Messages will be exchanged between CO and CPE. If it
is disabled then the group would be bonded statically and
CO would assume CPE to know all the configuration
parameters like SID format, number of links in the
bonded group and the links participating in bonding. If it
is enabled then CO would inform all these parameters to
CPE using Autonomous Status Messages.
Type: Create - Optional
Modify - Optional
Default value: enable
SID Format: 8 bit or 12 bit SID. Only 8 bit format is being
supported
Type: Create - Optional
Modify - Optional
Default value: 1
The maximum bit rate ratio among member links in a
bonding group in upstream direction.
Type: Create - Optional
Modify - Optional
Valid values: 1 -4
Default value: 4
HEC Error percentage of the link upstream rate which will
act as Threshold for link to be part of group in Rx
direction
Type: Create - Optional
Modify - Optional
Valid values: 1 -10
Default value: 2
This field specifies the number of links required to be up
for bonding to start ASM protocol
Type: Create - Optional
Modify - Optional
Default value: 0
IRL Threshold for ASM messages
Type: Create - Optional
Modify - Optional
Valid values: 1 -8
Default value: 8
Maximum ATM port Upstream Rate
Type: Create - Optional
Modify - Optional
Valid values: 0 -8000
Default value: 4000
Administrative status of the interface.
Type: Create - Optional
Modify - Optional
Valid values: enable, disable
Default value: enable
Example:
$ create abond group intf ifname abond-0 groupid 1 minaggrrateupstrm 5
minaggrratednstrm 5 diffdelaytolupstrm 0 diffdelaytoldnstrm 0 asmprotocol
Disable sidformat EightBitSID maxrxbitrateratio 2 linkhecthrshld 1
numoflinksupforgrpup One asmirlthreshold 0 maxatmportusrate 0
Output
Verbose Mode On
Entry Created
ifname
: abond-0
GroupId
: 1
MinAggrRateUpstrm
: 5
MinAggrRateDnstrm
: 5
DiffDelayTolUpstrm
: 4
DiffDelayTolDnstrm : 4
AsmProtocol
EightBitSID
: Disable
SidFormat
:
MaxRxBitRateRatio
: 2
LinkHecThreshold
: 1
CtrlVpi
: 0
CtrlVci
: 0
AsmIrlThreshold
: 0
Admin Status
: Enable
NoOfLinksUpForGrpUp : One
MaxAtmPortUsRate
: 0
Oper Status
: Up
Verbose Mode Off:
Output Fields
Field
Description
ifname
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces. Valid Value
is abond-X. Modification and deletion is not possible if
interface is enabled
This specifies the group id configured for this interface.
This field is configured statically when the bonded group
is provisioned and must not be changed while the group
is in service. These fields may be used by an operator to
help identify mis-configuration or to assist in
management or debugging of the link.
Minimum Aggregate Data Rate in bits per second in
Upstream direction.
Minimum Aggregate Data Rate in bits per second in
Downstream direction.
The maximum differential delay among member links in
a bonding group in Upstream direction.
The maximum differential delay among member links in
a bonding group in downstream direction.
This parameter specifies whether Autonomous Status
Messages will be exchanged between CO and CPE. If it
is disabled then the group would be bonded statically
and CO would assume CPE to know all the
configuration parameters like SID format, number of
links in the bonded group and the links participating in
bonding. If it is enabled then CO would inform all these
parameters to CPE using Autonomous Status
Messages.
SID Format: 8 bit or 12 bit SID. Only 8 bit format is being
supported
The maximum bit rate ratio among member links in a
bonding group in upstream direction.
GroupId
MinAggrRateUpstrm
MinAggrRateDnstrm
DiffDelayTolUpstrm
DiffDelayTolDnstrm
AsmProtocol
SidFormat
MaxRxBitRateRatio
151
LinkHecThreshold
HEC Error percentage of the link upstream rate which
will act as Threshold for link to be part of group in Rx
direction
Control Channel VPI: VPI value being used for Sending
and Receiving ASM Messages
Control Channel VCI: VCI value being used for Sending
and Receiving ASM Messages
This field specifies the number of links required to be up
for bonding to start ASM protocol
IRL Threshold for ASM messages
Maximum ATM port Upstream Rate
CtrlVpi
CtrlVci
NoOfLinksUpForGrpUp
AsmIrlThreshold
MaxAtmPortUsRate
Oper Status
8.3.2
8.3.2.1
The actual/current state of the interface. It can be either
up or down.
ABOND group stats Commands
Get abond group stats
Description: Use this command to get.
Command Syntax: get abond group stats [ifname <interface-name>]
8.3.2.2
Reset abond group stats
Description: Use this command to reset.
Command Syntax: reset abond group stats ifname <interfacename>
Parameters:
Name
Description
Ifname <interfacename>
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces. Valid
Value is abond-X
Type: Reset - Mandatory
Get - Optional
Valid values: abond-0-abond-1
Example
$ get abond group stats ifname abond-0
Output
ifname
: abond-0
AchievedAggrRateUpstrm
AchievedAggrRateDnstrm
: 10
: 12
CellLossUpstrmCurrent
CellLossDnstrmCurrent
: 12
: 20
CellLossUpstrmPrv15min
CellLossDnstrmPrev15Min
: 12
: 20
CellLossUpstrmCurrentDay
CellLossDnstrmCurrentDay
: 12
: 20
CellLossUpstrmPrevDay
CellLossDnstrmPrevDay
: 12
: 20
GroupFailureCntCurrent
GroupFailureCntPrev15Min
: 15
: 15
GrpFailureCntCurrentDay
GrpFailureCntPrevDay
: 15
: 15
GrpUnavailableSecCurrent : 15
GrpUnavailableSecPrev15Min : 15
GrpUnavailblSecCurrentDay : 15
GrpUnavailblSecPrevDay
: 15
ASMTxCnt
ASMRxCnt
152
: 10
: 10
GrpFailureReason
: MinRateNotAchievedUpAndDn
AsmRxCrcErrorCount
: 10
Output Fields
Field
Description
ifname
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces. Valid Value
is abond-X
Achieved aggregate data rate in bits per sec in
upstream direction.
Achieved aggregate data rate in bits per sec in
downstream direction.
Group cell loss count upstream for current 15 minutes.
AchievedAggrRateUp
strm
AchievedAggrRateDn
strm
CellLossUpstrmCurre
nt
CellLossDnstrmCurre
nt
CellLossUpstrmPrv15
min
CellLossDnstrmPrev1
5Min
CellLossUpstrmCurre
ntDay
CellLossDnstrmCurre
ntDay
8.3.3
8.3.3.1
Group Rx cell loss count downstream for current 15
minutes.
Group cell loss count upstream for Last 15 minutes.
Group cell loss count downstream for Last 15 minutes.
Group cell loss count upstream for current Day.
Group Rx cell loss count downstream for current Day.
CellLossUpstrmPrevD
ay
Group Rx cell loss count upstream for previous Day.
CellLossDnstrmPrevD
ay
GroupFailureCntCurre
nt
GroupFailureCntPrev
15Min
GrpFailureCntCurrent
Day
GrpFailureCntPrevDa
y
GrpUnavailableSecCu
rrent
GrpUnavailableSecPr
ev15Mi n
GrpUnavailblSecCurr
entDay
GrpUnavailblSecPrev
Day
ASMTxCnt
ASMRxCnt
GrpFailureReason
AsmRxCrcErrorCount
Group Rx cell loss count downstream for Previous Day.
Group failure count for current 15 minutes.
Group failure count for previous 15 minutes.
Group failure count for current Day.
Group failure count for previous Day.
Group unavailable second current.
Group unavailable second previous 15 Min.
Group unavailable second current Day.
Group unavailable second for previous Day.
Group ASM Tx count.
Group ASM Rx count.
Failure reason for the abond Group.
group Asm Rx crc error count.
Abond link entry Commands
Get abond link entry
Description Use this command to get.
Command Syntax get abond link entry [ifname <interface-name>]
[lowif <lowif-val>]
8.3.3.2
Create abond link entry
Description: Use this command to create.
Command Syntax: create abond link entry ifname <interface-name>
lowif <lowif-val> [txlinkadminstatus Enable | Disable]
[rxlinkadminstatus Enable | Disable] [asmrxgroupintf
<asmrxgroupintf>] [asmrxlinkindex <asmrxlinkindex>]
153
8.3.3.3
Delete abond link entry
Description: Use this command to delete.
Command Syntax: delete abond link entry ifname <interface-name>
lowif <lowif-val>
8.3.3.4
Modify abond link entry
Description: Use this command to modify.
Command Syntax: modify abond link entry ifname <interfacename> lowif <lowif-val> [txlinkadminstatus Enable | Disable]
[rxlinkadminstatus Enable | Disable]
Parameters:
Name
Ifname <interfacename>
lowif <lowif-val>
txlinkadminstatus
Enable | Disable
rxlinkadminstatus
Enable | Disable
asmrxgroupintf
<asmrxgroupintf>
Description
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces.
ValidValue is abond-X. Link can not be created,
deleted or modified if associated abond group
interface is enabled.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: abond-0-abond-1
This specifies the interface index used for the abond
link (DSL) entry. Valid Value is dsl-X ,dsli-X , dslf-X
Type: Create - Mandatory
Delete - Mandatory
Modify -Mandatory
Get - Optional
This specifies the Tx Status for the link in a Group.
Type: Create - Optional
Modify - Optional
Default value: enable
This specifies the Rx Status for the link in a Group.
Type: Create - Optional
Modify - Optional
Default value: enable
Abond group Interface Index of proxy link.
Type: Create -- Optional
Valid values: abond-0_ABONDGR_MAX_IFINDEX
Default value: 0xffffffff
asmrxlinkindex
<asmrxlinkindex>
Lower Interface Index of Proxy link.
Type: Create -- Optional
Default value: 0xffffffff
Example
$ create abond link entry ifname abond-0 lowif dsl-0 txlinkadminstatus enable
rxLinkadminstatus enable asmrxgroupintf abond-0 asmrxlinkindex dsl-0
Output
Verbose Mode On
Entry Created
154
ifname
: abond-0
lowif
: dsl-0
AsmRxGroupIntf
: abond-0
AsmRxLinkIndex
: dsl-0
TxLinkAdminStatus : enable
RxLinkAdminStatus : enable
TxLinkOperStatus
RxLinkOperStatus
: Disable
: Disable
AsmTxLinkStatus
: SelectedToCarryBondingTraffic
AsmRxLinkStatus
: SelectedToCarryBondingTraffic
Verbose Mode Off:
Entry Created
Output Fields
8.3.4
8.3.4.1
Field
Description
ifname
This specifies the interface index used for the ATM
Based Multi pair Bonding type of interfaces. Valid
Value is abond-X. Link can not be created , deleted
or modified if associated abond group interface is
enabled.
lowif
This specifies the interface index used for the abond
link (DSL) entry. Valid Value is dsl-X ,dsli-X , dslf-X
AsmRxGroupIntf
Abond group Interface Index of proxy link.
AsmRxLinkIndex
Lower Interface Index of Proxy link.
TxLinkAdminStatus
This specifies the Tx Status for the link in a Group.
RxLinkAdminStatus
This specifies the Rx Status for the link in a Group.
TxLinkOperStatus
The current operational status of the abond link in
Tx direction.
RxLinkOperStatus
This specifies the rx operational Status for the link in
a Group.
AsmTxLinkStatus
The current Tx Link status of the abond link as
reflected in ASM Messages.
AsmRxLinkStatus
The current Rx Link status of the abond link as
reflected in ASM Messages.
Abond link stats Commands
Get abond link stats
Description: Use this command to get.
Command Syntax: get abond link stats [ifname <interface-name>]
[lowif <lowif-val>]
8.3.4.2
Reset abond link stats
Description: Use this command to reset.
Command Syntax: reset abond link stats ifname<interface-name>
lowif <lowif-val>
Parameters:
Name
Description
ifname <interfacename>
This specifies the interface index used for the
ATM Based Multi pair Bonding type of interfaces.
Valid Value is abond-X
Type: Reset - Mandatory
Get - Optional
Valid values: 0 - 30
This specifies the interface index used for the
abond link (DSL) interfaces. Valid Value is dsl-X,
dsli-X, dslf-X
Type: Reset - Mandatory
Get - Optional
lowif <lowif-val>
Example
$ get abond link stats ifname abond-0 lowif dsl-0
155
Output
ifname
: abond-0
lowif
: dsl-0
ASMTxCount
: 10
ASMRxCount : 10
TxLinkFailureReason : HecLimitExceeded
RxLinkFailureReason : HecLimitExceeded
Output Fields
Field
Description
ifname
This specifies the interface index used for the
ATM Based Multi pair Bonding type of interfaces.
Valid Value is abond-X
This specifies the interface index used for the
abond link (DSL) interfaces. Valid Value is dsl-X,
dsli-X, dslf-X
Per-link ASM Tx count. These are not exact
counts and have been kept for debugging.
Per-link ASM Rx count. These are not exact
counts and have been kept for debugging.
Failure reason for the abond link in Tx direction.
Failure reason for the abond link in Rx direction.
lowif
ASMTxCount
ASMRxCount
TxLinkFailureReason
RxLinkFailureReason
156
8.4
8.4.1
8.4.1.1
Aggregation Commands
Active Standby aggr info Commands
Get actstdby aggr info
Description: Use this command to get.
Command Syntax: get actstdby aggr info [ifname <interface-name>]
8.4.1.2
Modify actstdby aggr info
Description: Use this command to create.
Command Syntax: modify actstdby aggr info ifname <interfacename> [status Enable | Disable]
Parameters:
Name
Description
ifname ifname
This specifies the aggregator interface index on
which active standby is to be enabled. Valid Value is
aggr-0.
Type: Modify -- Mandatory
Get -- Optional
Valid values: aggr-0
status enable | disable
This specifies whether active standby mode is to be
enabled or not.
Type: Modify -- Optional
Example
$ get actstdby aggr info IfName aggr-0
Output
Interface Index : aggr-0
Status
: Enable
Output Fields
Field
Description
Interface Index
This specifies the aggregator interface index on
which active standby is to be enabled. Valid Value is
aggr-0.
Status
This specifies whether active standby mode is to be
enabled or not.
Caution
• Active Standby mode shall not be enabled, if aggregator interface
and redundancy aggregator are not created, or if LACP aggregator
is created for the aggregator interface.
• If only Active Standby is desired and no load sharing is expected
then bridge port shall be created over the aggregator only after
Active Standby has been enabled for redundancy aggregator. If the
bridge port is created over aggregator before enabling Active
Standby for it, the load sharing shall start and continue till Active
Standby is enabled.
References
• Redundancy commands.
157
8.4.2
8.4.2.1
Aggr intf Commands
Get aggr intf
Description: Use this command to get.
Command Syntax: get aggr intf [ifname <interface-name>]
8.4.2.2
Create aggr intf
Description: Use this command to create.
Command Syntax: create aggr intf ifname <interface-name> [ ip <ipval> ] [ mask <mask-val> ] [ usedhcp False | True ] [ mgmtvlanid
<mgmtvlanid-val> ] [ mgmtsvlanid <mgmtsvlanid-val> ] [ priority
<priority-val> ] [ enable | disable ]
8.4.2.3
Delete aggr intf
Description: Use this command to delete.
Command Syntax: get aggr intf [ifname <interface-name>]
8.4.2.4
Modify aggr intf
Description: Use this command to create.
Command Syntax: create aggr intf ifname <interface-name> [ ip <ipval> ] [ mask <mask-val> ] [ usedhcp False | True ] [ mgmtvlanid
<mgmtvlanid-val> ] [ mgmtsvlanid <mgmtsvlanid-val> ] [ priority
<priority-val> ] [ enable | disable ]
Parameters:
Name
Description
ifname <interface-name>
This specifies the interface index used for the
Aggregator type of interfaces. Valid Value is
aggr-0 Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0
This specifies the IP address configured for the
interface.
Type: Create - Optional
Modify - Optional
Default value: 0.0.0.0
This specifies the network mask configured for
the interface. If either of 'IP Address' or 'mask' is
non-null the other must also be non-null and vice
versa. Type: Create - Optional
Modify - Optional
Default value: 0.0.0.0
This specifies whether a DHCP client is to be
triggered to obtain an IP address for this
interface from a DHCP server.
Type: Create - Optional
Modify - Optional
Valid values: False, True
Default value: false
VLAN(C-Vlan) for management traffic on this
interface. Non-zero value of this field is valid
only if either 'ip' field is non-zero or 'usedhcp'
field is true. If no Management Vlanid is
specified (in the create operation) or it's value is
set to zero (either in create or modify operation)
then the system shall use the value of
'portvlanid' associated with the bridge port
created on this interface as the Management
ip <ip-val>
mask <mask-val>
usedhcp False | True
mgmtvlanid
<mgmtvlanid-val>
158
mgmtsvlanid
<mgmtsvlanid-val>
priority <priority-val>
enable | disable
Vlan Index. In case the management vlan (i.e.
'mgmtvlanid' or the associated 'portvlanid', if
'mgmtvlanid' is zero) doesn't exist on the system
then IP based management on this management
VLAN shall not happen on the interface till the
corresponding VLAN is created with the Net side
port as its member.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 4095
Default value: 0
Applicable only in stacked vlan mode, this is SVlan for management traffic on this interface.
Non-zero value of this field is valid only if either
'ip' field is nonzero or 'usedhcp' field is true. If no
management Svlanid is specified (in the create
operation) or it's value is set to zero (either in
create or modify operation) then the system shall
use the value of 'psvlanid' associated with the
bridge port created on this interface as the
management vlan id. In case the management
vlan (virtual vlan mapped to S-VLAN and CVLAN for the frame) doesn't exist (ie. Virtual vlan
mapped to 'mgmtsvlanid' or the associated '
psvlanid ', if 'mgmtsvlanid' is zero) on the system
then IP based management shall not happen on
the interface till the corresponding virtual-VLAN
is created with the Net side port as its member.
Type: Create - Optional
Modify - Optional
Valid values: 0 – 4095
Default value: 0
Priority to be set in Tagged Ethernet PDUs sent
on Management VLAN over this interface. This
field is valid only if either 'ip' field is non-zero or
'usedhcp' field is true. In Native Vlan mode this
priority shall be used for C-Vlan tag while in
stacked vlan mode it shall be used for S-Vlan
tag.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 7
Administrative status of the interface.
Type: Create -- Optional
Modify -- Optional
Valid values: enable, disable
Default value: enable
Example
$ create aggr intf IfName aggr-0 ip 172.25.100.100 mask 255.255.0.0
usedhcp False mgmtvlanid 2 mgmtsvlanid 2 priority 2 enable
Output
Verbose Mode On
Entry Created
Interface Index
: aggr-0
IP Address
255.255.0.0
: 172.25.100.100
UseDhcp
: False
Mgmt VLAN Index
: 2
Mgmt S-VLAN Index
: 2
Mask
:
Tagged Mgmt PDU Prio : 2
Oper Status
Verbose Mode Off:
Entry Created
159
: Up
Admin Status : Enable
Output Fields
Field
Description
Interface Index
This specifies the interface index used for the
Aggregator type of interfaces. Valid Value is
aggr-0
This specifies the IP address configured for the
interface.
This specifies the network mask configured for
the interface. If either of 'IP Address' or 'mask' is
non-null the other must also be non-null and vice
versa.
This specifies whether a DHCP client is to be
triggered to obtain an IP address for this
interface from a DHCP server.
VLAN(C-Vlan) for management traffic on this
interface. Non-zero value of this field is valid
only if either 'ip' field is non-zero or 'usedhcp'
field is true. If no Management Vlanid is
specified (in the create operation) or it's value is
set to zero (either in create or modify operation)
then the system shall use the value of
'portvlanid' associated with the bridge port
created on this interface as the Management
Vlan Index. In case the management vlan (i.e.
'mgmtvlanid' or the associated 'portvlanid', if
'mgmtvlanid' is zero) doesn't exist on the system
then IP based management on this management
VLAN shall not happen on the interface till the
corresponding VLAN is created with the Net side
port as its member.
Applicable only in stacked vlan mode, this is SVlan for management traffic on this interface.
Non-zero value of this field is valid only if either
'ip' field is nonzero or 'usedhcp' field is true. If no
management Svlanid is specified (in the create
operation) or it's value is set to zero (either in
create or modify operation) then the system shall
use the value of 'psvlanid' associated with the
bridge port created on this interface as the
management vlan id. In case the management
vlan (virtual vlan mapped to S-VLAN and CVLAN for the frame) doesn't exist (ie. Virtual vlan
mapped to 'mgmtsvlanid' or the associated '
psvlanid ', if 'mgmtsvlanid' is zero) on the system
then IP based management shall not happen on
the interface till the corresponding virtual-VLAN
is created with the Net side port as its member.
Priority to be set in Tagged Ethernet PDUs sent
on Management VLAN over this interface. This
field is valid only if either 'ip' field is non-zero or
'usedhcp' field is true. In Native Vlan mode this
priority shall be used for C-Vlan tag while in
stacked vlan mode it shall be used for S-Vlan
tag.
The actual/current state of the interface. It can
be either up or down.
The desired state of the interface. It may be
either Up or Down.
IP Address
Mask
UseDhcp
Mgmt VLAN Index
Mgmt S-VLAN Index
Tagged Mgmt PDU Prio
Oper Status
Admin Status
Cautions
• If an aggregator interface is being created, all configurations of
aggregated links (layer2 ethernet interfaces), should be same.
8.4.3
8.4.3.1
LACP Aggr Commands
Get lacp aggr
Description: Use this command to get.
160
Command Syntax: gets lacp aggr [aggrifname <aggrifname-val >]
8.4.3.2
Create lacp aggr
Description: Use this command to create.
Command Syntax: create lacp aggr aggrifname <aggrifname-val>
[actorsystemprio <actorsystemprio-val>] [actoradminkey
<actoradminkey-val>] [collectormaxdelay <collectormaxdelay-val>]
[aggrtype Static | Lacp]
8.4.3.3
Delete lacp aggr
Description: Use this command to delete.
Command Syntax: delete lacp aggr aggrifname <aggrifname-val>
8.4.3.4
Modify lacp aggr
Description: Use this command to modify.
Command Syntax: modify lacp aggr aggrifname <aggrifname-val>
[actorsystemprio <actorsystemprio-val>] [actoradminkey
<actoradminkey-val>] [collectormaxdelay <collectormaxdelay-val>]
[aggrtype Static | Lacp]
Parameters:
Name
Description
aggrifname
<aggrifname-val>
The Aggregator interface name.
Type: Create --­- Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: aggr-0
A 2-octet read-write value indicating the priority
value associated with the Actor's System ID.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 255
Default value: 10
The current administrative value of the Key for
the Aggregator
Type: Create Optional
Modify Optional
Valid values: 0 - 65535
Default value: 0
The value of this 16-bit read-write attribute
defines the maximum delay,in tens of
microseconds,that may be imposed by the
Frame Collector between receiving a frame from
an Aggregator Parser,and either delivering the
frame to its MAC Client or discarding the frame.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 65535
Default value: 0
Aggregation type. It can be either static or lacp
Type: Create - Optional
Modify - Optional
Default value: Static
actorsystemprio
<actorsystemprio-val>
actoradminkey
<actoradminkey-val>
collectormaxdelay
<collectormaxdelay-val>
aggrtype Static | Lacp
Example
$ create lacp aggr aggrifname aggr-0 actorsystemprio 2 actoradminkey
1000 collectormaxdelay 2 aggrtype Static
Output
Verbose Mode On
161
Entry Created
Aggr IfName
: aggr-0
Mac Address
true
: 23:45:67:89:00:01 Aggregate
Actor Sys Priority : 2
2
Partner Sys Priority :
Actor Sys ID
: 23:45:67:89:00:01
Partner Sys ID
: 23:45:67:89:00:01
Actor Oper Key
2
: 10
Partner Oper Key
:
Actor Admin Key
2
: 1000
Collector Max Delay
:
Aggregation Type
: Static
Verbose Mode Off:
Entry Created
Output Fields
Field
Description
Aggr IfName
Mac Address
The Aggregator interface name.
A 6-octet read-only value carrying the individual
MAC address assigned to the Aggregator.
A read-only Boolean value indicating whether
the Aggregator represents an Aggregate (TRUE)
or an Individual link (FALSE).
A 2-octet read-write value indicating the priority
value associated with the Actor's System ID.
A 2-octet read-only value that indicates the
priority value associated with the Partners
SystemID.
A 6-octet read only MAC address value used as
a unique identifier for the System that contains
this Aggregator.
A 6-octet read-only MAC address value
consisting of the unique identifier for the current
protocol Partner of this Aggregator.A value of
zero indicates that there is no known Partner.
The current operational value of the Key for the
Aggregator.
The current operational value of the Key for the
Aggregator is current protocol Partner.
The current administrative value of the Key for
the Aggregator
The value of this 16-bit read-write attribute
defines the maximum delay,in tens of
microseconds,that may be imposed by the
Frame Collector between receiving a frame from
an Aggregator Parser,and either delivering the
frame to its MAC Client or discarding the frame.
Aggregation type. It can be either static or lacp
Aggregate
Actor Sys Priority
Partner Sys Priority
Actor Sys ID
Partner Sys ID
Actor Oper Key
Partner Oper Key
Actor Admin Key
Collector Max Delay
Aggregation Type
Cautions
• LACP aggregator creation shall fail, if aggregator interface is not
created.
• LACP aggregator shall not be created, if Redundancy aggregator is
created for an aggregator interface.
References
• create aggr intf
• get aggr intf
162
:
8.4.4
8.4.4.1
LACP AGGRPort Info Commands
Get lacp aggrport info
Description: Use this command to get a LACP aggregator port
information.
Command Syntax: get lacp aggrport info [ifname <interface-name>]
8.4.4.2
Modify lacp aggrport info
Description Use this command to modify LACP aggregator port
information.
Command Syntax: modify lacp aggrport info ifname <interfacename> [actoradminkey <actoradminkey-val>] [partadminkey
<partadminkey-val>] [actorportprio <actorportprio-val>]
[partadminportprio <partadminportprio-val>] [actorsysprio
<actorsysprio-val>] [partadminsysprio <partadminsysprio-val>]
[partadminsysid <partadminsysid-val>] [partadminport
<partadminport-val>] [actoradminstate activity | timeout | aggr]
[partadminstate activity | timeout | aggr] [aggrstatus enable|disable]
[pktpriority <pktpriority-val>]
Parameters:
Name
Description
Ifname <interfacename>
The IfName of the Ethernet interface for the
aggregator.
Type : Modify - Mandatory
Get - Optional
Valid values : eth-*, eoa-*
The current administrative value of the Key for the
Aggregator.
Type : Optional
Valid values: 1 - 2^16 – 1
The current administrative value of the Key for the
Aggregator's current protocol Partner.
Type : Optional
Valid values: 1 - 2^16 – 1
The priority value assigned to this Aggregation
Port Type : Optional
Valid values : 0 - 2^8 – 1
The current administrative value of the port
priority, for the protocol Partner.
Type : Optional
Valid values: 0 – 255
A 2-octet read-write value indicating the priority
value associated with the Actor's System ID.
Type : Optional
Valid values: 0 – 255
A 2-octet read-only value that indicates the priority
value associated with the Partner's System ID.
Type : Optional
Valid values: 0 - 255
A 6-octet read-write MACAddress value
representing the administrative value of the
Aggregation Port’s protocol Partner's SystemID
Type : Optional
Valid values: 00:00:00:00:00:00 - ff:ff:ff:ff:ff:ff
The current administrative value of the port
number for the protocol Partner.
Type : Optional
Valid values: 0 - 65535
Administrative state of actor
Type: Optional
actoradminkey
<actoradminkey-val>
partadminkey
<partadminkey-val>
actorportprio
<actorportprio-val>
partadminportprio
<partadminportprio-val>
actorsysprio
<actorsysprio-val>
partadminsysprio
<partadminsysprio-val>
partadminsysid
<partadminsysid-val>
partadminport
<partadminport-val>
actoradminstate
activity | timeout |
aggr
163
partadminstate
activity | timeout |
aggr
aggrstatus
enable|disable
pktpriority <pktpriorityval>
Administrative state of Partner.
Type: Optional
Specifies whether aggregation(bonding) is to be
enabled over this Aggregation Port.
Type : Optional
Valid values: enable|disable
For LACP PDUs, this priority shall be used for
choice of traffic class/Queue on outgoing
interface. Type: Modify Optional
Valid values: 0 - 7
Example
$ get lacp aggrport info ifname eth-0
Output
Interface
Aggregate
: true
Actor Oper Key
Key
: 2
Actor Admin Key
Key
: 2
Actor Port Priority
Priority : 1
Actor System Priority
Priority : 1
Actor System ID
Priority : 2
Actor Port
Priority
: 2
Partner Admin Sys Id
Port
: 1
Partner Oper Sys Id
Port
: 1
Port Actor Admin State
Port Partner Admin State
Port Actor Oper State
Port Partner Oper State
Attached Agg ID
ID
: aggr-0
Aggregation Status
PacketsPrio
:2
: eth-0
Port Is
: 10
Partner Oper
: 1000
Partner Admin
: 1
Partner Admin Port
: 2
Partner Oper Port
: 23:45:67:89:00:01
Partner Admin Sys
: 2
Partner Oper Sys
: 23:45:67:89:00:01
Partner Admin
: 23:45:67:89:00:01
Partner Oper
:
:
:
:
:
Selected Agg
distrib
activity
default
default
aggr-0
: Enable
LACP
Output Fields
164
Field
Description
Interface
The IfName of the Ethernet interface for the
aggregator.
Port Is Aggregate
Boolean value indicating whether the
Aggregation Port is able to Aggregate
('TRUE'), or is only able to operate as an
Individual link ('FALSE').
Actor Oper Key
The current operational value of the Key for
the Aggregator.
Partner Oper Key
The current operational value of the Key for
the Aggregator's current protocol Partner.
Actor Admin Key
The current administrative value of the Key
for the Aggregator.
Partner Admin Key
The current administrative value of the Key
for the Aggregator's current protocol Partner.
Actor Port Priority
The priority value assigned to this
Aggregation Port.
Partner Admin Port
Priority
The current administrative value of the port
priority for the protocol Partner.
Actor System Priority
A 2-octet, read-write value indicating the
priority value associated with the Actor's
System ID.
Partner Oper Port Priority
The current operational value of the port
priority for the protocol Partner.
Actor System ID
A 6-octet, read-write MAC address value,
used as a unique identifier for the System that
contains this Aggregator.
Partner Admin Sys
Priority
A 2-octet, read-only value that indicates the
priority value associated with the Partner's
System ID.
Actor Port
The port number locally assigned to the
Aggregation Port.
Partner Oper Sys Priority
A 2-octet read-only value that indicates the
priority value associated with the PartnerÌs
System ID.
Partner Admin Sys Id
A 6-octet read-write MACAddress value
representing the administrative value of the
Aggregation Port’s protocol Partner's System
ID.
Partner Admin Port
The current administrative value of the port
number for the protocol Partner.
Partner Oper Sys Id
A 6-octet read-write MACAddress value
representing the operational value of the
Aggregation Port’s protocol Partner's System
ID.
Partner Oper Port
The current operational value of the port
number for the protocol Partner.
Port Actor Admin State
Administrative state of Actor.
Port Partner Admin State
Administrative state of Partner.
Port Actor Oper State
Operational state of Actor.
Port Partner Oper State
Operational state of Partner.
Attached Agg ID
The identifier value of the Aggregator that this
Aggregation Port has currently selected.
Selected Agg ID
The identifier value of the Aggregator that this
Aggregation Port has currently selected.
Aggregation Status
Whether or not aggregation(bonding) is to be
enabled over this Aggregation Port..
LACP PacketsPrio
For LACP PDUs, this priority shall be used for
choice of traffic class/Queue on outgoing
interface.
References
• lacp aggrport list
• lacp aggrport stats
8.4.5
8.4.5.1
LACP AGGRPort List Command
Get lacp aggrport list
Description: Use this command to get a LACP aggregator port list.
Command Syntax: get lacp aggrport list [aggrifname <aggrifnameval>]
Parameters:
165
Name
Description
Aggrifname
<aggrifname-val>
The Aggregator interface name.
Type : Optional
Valid values: aggr-*
Mode Super-User, User
Example
$ get lacp aggrport list
Output
Aggr IfName :
aggr-0
Port List
eth-0 eth-1
:
Output Fields
Field
Description
Aggr IfName
Port List
The Aggregator interface name.
List of the ports corresponding to given
aggregator index.
References
• lacp aggr
• lacp aggrport info
• lacp aggrport stats.
8.4.6
8.4.6.1
LACP AGGRPort Stats Commands
Get lacp aggrport stats
Description: Use this command to get LACP aggregator port statistics.
Command Syntax: get lacp aggrport stats [ifname <interface-name>]
8.4.6.2
Reset lacp aggrport stats
Description: Use this command to reset LACP aggregator port
statistics.
Command Syntax: reset lacp aggrport stats ifname <interfacename>
This command is not supported in this release.
Parameters:
Name
Description
Ifname <interfacename>
The IfName of the Ethernet interface for the
aggregator.
Type : Modify - Mandatory
Get - Optional
Valid values : eth-*, eoa-*
Example
$ get lacp aggrport stats ifname eth-0
Output
Interface
LACPDUs Rx
Tx
: eth-0
MarkerPDUs Rx
Tx
: 1
LACPDUs
: 1
MarkerPDUs
Marker Response PDUs Rx : 1
Tx : 1
Marker Response PDUs
Unknown Rx
Rx
Illegal
Output Fields
166
: 1
: 1
: 1
: 1
Field
Description
Interface
The Interface name of the Ethernet interface for
the aggregator.
The number of valid LACP PDUs received on this
Aggregation Port.
The number of LACP PDUs transmitted on this
Aggregation Port.
The number of valid Marker PDUs received on this
Aggregation Port.
The number of Marker PDUs transmitted on this
Aggregation Port.
The number of valid Marker Response PDUs
received on this Aggregation Port.
The number of Marker Response PDUs
transmitted on this Aggregation Port.
The number of frames received, that either carry
the Slow Protocols Ethernet Type value, but
contain an unknown PDU, or, are addressed to
the Slow Protocols group MAC Address, but do
not carry the Slow Protocols Ethernet Type.
The number of frames received, that carry the
Slow
Protocols Ethernet Type value, but contain a badly
formed PDU or an illegal value of Protocol
Subtype.
LACPDUs Rx
LACPDUs Tx
MarkerPDUs Rx
MarkerPDUs Tx
Marker Response
PDUs Rx
Marker Response
PDUs Tx
Unknown Rx
Illegal Rx
References
• lacp aggr
• lacp aggrport list
• lacp aggrport info.
8.4.7
8.4.7.1
Redundancy aggr info Commands
Get rdncy aggr info
Description: Use this command to get.
Command Syntax: get rdncy aggr info [ifname <interface-name]
8.4.7.2
Create rdncy aggr info
Description: Use this command to create.
Command Syntax: create rdncy aggr info ifname ifname [revdistrib
Enable | Disable] [fallback Enable | Disable]
8.4.7.3
Delete rdncy aggr info
Description: Use this command to delete
Command Syntax: delete rdncy aggr info ifname <interface-name>
8.4.7.4
Modify rdncy aggr info
Description: Use this command to modify
Command Syntax: modify rdncy aggr info ifname <interface-name>
[revdistrib Enable | Disable] [fallback Enable | Disable]
Parameters:
Name
Description
ifname <interfacename>
This specifies the interface index used for the
Redundancy Aggregator type of interfaces. Valid
Value is aggr-0
Type: Create -- Mandatory
167
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: aggr-0
revdistrib Enable |
Disable
It denotes whether reverse distribution filtering is
to be enforced for traffic in the receiving direction,
when both the links are active, for this aggregator
interface. If duplicate packets are expected on the
redundant links (if uplink aggregating device is
layer2 switch), Reverse distribution filtering may
be enabled. But if there is no chance of such
duplicate packets, or the duplicate packets need
not have a special handling, reverse distribution
filtering may be disabled.
Type: Create -- Optional
Modify -- Optional
Default value: enable
fallback Enable |
Disable
This specifies whether fallback is to happen for
aggregator interface, when a link goes down. As
fallback trigger leads to re-propagation of protocol
PDUs to the links based on the state of the links,
this may be enabled if re-propagation of protocol
PDUs is required for immediate restoration of peer
protocol state on uplink devices. If such a
treatment is not required and Protocol time out
may only be triggered for re-propagation, Fallback
trigger should be disabled.
Type: Create -- Optional
Modify -- Optional
Default value: enable
Example
$ create rdncy aggr info IfName aggr-0 revdistrib disable fallback
disable
Output
Verbose Mode On
Entry Created
Interface Index
: aggr-0
Reverse Distribution : disable
FallBack : disable
Verbose Mode Off:
Entry Created
Output Fields
168
Field
Description
Interface Index
This specifies the interface index used for the
Redundancy Aggregator type of interfaces. Valid
Value is aggr-0
Reverse Distribution
It denotes whether reverse distribution filtering is
to be enforced for traffic in the receiving direction,
when both the links are active, for this aggregator
interface. If duplicate packets are expected on the
redundant links (if uplink aggregating device is
layer2 switch) Reverse distribution filtering may be
enabled. But if there is no chance of such
duplicate packets or the duplicate packets need
not have a special handling reverse distribution
filtering may be disabled.
FallBack
This specifies whether fallback is to happen for
aggregator interface, when a link goes down. As
fallback trigger leads to re-propagation of protocol
PDUs to the links based on the state of the links,
this may be enabled if re-propagation of protocol
PDUs is required for immediate restore of peer
protocol state on uplink devices. If such a
treatment is not required and Protocol time out
may only be trigger for re-propagation, Fallback
trigger should be disabled.
Caution
• Redundancy aggregator shall not be created, if aggregator interface
is not created or if LACP aggregator is created for the aggregator
interface.
References
• create aggr intf command
• get aggr intf command
8.4.8
8.4.8.1
Redundancy aggrport list Commands
Get rdncy aggrport list
Description: Use this command to get.
Command Syntax: get rdncy aggrport list [aggrifname <interfacename>]
Parameters:
Name
Description
aggrifname <interfacename>
Index of the redundancy aggregator, for which
layer2 interfaces are associated. Valid Value is
aggr-0
Type: Get -- Optional
Valid values: aggr-0
Example
$ get rdncy aggrport list aggrifname aggr-0
Output
Aggr IfName
: aggr-0
PortList
: eth-0 eth-1
Port List Interface type : None
Output Fields
169
Field
Description
Aggr IfName
Index of the redundancy aggregator, for which
layer2 interfaces are associated. Valid Value is
aggr-0
PortList
The complete list of active layer2 interfaces
associated with the aggregator interface by
virtue of redundancy. Each bit set represents the
Ethernet interface, that is actively associated
with redundancy based aggregation. An
interface is actively associated with aggregator
interface, if data for the aggregator interface can
be transmitted/received over it.
Port List Interface
type
It denotes what type of interfaces (Physical
ethernet) are present in Port List. If no interface
are present in port list the value shall be None
8.4.9
8.4.9.1
Redundancy aggr stats Commands
Get rdncy aggr stats
Description: Use this command to get.
Command Syntax: get rdncy aggr stats [ifname <interface-name>]
8.4.9.2
Reset rdncy aggr stats
Description: Use this command to reset.
Command Syntax: reset rdncy aggr stats ifname <interface-name>
Parameters:
Name
Description
ifname <interface-name>
This specifies the interface index used for the
Aggregator type of interfaces for which the
redundancy stats are desired. Valid Value is
aggr-0
Type: Reset -- Optional
Get -- Optional
Valid values: aggr-0
Example
$ get rdncy aggr stats IfName aggr-0
Output
Interface Index
: aggr-0
Collapse Count
: 1
DeCollapse Count
: 1
Last Collapse Time [MM/DD/YYYY::HH:MM:SS]
04/21/2003:12:23:34
:
Last De-Collapse Time [MM/DD/YYYY::HH:MM:SS] :
04/21/2003:12:23:34
Output Fields
170
Field
Description
Interface Index
This specifies the interface index used for the
Aggregator type of interfaces for which the
redundancy stats are desired. Valid Value is
aggr-0
Collapse Count
This specifies the number of times one of the
redundant interfaces has gone down and the
traffic had to be moved on to the other
redundant interface, which is up.
DeCollapse Count
This specifies the number of times one of the
failed redundant interfaces has come up and
the traffic had to be redistributed among
mutually redundant interfaces.
Last Collapse Time
[MM/DD/YYYY::HH:MM:SS]
This specifies time at which the last collapse
(one of the redundant interface has gone
down) occurred. The display format shall be
mm/dd/yyyy:hr:min:sec.
Last De-Collapse Time
[MM/DD/YYYY::HH:MM:SS]
This specifies time at which the last decollapse (one of the failed redundant
interface has come up) occured. The display
format shall be mm/dd/yyyy:hr:min:sec.
8.5
8.5.1
8.5.1.1
ATM Commands
AAL5 VC Statistics Commands
Get atm aal5 stats
Description: Use this command to get AAL5 VC statistics.
Command Syntax: get atm aal5 stats [ifname <interface-name>]
Parameters:
Name
Description
Ifname <interfacename>
This parameter specifies the interface for which
information is desired
Type : Get - Optional
Valid values : aal5-0 -
Example
$ get atm aal5 stats ifname aal5-0
Output
Low IfName
VPI
Tx Frames count
Tx Bytes count
: atm-0
: 0
VC IfName
: aal5-0
VCI
: 1
: 100
Rx Frames count
: 1535
CRC Errors count : 0
: 85
Rx Bytes count
: 1200
Oversized SDU
: 0
Output Fields
Field
Description
VC IfName
The name of the aal5 (aal5-0 etc) interface,
for which statistics needs to be retrieved.
This specifies the ATM port name. It can be :
atm-0
This is the Virtual Port Identifier.
This is the Virtual Circuit Identifier.
The number of AAL5 CPCS PDUs transmitted
on this AAL5 VCC.
The number of AAL5 CPCS PDUs received
on this AAL5 VCC.
The number of octets contained in AAL5
CPCS PDUs received on this AAL5 VCC.
The number of octets contained in AAL5
CPCS PDUs received on this AAL5 VCC.
This specifies the number of CRC errors
encountered.
This specifies the number of oversized SDUs
received.
Low IfName
VPI
VCI
Tx Frames count
Rx Frames count
Tx Bytes count
Rx Bytes count
CRC Errors count
Oversized SDU
References
• atm vc related commands
• atm port and statistics related commands
• atm vc statistics commands.
8.5.2
8.5.2.1
ATM OAM CC Commands
Get oam cc vc
Description: Use this command to get.
Command Syntax: get oam cc vc [ifname <interface-name>]
171
8.5.2.2
Modify oam cc vc
Description: Use this command to modify.
Command Syntax: modify oam cc vc ifname <interface-name>
[action act | deact] [dir sink | src | both] [mode auto | manual]
Parameters:
Name
Description
ifname <interfacename>
This parameter specifies the interface, for which
information is desired. In case the field is not
specified, then the information for all valid
interfaces should be displayed.
Type: Modify -- Mandatory
Get -- Optional
action act | deact
This field specifies the CC action to be taken. This
is used along with CC direction field.
Type: Modify -- Optional
dir sink | src | both
This field specifies the direction for CC
activation/Deactivation.Direction could be source
(src), sink or both.
Type: Modify -- Optional
mode auto | manual
This specifies the activation/deactivation capability
at a VCC.
Type: Modify -- Optional
Example
$ get oam cc vc ifname aal5-0
Output
ifName
Mode
SourceOperStatus SinkOperStatus Initiator
-----------------------------------------------------------aal5-0
Manual activated
LOC
Self
Output Fields
Field
Description
ifName
This parameter specifies the interface, for which
information is desired. In case the field is not
specified, then the information for all valid interfaces
should be displayed.
Mode
This specifies the activation/deactivation capability
at a VCC.
SourceOperStatus
This field specifies the current operational state of
source point of the VCC.
SinkOperStatus
This field specifies the current operational state of
sink point of the VCC.
Initiator
This field is valid only in auto mode and it specifies
the current initiator of CC Activation/Deactivation.
References
• atm vc related commands.
• atm port and statistics related commands.
• atm oam loopback commands.
172
8.5.3
8.5.3.1
ATM OAM Loopback Commands
Get oam lpbk vc
Description Use this command to get.
Command Syntax get oam lpbk vc [ifname <interface-name>]
8.5.3.2
Modify oam lpbk vc
Description: Use this command to modify.
Command Syntax: modify oam lpbk vc ifname <interface-name>
[e2e | seg] [lbid <lbid-val>]
Parameters:
Name
Description
ifname <interfacename>
Interface Index of the ATM port, on which this VC
is getting configured.
Type: Modify - Mandatory
Get - Mandatory
This specifies the loop back type used. It may be:
e2e or segment.
Type: Modify - Optional
This defines the loopback site, which will loopback
the cell.
Type: Modify - Optional
e2e | seg
Lbid < lbid-val>
Example
$ get oam lpbk vc ifname aal5-0
Output
IfName
: aal5-0
LB Type
: e2e
VPI : 1
VCI : 1
OAM Location Id : 0xffffffffffffffffffffffffffffffff
OAM LB Result
: E2e Succeeded
Output Fields
Field
Description
IfName
Interface Index of the ATM port, on which this
VC is getting configured.
This is the Virtual Circuit Identifier.
This is the Virtual Port Identifier.
This specifies the loop back type used. It may
be:e2e or segment.
This defines the loopback site, which will
loopback the cell.
This specifies the result of the loop back test.
It may be Result Unavailable, Seg
Succeeded, Seg Failed, E2e Succeeded, E2e
Failed, Test Aborted, or Test In Progress.
VPI
VCI
LB Type
OAM Location Id
OAM LB Result
References
8.5.4
8.5.4.1
•
atm vc related commands.
•
atm port and statistics related commands.
ATM Port Commands
Get atm port
Description: Use this command to get.
Command Syntax: get atm port [ifname <interface-name>]
173
8.5.4.2
Create atm port
Description: Use this command to create.
Command Syntax: create atm port ifname <interface-name> lowif
<lowif-val> [ maxvc <maxvc-val> ] [ maxvpibits <maxvpibits-val> ]
[ maxvcibits <maxvcibits-val> ] [ oamsrc <oamsrc-val> ] [ orl <orlval> ] [ trfclassprofileid <trfclassprofileid-val> ] [ profilename
<profilename-val> ] [ ctlpktinstid <ctlpktinstid-val> ]
[ atmtransporttype cell | packet ] [ mirrormode data | mirror ]
[ enable | disable ]
8.5.4.3
Delete atm port
Description: Use this command to delete.
Command Syntax: delete atm port ifname <interface-name>
8.5.4.4
Modify atm port
Description: Use this command to modify.
Command Syntax: modify atm port ifname <interfacename>[ maxvc <maxvc-val> ] [ maxvpibits <maxvpibits-val> ]
[ maxvcibits <maxvcibits-val> ] [ oamsrc <oamsrc-val> ] [ orl <orlval> ] [ trfclassprofileid <trfclassprofileid-val> ] [ profilename
<profilename-val> ] [ atmtransporttype cell | packet ] [ enable |
disable ]
Parameters:
Name
Description
ifname <interfacename>
Physical interface index
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
This is the IfIndex of the low interface on which this
ATM port is configured. Lower interface can be of
type dsl-* or dsli-* or dslf-* or abond-*
Type: Create - Mandatory
This specifies the maximum number of VCCs
(PVCCs), supported at this ATM interface. This field
is not valid if the atmtransporttype has the value
packet
Type: Create - Optional
Modify - Optional
Valid values: 1 -8
Default value: 8
The maximum number of active VPI bits configured
for use at the ATM interface.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 8
Default value: 8
This specifies the maximum number of active VCI
bits configured for use at this ATM interface.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 16
Default value: 16
Loopback source id assigned to the ATM port. The
ATM port will respond to all loopback cells, which
carry this OAM id. This field is not valid if the
atmtransporttype has the value packet.
Type: Create - Optional
Modify - Optional
Default value: 0xffffffffffffffffffffffffffffffff
lowif <lowif-val>
maxvc <maxvc-val>
maxvpibits
<maxvpibits-val>
maxvcibits
<maxvcibits-val>
oamsrc <oamsrc-val>
174
orl <orl-val>
trfclassprofileid
<trfclassprofileid-val>
profilename
<profilename-val>
ctlpktinstid
<ctlpktinstid-val>
atmtransporttype cell
|packet
mirrormode data |
mirror
enable | disable
This parameter specifies the output rate limiting
value in KBPS to be applied on this interface.
Type: Create - Optional
Modify - Optional
Valid values: 64 - 6000
Default value: 54000
This specifies the traffic class profile to be
associated with the ATM port.
Type: Create - Optional
Modify - Optional
Valid values: 1 -8
Default value: 1
This specifies the scheduling profile to be
associated with the ATM port.
Type: Create - Optional
Modify - Optional
Default value: "SPPROFILE"
This specifies the control packet instance identifier
associated with this interface. If the user does not
provide any instance identifier while creating an
interface an instance is created internally from the
default profile governed by the macro 1 and
associated to the interface. This will reduce the total
number to instances that can be now created by
one. The default instance is governed by macro 0.
Type: Create - Optional
Valid values: 1 -146
Default value: 0
This specifies the transport type of the atm
interface. This can be either Cell which means that
actual Atm Cells shall be received over the UTOPIA
interface, or Packet , which means that Pseudo
Cells corresponding to Packet VDSL shall be
received over this ATM interface. This is not
modifiable if any ATM VC is created on top of this
ATM port.
Type: Create - Optional
Modify - Optional
Default value: 1
This field configures ATM port in data mode or
mirror mode. In mirror mode, only the mirrored
packets are allowed to go out of the port and regular
customer data is forbidden. Scheduling profile field
is ignored in mirror mode.
Type: Create - Optional
Default value: data
Administrative status of the interface.
Type: Create - Optional
Modify - Optional
Valid values: enable, disable
Default value: enable
Example
$ create atm port ifname atm-0 lowif dsl-0 maxvc 5 maxvpibits 6
maxvcibits 12S oamsrc 0xffffffffffffffffffffffffffffffff orl 3000 trfclassprofileid
3 profilename gold ctlpktinstid 1 atmtransporttype Cell mirrormode
mirror enable
Output
Verbose Mode On
Entry Created
IfName
: atm-0
MaxVccs
: 5
MaxVpiBits
: 6
MaxVciBits
OAMSrc
175
LowIfName
: dsl-0
: 12
: 0xffffffffffffffffffffffffffffffff
ORL(kbps)
: 3000
UnknownVPI
: 35
ProfileName
: gold
Current Output Rate
: 64
trfclassprofileid
: 3
UnknownVCI
: 35
Ctl Pkts Instance Id : 1
ATM Transport Type
: Cell
Mirror Mode
: mirror
Oper Status
: Up
Admin Status : Enable
Verbose Mode Off:
Entry Created
Output Fields
176
Field
Description
IfName
Physical interface index
LowIfName
This is the IfIndex of the low interface on
which this ATM port is configured. Lower
interface can be of type 94 or 124 or 125 or
0xfffffff9
MaxVccs
This specifies the maximum number of VCCs
(PVCCs), supported at this ATM interface.
This field is not valid if the atmtransporttype
has the value packet
MaxConfVccs
This specifies the current number of VCCs
configured on this port.
MaxVpiBits
The maximum number of active VPI bits
configured for use at the ATM interface.
MaxVciBits
This specifies the maximum number of active
VCI bits configured for use at this ATM
interface.
OAMSrc
Loopback source id assigned to the ATM port.
The ATM port will respond to all loopback
cells, which carry this OAM id. This field is not
valid if the atmtransporttype has the value
packet.
ORL(kbps)
This parameter specifies the output rate
limiting value in KBPS to be applied on this
interface.
UnknownVPI
This parameter specifies the last seen
unknown VPI on this ATM interface. This field
is not valid if the atmtransporttype has the
value packet.
UnknownVCI
This parameter specifies the last seen
unknown VCI on this ATM interface. This field
is not valid if the atmtransporttype has the
value packet.
ProfileName
This specifies the scheduling profile to be
associated with the ATM port.
Current Output Rate
This parameter specifies the current output
rate value in KBPS that is available on this
interface, based on the minimum of DSL
trained rate and OutPut Rate limit configured
for the ATM port.
trfclassprofileid
This specifies the traffic class profile to be
associated with the ATM port.
Ctl Pkts Instance Id
This specifies the control packet instance
identifier associated with this interface. If the
user does not provide any instance identifier
while creating an interface an instance is
created internally from the default profile
governed by the macro 1 and associated to
the interface. This will reduce the total
number to instances that can be now created
by one. The default instance is governed by
macro 0.
8.5.5
8.5.5.1
ATM Transport Type
This specifies the transport type of the atm
interface. This can be either Cell which
means that actual Atm Cells shall be received
over the UTOPIA interface, or Packet , which
means that Pseudo Cells corresponding to
Packet VDSL shall be received over this ATM
interface. This is not modifiable if any ATM
VC is created on top of this ATM port.
Mirror Mode
This field configures ATM port in data mode
or mirror mode. In mirror mode, only the
mirrored packets are allowed to go out of the
port and regular customer data is forbidden.
Scheduling profile field is ignored in mirror
mode.
Oper Status
The actual/current state of the interface. It can
be either up or down.
Admin Status
The desired state of the interface. It may be
either Up or Down.
ATM VC Commands
Create atm vc intf
Description: Use this command to create a new ATM Virtual Circuit
(VC).
Command Syntax : create atm vc intf ifname <interface-name> vpi
<vpi-val> vci <vci-val> lowif <atm-port-interface-name> [enable |
disable] [aal5] [a5txsize <aal5-cpcs-tx-sdu-size>] [a5rxsize <aal5cpcs-rx-sdu-size>] [vcmux | llcmux | auto | ethernet] [pvc] [channel
fast|interleaved] [ mgmtmode data|mgmt|DataAndMgmt| raw]
[ maxnumproto <maxnumproto-val> ] [ autostatus Enable|Disable ]
[ autosupportedprot none|{pppoa | eoa | ipoa}+]
[ autovcmuxforcedprot None | pppoa | eoa | ipoa]
[ autosensetriggertype dynamic | opstatechange ] [ ctlpktgroupid
<ctlpktgroupid> | none ]
8.5.5.2
Delete atm vc intf
Description: Use this command to delete an existing ATM Virtual
Circuit (VC).
Command Syntax: delete atm vc intf ifname <interface-name>
8.5.5.3
Get atm vc intf
Description: Use this command to display information corresponding
to a single VC, or for all VCs.
Command Syntax: get atm vc intf [ifname <interface-name>]
8.5.5.4
Modify atm vc intf
Description: Use this command to modify ATM VC parameters.
Command Syntax: modify atm vc intf ifname <interface-name> [vpi
<vpi-val>] [vci <vci-val>] {enable | disable} [a5txsize <aal5-cpcs-txsdu-size>] [a5rxsize <aal5-cpcs-rx-sdu-size>] [vcmux | llcmux | auto |
ethernet] [ mgmtmode data | mgmt | DataAndMgmt | raw]
[ autosupportedprot none|{pppoa | eoa | ipoa}+]
177
[ autovcmuxforcedprot None | pppoa | eoa | ipoa]
[ autosensetriggertype dynamic | opstatechange ]
Parameters
Name
Description
ifname <interfacename>
This specifies name of VC Interface.
Type: Create – Mandatory
Delete – Mandatory
Get – Optional
Modify – Mandatory
Valid values : aal5-0 - *
Interface Index of the ATM port, on which this VC
is getting configured.
Type: Mandatory
Valid values : atm-0 - *
Virtual Path Identifier. In order to modify, the VPI
value shall be the new VPI value and the admin
status of VC interface shall be disabled. Also, the
VPI and VCI value cannot be modified along with
admin status in one command. If encaptype is
Ethernet than value of this field has to be 0.
Type : Create – Mandatory
Modify – Optional
Valid values : 0-2^8
Virtual Circuit Identifier. In order to modify, the VCI
value shall be the new VCI value and the admin
status of VC interface shall be disabled. Also, the
VPI and VCI value cannot be modified along with
admin status in one command. If encaptype is
Ethernet than value of this field has to be 0.
Type: Create – Mandatory
Modify – Optional
Valid values : 1-2^16
It denotes the Management Mode of the ATM VC.
If it is Data, then only data transmission can take
place. If it is Mgmt, then management of remote
CPE device can happen on that ATM VC and
packets on that ATM VC shall start coming to
Control Plane. In DataAndMgmt mode, data
transmission as well as remote CPE management
can happen on the same ATM VC interface. In
DataAndMgmt mode, the acceptable values for
atmVCCAAL5EncapType are llcmux and auto. In
Mgmt mode, EoA interface cannot be created on
the ATM VC and both Ethernet as well as nonethernet packets on that ATM VC shall be
received at the Control Plane. In DataAndMgmt
mode, if EoA is created, then only non-ethernet
packets on that ATM VC shall be received at the
Control Plane. However, if EoA is not created then
all the packets on that ATM VC shall be received
at the Control Plane. However, to configure ATM
VC in DataAndMgmt mode, a good practice is to
to create ATM VC in disable mode till EoA is
created on it, to prevent flooding at Control Plane.
In order to run STP, the mode has to be
DataAndMgmt. If the mode is RawATM(4), ATM
cells are given to Control Plane. In this mode,
EoA interface cannot be created on the ATM VC.
If EoA interface is already created on the ATM VC,
its mode cannot be changed to either Mgmt(2) or
RawATM(4). This field is not valid if encaptype is
Ethernet.
Type: Create - Optional
Default value: Data
This specifies the Admin Status of the VC.
Type: Optional
Default Value: enable
lowif <atm-portinterfacename>
vpi <vpi-val>
vci <vci-val>
mgmtmode Data |
Mgmt | DataAndMgmt
| Raw
enable|disable
178
aal5
a5txsize <aal5-cpcstxsdu-size >
a5rxsize <aal5-cpcsrxsdu-size>
vcmux|llcmux|auto|
ethernet
Pvc
channel
fast|interleaved
Maxnumproto
<maxnumproto-val>
Autostatus
Enable|Disable
autosupportedprot
none|{pppoa | eoa |
ipoa}+
autovcmuxforcedprot
None | pppoa | eoa |
ipoa
179
This specifies the AAL type in use for this VC. The
only type of AAL supported in Columbia Packet is
AAL5. This field is not valid for an ATM VC with
encaptype as Ethernet.
Type: Create Optional
Default value: aal5
This specifies the maximum transmit CPCS SDU
size to be used.
Type: Optional
Valid values : 1-1536
Default Value: 1536
This specifies the maximum receive CPCS SDU
size to be used
Type: Optional
Valid values : 1-1536
Default Value: 1536
This specifies the data encapsulation method to
be used over the AAL5 SSCS layer. "auto" means
autosense the muxType(llc/vc). Auto mode is only
used to sense the llc/vcmux. Atm VC with
encaptype as ethernet can be created only over
an ATM port which has value of atmtransporttype
as packet.The VPI/VCI values for this atm vc shall
be 0/0. aaltype, mgmtmode and oam related
parameters are not valid for an ATM VC with
encaptype as Ethernet.
Type: Optional
Default Value: llcmux
This specifies the type of VC. The only value
supported is PVC.
Type: Optional
Default Value: pvc
This extension specifies the type of channel on
which the ATM VC's cells have to be transmitted/
received. This field is deprecated and currently
not in use.
Type: Optional
Default Value: Interleaved
This field specifies the maximum number of
simultaneous active protocol stacks supported on
this interface. Currently, only one protocol stack is
supported.
Type: Create - Optional
Default value: 1
This field specifies whether the Auto mode is to be
enabled or not. In the Auto mode, the stack above
this interface will be determined and created
based on the protocol packets sensed on this
interface. For example, if the protocol packet
sensed above this interface is an EoA packet,
then the corresponding EoA stack will be created
above this interface. However, the corresponding
EoA interface must have been created with the
config status field set as config mode. This field is
not valid if encaptype is Ethernet.
Type: Create - Optional
Default value: disable
This field specifies Higher layer protocols which
are supported for auto detection on the given ATM
VC. Only the packets if the protocols mentioned in
this field can lead to Auto detection. This field is
meaningful only when autostatus flag as enable.
Type: Create - Optional
Modify - Optional
Default value: 1
This field specifies that if the encap type detected
is VCMux, the user can configure to build a
specific protocol stack automatically. It can only be
present with the autostatus flag as enable. In case
autosensetriggertype
dynamic |
opstatechange
ctlpktgroupid
ctlpktgroupid | none
of a conflict with autoSupportedProtocols, its value
will override.
Type: Create - Optional
Modify - Optional
Default value: none
This field specifies at what time autodetection of
Encapsulation type or higher protocol layers is to
be done - all the time or only when Operational
Status of ATM VC is changed to UP. If its value is
'dynamic', then detection can happen anytime a
packet is received. If its value is 'opstatechange',
then autodetection happens only when
Operational status of ATM VC changes to UP.
This field is not valid if encaptype is Ethernet.
Type: Create - Optional
Modify - Optional
Default value: dynamic
The Control packet instance group associated with
this VC. The flows for this interface shall be
mapped to control packet instances as mapped for
the flows corresponding to the groupid configured
in ctrlpkt group info command. If this group does
not have entries for some of the flows, then those
flows shall be mapped to the ctlpktinstid of ATM
port, for which this VC is being created. If the
group id is 0, then all the flows shall be mapped to
ctlpktinstid of ATM port, for which this VC is being
created.
Type: Create - Optional
Valid values: 0 -50
Default value: 0
Example
$ create atm vc intf ifname aal5-0 lowif atm-0 vpi 10 vci 10 enable aal5
pvc a5txsize 1536 a5rxsize 1536 llcmux mgmtmode data
autosupportedprot pppoa eoa autovcmuxforcedprot pppoa
autosensetriggertype dynamic ctlpktgroupid none
Output
Verbose Mode On
Entry Created
VC IfName
: aal5-0
Low IfName
: atm-0
VPI
:
VCI
: 35
Admin Status
: Up
Oper Status
: Down
Aal5 Tx Size
: 1536
Aal5 Rx Size
: 1536
AAL Type
: AAL5
AAL5 Encap
: llcmux
channel
: Interleaved
Last Change(sec) : 0
MgmtMode
: Data
Row Status
: active
VC Type
to Point
: PVC
VC Topology
: Point
0
Max simultaneous protocol
: 1
Auto Status
: Disable
Auto Supported Protocol
: pppoa eoa
Auto VC Mux Forced Protocol : None
Auto Sense Trigger Type
: dynamic
Auto Curr Sensed Encaps Typee : none
Ctl Pkts Group Id
: none
Auto Supported Protocol : pppoa eoa
Output Fields
180
Field
Description
VC IfName
VC Interface Name. It can be : aal5-0 - *
181
Low IfName
Interface Index of the ATM port, on which this
VC is getting configured.
VPI
Virtual Path Identifier. In order to modify, the VPI
value shall be the new VPI value and the admin
status of VC interface shall be disabled. Also,
the VPI and VCI value cannot be modified along
with admin status in one command. If encaptype
is Ethernet than value of this field has to be 0.
VCI
Virtual Circuit Identifier. In order to modify, the
VCI value shall be the new VCI value and the
admin status of VC interface shall be disabled.
Also, the VPI and VCI value cannot be modified
along with admin status in one command. If
encaptype is Ethernet than value of this field has
to be 0.
Oper Status
This specifies the actual/current state of the
interface. It can be either Up or Down
Admin Status
This specifies the desired state of the interface.
It may be either Up/Down.
Aal5 Tx Size
This specifies the transmit CPCS SDU size to be
used.
Aal5 Rx Size
This specifies the receive CPCS SDU size to be
used.
Aal Type
This specifies the AAL type in use for this VC.
The only type of AAL supported in Columbia
Packet is AAL5. This field is not valid for an ATM
VC with encaptype as Ethernet.
Aal5 Encap
This specifies the data encapsulation method to
be used over the AAL5 SSCS layer. "auto"
means autosense the muxType(llc/vc). Auto
mode is only used to sense the llc/vcmux . Atm
VC with encaptype as ethernet can be created
only over an ATM port which has value of
atmtransporttype as packet.The VPI/VCI values
for this atm vc shall be 0/0. aaltype, mgmtmode
and oam related parameters are not valid for an
ATM VC with encaptype as Ethernet.
channel
This extension specifies the type of channel on
which the ATM VC's cells have to be
transmitted/received. This field is deprecated
and currently not in use.
Last Change
The value of sysUpTime at the time this VC
entered its current operational state.
MgmtMode
It denotes the Management Mode of the ATM
VC. If it is Data, then only data transmission can
take place. If it is Mgmt, then management of
remote CPE device can happen on that ATM VC
and packets on that ATM VC shall start coming
to Control Plane. In DataAndMgmt mode, data
transmission as well as remote CPE
management can happen on the same ATM VC
interface. In DataAndMgmt mode, the only
acceptable value for atmVCCAAL5EncapType is
llc. In Mgmt mode, EoA interface can't be
created on the ATM VC and both Ethernet as
well as non-Ethernet packets on that ATM VC
shall be received at Control Plane. In
DataAndMgmt mode, if EoA is created then only
non-Ethernet packets on that ATM VC shall be
received at Control Plane. However, if EoA is not
created then all the packets on that ATM VC
shall be received at Control Plane. However, to
configure ATM VC in DataAndMgmt mode, good
practice is to create ATM VC in disable mode till
EoA is created on it, to prevent flooding at
Control Plane. In order to run STP, the mode
has to be DataAndMgmt. If the mode is
RawATM(4), ATM cells are given to Control
Plane. In this mode, EoA interface cannot be
created on the ATM VC. If EoA interface is
already created on the ATM VC, its mode cannot
be changed to either Mgmt(2) or RawATM(4).
This field is not valid if encaptype is Ethernet.
182
RowStatus
This defines the row-status of the interface entry
VC Type
This field specifies whether VC type is PVC or
SVC.
VC Topology
This field specifies the VC connection topology
type.
Max simultaneous
protocol
This field specifies the maximum number of
simultaneous active protocol stacks supported
on this interface. Currently, only one protocol
stack is supported.
Auto Status
This field specifies whether the Auto mode is to
be enabled or not. In the Auto mode, the stack
above this interface will be determined and
created based on the protocol packets sensed
on this interface. For example, if the protocol
packet sensed above this interface is an EoA
packet, then the corresponding EoA stack will be
created above this interface. However, the
corresponding EoA interface must have been
created with the gsvEoaConfigMode field's bit
corresponding to the 'Auto' set.
Auto Supported
Protocol
This field specifies Higher layer protocols which
are supported for auto detection on the given
ATM VC. Only the packets if the protocols
mentioned in this field can lead to Auto
detection. This field is meaningful only when
autostatus flag is enable.
Auto VC Mux Forced
Protocol
This field specifies if the encap type detected is
VCMux, the user can configure to build a
specific protocol stack automatically. This field is
meaningful only when autostatus flag as enable.
In case of conflict with autoSupportedProtocols,
its value will override.
Auto Sense Trigger
Type
This field specifies at what time autodetection of
Encapsulation type or higher protocol layers is to
be done - all the time or only when Operational
Status of ATM VC is changed to UP. If its value
is 'dynamic', then detection can happen anytime
a packet is received. If its value is
'opstatechange', then autodetection happens
only when Operational status of ATM VC
changes to UP. This field is not valid if
encaptype is Ethernet.
Auto Curr Sensed
Encaps Type
This field specifies the current sensed
Encapsulation type in case the Encapsulation
type is being autodetected. The value of this
field will be the same as the field 'AAL5
Encapsulation Type' if the Encapsulation type is
preconfigured. This is a read only field for all
agents, except for the Auto Sense Agent.
Ctl Pkts Group Id
The Control packet instance group associated
with this VC. The flows for this interface shall be
mapped to control packet instances as mapped
for the flows corresponding to the groupid
configured in ctrlpkt group info command. If this
group does not have entries for some of the
flows, then those flows shall be mapped to the
ctlpktinstid of ATM port, for which this VC is
being created. If the group id is 0, then all the
flows shall be mapped to ctlpktinstid of ATM
port, for which this VC is being created.
Caution
The specified lower interface should exist. Please refer to the create
atm port command.
References
• ATM interface commands
• ATM statistics commands
• ATM OAM commands
• ATM VC statistics commands.
8.5.6
8.5.6.1
ATM VC Statistics Commands
Get atm vc stats
Description: Use this command to get statistical information about a
specific or all ATM virtual circuits.
Command Syntax: get atm vc stats [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
This specifies the Virtual Circuit. If this is not
specified, then information for all VCs is displayed.
Type : Get – Optional
Valid values : aal5-0 - *
Example
$ get atm vc stats ifname aal5-0
Output
Low IfName
: atm-0
VC IfName
: aal5-0
VPI
: 1
VCI
: 1
Total Tx Cells count : 250
Total Rx Cells count : 20
CLPI 0 Rx Cells count : 10
Rx Pkts Rejected count
: 0
Output Fields
Field
Description
LowIf
This specifies the ATM port name. It can be :
atm-0
It is the Virtual Port Identifier.
It is the Virtual Circuit Identifier.
The name of the aal5 (aal5-0 etc) interface,
for which statistics needs to be retrieved.
The total number of valid ATM cells
transmitted by this interface.
The total number of valid ATM cells received
by this interface.
The number of valid ATM cells received by
this interface with CLP=0.
The total number of valid ATM cells discarded
by the interface.
VPI
VCI
VC IfName
Total Tx Cells count
Total Rx Cells count
CLPI 0 Rx Cells
Rx Pkts Rejected count
References
• Other atm vc related commands
• oam lpbk command
183
• atm port related commands
• atm statistics related commands
184
8.6
8.6.1
8.6.1.1
Bridging Commands
Bridge forwarding Commands
Get bridge forwarding
Description: Use this command to get.
Command Syntax: get bridge forwarding [vlanid <vlanid-val>]
[macaddr <macaddr-val>]
8.6.1.2
Delete bridge forwarding
Description: Use this command to delete.
Command Syntax: delete bridge forwarding [vlanid <vlanid-val>]
[macaddr <macaddr-val>]
Parameters
Name
Description
vlanid <vlanid-val>
Vlan Id to uniquely identify the entry for which the
bridge has forwarding and/or filtering information.
To delete an individual learnt entry or all learnt
entries, the FdbId should be set to a valid value in
case of IVL. In SVL case, this value is ignored
except when the value is 4097 which is the value
of a special Vlan Id used for managing the traffic
for those VLANs that are neither created nor learnt
in the system. When Vlan transparency feature is
supported, the valid range for this also includes
4097. VLAN here means the 802.1q Vlan in case
of Native Vlan mode and Virtual Vlan in case of
Stacked Vlan Mode.
Type: Delete - Optional
Get - Optional
Valid values: 0 - 4095
A unicast MAC address for which the bridge has
forwarding and/or filtering information. In the case
of "delete all" entries in a given FDB; the MacAddr
shall have INVALID value specified by FF: FF: FF:
FF: FF: FF. To delete an individual entry, valid
value of Mac address has to be specified.
Type: Delete - Optional
Get - Optional
macaddr <macaddrval>
Example
$ get bridge forwarding vlanid 10 macaddr 02:2e:22:3d:44:56
Output
MAC Addr
PortId
VlanId
Status
----------------------------------------------------------02:2e:22:3d:44:56
10
10
learned
Output Fields
Field
Description
MAC Addr
A unicast MAC address for which the bridge
has forwarding and/or filtering information. In
the case of "delete all" entries in a given FDB;
the MacAddr shall have INVALID value
specified by FF: FF: FF: FF: FF: FF. To delete
an individual entry, valid value of Mac
address has to be specified.
Vlan Id to uniquely identify the entry for which
VlanId
185
PortId
Status
the bridge has forwarding and/or filtering
information. To delete an individual learnt
entry or all learnt entries, the FdbId should be
set to a valid value in case of IVL. In SVL
case, this value is ignored except when the
value is 4097 which is the value of a special
Vlan Id used for managing the traffic for those
VLANs that are neither created nor learnt in
the system. When Vlan transparency feature
is supported, the valid range for this also
includes 4097. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual
Vlan in case of Stacked Vlan Mode.
Port number of the port on which a frame
having a source address equal to the value of
the corresponding instance of
dot1qTpFdbAddress, has been seen. This
may have a value of "0" if the statically
configured address has a dynamic port
binding and the port has not been learnt yet.
The status of this entry. The value learned
(3), indicates that the value of the
corresponding instance of dot1qTpFdbPort
was learned, and is being used. mgmt (5) the value of the corresponding instance of
dot1qTpFdbAddress is also the value of an
existing instance of dot1qStaticAddress. The
value internal (6) indicates that the entry is an
internal entry and cannot be deleted by the
user. This entry gets created for the
IPOE/PPPOE interfaces when the bridge port
over those IPOE/PPOE interfaces gets admin
enabled. The mac address in this entry shall
be the one specified in the mac address
profile and VlanId shall be the PortVlanId of
the Bridge Port.The value other (1) indicates
that this is associated with a sticky port.
References
• bridge port related commands
• bridge port stats command
• bridge static related commands
• bridge mode related commands.
8.6.2
8.6.2.1
Bridge Mode Commands
Get bridge mode
Description: Use this command to get the current bridging mode.
Command Syntax: get bridge mode
Parameters
None
Example
$ get bridge mode
Output
Bridging Mode is Enabled
Output Fields None
References
• modify bridge mode command
• bridge port command
186
• bridge port stats command
• bridge static command
• bridge forwarding command
• DHCP Client commands.
8.6.3
8.6.3.1
Bridge Port Cap Commands
Get bridge port cap
Description: Use this command is used to get.
Command Syntax: get bridge port cap [portid <portid-val>]
Parameters
Name
Description
portid <portid-val>
The index of base port
Type :Optional
Valid values: 1 - 386
Default value: None
Mode Super-User, User
Example
$get bridge port cap
Output
Portid : 45
Port Capabilities : Tagging FrameTypes IngressFiltering
Output Fields
8.6.4
8.6.4.1
Field
Description
portid
Port Capabilites
The index of base port.
Capabilities that are allowed on a per-port
basis.
Bridge port forwarding Commands
Get bridge port forwarding
Description: Use this command to get.
Command Syntax: get bridge port forwarding [portid <portid-val>]
[vlanid <vlanid-val>] [macaddr <macaddr-val>]
8.6.4.2
Delete bridge port forwarding
Description: Use this command to delete.
Command Syntax: delete bridge port forwarding portid <portid-val>
[vlanid <vlanid-val>] [macaddr <macaddr-val>]
Parameters
Name
Description
portid <portid-val>
Port number of the port on which a frame having a
source address equal to the value of the
corresponding instance of dot1qTpFdbAddress,
has been seen. This may have a value of "0" if the
statically configured address has a dynamic port
binding and the port has not been learnt yet.
Type: Delete - Mandatory
Get - Optional
Valid values: 1 - 386
Vlan Id to uniquely identify the entry for which the
bridge has forwarding and/or filtering information.
vlanid <vlanid-val>
187
macaddr <macaddrval>
To delete an individual learned entry or all learned
entries, the FdbId should be set to a valid value in
case of IVL. In SVL case, this value is ignored
except when the value is 4097, which is the value
of a special Vlan Id used for managing the traffic
for those VLANs that are neither created nor
learned in the system. When Vlan transparency
feature is supported, the valid range for this also
includes 4097. VLAN here means the 802.1q Vlan
in case of Native Vlan mode and Virtual Vlan in
case of Stacked Vlan Mode.
Type: Delete - Optional
Get - Optional
Valid values: 0 -4096
In the case of "delete all" entries corresponding to
a port in a given FDB; the MacAddr shall have
INVALID value specified by FF: FF: FF: FF: FF:
FF. To delete an individual entry, valid value of
Mac address has to be specified.
Type: Delete - Optional
Get - Optional
Example
$ get bridge port forwarding portid 10 vlanid 10 macaddr 02:03: ee:
34:55:66
Output
Port Id
: 10
vlan id : 10
Mac Addr : 02:03:ee:34:55:66
Status
: Mgmt
Output Fields
Field
Description
Port Id
Port number of the port on which a frame
having a source address equal to the value of
the corresponding instance of
dot1qTpFdbAddress, has been seen. This
may have a value of "0" if the statically
configured address has a dynamic port
binding and the port has not been learnt yet.
Vlan Id to uniquely identify the entry for which
the bridge has forwarding and/or filtering
information. To delete an individual learned
entry or all learned entries, the FdbId should
be set to a valid value in case of IVL. In SVL
case, this value is ignored except when the
value is 4097, which is the value of a special
Vlan Id used for managing the traffic for those
VLANs that are neither created nor learned in
the system. When Vlan transparency feature
is supported, the valid range for this also
includes 4097. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual
Vlan in case of Stacked Vlan Mode.
In the case of "delete all" entries
corresponding to a port in a given FDB; the
MacAddr shall have INVALID value specified
by FF: FF: FF: FF: FF: FF. To delete an
individual entry, valid value of Mac address
has to be specified.
The status of this entry. The value learned
(3), indicates that the value of the
corresponding instance of dot1qTpFdbPort
was learned, and is being used. mgmt (5) the value of the corresponding instance of
dot1qTpFdbAddress is also the value of an
existing instance of dot1qStaticAddress. The
vlan id
Mac Addr
Status
188
value internal (6) indicates that the entry is a
internal entry and cannot be deleted by the
user. This entry gets created for the
IPOE/PPPOE interfaces when the bridge port
over those IPOE/PPOE interfaces gets admin
enabled. The mac address in this entry shall
be the one specified in the mac address
profile and VlanId shall be the PortVlanId of
the Bridge Port. The value other (1) indicates
that this is associated with a sticky port.
8.6.5
8.6.5.1
Bridge Port Map Commands
Get bridge port map
Description: Use this command to get.
Command Syntax: get bridge port map [portid <portid-val>] [ifname
<interface-name>]
8.6.5.2
Create bridge port map
Description: Use this command to create.
Command Syntax: create bridge port map portid <portid-val>
ifname <interface-name>
8.6.5.3
Delete bridge port map
Description: Use this command to delete.
Command Syntax: delete bridge port map portid <portid-val>
ifname <interface-name>
Parameters
Name
Description
portid <portid-val>
The bridge port with which a lower interface is
being associated in the autosensing scenario.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Valid values: eoa-*, pppoe-*,ipoe-*
'ifname' associated with 'portid'. Only the indices
of interfaces belonging the types eoa, pppoe or
ipoe, are valid values for this interface.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Values: eoa-*, pppoe-*,ipoe-*
ifname <interfacename>
Example
$ create bridge port map portid 2 ifname eoa-0
Output
Verbose Mode On
Entry Created
Port Id : 2
Interface Index : eoa-0
Verbose Mode Off:
Entry Created
Output Fields
Field
Description
Port Id
The bridge port with which a lower interface is
being associated in the autosensing scenario.
'ifname' associated with 'portid'. Only the
indices of interfaces belonging the types eoa,
Interface Index
189
pppoe or ipoe, are valid values for this
interface..
8.6.6
8.6.6.1
Bridge Port Stats Table Commands
Get bridge port stats
Description: Use this command to get the statistics of a single port, or
all the ports.
Command Syntax: get bridge port stats [portid <portid-val>]
8.6.6.2
Reset bridge port stats
Description: Use this command to reset bridge port statistics.
Command Syntax: reset bridge port stats portid <portid-val>
Parameters
Name
Description
portid <portidval>
This is the bridge port identifier. If this is not specified in
the get command, then information for all ports is
displayed.
Type : Get - Optional
Reset - Mandatory
Valid values : 1- 578
Example
$ get bridge port stats portid 1
Output
Verbose Mode On
PortId
: 1
Max Info Size
: 1500
Out Frames
: 138
In Frames
: 129
In Discards
: 3
HC In Frames
: 300
HC Out Frames
: 350
HC In Discards
: 400
Output Fields
Field
Description
PortId
This is the bridge port identifier. It can be :
1- 386
The maximum size of the INFO (non-MAC)
field that this port will receive or transmit.
The number of frames that have been
transmitted by this port to its segment.
The number of frames that have been
received by this port from its segment.
Count of valid frames received, which were
discarded (i.e., filtered) by the Forwarding
Process.
Number of frames that have been received
by this port from its segment. This is valid
only for Ethernet interfaces.
Number of frames that have been
transmitted by this port to its segment. This
is valid only for Ethernet interfaces.
Count of valid frames received and
discarded (i.e filtered) by the Forwarding
Process. This is valid only for Ethernet
interfaces.
Max Info Size
Out Frames
In Frames
In Discards
HC In Frames
HC Out Frames
HC In Discards
190
8.6.7
8.6.7.1
Bridge Port Table Commands
Create bridge port intf
Description Use this command to create a new bridge port.
Command Syntax: create bridge port intf portid <portid-val> ifname
<interface-name> [maxucast <max-ucast-addresses> ] [learning
enable|disable][status enable|disable] [stickystatus enable | disable]
[FdbModify enable | disable][ aclglbdenyapply Enable | Disable ]
[ aclglbtrackapply Enable | Disable ] [ proxyarpstatus enable |
disable ] [ arptstatus Enable | Disable ] [ darpstatus Enable | Disable ]
[ porttype trusted | untrusted ]
8.6.7.2
Delete bridge port intf
Description: This command is used to delete an existing bridge port.
Command Syntax: delete bridge port intf portid <portid-val>
8.6.7.3
Get bridge port intf
Description: Use this command to get.
Command Syntax: get bridge port intf [portid <portid-val>]
8.6.7.4
Modify bridge port intf
Description Use this command to modify.
Command Syntax: modify bridge port intf portid <portid-val>
[ maxucast <maxucast-val> ] [ learning enable | disable ] [ status
enable | disable ] [ stickystatus enable | disable ] [ fdbmodify enable |
disable ] [ aclglbdenyapply Enable | Disable ] [ aclglbtrackapply
Enable | Disable ] [ proxyarpstatus enable | disable ] [ arptstatus
Enable | Disable ] [ darpstatus Enable | Disable ] [ porttype trusted |
untrusted ]
Parameters
Name
Description
portid <portid-val>
The bridge port id
Type: Modify -Mandatory
Get - Optional
Valid values: 1 - 578
Interface name associated with the Port,
Type: mandatory,
Values: eth-*, eoa-*, pppoe-*, ipoe-*, vir-*
This specifies the maximum number of unicast
addresses, which can be learnt from this port. This
is modifiable when the admin status of bridge port
is disabled. Max of number of unicast entries that
can be learnt/configured on a birdge port on CPE
side is 128. The default value for number of
unicast entries that can be learnt or configured on
a CPE side bridge port is 16. Max of number of
unicast entries that can be learnt/configured on a
birdge port on NET side is 4096. The default value
for number of unicast entries that can be learnt or
configured on a bridge port is 4096. Max of
number of unicast entries that can be
learnt/configured on a birdge port on downlink side
is 256. The default value for number of unicast
entries that can be learnt or configured on a bridge
port is 256. This field is unused if the bridge port is
created over an PPPOE/IPOE interface or
PPPOE/ IPOE is sensed. Any value of this field
shall be ignored for a bridge port created over a
PPPOE/IPOE interface.
Type: Modify - Optional
ifname <interfacename>
maxucast <maxucastval>
191
learning enable |
disable
status enable | disable
stickystatus enable
|disable
fdbmodify enable |
disable
aclglbdenyapply
Enable |Disable
aclglbtrackapply
Enable |Disable
proxyarpstatus enable
|disable
192
The State of Learning on this bridge port. The
value enable (1) indicates that unicast Mac
address learning is enabled and the value disable
indicates that unicast Mac address learning is
disabled on this bridge port. The default value of
learning status for CPE/Downlink side bridge ports
shall be enable and for NET side bridge port
default value shall be enable. This field is unused
if the bridge port is created over a PPPOE/IPOE
interface or PPPOE/IPOE is sensed. Any value of
this field shall be ignored for a bridge port created
over a PPPOE/IPOE interface.
Type: Modify - Optional
The desired state of the bridge port. On creation
the bridge port shall be created in enabled
AdminStatus by default.
Type: Modify - Optional
Indicates if the port has been set as sticky. The
value enable(1) indicates that the entries learnt on
this port won't be aged out. It also indicates that
the entries learnt on this port shall not be learnt on
any other port. The entries learnt on this port can
only be removed by management action or by
making the value as disable (2) so that the entries
can be aged out. This field is unused if the bridge
port is created over an PPPOE/ IPOE interface or
PPPOE/IPOE is sensed. Any value of this field
shall be ignored for a bridge port created over a
PPPOE/IPOE interface.
Type: Modify - Optional
This specifies whether this port can overwrite an
existing forwarding database entry. This field is
unused if the bridge port is created over an
PPPOE/ IPOE interface or PPPOE/IPOE is
sensed. Any value of this field shall be ignored for
a bridge port created over a PPPOE/IPOE
interface.
Type: Modify - Optional
This specifies whether the global acl macentry
deny list represented by MO AclGlobalMacList is
to be applied to this port or not. The default value
of this parameter shall depend on the port type.
For Net side ports, the default value shall be
disable and for the cpe side ports the default value
shall be enable. This field is unused if the bridge
port is created over an PPPOE/IPOE interface or
PPPOE/IPOE is sensed. Any value of this field
shall be ignored for a bridge port created over a
PPPOE/IPOE interface.
Type: Modify - Optional
This specifies whether the global acl macentry
track list represented by MO AclGlobalMacList is
to be applied to this port or not. The default value
of this parameter shall depend on the port type.
For Net side ports, the default value shall be
disable and for the cpe side ports the default value
shall be enable. This field is unused if the bridge
port is created over an PPPOE/IPOE interface or
PPPOE/ IPOE is sensed. Any value of this field
shall be ignored for a bridge port created over a
PPPOE/IPOE interface.
Type: Modify - Optional
The Proxy Arp Status on this bridge port. The
value enable of this field indicates that Proxy Arp
request can be received through this port. This
field can be enabled only on bridge port created
over ethernet or aggregator interface. Before
enabling this field user should create a filter rule
with rule action as Copy to Control and rule
description as IPOE_CONTROL and map it to all
those interfaces through which user wants to
receive proxy arp requests.
Type: Modify - Optional
arptstatus Enable |
Disable
This specifies whether ARP translation will be
done on the ARP packets received/transmitted on
this port. When enabled, ARP source MAC
address of the incoming ARP packets (both
request/reply) will be changed to virtual MAC
address (if applicable) and the ARP target MAC
address of the outgoing ARP reply packets will be
changed to the original host MAC address (if
applicable).
Type: Modify -- Optional
darpstatus Enable |
Disable
This specifies whether the ARP packets received
on this bridge port are to be directed to a single
port using (VLANId, IP address) to bridge port
mapping learnt using DRA. This field can be
enabled only on the NET side bridge port. This
attribute is effective in conjunction with the
attribute 'gsv dot1qVlanStaticDirectedARP' of
'Dot1qVlanStatic' MO. ARP packets are to be
directed as mentioned above, only if both the flags
are enabled. If any of the two is disabled, the
ARP packets will be forwarded as per the normal
bridging flow.
Type: Modify -- Optional
porttype trusted |
untrusted
This field specifies whether the port is trusted or
not. This information is used by some of the
control plane applications to send packet on
trusted ports, in case the application fails to
uniquely determine a port.
Type: Modify -- Optional
Example
$ create bridge port intf ifname eth-0 portid 10 maxucast 10 learning
enable stickystatus enable status enable fdbmodify disable
aclglbdenyapply Disable aclglbtrackapply Disable proxyarpstatus
enable arptstatus enable darpstatus enable porttype trusted
Output
Port Id
: 10
Max Unicast Addresses
enable
: 10
Learning Status
:
Port Oper Status
Disable
: Disable
Port Admin Status
:
Sticky Status
Disable
: enable
FDB Modify
:
Acl Global Deny Apply
: Disable
:
Acl Global Track Apply : Disable
ProxyArpStatus
eoa-1
: enable
Sensed IfIndex
ArpTStatus
enable
: enable
Directed ARP status :
Port Type
: trusted
Output Fields
Field
Description
Port Id
If Name
The bridge port id
The interface name associated with the given
port.
This specifies the maximum number of unicast
Max Unicast Addresses
193
Learning Status
Port Oper Status
Port Admin Status
Sticky Status
FDB Modify
194
addresses, which can be learnt from this port.
This is modifiable when the admin status of
bridge port is disabled. Max of number of
unicast entries that can be learnt/configured on
a birdge port on CPE side is 4096. The default
value for number of unicast entries that can be
learnt or configured on a CPE side bridge port
is 4096. Max of number of unicast entries that
can be learnt/configured on a birdge port on
NET side is 4096. The default value for
number of unicast entries that can be learnt or
configured on a bridge port is 4096. Max of
number of unicast entries that can be
learnt/configured on a birdge port on downlink
side is 256. The default value for number of
unicast entries that can be learnt or configured
on a bridge port is 256. This field is unused if
the bridge port is created over an
PPPOE/IPOE interface or PPPOE/ IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
interface.
The State of Learning on this bridge port. The
value enable (1) indicates that unicast Mac
address learning is enabled and the value
disable indicates that unicast Mac address
learning is disabled on this bridge port. The
default value of learning status for
CPE/Downlink side bridge ports shall be
enable and for NET side bridge port default
value shall be disable. This field is unused if
the bridge port is created over an
PPPOE/IPOE interface or PPPOE/IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
interface.
The current operational state of the bridge
port. If AdminStatus of the bridge port is
disable (2), then OperStatus of the port should
be disable (2). If AdminStatus of the bridge
port is changed to enable(1), then OperStatus
of the port should change to enable(1) if the
bridge port is ready to transmit and receive
network traffic. The bridge port will have the
OperStatus value as dormant (5) if the
'configstatus' of the bridge port is 'config' and it
is waiting for a packet to be sensed, on its
lower interface index, to get activated.
The desired state of the bridge port. On
creation the bridge port shall be created in
enabled AdminStatus by default.
Indicates if the port has been set as sticky. The
value enable(1) indicates that the entries learnt
on this port won't be aged out. It also indicates
that the entries learnt on this port shall not be
learnt on any other port. The entries learnt on
this port can only be removed by management
action or by making the value as disable (2) so
that the entries can be aged out. This field is
unused if the bridge port is created over an
PPPOE/ IPOE interface or PPPOE/IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
interface.
This specifies whether this port can overwrite
an existing forwarding database entry. This
field is unused if the bridge port is created over
an PPPOE/ IPOE interface or PPPOE/IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
Acl Global Deny Apply
Acl Global Track Apply
ProxyArpStatus
Sensed IfIndex
195
interface.
This specifies whether the global acl macentry
deny list represented by MO AclGlobalMacList
is to be applied to this port or not. The default
value of this parameter shall depend on the
port type. For Net side ports, the default value
shall be disable and for the cpe side ports the
default value shall be enable. This field is
unused if the bridge port is created over an
PPPOE/IPOE interface or PPPOE/IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
interface.
This specifies whether the global acl macentry
track list represented by MO AclGlobalMacList
is to be applied to this port or not. The default
value of this parameter shall depend on the
port type. For Net side ports, the default value
shall be disable and for the cpe side ports the
default value shall be enable. This field is
unused if the bridge port is created over an
PPPOE/IPOE interface or PPPOE/ IPOE is
sensed. Any value of this field shall be ignored
for a bridge port created over a PPPOE/IPOE
interface.
The Proxy Arp Status on this bridge port. The
value enable of this field indicates that Proxy
Arp request can be received through this port.
This field can be enabled only on bridge port
created over ethernet or aggregator interface.
Before enabling this field user should create a
filter rule with rule action as Copy to Control
and rule description as IPOE_CONTROL and
map it to all those interfaces through which
user wants to receive proxy arp requests.
This specifies the sensed interface index
corresponding to the bridge port. This field is
used to determine the stack sensed for this
bridge port in the auto sensing scenario. This
field cannot be modified. If the oper status of
the bridge port is 'enable' or 'disable' then the
value of this field gives the interface index on
which the bridge port is currently stacked. If
the oper status is 'dormant' and the value of
this field is other than '-', then it represents the
last interface index on which the bridge port
had been stacked.
ArpTStatus
This specifies whether ARP translation will be
done on the ARP packets received/transmitted
on this port. When enabled, ARP source
MAC address of the incoming ARP packets
(both request/reply) will be changed to virtual
MAC address (if applicable) and the ARP
target MAC address of the outgoing ARP reply
packets will be changed to the original host
MAC address (if applicable).
Directed ARP status
This specifies whether the ARP packets
received on this bridge port are to be directed
to a single port using (VLANId, IP address) to
bridge port mapping learnt using DRA. This
field can be enabled only on the NET side
bridge port. This attribute is effective in
conjunction with the attribute 'gsv
dot1qVlanStaticDirectedARP' of
'Dot1qVlanStatic' MO. ARP packets are to be
directed as mentioned above, only if both the
flags are enabled. If any of the two is
disabled, the ARP packets will be forwarded as
per the normal bridging flow.
Port Type
8.6.8
8.6.8.1
This field specifies whether the port is trusted
or not. This information is used by some of the
control plane applications to send packet on
trusted ports, in case the application fails to
uniquely determine a port.
Bridge static mcast Commands
Get bridge static mcast
Description: Use this command to get.
Command Syntax: get bridge static mcast [vlanid <vlanid-val>]
[mcastaddr <mcastaddr-val>]
8.6.8.2
Create bridge static mcast
Description Use this command to create.
Command Syntax: create bridge static mcast vlanid <vlanid-val>
mcastaddr <mcastaddr-val> [egressports egressports | none]
[forbidegressports <forbidegressports-val> | none]
8.6.8.3
Delete bridge static mcast
Description Use this command to delete.
Command Syntax: delete bridge static mcast vlanid <vlanid-val>
mcastaddr <mcastaddr-val>
8.6.8.4
Modify bridge static mcast
Description: Use this command to modify.
Command Syntax: modify bridge static mcast vlanid <vlanid-val>
mcastaddr <mcastaddr-val> [egressports <egressports-val> | none |
none] [forbidegressports <forbidegressports-val>> | none]
Parameters
Name
Description
vlanid <vlanid-val>
The VLAN id for this VLAN. In devices supporting
"Shared Vlan for multicast" capability, the
information for a multicast MAC address is shared
across VLANS. Hence, vlanid is optional and can
be passed as zero or a valid vlanid value. In
devices supporting "Independent Vlan for
multicast" capability, each vlan can have its own
information for a multicast MAC address. Hence,
VLAN id is a mandatory parameter and a valid
value of vlanid must be passed. For the case
when the attribute "McastDeviceCapabilities" of
MO "sysSizingTable" has value "none", VLAN id is
not required. This feature is not supported for
VLAN with vlanid as 4097.VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0 - 4095
The destination multicast MAC address in a
frame, to which the filtering information of this
entry applies.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
mcastaddr
<mcastaddr-val>
196
egressports
<egressports-val>
|none
Forbidegressports
<forbidegressports-val>
| none
The set of ports, to which frames received from a
specific port and destined for a specific Multicast
MAC address must be forwarded. A port may not
be added in this set if it is already a member of the
set of ports in ForbiddenEgressPorts.
Type: Create - Optional
Modify - Optional
Valid values: 0
Default value: 0
The set of ports, to which frames received from a
specific port and destined for a specific Multicast
MAC address must not be forwarded, regardless
of any dynamic information. A port may not be
added in this set if it is already a member of the
set of ports in EgressPorts.
Type: Create - Optional
Modify - Optional
Valid values: 0
Default value: 0
Example
$ create bridge static mcast vlanid 7 mcastaddr 01:00:5E:00:00:01
recvport 0 egressports 10 forbidegressports 20 SKIP 1
Output
Verbose Mode On
Entry Created
VLan Index
01:00:5E:00:00:01
Egress ports
: 7
Mcast Address :
: 10
Forbidden Egress ports : 20
Verbose Mode Off:
Entry Created
Output Fields
Field
Description
VLan Index
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast"
capability, the information for a multicast MAC
address is shared across VLANS. Hence,
vlanid is optional and can be passed as zero or
a valid vlanid value. In devices supporting
"Independent Vlan for multicast" capability,
each vlan can have its own information for a
multicast MAC address. Hence, VLAN id is a
mandatory parameter and a valid value of
vlanid must be passed. For the case when the
attribute "McastDeviceCapabilities" of MO
"sysSizingTable" has value "none", VLAN id is
not required. This feature is not supported for
VLAN with vlanid as
GS_UNREGISTERED_VLANID.VLAN here
means the 802.1q Vlan in case of Native Vlan
mode and Virtual Vlan in case of Stacked Vlan
Mode.
The destination multicast MAC address in a
frame, to which the filtering information of this
entry applies.
The set of ports, to which frames received
from a specific port and destined for a specific
Multicast MAC address must be forwarded. A
port may not be added in this set if it is already
a member of the set of ports in
ForbiddenEgressPorts.
The set of ports, to which frames received
from a specific port and destined for a specific
Mcast Address
Egress ports
Forbidden Egress ports
197
Multicast MAC address must not be forwarded,
regardless of any dynamic information. A port
may not be added in this set if it is already a
member of the set of ports in EgressPorts.
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
References
• Bridge Commands
8.6.9
8.6.9.1
Bridge static ucast Commands
Get bridge static ucast
Description: Use this command to get.
Command Syntax: get bridge static ucast [vlanid <vlanid-val>]
[ucastaddr <ucastaddr-val>]
8.6.9.2
Create bridge static ucast
Description: Use this command to create.
Command Syntax: create bridge static ucast vlanid <vlanid-val>
ucastaddr <ucastaddr-val> [portid <portid-val>]
8.6.9.3
Delete bridge static ucast
Description Use this command to delete.
Command Syntax: delete bridge static ucast vlanid <vlanid-val>
ucastaddr <ucastaddr-val>
8.6.9.4
Modify bridge static ucast
Description Use this command to modify.
Command Syntax: modify bridge static ucast vlanid <vlanid-val>
ucastaddr <ucastaddr-val> [portid <portid-val>]
Parameters
Name
Description
vlanid <vlanid-val>
The VLAN index referring to this VLAN. In case of
device capability not supporting vlans, vlan id "0"
is a valid value. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual Vlan
in case of Stacked Vlan Mode.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0 - 4095
The destination unicast MacAddr to which filtering
info applies.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
The set of ports, for which a frame with a specific
unicast address will be flooded in the event that it
has not been learned. It also specifies the set of
ports a specific unicast address may be
dynamically learnt on. This list shall have only the
CPE side ports. Currently only one port can be set
in this list. Type: Create - Optional
Modify - Optional
ucastaddr <ucastaddrval>
portid <portid-val>
198
Valid values:1-386
Example
$create bridge static ucast vlanid 1 ucastaddr 1:1:1:1:1:1 recvport 0
portid 2 status 1 cfgmode Config
Output
Verbose Mode On
Entry Created
Vlan Index : 1
Port Id
Ucast Address : 1:1:1:1:1:1
:2
Verbose Mode Off:
Entry Created
Output Fields
Field
Description
Vlan Index
The VLAN index referring to this VLAN. In case of
device capability not supporting vlans, vlan id "0"
is a valid value. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual Vlan
in case of Stacked Vlan Mode.
The destination unicast MacAddr to which filtering
info applies.
The set of ports, for which a frame with a specific
unicast address will be flooded in the event that it
has not been learned. It also specifies the set of
ports a specific unicast address may be
dynamically learnt on. This list shall have only the
CPE side ports. Currently only one port can be set
in this list. Type - optional, Valid values:1-386
Ucast Address
Port Id
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
References
• Bridge Commands.
8.6.10
8.6.10.1
Bridge tbg traps Commands
Get bridge tbg traps
Description: Use this command to get.
Command Syntax: get bridge tbg traps
8.6.10.2
Modify bridge tbg traps
Description: Use this command to modify.
Command Syntax: modify bridge tbg traps [bindingstatus enable |
disable] [fdbtrapstatus enable | disable] [vmactrapstatus enable |
disable] [traploss Ok | Notok]
Parameters
199
Name
Description
bindingstatus enable
|disable
This parameter allows the user to enable or
disable the generation of 'binding status changed'
trap. This trap is sent when the port binding of a
unicast entry changes, i.e. the same address is
learnt on a different port in the same Forwarding
Database.
Type: Modify - Optional
fdbtrapstatus enable
|disable
vmactrapstatus
enable |disable
traploss Ok | Notok
This parameter allows the user to enable or
disable the generation of forwarding table trap.
This trap is sent when an entry in the forwarding
table is learnt/ created/modified/deleted or aged
out. These traps shall be given by the packet filter
module to the applications registered for these
traps.
Type: Modify - Optional
This parameter allows the user to enable or
disable the generation of trap when MAC to Virtual
MAC mapping for the MAC address is not found in
the M2VMac database associated with the
corresponding interface. These traps shall be
given by the packet filter module to the
applications registered for these traps.
Type: Modify - Optional
This parameter tells whether the loss of binding
status and forwarding table trap is acceptable or
not. Such a trap can be lost because of the
unavailability of resources. ‘OK’ means trap loss is
acceptable. In this case, when the trap is lost an
indication shall be given to the application, which
can then synchronize its database with the
forwarding table. ‘NotOK’ means trap loss is not
acceptable. In this case, if it is not possible to
raise the trap for any forwarding table entry getting
learnt/modified/deleted, that entry shall not get
learnt/modified/delete.
Type: Modify - Optional
Example
$ get bridge tbg traps
Output
Binding Status Changed Trap : enable
Virtual Mac Trap
Forwarding Table Trap : enable
: enable
Forwarding Table Trap Loss : OK
Output Fields
Field
Description
Binding Status
Changed Trap
This parameter allows the user to enable or
disable the generation of 'binding status changed'
trap. This trap is sent when the port binding of a
unicast entry changes, i.e. the same address is
learnt on a different port in the same Forwarding
Database.
This parameter allows the user to enable or
disable the generation of forwarding table trap.
This trap is sent when an entry in the forwarding
table is learnt/ created/modified/deleted or aged
out. These traps shall be given by the packet filter
module to the applications registered for these
traps.
This parameter allows the user to enable or
disable the generation of trap when MAC to Virtual
MAC mapping for the MAC address is not found in
the M2VMac database associated with the
corresponding interface. These traps shall be
given by the packet filter module to the
applications registered for these traps.
This parameter tells whether the loss of binding
status and forwarding table trap is acceptable or
not. Such a trap can be lost because of the
unavailability of resources. OK means trap loss is
acceptable. In this case, when the trap is lost an
indication shall be given to the application, which
can then synchronize its database with the
Forwarding Table
Trap
Virtual Mac Trap
Forwarding Table
Trap Loss
200
forwarding table. NotOK means trap loss is not
acceptable. In this case, if it is not possible to
raise the trap for any forwarding table entry getting
learnt/modified/deleted, that entry shall not get
learnt/modified/delete.
References
•
8.6.11
8.6.11.1
Bridge Commands
GARP Port Info Commands
Get garp port info
Description: Use this command to get.
Command Syntax: get garp port info [portid <portid-val>]
8.6.11.2
Modify garp port info
Description: Use this command to modify.
Command Syntax: modify garp port info portid <portid-val>
[jointimer <jointimer-val>] [leavetimer <leavetimer-val>] [leavealltimer
<leavealltimer-val>]
Parameters
Name
Description
portid <portid-val>
Index of the Bridge Port
Type
: Get - Optional
Modify - Mandatory
Valid values: 1 - 386
jointimer <jointimerval>
The GARP Join time, in centiseconds. Join time
value should be less than half the Leave time
value
Type
:Optional
Valid values: 10-255
leavetimer
<leavetimer-val>
The GARP Leave time, in centiseconds. Leave
time value should be greater than 2 times Join
time value.
Type
: Optional
Valid values: 10-255
leavealltimer
<leavealltimer-val>
The GARP LeaveAll time, in centiseconds.
LeaveAll time value should be large (more than 15
times) relative to Leave time value.
Type
: Optional
Valid values: 10-65535
Example
$ get garp port info
Output
PortId
Join Timer Leave Timer LeaveAll Timer
-------------------------------------------------------------------------------6
30
90
5000
Output Fields
Output Fields
Field
201
Description
PortId
Index of the Bridge Port.
Join Timer
The GARP Join time, in centiseconds. Join time
value should be less than half the Leave time
value.
Leave Timer
The GARP Leave time, in centiseconds. Leave
time value should be greater than 2 times Join
time value.
LeaveAll Timer
The GARP LeaveAll time, in centiseconds.
LeaveAll time value should be large (more than
15 times) relative to Leave time value.
References
• GVRP Commands
8.6.12
8.6.12.1
STP Group Commands
Get stp info
Description: Use this command to display the current status of the
Spanning Tree Protocol Group.
Command Syntax: get stp info
8.6.12.2
Modify stp info
Description: Use this command to alter the configuration for the
spanning tree protocol group.
Command Syntax: modify stp info [priority <priority-val>] [maxage
<maximum-age>] [htime <hello-time>] [fdelay <forward-delay>]
[enable|disable]
8.6.12.3
Reset stp stats
Description: Use this command to reset STP global statistics.
Command Syntax: reset stp stats
Parameters
Name
Description
Priority <priority-val>
The value of the write-able portion of the Bridge
ID,i.e.,the first two octets of the (8 octet long)
Bridge ID. The other (last) 6 octets of the Bridge
ID are given by the value of
dot1dBaseBridgeAddress.
Type
: Optional
Valid values: 0 - 65535.
Maxage <maximumage>
The maximum age of Spanning Tree Protocol
information learned from the network on any port
before it is discarded, in units of seconds. This
is the actual value that this bridge is currently
using.
Type
: Optional
Valid values: 6 - 40.
htime <hello-time>
202
The amount of time between the transmission of
Configuration bridge PDUs by this node on any
port when it is the root of the spanning tree or
trying to become so, in units of second. This is
the actual value that this bridge is currently
using.
Type
: Optional
Valid values: 1 - 10
Fdelay <forward-delay>
This is the actual time value, measured in units
of seconds, controls how fast a port changes its
spanning state when moving towards the
Forwarding state. The value determines how
long the port stays in each of the Listening and
Learning states, which precede the Forwarding
state. This value is also used, when a topology
change has been detected and is underway, to
age all dynamic entries in the Forwarding
Database.
Type
: Optional
Valid values: 4 - 30
Enable|disable
Spanning Tree Protocol to be enabled on the
Bridge or not. Spanning Tree Protocol can not
be enabled in Stacked Vlan mode.
Type : Optional
Valid values:
disable | enable
Example
$ modify stp info priority 0x20 maxage 25 htime 5 fdelay 20 enable
Output
Protocol Spec. : IEEE 8021D
Priority : 0x20
Top. Changes
: 1
Curr Top. Age(sec) : 35.0
Desig Root
: 00:20:00:10:5A:6C:DB:20 Root Cost : 0
Root Port
: None
Hold Time (sec) : 1.0
Br Max Age(sec) : 25
Curr Max Age (sec) : 20.0
Br Hello Time(sec) : 5
Curr Hello Time(sec) :2.0
Br Fwd Delay(sec) : 20
Curr Fwd Delay (sec) :15.0
STP status
: enable
Verbose Mode Off
Set Done
Output Fields
203
Field
Description
Protocol Spec
An indication of what version of the Spanning
Tree Protocol is being run.
Priority
The value of the write-able portion of the Bridge
ID,i.e.,the first two octets of the (8 octet long)
Bridge ID. The other (last) 6 octets of the Bridge
ID are given by the value of
dot1dBaseBridgeAddress.
Top. Changes
The total number of topology changes detected
by this bridge since the management entity was
last reset or initialized.
Curr Top. Age(Sec)
The time (in second) since the last time a
topology change was detected by the bridge
entity.
Desig Root
The bridge identifier of the root of the spanning
tree as determined by the Spanning Tree
Protocol as executed by this node. This value is
used as the Root Identifier parameter in all
Configuration Bridge PDUs originated by this
node.
Root Cost
The cost of the path to the root as seen from this
bridge.
Root Port
The port number of the port which offers the
lowest cost path from this bridge to the root
bridge.
Hold Time (Sec)
This time value determines the interval length
during which no more than two Configuration
bridge PDUs shall be transmitted by this node, in
units of seconds.
Br Max Age(Sec)
The maximum age of Spanning Tree Protocol
information learned from the network on any port
before it is discarded, in units of seconds, when
this bridge is the root of the spanning tree. Note
that IEEE-802.1D specifies that the range for
this parameter is related to the value of
dot1dStpBridgeHelloTime.
Curr Max Age (Sec)
The maximum age of Spanning Tree Protocol
information learned from the network on any port
before it is discarded, in units of seconds. This
is the actual value that this bridge is currently
using.
Br Hello Time(Sec)
The value that all bridges use for HelloTime
when this bridge is acting as the root.
Curr Hello Time(Sec)
The amount of time between the transmission of
Configuration bridge PDUs by this node on any
port when it is the root of the spanning tree or
trying to become so, in units of second. This is
the actual value that this bridge is currently
using.
Br Fwd Delay(Sec)
The value that all bridges use for ForwardDelay
when this bridge is acting as the root. Note that
IEEE-802.1D specifies that the range for this
parameter is related to the value of
dot1dStpBridgeMaxAge.
Curr Fwd Delay (Sec)
This is the actual time value, measured in units
of seconds, controls how fast a port changes its
spanning state when moving towards the
Forwarding state. The value determines how
long the port stays in each of the Listening and
Learning states, which precede the Forwarding
state. This value is also used, when a topology
change has been detected and is underway, to
age all dynamic entries in the Forwarding
Database.
STP status
Spanning Tree Protocol to be enabled on the
Bridge or not. Spanning Tree Protocol can not
be enabled in Stacked Vlan mode.
References
• get stp info command
• stp port related commands.
8.6.13
8.6.13.1
STP Port Commands
Get stp port
Description: Use this command to display port specific information for
the Spanning Tree Protocol, for all ports, or for the specified port.
Command Syntax: get stp port info portid <portid-val>
8.6.13.2
Modify stp port
Description: Use this command to alter the configuration for the
spanning tree protocol.
204
Command Syntax: modify stp port info portid <portid-val>
[enable|disable] [pcost <pcost-val>] [priority <priority-val>]
[pktpriority <pktpriority-val>]
8.6.13.3
Reset stp port stats
Description: Use this command to reset the STP port stats for a
specific interface.
Command Syntax: reset stp port stats portid <portid-val>
Parameters
Name
Description
portid <portid-val>
The port number of the port for which this entry
contains Spanning Tree Protocol management
information.
Type : Mandatory
Valid values: 1 to 386;
Spanning Tree Protocol to be enabled on the Port
or not
Type: Optional
Valid values: enable, disable
The contribution of this port to the path cost of
paths towards the spanning tree root, which
include this port.
Type : Optional
Valid values: 1 - 65535
The value of the priority field which is contained in
the most significant 6 bits of the more significant
octet of the (2 octet long) Port ID. The least
significant 2 bits of the more significant octet and
the less significant octet (total 10 bits) of the Port
ID is given by the value of dot1dStpPort.
Type: Optional
Valid values: 0 -255.
For STP PDUs, this priority shall be used for
choice of traffic class/ Queue on out¦going
interface. In case the bridge port is over an
Aggregated ATM VC, this will also be used to
identify the VC, on which the packet is to be sent.
Type: Modify - Optional
Valid values: 0 - 7
enable|disable
pcost <pcost-val>
priority <priority-val>
pktpriority <pktpriorityval>
Example
$ modify stp port portid 1 disable pcost 1000 priority 0x10
Output
Verbose Mode On
Port ID : 1
State : Forwarding
Path Cost : 100
Desig Root:80:00:00:10:5A:6C
Desig Port : 0x8000
Priority
PortStatus
Desig Cost
: 0x0
: Enable
: 0
Desig Bridge:80:00:00:10:5A:6C
Fwd Transitions : 1
STP Status : Enable
Set Done
Port ID : 1
State : Forwarding
Path Cost : 100
Desig Root:80:00:00:10:5A:6C
: 0x0
PortStatus : Enable
Desig Cost : 0
Desig Bridge:80:00:00:10:5A:6C
Desig Port : 0x8000
Fwd Transitions : 1
STP Status : Enable
STP PacketsPrio : 2
Verbose Mode Off
205
Priority
Set Done
Output Fields
Field
Description
Port Id
The port number of the port for which this entry
contains Spanning Tree Protocol management
information.
The value of the priority field which is
contained in the most significant 6 bits of the
more significant octet of the (2 octet long) Port
ID. The least significant 2 bits of the more
significant octet and the less significant octet
(total 10 bits) of the Port ID is given by the
value of dot1dStpPort.
The port's current state as defined by
application of the Spanning Tree Protocol.
This state controls what action a port takes on
reception of a frame.
The enabled/disabled status of the port.
The contribution of this port to the path cost of
paths towards the spanning tree root which
include this port.
The path cost of the Designated Port of the
segment connected to this port. This value is
compared to the Root Path Cost field in
received bridge PDUs.
The unique Bridge Identifier of the Bridge
recorded as the Root in the Configuration
BPDUs transmitted by the Designated Bridge
for the segment to which the port is attached.
The Bridge Identifier of the bridge which this
port considers to be the Designated Bridge for
this port's segment.
The Port Identifier of the port on the
Designated Bridge for this port's segment.
The number of times this port has transitioned
from the Learning state to the Forwarding
state.
Spanning Tree Protocol to be enabled on the
Bridge or not.
For STP PDUs, this priority shall be used for
choice of traffic class/ Queue on out¦going
interface. In case the bridge port is over an
Aggregated ATM VC, this will also be used to
identify the VC, on which the packet is to be
sent
Priority
State
Port Status
Path Cost
Desig Cost
Desig Root
Desig Bridge
Desig Port
Fwd Transitions
STP status
STP PacketsPrio
Caution
• The specified interface should be an existing bridge interface.
References
• bridge port intf command.
8.6.14
8.6.14.1
Transparent Bridging Table Commands
Modify bridge tbg info
Description Use this command to modify.
Command Syntac: modify bridge tbg info [aging <aging-timeout> ]
[slaveaging <aging-timeout> ] [netaging <aging-timeout> ]
[ floodsupport enable | disable ] [ bcastsupport enable | disable]
[ mcastsupport enable | disable ] [ mcastdrop enable | disable ]
[ dropiffdbfull <dropiffdbfull-val> ] [ resnetlearning <resnetlearningval> ] [resvmacprofileid <resvmacprofileid-val> ]
206
8.6.14.2
Get bridge tbg info
Description: Use this command to get bridging related global
information.
Command Syntax: get bridge tbg info
Parameters
Name
Description
Aging <aging-timeout>
The timeout period, in seconds, for aging out
dynamically learned forwarding information from
CPEs. The value 0 can be configured when aging
is to be stopped.
Type: Modify Optional
Valid values: 10 -1000000
The timeout period, in seconds, for aging out
dynamically learned forwarding information
learned from the slave device. The recommended
value for this is more than or equal to the value for
dot1dTpAgingTimeOut. The value 0 can be
configured when aging is to be stopped.
Valid values: 10 -1000000
The timeout period, in seconds, for aging out
dynamically learned forwarding information from
NET side port. This is used only for full bridge
configuration. The recommended value of net
aging timeout should be greater than that of the
ìAgingî parameter. The value 0 can be configured
when aging is to be stopped.
Valid values: 10 -1000000
This is used to specify whether the unknown
unicast packets are to be flooded or not. The
value for this is used along with per vlan
configuration for flood support to determine if
flooding has to be done for unknown unicast
packet.
Type : Optional
Valid Values: enable | disable
This is used to specify whether the broadcasting is
supported or not. The value for this is used along
with per vlan configuration broadcast support, to
determine if broadcasting has to be done for the
broadcast packet.
Used to specify whether the multicast is supported
or not.
Type : Optional
Valid Values: enable| disable
Used to specify whether the multicast packets are
to be dropped, or to be forwarded, if multicast is
not supported. This is only valid if
dot1dTpMcastSupport is false.
Type : Optional
Valid Values: enable|disable
This specifies if the frame for which learning could
not be done because of forwarding table limit
being reached, is to be dropped. If this is enabled
the frame for which learning could not be done
because of limit exceeded shall be dropped, else
forwarded based on bridge forwarding logic.This
being enabled shall reduce flooding, as when a
response to such a frame from which learning
could not be done shall come the frame shall be
flooded, as the entry for that unicast address, shall
not be found in forwarding table.
Type : Optional
Valid Values: enable or disable
Default value: enable
This specifies if learning can be done over net
side port for residential bridging. Learning shall be
slaveaging <aging–
timeout>
netaging <aging –
timeout>
floodsupport enable |
disable
bcastsupport
enable|disable
mcastsupport
enable|disable
mcastdrop
enable|disable
dropiffdbfull enable |
disable
resnetlearning enable
| disable
207
resvmacprofileid
<resvmacprofileid-val>
done on Net port in case of vlan with residential
bridging if 'dot1dPortGsLearningStatus' and
'dot1dTpGsResidentialNetLearning'is enabled. In
case of vlan with 'unrestricted' or 'restricted'
bridging the learning is governed only by per port
configuration i.e. 'dot1dBasePortTable'. Currently
the modification of this parameter is not
supported.
Type : Optional
Valid Values: enable or disable
Default value: enable
The Profile is used to determine the behavior for
Reserved Mac destined frames on the bridge.
Reserved Mac addresses are the multicast
addresses defined as reserved in IEEE 802.1Q
and IEEE 802.1ad. If it does not contain any valid
value then the behavior for Reserved Mac
destined frames is determined based on Resvd
Mac profile associated with the VLAN in which the
frame belongs to.VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual Vlan
in case of Stacked Vlan Mode.
Type: Modify - Optional
Valid values: 1 -4
Example
$ modify bridge tbg info aging 20 slaveaging 100
Output
Verbose Mode On
MacAddress
: 00:BB:CC:DD:EE:FF
No. of Ports
: 0
Base Type
: Transparent
Aging Timeout(sec)
TimeOut(sec) : 600
: 300
Slaveaging
Netaging TimeOut(sec) : 600
Support
: Disable
Flood
BroadCast Support
: Enable
Support
: Enable
MultiCast
MultiCast Drop
: Disable
Status
: Unrestricted
Full Bridging
Drop If FDB full status: Enable
ResidentialNetLearning : Enable
Reserved Mac Profile Id: 1
Set Done
MacAddress
: 00:BB:CC:DD:EE:FF
No. of Ports
: 0
Base Type
: Transparent
Aging Timeout(sec)
TimeOut(sec) : 100
: 20
Netaging TimeOut(sec) : 600
Support
: Disable
Flood
BroadCast Support
: Enable
Support
: Enable
MultiCast
MultiCast Drop
: Disable
Status
: Unrestricted
Full Bridging
Drop If FDB full status: Enable
ResidentialNetLearning : Enable
Reserved Mac Profile Id: 1
Output Fields
208
Slaveaging
Field
Description
MacAddress
The MAC address used by this bridge, when it
must be referred to, in a unique fashion. It is the
address of one of the Ethernet ports.
The maximum number of ports that can be
controlled by this bridge.
Indicates what type of bridging this bridge can
perform. It is always Transparent Bridging or
STP.
The timeout period, in seconds, for aging out
dynamically learned forwarding information from
CPEs. The value 0 can be configured when
aging is to be stopped.
The timeout period, in seconds, for aging out
dynamically learned forwarding information
learned from the slave device. The
recommended value for this is more than or
equal to the value for dot1dTpAgingTimeOut.
The value 0 can be configured when aging is to
be stopped.
This is used to specify whether the unknown
unicast packets are to be flooded or not. The
value for this is used along with per vlan
configuration for flood support to determine if
flooding has to be done for unknown unicast
packet.
This is used to specify whether the broadcasting
is supported or not. The value for this is used
along with per vlan configuration broadcast
support, to determine if broadcasting has to be
done for the broadcast packet.
Used to specify whether the multicast is
supported or not.
Used to specify whether the multicast packets
are to be dropped, or to be forwarded, if
multicast is not supported. This is only valid if
dot1dTpMcastSupport is false.
The timeout period, in seconds, for aging out
dynamically learned forwarding information from
NET side port. This is used only for full bridge
configuration. The recommended value of net
aging timeout should be greater than that of
dot1dTpAgingTimeOut.
This specifies the current state of full bridging on
the bridge. Thebridge can be set to residential
bridging, restricted full bridging or unrestricted
full bridging. In residential bridging, all packets
from a CPE side port are sent to Net side port
without doing a lookup in the forwarding table. In
restricted full bridging, there is a lookup and a
packet coming from a CPE port destined for
another CPE port is dropped. Hence, CPE-CPE
switching is not permitted. In unrestricted full
bridging, all traffic is forwarded based on lookup.
This specifies if the frame for which learning
could not be done because of forwarding table
limit being reached, is to be dropped. If this is
enabled the frame for which learning could not
be done because of limit exceeded shall be
dropped, else forwarded based on bridge
forwarding logic.This being enabled shall reduce
flooding, as when a response to such a frame
from which learning could not be done shall
come the frame shall be flooded, as the entry for
that unicast address, shall not be found in
forwarding table.
This specifies if learning can be done over net
side port for residential bridging. Learning shall
be done on Net port in case of vlan with
No. of Ports
Base Type
Aging TimeOut
Slaveaging TimeOut
Floodsupport
Bcastsupport
Mcastsupport
Mcastdrop
NetAgingTimeout
Full Bridging Status
Drop If FDB full status
ResidentialNetLearning
209
Reserved Mac Profile Id
residential bridging if
'dot1dPortGsLearningStatus' and
'dot1dTpGsResidentialNetLearning'is enabled.
In case of vlan with 'unrestricted' or 'restricted'
bridging the learning is governed only by per
port configuration i.e. 'dot1dBasePortTable'.
Currently the modification of this parameter
is not supported.
The Profile is used to determine the behavior for
Reserved Mac destined frames on the bridge.
Reserved Mac addresses are the multicast
addresses defined as reserved in IEEE 802.1Q
and IEEE 802.1ad. If it does not contain any
valid value then the behavior for Reserved Mac
destined frames is determined based on Resvd
Mac profile associated with the VLAN in which
the frame belongs to.VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
References
• Bridge Port commands
• Bridge Port stats commands
• Ethernet commands
210
8.7
8.7.1
8.7.1.1
Bridge Multicast Commands
Bridge mcast forwarding Commands
Get bridge mcast forwarding
Description: Use this command to get.
Command Syntax: get bridge mcast fwdall [vlanid <vlanid-val>]
8.7.1.2
Modify bridge mcast fwdall
Description: Use this command to modify.
Command Syntax: modify bridge mcast fwdall [vlanid <vlanid-val>]
[egressports <egressports-val> | none] [forbidegressports
<forbidegressports-val> | none]
Parameters
Name
Description
vlanid <vlanid-val>
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast" capability,
the information for a multicast MAC address is
shared across vlans. Hence vlan id is an
optional parameter. In devices supporting
"Independent Vlan for multicast" capability, each
vlan can have its own information for a multicast
MAC address. Hence vlanid is a mandatory
parameter in all the commands other than - get.
For No Vlan case, vlan id is not required. VLAN
here means the 802.1q Vlan in case of Native
Vlan mode and Virtual Vlan in case of Stacked
Vlan Mode.
Type: Get - Optional
Valid values: 0 - 4095
egressports
<egressports-val> | none
The set of ports, configured by management in
this VLAN, to which all multicast groupaddressed frames are to be forwarded. More
than one value can be given, separated by
spaces.
Type: Modify -- Optional
Valid values: 0
forbidegressports
<forbidegressports-val> |
none
The set of ports configured by management in
this VLAN, for which the Service Requirement
attributes Forward All Multicast Groups, may not
be dynamically registered by GMRP. More than
one value can be given, separated by spaces.
Type: Modify -- Optional
Valid values: 0
Example
$ get bridge mcast fwdall vlanid 1
Output
VLAN Index
: 1
Forward All Ports
: 34
Forward All Static Ports
: 1 2 3 5
Forward All Forbidden Ports : 4 9 10 11
Output Fields
211
Field
Description
Vlan Index
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast" capability,
the information for a multicast MAC address is
shared across vlans. Hence vlan id is an
optional parameter. In devices supporting
"Independent Vlan for multicast" capability, each
vlan can have its own information for a multicast
MAC address. Hence vlanid is a mandatory
parameter in all the commands other than - get.
For No Vlan case, vlan id is not required. VLAN
here means the 802.1q Vlan in case of Native
Vlan mode and Virtual Vlan in case of Stacked
Vlan Mode.
Forward All Ports
The complete set of ports in this VLAN, to which
all multicast group-addressed frames are to be
forwarded. This includes ports for which this
need has been determined dynamically by
GMRP, or configured statically by management.
Forward All Static Ports
The set of ports, configured by management in
this VLAN, to which all multicast groupaddressed frames are to be forwarded. More
than one value can be given, separated by
spaces.
Forward All Forbidden
Ports
The set of ports configured by management in
this VLAN, for which the Service Requirement
attribute Forward All Multicast Groups, may not
be dynamically registered by GMRP. More than
one value can be given, separated by spaces.
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
References
• bridge static multicast
8.7.2
8.7.2.1
Bridge mcast forwarding Commands
Get bridge mcast forwarding
Description: Use this command to get.
Command Syntax: get bridge mcast forwarding [vlanid <vlanid-val>]
[macaddr <macaddr-val>]
Parameters
212
Name
Description
vlanid <vlanid-val>
The VLAN id for this VLAN. In devices supporting
"Shared Vlan for multicast" capability, the
information for a multicast MAC address is shared
across VLANS. Hence, vlanid is not required and
is passed as zero. In devices supporting
"Independent Vlan for multicast" capability. Each
vlan can have its own information for a multicast
MAC address. Hence, VLAN id is a mandatory
parameter and a valid value of vlanid must be
passed. For No Vlan case VLAN id is not required.
When Vlan transparency feature is supported, the
valid range for vlanid also includes 4097. In case
of "Shared Vlan Multicast also there shall always
be a seperate entry for 4097 if the VLAN with that
VLAN Id is created. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual Vlan
in case of Stacked Vlan Mode.
Type: Modify - Optional
Get - Optional
Valid values: 0 - 4095
macaddr <macaddrval>
The destination Group MAC address in a frame, to
which this entry's filtering information applies
Type: Get -- Optional
Example
$ get bridge mcast forwarding vlanid 1 macaddr 01:00:5E:00:08:01
Output
Vlan Index
: 1
Mac Address : 01:00:5E:00:08:01
Egress ports : 1 2
Group Learnt : 1
Output Fields
Field
Description
VLAN Index
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast"
capability, the information for a multicast MAC
address is shared across VLANS. Hence,
vlanid is not required and is passed as zero. In
devices supporting "Independent Vlan for
multicast" capability. Each vlan can have its
own information for a multicast MAC address.
Hence, VLAN id is a mandatory parameter and
a valid value of vlanid must be passed. For No
Vlan case VLAN id is not required. When Vlan
transparency feature is supported, the valid
range for vlanid also includes 4097. In case of
"Shared Vlan Multicast also there shall always
be a seperate entry for 4097 if the VLAN with
that VLAN Id is created. VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
Mac Address
The destination Group MAC address in a
frame, to which this entry's filtering information
applies
Egress ports
The complete set of bridge ports, in this
VLAN, to which frames destined for this Group
MAC address are currently being explicitly
forwarded. This does not include ports for
which this address is only implicitly forwarded,
in the dot1qForwardAllPorts list.
Group Learnt
The subset of bridge ports in EgressPorts,
which were learned by GMRP or some other
dynamic mechanism, in this Filtering database.
References
• bridge static multicast
8.7.3
8.7.3.1
Bridge mcast fwdunreg Commands
Get bridge mcast fwdunreg
Description: Use this command to get.
Command Syntax: get bridge mcast fwdunreg [vlanid <vlanid-val>]
8.7.3.2
Modify bridge mcast fwdunreg
Description Syntax: Use this command to modify.
213
Command Syntax: modify bridge mcast fwdunreg [vlanid <vlanidval>] [egressports <egressports-val> | none] [forbidegressports
<forbidegressports-val> | none]
Parameters
Name
Description
vlanid <vlanid-val>
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast" capability,
the information for a multicast MAC address is
shared across VLANS. Hence, vlanid is not
required and is passed as zero. In devices
supporting "Independent Vlan for multicast"
capability. Each vlan can have its own
information for a multicast MAC address. Hence,
VLAN id is a mandatory parameter and a valid
value of vlanid must be passed. For No Vlan
case VLAN id is not required. When Vlan
transparency feature is supported, the valid
range for vlanid also includes 4097. In case of
"Shared Vlan Multicast also there shall always
be a seperate entry for 4097 if the VLAN with
that VLAN Id is created. VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
Type: Modify - Optional
Get - Optional
Valid values: 0 - 4095
The set of ports, configured by management, in
this VLAN, to which multicast group-addressed
frames for which there is no more specific
forwarding information, are to be forwarded.
More than one value can be given, separated by
spaces.
Type: Modify - Optional
Valid values: 0
The set of ports, configured by management in
this VLAN, for which the Service Requirement
attribute Forward Unregistered Multicast Groups,
may not be dynamically registered by GMRP.
More than one value can be given, separated by
spaces.
Type: Modify - Optional
Valid values: 0
egressports
<egressports-val> | none
forbidegressports
<forbidegressports-val> |
none
Example
$ get bridge mcast fwdunreg vlanid 1
Output
VLAN Index
: 1
Forward Unregistered Ports
: 45
Forward Unregistered Static Ports
: 1 2 3 6
Forward Unregistered Forbidden Ports : 4 9 10
Output Fields
214
Field
Description
VLAN Index
The VLAN id for this VLAN. In devices supporting
"Shared Vlan for multicast" capability, the
information for a multicast MAC address is shared
across VLANS. Hence, vlanid is not required and
is passed as zero. In devices supporting
"Independent Vlan for multicast" capability. Each
vlan can have its own information for a multicast
MAC address. Hence, VLAN id is a mandatory
parameter and a valid value of vlanid must be
Forward Unregistered
Ports
Forward Unregistered
Static Ports
Forward Unregistered
Forbidden Ports
passed. For No Vlan case VLAN id is not required.
When Vlan transparency feature is supported, the
valid range for vlanid also includes 4097. In case
of "Shared Vlan Multicast also there shall always
be a seperate entry for 4097 if the VLAN with that
VLAN Id is created. VLAN here means the 802.1q
Vlan in case of Native Vlan mode and Virtual Vlan
in case of Stacked Vlan Mode.
The complete set of ports in this VLAN, to which
multicast group-addressed frames for which there
is no more specific forwarding information, will be
forwarded. This includes ports, for which this need
has been determined dynamically by GMRP, or
configured statically by management.
The set of ports, configured by management, in
this VLAN, to which multicast group-addressed
frames for which there is no more specific
forwarding information, are to be forwarded. More
than one value can be given, separated by
spaces.
The set of ports, configured by management in
this VLAN, for which the Service Requirement
attribute Forward Unregistered Multicast Groups,
may not be dynamically registered by GMRP.
More than one value can be given, separated by
spaces.
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
References
• Bridge commands.
8.7.4
8.7.4.1
Bridge Static Multicast Commands
Create bridge static mcast
Description: Use this command is used to create.
Command Syntax: create bridge static mcast [vlanid <vlanid-val>]
mcastaddr <mcastaddr-val> [egressports <egressports-val>]
[forbidegressports <forbidegressports-val>]
8.7.4.2
Delete bridge static mcast
Description: Use this command is used to delete.
Command Syntax: delete bridge static mcast [vlanid <vlanid-val>]
mcastaddr <mcastaddr-val>
8.7.4.3
Get bridge static mcast
Description: Use this command is used to get.
Command Syntax: get bridge static mcast [vlanid <vlanid-val>]
[mcastaddr <mcastaddr-val>]
8.7.4.4
Modify bridge static mcast
Description: Use this command is used to modify
Command Syntax: modify bridge static mcast [vlanid <vlanid-val>]
mcastaddr <mcastaddr-val> [egressports <egressports-val>]
[forbidegressports <forbidegressports-val>]
Parameters
215
Name
Description
Vlanid <vlanid-val>
The VLAN ID for this VLAN. In devices
supporting "Shared Vlan for multicast" capability,
mcastaddr
<mcastaddr-val>
egressports
<egressports-val>|none
forbidegressports
<forbidegressportsval>|none
the information for a multicast MAC address is
shared across VLANs. Hence vlan id is an
optional parameter. In devices supporting
"Independent Vlan for multicast" capability, each
vlan can have its own information for a multicast
MAC address. Hence vlanid is a mandatory
parameter in all the commands other than - get.
For No Vlan case, vlan id is not required. This
feature is not supported for VLAN with vlanid as
4097.
Type: Optional for all commands
Valid values: 0 - 4095
Default value:
The destination multicast MAC address in a
frame, to which this entry's filtering information
applies. Bit 0 of the first octet of the MAC
address indicates a group (multicast) MAC
address, if the bit is SET. For example,
01:00:00:00:00:00,03:FF:FF:FF:FF. Addresses
in the range 01:80:C2:00:00:00 01:80:C2:00:00:0f and 01:80:C2:00:00:20 01:80:C2:00:00:2f have been blocked as value
of this index, as these are reserved GARP
addresses.
Type : Create - Mandatory
Modify - Mandatory
Delete - Mandatory
Get - Optional
Default value:
The set of ports, to which frames received from
a specific port and destined for a specific
Multicast MAC address must be forwarded. A
port may not be added in this set, if it is already
a member of the set of ports in
ForbidEgressPorts. More than one value can
be given, separated by spaces.
Type :Optional for all commands
Valid values: 1 – 386
Default value: none
The set of ports, to which frames received from
a specific port and destined for a specific
Multicast MAC address must not be forwarded,
regardless of any dynamic information. A port
may not be added in this set if it is already a
member of the set of ports in EgressPorts.
Type :Optional for all commands
Valid values : 1 – 386
Default value: none
Example
$ create bridge static mcast vlanid 7 mcastaddr 01:00:5e:00:00:01
egressports 10 forbidegressports 20
Output
Verbose Mode On:
Entry Created
VLan Index
01:00:5E:00:00:01
Egress ports
: 7
Mcast Address :
: 10
Forbidden Egress ports : 20
Verbose Mode Off:
Entry Created
Output Fields
216
Field
Description
VLan Index
The VLAN ID for this VLAN. In devices
Mcast Address
Egress ports
Forbidden Egress ports
supporting "Shared Vlan for multicast"
capability, the information for a multicast MAC
address is shared across vlans. Hence vlan id
is an optional parameter. In devices supporting
"Independent Vlan for multicast" capability,
each vlan can have its own information for a
multicast MAC address. Hence vlanid is a
mandatory parameter in all the commands
other than - get. For No Vlan case, vlan id is
not required. This feature is not supported for
VLAN with vlanid as 4097
The destination multicast MAC address in a
frame, to which the filtering information of this
entry applies.
The set of ports, to which frames received from
a specific port and destined for a specific
Multicast MAC address must be forwarded. A
port may not be added in this set if it is already
a member of the set of ports in
ForbiddenEgressPorts.
The set of ports, to which frames received from
a specific port and destined for a specific
Multicast MAC address must not be forwarded,
regardless of any dynamic information. A port
may not be added in this set if it is already a
member of the set of ports in EgressPorts.
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
References
• Bridge commands.
217
8.8
8.8.1
8.8.1.1
DHCP Commands
DHCP Client Commands
Get dhcp client info
Description: Use this command to get DHCP client information for
clients, on the specified interface, or for all the interfaces.
Command Syntax: get dhcp client info [ifname <interface-name>]
Parameters
Name
Description
Ifname <interfacenamef>
This specifies the interface name on which DHCP
is running. If this is not specified, then information
for clients on all such interfaces will be displayed.
Type : Optional
Valid values : eth-*, aggr-*
Mode Super-User, User
Example $ get dhcp client info ifname eth-0
Output
If-name
(sec)
Server
Status
Lease Start Date
Lease Time
-----------------------------------------------------------eth-0
1.1.1.1
Bound
Thu Jan 01 00:00:38 1970 500
Output Fields
FIELD
If-Name
Server
Status
Lease Start Date
Lease Time
Description
This is an interface on which DHCP is running: It
can be : eth-*, aggr-*
This specifies the address of the DHCP server
with whom the client has obtained the IP address
and other configuratio.s
This specifies the current state of the client. It may
be:Init, Selecting, Bound, Requesting, Renew or
Bind.
This signifies the date on which the DHCP server
leased out the IP address to the client.
This specifies the time period, (in seconds), for
which an IP address was leased out by the server.
The client is expected to renew the lease before
the expiry of this timer or release the IP Address.
References
• dhcp client stats related commands
8.8.1.2
Get dhcp client stats
Description: Use this command to get DHCP client statistics on an
interface on which the DHCP client is running, or on all such interfaces.
Command Syntax: get dhcp client stats [ifname <interface-name>]
Parameters
FIELD
Description
Ifname <interface-name> This specifies the interface name on which DHCP is
running. If this is not specified then information for
clients on all such interfaces will be displayed.
Type: Optional
218
Valid values : eth-0- *
Mode Super-User, User
Example $ get dhcp client stats ifname eth-0
Output
If-name
: eth-0
Msgs Sent
0
: 4
Msgs Rcvd
:
Decline Sent
0
: 0
Offer Msgs Rcvd
:
Discover Msgs Sent
: 4
Req Sent
0
: 0
Acks Rcvd
:
Rel Sent
0
: 0
Nacks Rcvd
:
Inform Sent
0
: 0
Invalid Rcvd
:
Output Fields
FIELD
If-Name
Msgs Sent
Msgs Rcvd
Decline Sent
Offer Msgs Rcvd
Discover Msgs Sent
Req Sent
Acks Rcvd
Rel Sent
Nacks Rcvd
Inform Sent
Invalid Rcvd
Description
This is an interface on which DHCP is running: It
can be : eth-0
This specifies number of DHCP messages
received sent on this interface.
This specifies number of DHCP messages sent
received on this interface.
This specifies number of DHCP decline messages
sent on this interface.
This specifies number of DHCP offer messages
received on this interface.
This specifies number of DHCP discover
messages sent on this interface.
This specifies number of DHCP request messages
sent on this interface.
This specifies number of DHCP acks received on
this interface.
This specifies number of DHCP release messages
sent on this interface.
This specifies number of DHCP nacks received on
this interface.
This specifies number of DHCP inform messages
sent on this interface.
This specifies number of invalid dhcp messages
received on this interface.
References
• dhcp client info related commands
219
8.9
8.9.1
8.9.1.1
DSL Commands
ADSL Alarm Profile Commands
Get adsl alarm profile
Description: Use this command to get.
Command Syntax: get adsl alarm profile [ifname <interface-name>]
8.9.1.2
Modify adsl alarm profile
Description: Use this command to modify.
Command Syntax: modify adsl alarm profile ifname <interfacename> [ atucthresh15minlofs <atucthresh15minlofs-val> ]
[ atucthresh15minloss <atucthresh15minloss-val> ]
[ atucthresh15minlols <atucthresh15minlols-val> ]
[ atucthresh15minlprs <atucthresh15minlprs-val> ]
[ atucthresh15miness <atucthresh15miness-val> ]
[ atucthreshfastrateup <atucthreshfastrateup-val> ]
[ atucthreshintlrateup <atucthreshintlrateup-val> ]
[ atucthreshfastratedn <atucthreshfastratedn-val> ]
[ atucthreshintlratedn <atucthreshintlratedn-val> ] [ atucinitfailtrap
False | True ] [ atucoptrapenable False | True ] [ aturthresh15minlofs
<aturthresh15minlofs-val> ] [ aturthresh15minloss
<aturthresh15minloss-val> ] [ aturthresh15minlprs
<aturthresh15minlprs-val> ] [ aturthresh15miness
<aturthresh15miness-val> ] [ aturthreshfastrateup
<aturthreshfastrateup-val> ] [ aturthreshintlrateup
<aturthreshintlrateup-val> ] [ aturthreshfastratedn
<aturthreshfastratedn-val> ] [ aturthreshintlratedn
<aturthreshintlratedn-val> ] [ atucgspmstatetrapenable False | True ]
[ linealarmgscntrsreset False | True ]
Parameters
Name
Description
ifname <fname-val>
The ADSL alarm interface name, whose profile is
to be modified or viewed
Type: Modify - Mandatory
Get - Optional
atucthresh15minlofs
<atucthresh15minlofsval>
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send an
'adslAtucPerfLofsThreshTrap'.
Type: Modify -- Optional
Valid values: 0 - 900
atucthresh15minloss
<atucthresh15minlossval>
The number of Loss of Signal Seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes the SNMP agent to send an
'adslAtucPerfLossThreshTrap'.
Type: Modify -- Optional
Valid values: 0 - 900
atucthresh15minlols
<atucthresh15minlolsval>
220
The number of Loss of Link Seconds encountered
by an ADSL interface within any given 15 minute
performance data collection period, which causes
the SNMP agent to send an
'adslAtucPerfLolsThreshTrap'.
Type: Modify -- Optional
Valid values: 0 - 900
atucthresh15minlprs
<atucthresh15minlprsval>
The number of Loss of Power Seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes the SNMP agent to send an
'adslAtucPerfLprsThreshTrap'.
Type: Modify -- Optional
Valid values: 0 - 900
atucthresh15miness
<atucthresh15minessval>
The number of Errored Seconds encountered by
an ADSL interface within any given 15 minute
performance data collection period, which causes
the SNMP agent to send an
'adslAtucPerfESsThreshTrap'.
Type: Modify -- Optional
Valid values: 0 - 900
atucthreshfastrateup
<atucthreshfastrateupval>
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate >= ChanPrevTxRate plus
the value of this object.
Type: Modify -- Optional
atucthreshintlrateup
<atucthreshintlrateupval>
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate >= ChanPrevTxRate plus
the value of this object.
Type: Modify -- Optional
atucthreshfastratedn
<atucthreshfastratednval>
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate <= ChanPrevTxRate
minus the value of this object.
Type: Modify -- Optional
atucthreshintlratedn
<atucthreshintlratednval>
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate <= ChanPrevTxRate
minus the value of this object.
Type: Modify -- Optional
atucinitfailtrap False |
True
Enables and disables the InitFailureTrap. This
object is defaulted disable.
Type: Modify -- Optional
Valid values: False, True
atucoptrapenable
False | True
Enables/disables the OpStateChangeTrap
Type: Modify -- Optional
Valid values: False, True
aturthresh15minlofs
<aturthresh15minlofsval>
The number of Loss of Frame Seconds
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send an
'adslAturPerfLofsThreshTrap'
Type: Modify -- Optional
Valid values: 0 - 900
aturthresh15minloss
221
The number of Loss of Signal Seconds
<aturthresh15minlossval>
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send an
'adslAturPerfLossThreshTrap'
Type: Modify -- Optional
Valid values: 0 - 900
aturthresh15minlprs
<aturthresh15minlprsval>
The number of Loss of Power Seconds
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send an
'adslAturPerfLprsThreshTrap'
Type: Modify -- Optional
Valid values: 0 - 900
aturthresh15miness
<aturthresh15minessval>
The number of Errored Seconds encountered by
an ADSL interface within any given 15 minutes
performance data collection period, which causes
the SNMP agent to send an
'adslAturPerfESsThreshTrap'
Type: Modify -- Optional
Valid values: 0 - 900
aturthreshfastrateup
<aturthreshfastrateupval>
Applies to 'Fast' channels only. Configured change
in rate causing an adslAturRateChangeTrap A
trap is produced when: ChanCurrTxRate >
ChanPrevTxRate plus the value of this object.
Type: Modify -- Optional
aturthreshintlrateup
<aturthreshintlrateupval>
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate > ChanPrevTxRate plus
the value of this object.
Type: Modify -- Optional
aturthreshfastratedn
<aturthreshfastratednval>
Applies to 'Fast' channels only. Configured change
in rate causing an adslAturRateChangeTrap A
trap is produced when: ChanCurrTxRate <
ChanPrevTxRate minus the value of this object.
Type: Modify -- Optional
aturthreshintlratedn
<aturthreshintlratednval>
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate < ChanPrevTxRate minus
the value of this object.
Type: Modify -- Optional
atucgspmstatetrapen
able False | True
This indicates change in power mangement state
Type: Modify -- Optional
Valid values: False, True
linealarmgscntrsreset
False | True
This parameter resets performance counters at
runtime
Type: Modify -- Optional
Valid values: False, True
Example
$ get adsl alarm profile ifname dsl-0
Output
IfName
ADSL ATUC Configuration :
222
: dsl-0
-----------------------------Thresh 15Min Lofs(sec)
: 10
Thresh 15Min Loss(sec) : 20
Thresh 15Min Lols(sec)
: 30
Thresh 15Min Lprs(sec) : 50
Thresh 15Min Ess(sec)
: 40
Thresh Fast Rate Up(bps): 70
Thresh Intl Rate Up(bps)
: 30
Thresh Fast Rate Down(bps):10
Thresh Intl Rate Down(bps) : 30
Init Fail Trap
: true
OpStateTrapEnable
PowerMgmtTrapEnable
: True
: false
ADSL ATUR Configuration :
-----------------------------Thresh 15Min Lofs(sec)
: 10
Thresh 15Min Loss(sec)
: 10
Thresh 15Min Lprs(sec) : 10
Thresh 15Min Ess(sec)
: 10
Thresh Fast Rate Up(bps: 10
Thresh Intl Rate Up(bps)
: 10
Thresh Fast Rate Down(bps):10
Thresh Intl Rate Down(bps) : 10
Output Fields
223
FIELD
Description
IfName
The ADSL alarm interface name, whose profile is
to be modified or viewed
Thresh 15Min
Lofs(sec)
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send
an 'adslAtucPerfLofsThreshTrap'.
Thresh 15Min
Loss(sec)
The number of Loss of Signal Seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes the SNMP agent to send
an 'adslAtucPerfLossThreshTrap'.
Thresh 15Min Lols(sec)
The number of Loss of Link Seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes the SNMP agent to send
an 'adslAtucPerfLolsThreshTrap'.
Thresh 15Min
Lprs(sec)
The number of Loss of Power Seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes the SNMP agent to send
an 'adslAtucPerfLprsThreshTrap'.
Thresh 15Min Ess(sec)
The number of Errored Seconds encountered by
an ADSL interface within any given 15 minute
performance data collection period, which
causes the SNMP agent to send an
'adslAtucPerfESsThreshTrap'.
Thresh Fast Rate
Up(bps)
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate >= ChanPrevTxRate
plus the value of this object.
Thresh Intl Rate
Up(bps)
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate >= ChanPrevTxRate
plus the value of this object.
Thresh Fast Rate
Down(bps)
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate <= ChanPrevTxRate
minus the value of this object.
Thresh Intl Rate
Down(bps)
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAtucRateChangeTrap. A trap is produced
when: ChanCurrTxRate <= ChanPrevTxRate
minus the value of this object.
Init Fail Trap
Enables and disables the InitFailureTrap. This
object is defaulted disable.
OpStateTrapEnable
Enables/disables the OpStateChangeTrap
PowerMgmtTrapEnable
This indicates change in power mangement state
Thresh 15Min
Lofs(sec)
The number of Loss of Frame Seconds
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send
an 'adslAturPerfLofsThreshTrap'
Thresh 15Min
Loss(sec)
The number of Loss of Signal Seconds
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send
an 'adslAturPerfLossThreshTrap'
Thresh 15Min
Lprs(sec)
The number of Loss of Power Seconds
encountered by an ADSL interface within any
given 15 minutes performance data collection
period, which causes the SNMP agent to send
an 'adslAturPerfLprsThreshTrap'
Thresh 15Min Ess(sec)
The number of Errored Seconds encountered by
an ADSL interface within any given 15 minutes
performance data collection period, which
causes the SNMP agent to send an
'adslAturPerfESsThreshTrap'
Thresh Fast Rate
Up(bps)
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate > ChanPrevTxRate plus
the value of this object.
Thresh Intl Rate
Up(bps)
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate > ChanPrevTxRate plus
the value of this object.
Thresh Fast Rate
Down(bps)
Applies to 'Fast' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate < ChanPrevTxRate
minus the value of this object.
Thresh Intl Rate
Down(bps)
Applies to 'Interleave' channels only. Configured
change in rate causing an
adslAturRateChangeTrap A trap is produced
when: ChanCurrTxRate < ChanPrevTxRate
minus the value of this object.
References
• ADSL Commands
8.9.2
8.9.2.1
ADSL Alarm Profilext Commands
Get adsl alarm profilext
Description: Use this command to get.
Command Syntax: get adsl alarm profilext [ifname <interfacename>]
224
8.9.2.2
Modify adsl alarm profilext
Description: Use this command to modify.
Command Syntax: modify adsl alarm profilext ifname <interfacename> [ atucthresh15minffstr <atucthresh15minffstr-val> ]
[ atucthresh15minsesl <atucthresh15minsesl-val> ]
[atucthresh15minuasl <atucthresh15minuasl-val> ]
[atucthresh15minfecsl <atucthresh15minfecsl-val>]
[ atucthresh1daylofs <atucthresh1daylofs-val> ] [atucthresh1dayloss
<atucthresh1dayloss-val> ] [ atucthresh1daylols <atucthresh1daylolsval> ][ atucthresh1daylprs <atucthresh1daylprs-val> ]
[ atucthresh1dayess <atucthresh1dayessval> ][ atucthresh1daysesl <atucthresh1daysesl-val> ]
[ atucthresh1dayuasl <atucthresh1dayuasl-val>]
[atucthresh1dayfecsl <atucthresh1dayfecsl-val> ]
[ aturthresh15minsesl <aturthresh15minsesl-val> ]
[ aturthresh15minuasl <aturthresh15minuaslval> ][aturthresh15minfecsl <aturthresh15minfecsl-val>]
[ aturthresh1daylofs <aturthresh1daylofs-val> ] [ aturthresh1dayloss
<aturthresh1dayloss-val> ] [aturthresh1daylprs <aturthresh1daylprsval> ] [ aturthresh1dayess <aturthresh1dayess-val> ]
[aturthresh1daysesl <aturthresh1daysesl-val> ] [ aturthresh1dayuasl
<aturthresh1dayuasl-val> ][aturthresh1dayfecsl <aturthresh1dayfecslval>]
Parameters
Name
Description
ifname <fname-val>
The ADSL alarm interface name, whose profile is
to be modified or viewed
Type: Modify - Mandatory
Get - Optional
The number of failed retrains encountered by an
ADSL interface within any giving 15 minute
performance data collection period, which cause
the SNMP agent to send an
adslAtucFailedFastRTrap.
Type: Modify - Optional
Valid values: 0 - 900
The number of Severe errored seconds
encountered by an ADSL interface within any
giving 15 minute performance data collection
period, which cause the SNMP to send an
adslAtucSesLTrap.
Type: Modify - Optional
Valid values: 0 - 900
The number of unavailable errored seconds
encountered by an ADSL interface within any
giving 15 minutes performance data collection
period, which cause the SNMP agent to send an
adslAtucUasLThreshTrap
Type: Modify - Optional
Valid values: 0 - 900
The number of Forward error correction seconds
encountered by an ADSL interface within any
giving 15 Minutes performance data collection
period, which causes
adslAtucPerfFecsLThreshTrap.
Type: Modify - Optional
Valid values: 0 - 900
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAtucPerfLofsThresh1DayTrap'.
Type: Modify - Optional
atucthresh15minffstr
<atucthresh15minffstrval>
atucthresh15minsesl
<atucthresh15minseslval>
atucthresh15minuasl
<atucthresh15minuaslval>
atucthresh15minfecsl
<atucthresh15minfecs
l-val>
atucthresh1daylofs
<atucthresh1daylofsval>
225
Valid values: 0 - 86400
atucthresh1dayloss
<atucthresh1daylossval>
atucthresh1daylols
<atucthresh1daylolsval>
atucthresh1daylprs
<atucthresh1daylprsval>
atucthresh1dayess
<atucthresh1dayessval>
atucthresh1daysesl
<atucthresh1dayseslval>
atucthresh1dayuasl
<atucthresh1dayuaslval>
atucthresh1dayfecsl
<atucthresh1dayfecslval>
aturthresh15minsesl
<aturthresh15minsesl>
aturthresh15minuasl
<aturthresh15minuasl>
aturthresh15minfecsl
<aturthresh15minfecsval>
226
The number of Loss of Signal Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAtucPerfLossThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Loss of Link Seconds encountered
by an ADSL interface, within any given 1 day
performance data collection period, which causes
the SNMP agent to send an
'adslAtucPerfLolsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Loss of Power Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAtucPerfLprsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Errored Seconds encountered by
an ADSL interface, within any given 1 day
performance data collection period, which causes
the SNMP agent to send an
'adslAtucPerfESsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Severe errored Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAtucPerfSesLThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of unavailable errored seconds
encountered by an ADSL interface within any
giving 1 day performance data collection period,
which cause the SNMP agent to send an
adslAtucPerfUasLThresh1DayTrap
Type: Modify - Optional
Valid values: 0 - 86400
The number of Forward error correction seconds
encountered by an ADSL interface within any
giving 1 day performance data collection period,
which causes atucPerfFecsLThresh1DayTrap.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Severe errored seconds
encountered by an ADSL interface within any
giving 15 minute performance data collection
period, which cause the SNMP to send an
adslAturPerfSesLThresh15MInTrap. Type: Modify
- Optional
Valid values: 0 - 900
The number of unavailable errored seconds
encountered by an ADSL interface within any
giving 15 Minutes performance data collection
period, which cause the SNMP agent to send an
adslAturPerfUasLThresh1DayTrap
Type: Modify - Optional
Valid values: 0 - 900
The number of Forward error correction seconds
encountered by an ADSL interface within any
giving 15 Minutes performance data collection
period, which causes
adslAturPerfFecsLThreshTrap.
aturthresh1daylofs
<aturthresh1daylofsval>
aturthresh1dayloss
<aturthresh1daylossval>
aturthresh1daylprs
<aturthresh1daylprsval>
aturthresh1dayess
<aturthresh1dayessval>
aturthresh1daysesl
<aturthresh1dayseslval>
aturthresh1dayuasl
<aturthresh1dayuaslval>
aturthresh1dayfecsl
<aturthresh1dayfecslval>
Type: Modify - Optional
Valid values: 0 - 900
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAturPerfLofsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Loss of Signal Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAturPerfLossThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Loss of Power Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAturPerfLprsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Errored Seconds encountered by
an ADSL interface, within any given 1 day
performance data collection period, which causes
the SNMP agent to send an
'adslAturPerfESsThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of Severe errored Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes the SNMP agent to send an
'adslAturPerfSesLThresh1DayTrap'.
Type: Modify - Optional
Valid values: 0 - 86400
The number of unavailable errored seconds
encountered by an ADSL interface within any
giving 1 day performance data collection period,
which cause the SNMP agent to send an
adslAturPerfUasLThresh1DayTrap
Type: Modify - Optional
Valid values: 0 - 86400
The number of Forward error correction seconds
encountered by an ADSL interface within any
given 1 day performance data collection period,
which causes aturPerfFecsLThresh1DayTrap.
Type: Modify - Optional
Valid values: 0 - 86400
Example
$ get adsl alarm profilext ifname dsl-0
Output
IfName
: dsl-0
Atuc Thresh 15Min Fail FastR(sec) : 10
227
Atuc Thresh 15Min SesL(sec)
: 14
Atuc Thresh 15Min UasL(sec)
: 10
Atuc Thresh 15Min FecsL(sec)
: 10
Atuc Thresh 1 Day Lofs(sec)
: 10
Atuc Thresh 1 Day Loss(sec)
: 10
Atuc Thresh 1 Day Lols(sec)
: 10
Atuc Thresh 1 Day Lprs(sec)
: 10
Atuc Thresh 1 Day ESs(sec)
: 10
Atuc Thresh 1 Day SesL(sec)
: 10
Atuc Thresh 1 Day UasL(sec)
: 10
Atuc Thresh 1 Day FecsL(sec)
: 10
Atur Thresh 15Min Sesl(sec)
: 10
Atur Thresh 15Min UasL(sec)
: 10
Atur Thresh 15Min FecsL(sec)
: 10
Atur Thresh 1 Day Lofs(sec)
: 10
Atur Thresh 1 Day Loss(sec)
: 10
Atur Thresh 1 Day Lprs(sec)
: 10
Atur Thresh 1 Day ESs(sec)
: 10
Atur Thresh 1 Day SesL(sec)
: 10
Atur Thresh 1 Day UasL(sec)
: 10
Atur Thresh 1 Day FecsL(sec)
: 10
Output Fields
FIELD
Description
IfName
The ADSL alarm interface name, whose profile is
to be modified or viewed
The number of failed retrains encountered by an
ADSL interface within any given 15 minute
performance data collection period, which causes
adslAtucFailedFastRTrap.
The number of Severe errored seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
period, which causes adslAtucSesLTrap.
The number of unavailable errored seconds
encountered by an ADSL interface within any
given 15 Minute performance data collection
period, which causes adslAtucUasLThreshTrap.
The number of Forward error correction seconds
encountered by an ADSL interface within any
given 15 Minute performance data collection
period, which causes
adslAtucPerfFecsLThreshTrap.
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAtucPerfLofsThresh1DayTrap.
The number of Loss of Signal Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAtucPerfLossThresh1DayTrap.
The number of Loss of Link Seconds encountered
by an ADSL interface, within any given 1 day
performance data collection period, which causes
adslAtucPerfLolsThresh1DayTrap.
The number of Loss of Power Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAtucPerfLprsThresh1DayTrap.
The number of Severe errored Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAtucPerfSesLThresh1DayTrap.
The number of unavailable errored seconds
encountered by an ADSL interface within any
given 1 day performance data collection period,
which causes adslAtucPerfUasLThresh1DayTrap.
The number of Forward error correction seconds
encountered by an ADSL interface within any
given 1 day performance data collection period,
which causes atucPerfFecsLThresh1DayTrap.
The number of Severe errored seconds
encountered by an ADSL interface within any
given 15 minute performance data collection
Atuc Thresh 15Min
Fail FastR(sec)
Atuc Thresh 15Min
SesL(sec)
Atuc Thresh 15Min
UasL(sec)
Atuc Thresh 15Min
FecsL(sec)
Atuc Thresh 1 Day
Lofs(sec)
Atuc Thresh 1 Day
Loss(sec)
Atuc Thresh 1 Day
Lols(sec)
Atuc Thresh 1 Day
Lprs(sec)
Atuc Thresh 1 Day
SesL(sec)
Atuc Thresh 1 Day
UasL(sec)
Atuc Thresh 1 Day
FecsL(sec)
Atur Thresh 15Min
Sesl(sec)
228
Atur Thresh 15Min
UasL(sec)
Atur Thresh 15Min
FecsL(sec)
Atur Thresh 1 Day
Lofs(sec)
Atur Thresh 1 Day
Loss(sec)
Atur Thresh 1 Day
Lprs(sec)
Atur Thresh 1 Day
ESs(sec)
Atur Thresh 1 Day
SesL(sec)
Atur Thresh 1 Day
UasL(sec)
Atur Thresh 1 Day
FecsL(sec)
period, which causes
adslAturPerfSesLThresh15MInTrap.
The number of unavailable errored seconds
encountered by an ADSL interface within any
given 15 Minute performance data collection
period, which causes
adslAturPerfUasLThresh1DayTrap.
The number of Forward error correction seconds
encountered by an ADSL interface within any
given 15 Minute performance data collection
period, which causes
adslAturPerfFecsLThreshTrap.
The number of Loss of Frame Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAturPerfLofsThresh1DayTrap.
The number of Loss of Signal Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAturPerfLossThresh1DayTrap.
The number of Loss of Power Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAturPerfLprsThresh1DayTrap.
The number of Errored Seconds encountered by
an ADSL interface, within any given 1 day
performance data collection period, which causes
adslAturPerfESsThresh1DayTrap.
The number of Severe errored Seconds
encountered by an ADSL interface, within any
given 1 day performance data collection period,
which causes adslAturPerfSesLThresh1DayTrap.
The number of unavailable errored seconds
encountered by an ADSL interface within any
given 1 day performance data collection period,
which causes adslAturPerfUasLThresh1DayTrap.
The number of Forward error correction seconds
encountered by an ADSL interface within any
given 1 day performance data collection period,
which causes aturPerfFecsLThresh1DayTrap.
References
• ADSL Commands
8.9.3
8.9.3.1
ADSL ATUC Channel Commands
Get adsl atuc channel
Description: Use this command to get.
Command Syntax: get adsl atuc channel [ifname <interface-name>]
Parameters
Name
Description
ifname <fname-val>
The ADSL ATUC channel interface name.
Type: Get – Optional
Valid values: dsli-0 - dsli-23
Example
$ get adsl atuc channel ifname dsli-0
Output
Ifname
229
: dsli-0
Interleave Delay(ms) : 20
Curr Tx Rate(bps)
Prev Tx Rate(bps)
: 40
Crc Block Length(byte) : 90
Gs Curr Atm Status
: NoAtmDefect
GsRsDepth
: 20
GsSymbolsPerRsWord
: 80
: 10
GsRedundantBytesPerRsCode: 100
AtucChanPerfAtmCD
: 10
AtucChanPerfAtmCU
: 10
AtucChanGsINPdn
: 10
AtucChanGsL0dn
: 10
AtucChanGsM0dn
: 10
AtucChanGsT0dn
: 10
AtucChanGsB0dn
: 10
Output Fields
FIELD
Description
Ifname
The ADSL ATUC channel interface name.
Interleave Delay(ms)
Curr Tx Rate(bps)
Interleave delay for this channel.
Actual transmit rate on this channel.
Prev Tx Rate(bps)
The rate at the time of the last
adslAtucRateChangeTrap event.
Indicates the length of the channel data-block, on
which the CRC operates.
Indicates the current ATM Status.
Indicates the number of DMT symbols per ReedSolomon code word (S), in the downstream
direction.
Indicates interleaving depth (D), in the
downstream direction.
Indicates the number of redundant bytes (R), per
Reed-Solomon code in the downstream direction.
Provides a count of the total number of cells
passed through the cell delineation and HEC
function process operating on the ATM Data Path
while in the SYNC state.(length = 4 bytes).
Provides a count of the total number of cells in the
ATM Data Path delivered at the logical interface
between the ATU-C and a digital network element,
such as one or more switching systems.
The actual number of Impulse Noise
Protection(INP) symbols for the downstream
interleaved channel. One symbol equals 250 µs,
so an INP of 1 correlates to a correction time of
250 µs.
The number of bits from the upstream latency path
function #0 included per DMT symbol.(length = 4
bytes). It is not available for ADSL.
The number of Mux Data Frames per FEC Data
Frame in upstream latency path function
#0.(length = 4 bytes). It is not available for ADSL.
The ratio of the number of Mux Data Frames to
the number of sync octets in the upstream latency
path function #0.(length = 4 bytes). It is not
available for ADSL.
The nominal number of octets from frame bearer
#0 per Mux Data Frame at Reference Point A in
upstream latency path function #0.(length = 4
bytes). It is not available for ADSL.
Crc Block
Length(byte)
Gs Curr Atm Status
GsSymbolsPerRsWor
d
GsRsDepth
GsRedundantBytesPe
rRsCode
AtucChanPerfAtmCD
AtucChanPerfAtmCU
AtucChanGsINPdn
AtucChanGsL0dn
AtucChanGsM0dn
AtucChanGsT0dn
AtucChanGsB0dn
8.9.4
8.9.4.1
ADSL ATUC Chanperf Commands
Get adsl atuc chanperf
Description: Use this command to get.
Command Syntax: get adsl atuc chanperf [ifname <interface-name>]
Parameters
Name
Description
ifname <fname-val>
The ADSL ATUC channel interface name, for
which performance is to be viewed.
Type : Get - Optional
Valid values : dsli-0 - *, dslf-0 - *
Example
230
$ get adsl atuc chanperf ifname dsli-0
Output
Ifname
: dsli-0
Perf Valid Intervals
: 20
Perf Invalid Intervals
: 30
Perf Valid 1Day Intvl
: 20
Perf Invalid 1Day Intvl
: 20
PerfData
Curr15Min
Curr1Day Prev1Day
Time Elapsed
/Monitored(sec)
15
10
20
45
Rx Blocks
10
45
30
89
Tx Blocks
20
65
70
48
Corrected Blocks
25
35
35
25
Uncorrected Blocks
30
95
80
30
NCD Count
90
86
35
20
OCD Count
60
42
15
20
HEC Count
45
21
75
35
NCD Failure Count
20
20
20
20
LCD Failure Count
20
20
20
20
Output Fields
FIELD
Description
Ifname
IfIndex of the interface of type adslfast and
adslInterleave.
Perf Valid Intervals
The number of previous 15-minute intervals in the
interval table for which data was collected. (length
= 4 bytes)
Perf Invalid Intervals
The number of intervals in the range from 0 to the
value of "adslAtucChanPerfValidIntervals" for
which no data is available. This object will typically
be zero except in cases where the data for some
intervals are not available (e.g., in proxy
situations). (length = 4 bytes)
Perf Valid 1Day Intvl
The number of previous 1-Day intervals in the
interval table for which data was collected.(length
= 4 bytes)
Perf Invalid 1Day Intvl
The number of intervals in the range from 0 to the
value of adslAtucChanPerfValid1DayIntervals for
which no data is available. This object will typically
be zero except in cases where the data for some
intervals are not available (e.g., in proxy
situations).(length = 4 bytes)
Time
Elapsed/Monitored(se
c)
Total elapsed seconds in the intervals –
Curr15Min, Curr1Day and Monitored seconds in
Prev1Day.
Rx Blocks
Performance Data :
Count of all encoded blocks received on this
channel since agent was reset .
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received on this
channel in the current 15 minute/ current 1 day/
previous 1 day interval.
Tx Blocks
Performance Data :
Count of all encoded blocks transmitted on this
channel since agent reset.
231
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks transmitted on this
channel in the current 15-minute/ current 1-day/
previous 1-day interval.
Corrected Blocks
Performance Data :
Count of all encoded blocks received with
corrected errors on this channel since agent reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received with
corrected errors on this channel, in the current 15
minute/ current 1 day/ previous 1 day interval.
Uncorrected Blocks
Performance Data :
Count of all encoded blocks received with
uncorrected errors on this channel since agent
was reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received with
uncorrected errors on this channel in the current
15 minute/ current 1 day/ previous 1 day interval.
NCD Count
Performance Data :
Number of packets with NCD (No Cell Delineation)
error.
Curr15Min/Curr1Day/Prev1Day :
Number of packets with NCD error received in the
current 15-minute/ current 1-day/ previous 1-day
interval.
OCD Count
Performance Data :
Number of packets with OCD (Out of Cell
Delineation) error.
Curr15Min/Curr1Day/Prev1Day :
Number of packets with OCD error received in the
current 15-minute/ current 1-day/ previous 1-day
interval.
HEC Count
Performance Data :
Number of packets with HEC error.
Curr15Min/Curr1Day/Prev1Day :
Number of packets with HEC error received in the
current 15 minute/ current 1 day/ previous 1 day
interval.
NCD Failure Count
Performance Data :
Count of all blocks received with no cell
delineation(NCD) failures since agent reset. An
NCD failure is declared when an NCD defect is
present for 2-3 seconds after SHOWTIME. (length
= 4 bytes). Curr15Min/Curr1Day/Prev1Day :
Count of all blocks received with no cell
delineation(NCD) failures in the current 15 minute/
current 1 day/ previous 1
day interval.
LCD Failure Count
Performance Data :
Count of all blocks received with loss of cell
delineation(LCD) failures since agent reset. An
LCD failure is declared when an LCD defect
persists for more than 2 - 3 seconds.(length = 4
232
bytes). Curr15Min/Curr1Day/Prev1Day :
Count of all blocks received with loss of cell
delineation(LCD) failures in the current 15 minute/
current 1 day/ previous 1
day interval.
8.9.5
8.9.5.1
ADSL ATUC ChanIntvl Commands
Get adsl atuc chanintvl
Description: Use this command to get.
Command Syntax: get adsl atuc chanintvl [ifname <interface-name>]
[nintrvl <nintrvl-val>]
Parameters
Name
Description
ifname <fname-val>
The ADSL ATUC channel interface name.
Type: Get - Mandatory
Valid values: dsli-0 – dsli-23
Performance Data Interval number.
Type: Get - Mandatory
Valid values: 1 - 96
nintrvl <nintrvl-val>
Example
$ get adsl atuc chanintvl ifname dsli-0 nintrvl 1
Output
Ifname
: dsli-0
IntervalNumber
: 1
Rx Blocks
: 10
Tx Blocks
: 45
Corrected Blocks
: 20
Uncorrected Blocks : 1
Gs Time Elapsed(sec)
: 30
Valid Data
GsNoCellDelineation
: 20
GsHeaderErrorCheck : 0
GsOutOfCellDelineation : 0
AtucChanIntvlLcds
: true
AtucChanIntvlNcds
: 20
: 20
Output Fields
FIELD
Description
Ifname
The ADSL ATUC channel interface name.
IntervalNumber
Rx Blocks
Performance Data Interval number.
Count of all encoded blocks received on this
channel during this interval.
Count of all encoded blocks transmitted on this
channel during this interval.
Count of all encoded blocks received with errors
that were corrected on this channel during this
interval.
Count of all encoded blocks received with
uncorrected errors on this channel during this
interval.
Total time elapsed (in seconds) in this interval.
Indicates if the data for this interval is valid.
Count of no cell delineation on this channel for
this interval.
GlobespanVirata parameter. Header error check
counter (hec) on this channel during this interval
(length = 4 bytes).
GlobespanVirata parameter. Count of out of cell
delineation (ocd) on this channel during this
interval (length = 4 bytes).
Count of all blocks received with NCD errors on
this channel during this interval.(length = 4
bytes).
Tx Blocks
Corrected Blocks
Uncorrected Blocks
Gs Time Elapsed(sec)
Valid Data
GsNoCellDelineation
GsHeaderErrorCheck
GsOutOfCellDelineatio
n
AtucChanIntvlNcds
233
AtucChanIntvlLcds
8.9.6
8.9.6.1
Count of all blocks received with LCD errors on
this channel during this interval.(length = 4
bytes).
ADSL ATUC Interval Commands
Get adsl atuc interval
Description: This command is used to get.
Command Syntax: get adsl atuc interval ifname <interface-name>
[nintrvl <num-of-intervals>]
Parameters
Name
Description
ifname <interfacename>
The ADSL ATUC channel interface name.
nintrvl <num-ofintervals>
Type: Get -- Mandatory
Valid values: dsl-0 – dsl-23
Number of intervals.
Type: Get – Optional
Valid values : 1- 96
Default Value : 12
Example
$ get adsl atuc interval ifname dsl-0 sintrvl 1 nintrvl 1
Output
Ifname
: dsl-0
IntervalNumber
: 12
IntervalValidData
: False
IntervalLofs(sec)
: 83
IntervalLoss(sec)
: 84
IntervalLols(sec)
: 85
IntervalLprs(sec)
: 86
IntervalESs(sec)
: 87
IntervalInits
: 88
IntervalFastR
: 191
IntervalFailedFastR : 192
IntervalSesL(sec)
: 193
IntervalUasL(sec)
: 194
IntervalFecsL(sec)
: 15
GsTimeElapsed(sec)
: 1001
IntervalInitsFailed : 15
Output Fields
234
FIELD
Description
Ifname
The ADSL ATUC channel interface name.
IntervalNumber
Count from 1 through 96 of 15-minute intervals.
Performance Data Interval number 1 is the most
recent previous interval; interval 96 is 24 hours
ago (length = 4 bytes).
IntervalValidData
This indicates if the data for this interval is valid.
IntervalLofs(sec)
Count of seconds in the interval when there was
Loss of Framing.
IntervalLoss(sec)
Count of seconds in the interval when there was
Loss of Signal.
IntervalLols(sec)
Count of seconds in the interval when there was
Loss of Link.
IntervalLprs(sec)
Count of seconds in the interval when there was
Loss of Power.
IntervalESs(sec)
Count of Errored Seconds in the interval.
IntervalInits
Count of the line initialization attempts during the
interval.
IntervalFastR
Count of seconds in the interval when there was
Fast Retrains.
8.9.7
8.9.7.1
IntervalFailedFastR
Count of seconds in the interval when there was
Failed Fast Retrains.
IntervalSesL(sec)
Count of seconds in the interval when there was
severely errored seconds.
IntervalUasL(sec)
Count of seconds in the interval when there was
unavailable errored seconds.
IntervalFecsL(sec)
Count of seconds in the interval when there was
Forward error correction seconds (length = 4
bytes).
GsTimeElapsed(sec)
Total elapsed seconds in this interval.
IntervalInitsFailed
Count of the failed full line initialization attempts
during the interval (length = 4 bytes).
ADSL ATUC Perf Commands
Get adsl atuc perf
Description Use this command to get ADSL ATUC interface
performance.
Command Syntax: get adsl atuc perf [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The ADSL ATUC interface name, for which
performance is to be viewed.
Type : Get – Optional
Valid values : dsl-0 - dsl-*
Example
$ get adsl atuc perf ifname dsl-0
Output
Ifname
: dsl-0
Perf Valid Intervals
: 20
Perf Invalid Intervals
: 30
AtucPerfStatLossL
: 10
PerfData
Curr15Min
Curr1Day
Prev1Day
Time Elapsed
/Monitored(sec)
30
10
20
30
LOFS (sec)
40
45
35
50
LOSS (sec)
30
65
75
20
LOLS (sec)
30
35
65
10
LPRS (sec)
10
95
30
80
ES (sec)
90
85
32
90
INITS
60
42
15
20
Perf Stat FastR
45
21
75
35
Perf Stat Failed FastR
43
46
40
45
Perf Stat SESL
41
48
67
65
Perf Stat UASL
37
49
90
50
Perf Stat FecsL
10
16
11
11
Perf Stat InitsFailed
10
16
11
11
Output Fields
235
FIELD
Description
Ifname
Ifindex of the type Adsl port Count of the number
of Loss of Framing failures since agent reset.
Perf Valid Intervals
The number of previous 15-minute intervals in the
interval table, for which data was collected. (length
= 4 bytes)
Perf Invalid Intervals
The number of intervals in the range from 0 to the
value of "adslAtucPerfValid-Intervals", for which
no data is available. This object will typically be
zero except in cases where the data for some
intervals are not available (e.g., in proxy
situations). (length = 4 bytes)
AtucPerfStatLossL
Count of 1-second intervals containing one or
more loss of signal (LOS) defects. (Not available
for ADSL)
Time
Elapsed/Monitored(se
c)
Performance Data : Total time elapsed in
seconds
Total elapsed seconds in the intervals –
Curr15Min, Curr1Day and Monitored seconds in
Prev1Day
LOFS (sec)
Performance Data : Count of number of Loss of
Framing failures since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval, when there was Loss of
Framing.
LOSS (sec)
Performance Data : Count of number of Loss of
signal failures since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval, when there was Loss of
signals.
LOLS (sec)
Performance Data : Count of number of Loss of
link failures since agent reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval, when there was Loss of
link.
LPRS (sec)
Performance Data : Count of number of Loss of
power failures since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval, when there was Loss of
power.
ES (sec)
Performance Data : Count of number of errored
seconds since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
errored seconds in the current 15-minute/ current
1-day/ previous 1-day interval.
INITS
Performance Data : Count of line initialization
attempts since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of line
initialization attempts in the current 15-minute/
current 1-day/ previous 1-day interval.
Includes both successful and failed attempts.
Perf Stat FastR
Performance Data : Count of fast retrain.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval, when there was Fast
Retrain.
236
Perf Stat Failed FastR
Performance Data : Count of failed fast retrain.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval when there was Failed
Fast Retrain.
Perf Stat SESL
Performance Data : Count of severely errored
second line.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval when there was severely
errored second.
Perf Stat UASL
Performance Data : Count of unavailable errored
seconds.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds in the current 15-minute/ current 1-day/
previous 1-day interval when there was
unavailable errored seconds.
Perf Stat FecsL
Performance Data:
Count of 1-second intervals, with one or more
forward error correction (FEC) anomalies, since
agent reset. (Not available for ADSL)
Curr15Min/Curr1Day/Prev1Day:
Count of 1-second intervals, in the current 15minute/current 1-day/previous 1-day interval, with
one or more forward error correction (FEC)
anomalies. (Not available for ADSL)
Perf Stat InitsFailed
Performance Data:
Count of the failed full initialization attempts in
current 15-minute/current 1-day/previous 1-day
interval. A failed full initialization is when showtime
is not reached at the end of the full initialization
procedure.
8.9.8
8.9.8.1
ADSL ATUC Physical Commands
Get adsl atuc physical
Description Use this command to get.
Command Syntax get adsl atuc physical [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The ADSL ATUC physical interface name.
Type: Get – Optional
Valid values: dsl-0 – dsl-23
Example
$ get adsl atuc physical ifname dsl-0
Output
237
Ifname
: dsl-0
Serial Number
: Conexant 1.0
Vendor ID
: 0039
Version Number
: 1.0
Curr Status
: NoDefect
Curr Snr Margin(dB/10)
: 20
Curr Atn(dB/10) : 80
CurrAttainable Rate(bps)
: 40
Curr Output Pwr(dB/10):90
GsOpState
: Data
GsActualStandard
: T1_413
GsTxAtmCellCounter
: 214
GsStartProgress
: 213
GsIdleBertError
: 200
GsBertSync
: BertOutOfSync
GsBertError
: 0
Data Boost Status
: Enable
Chan Perf BE
: 5
PM State
: L2
Chan Perf Cu
: 10
Extended PSD Status
: True
Chip Version
: 2
Pilot Tone
: 21
Overhead Channel
:4000
Psd Mask
: FlatMsk
System Vendor ID
GsRxAtmCellCounter
: 215
GsIdleBertCells
: 100
Chan Perf CD
: 2
: 12345678
ATU-C Self Test Result
: 10
Atuc G9941 Vendor ID:12345678
Atuc ACTPSDus (dB/10)
: 90
AtucStartBin(GSpan++):90
StartUp Error Code
: StartupErrorCodeMAXNOMATPus
BitSwapCount
: 90
ModPhase
: FlatRateCheck
Transmit Spectrum Shaping info
----------------------------------[ 0]
90
UpStream Gains per bin
--------------------------[ 0]
15
GsSeltInfoValid
: NotConnected
GsSeltLoopLen (in Feet)
: 20
GsSeltLoopEnd
: open
GsSeltLoopGauge
: greater_26awg
GsSeltUpShannonCap (in bps)
: 10
GsSeltDownShannonCap (in bps)
: 20
Selt InbandNoise Len (dBM/Hz)
---------------------------------[ 0]
0110030607
Selt Termination Resp (0-18Kft ms)
--------------------------------------[ 0]
0110030607
Selt UpMgnAtRate (dB/10)
----------------------------[ 0]
0110030607
Selt DownMgnAtRate (dB/10)
------------------------------[ 0]
0110030607
Delt HLINSCus
: 2
Delt HLOGMTus
: 2
DELT Last Tx State
: dmtatucg9941
Delt SnrmtUs
: 100
Delt HLINpsus
-----------------[ 0]
5
Delt HLOGpsus
-----------------[ 0]
20
Delt QLNpsus
----------------[ 0]
12
Delt DMT Bin SNR
238
Delt LNMTus
: 2
DELT Curr Status: FailedUnknown
--------------------[ 0]
16
Signal Atn(dB/10)
: 40
GsParametricTestResult
: Ok
Parametric Info
-------------------Bin Number
Number of bits/bin
-------------------------------------
Output Fields
239
FIELD
Description
Ifname
The ADSL ATUC physical interface name.
Serial Number
The vendor specific string that identifies the
vendor equipment.
Vendor ID
Vendor ID Code.
Version Number
The vendor specific version number sent by this
ATU as part of the initialization messages.
Curr Status
Indicates current state of the ATUC line. This is
a bit-map of possible conditions.
Curr Snr Margin(dB/10)
Noise Margin as seen by this ATU with respect
to its received signal in tenth dB.
Curr Atn(dB/10)
Measured difference in the total power
transmitted by the peer ATU and the total power
received by this ATU.
CurrAttainable
Rate(bps)
Indicates the maximum currently attainable data
rate by the ATU. This value will be equal to, or
greater than the current line rate.
Curr Output Pwr(dB/10)
Measured total output power transmitted by this
ATU.This is the measurement that was reported
during the last activation sequence.
GsOpState
Operational state of the Xcvr.
GsActualStandard
Actual standard used for connection, based on
the outcome of the negotiation with the Remote
Unit.
GsTxAtmCellCounter
Provides Tx ATM cell counter.
GsRxAtmCellCounter
Provides Rx ATM cell counter.
GsStartProgress
Defines the current detailed start up state of
Xcvr. 0x0ñ startup not in progress; 0x0 ñ
0x0FFF Handshake/Training/ Profile
Management/ Fast Retrain inprogress; 0x8000 ñ
0x8FFF DSP firmware DownLoad in progress;
0xF000 ñ 0xFFFF illegal Parameter
GsIdleBertError
Number of bit errors.
GsIdleBertCells
Number of idle cells.
GsBertSync
Indicates whether the Signal is in Sync or not.
GsBertError
Provides the number of bit errors detected
during BERT.
Data Boost Status
Conexant parameter that indicates whether
DataBoost is utilized for the connection.
Chan Perf CD
The near-end delineated total cell count
performance parameter is a count of the total
number of cells passed through the cell
delineation and HEC function process, operating
on the ATM Data Path, while in the SYNC state.
(Not available for ADSL)
240
Chan Perf BE
The near-end idle bit error count performance
parameter is a count of the number of bit errors
in the idle cell payload received in the ATM Data
Path at the near-end. (Not available for ADSL)
PM State
The Line Power Management state. (Not
available for ADSL)
Chan Perf Cu
The total number of data-only cells received by
ATUC.
Extended PSD Status
Conexant parameter that indicates whether an
extended upstream PSD is used - for G.Span
Plus mode of operation only. Only supported for
G.Span Plus, therefore this parameter is not
valid for ADSL2/ADSL2plus modes of operation.
Chip Version
The DSP version number.
Pilot Tone
Conexant parameter that indicates the Pilot
Tone Index.
Overhead Channel
Indicates the Overhead Channel. This feature is
not supported by DSLPHY as yet.
Psd Mask
Conexant parameter that indicates the actual
Psd Mask currently being used.
System Vendor ID
Indicates the Vendor ID as inserted by the ATUC in the Overhead Messages(ADSL2). Typically
identifies the ATU-C system integrator which
usually refers to the vendor of the smallest fieldreplaceable unit. ATU-C System Vendor ID may
not be the same as ATU-C Vendor ID. It is not
available for ADSL. This is string of 8 octets
containing 2 octet country code , 4 octet vendor
id and 2 octet vendor revision number.
ATU-C Self Test Result
Defines the ATU-C selftest result. The most
significant octet is: 00 hex if the self-test passed
or 01 hex if the self-test failed. Interpretation of
the other octets is vendor discretionary and can
be interpreted in combination with G.994.1 and
system Vendor IDs.
Atuc G9941 Vendor ID
Indicates the Vendor ID as inserted by the ATUC in the G.994.1 CL message. Typically
identifies the vendor of the ATU-C G.994.1
functionality. This is string of 8 octets containing
2 octet country code , 4 octet vendor id and 2
octet vendor revision number.
Atuc ACTPSDus
(dB/10)
This parameter defines the average upstream
transmit power spectrum density over the used
subcarriers delivered by the ATU-C at the U-C
reference point, at the instant of measurement.
It's value ranges from -90 to 0, in 0.1 dB/Hz
steps. It is available only for ADSL2/ADSL2plus.
AtucStartBin
(GSpan++)
This Gspan++ parameter indicates the start bin
of the bit loading up array.
StartUp Error Code
Conexant parameter which indicates the startup
error code.
BitSwapCount
This Conexant parameter indicates the bit swap
count. It can read only in data mode
ModPhase
Conexant parameter to monitor the status of
MoD
Atuc TSSpsUs
This parameter provides the Upstream Transmit
Spectrum Shaping parameter expressed as the
set of break points exchanged during G994.1.
Each breakpoint consists in a subcarrier index
and the associated shaping parameter. Value of
this parameter is in range 0 - 127, in multiples of
-0.5 dB. 127 is a special value indicating the
subcarrier is not transmitted. It is available only
for ADSL2/ADSL2plus.
241
GainspsUs
This parameter defines the upstream gains
allocation table per subcarrier. It is an array of
integer values in the 0 to 4093 range for
subcarriers 0 to NSCus-1. The gain value is
represented as a multiple of 1/512 on linear
scale. It is supported for ADSL2/ADSl2plus only.
GsSeltInfoValid
Indicates the information validity for the SELT
operation conducted on the Xcvr.
GsSeltLoopLen (in
Feet)
Indicates the LOOP Length in Feet once when
the SELT information is valid on the Xcvr.
GsSeltLoopEnd
Indicates whether the loop is short or open once
when the SELT information is valid on the Xcvr.
GsSeltLoopGauge
Indicates the LOOP wire gauge information
once, when the SELT information is valid on the
Xcvr.
GsSeltUpShannonCap
(in bps)
Indicates the upstream shannon capacity once,
when the SELT information is valid on the Xcvr.
GsSeltDownShannonC
ap (in bps)
Indicates the downstream shannon capacity
once, when the SELT information is valid on the
Xcvr.
AtucGsSeltInbandNois
e
512 values that indicate inband noise length in
dBM/Hz, covering both bands from 0 to 1.1 MHz.
AtucGsSeltTermination
Resp
180 discrete values that indicate termination
response magnitude from 0 to 18Kft.
AtucGsSeltUpMgnAtRa
te
300 values that indicate SNR margin in dB/10 at
a particular rate are provided, at 100K
increments, up to 15 Mbps.
AtucGsSeltDownMgnAt
Rate
300 values that indicate SNR margin in dB/10 at
a particular rate are provided, at 100K
increments, up to 15 Mbps.
Delt HLINSCus
The DELT-related parameter that provides the
scale factor to be applied to the upstream Hlin (f)
values. (Not available for ADSL and ADSL2plus)
Delt HLOGMTus
The DELT-related parameter that provides the
number of symbols used to measure the
upstream Hlog (f). (Not available for ADSL and
ADSL2plus)
Delt QLNMTus
The DELT-related parameter that provides the
number of symbols used to measure the
upstreamQLN (f) values. (Not available for ADSL
and ADSL2plus)
DELT Last Tx State
The DELT-related parameter that provides the
last successful transmitted initialization state by
the ATUC. (Not available for ADSL and
ADSL2plus)
Delt SnrmtUs
DELT-related parameter that provides the
number of symbols used to measure the
upstream SNR(f) values. (Not available for
ADSL and ADSL2plus).
DELT Curr Status
Current Status of Atuc Line in DELT Mode
Delt HLINpsus
The DELT-related parameter that provides an
array of complex upstream Hlin (f) values in
linear scale. (Not available for ADSL and
ADSL2plus)
8.9.9
8.9.9.1
Delt HLOGpsus
The DELT-related parameter that provides an
array of real upstream Hlog (f) values in dB. (Not
available for ADSL and ADSL2plus)
Delt QLNpsus
The DELT-related parameter that provides an
array of real upstream QLN (f) values in dB. (Not
available for ADSL and ADSL2plus)
Delt DMT Bin SNR
The DELT-related parameter that provides an
array of real upstream SNR (f) values in dB. (Not
available for ADSL and ADSL2plus)
Signal Atn(dB/10)
DELT-related parameter that provides the
upstream signal attenuation (length = 4 bytes).
(Not available for ADSL and ADSL2plus).
GsParametricTestResul
t
Indicates the Result of the Parametric Test
conducted on the Xcvr.
Parametric Info
Conexant parameter that indicates the
Parametric Test Array.
AtucDMTBinBits
Number of bits per bin for the bin indexed by this
element of the string. The 0th element contains
the number of bits for bin 0 through to the 31st
element, which contains the number of bits for
bin 31. The range of expected values is from 0
to 15 bits per bin.
ADSL ATUC Trap Commands
Get adsl atuc traps
Description: This command is used to get.
Command Syntax: get adsl atuc traps [ifname <interface-name>
Example
$ get adsl atuc traps ifname dsl-0
Output
Ifname
: dsl-0
Lofs Thresh Trap : 0
Loss Thresh Trap
: 1
Lols Thresh Trap : 0
Lprs Thresh Trap
: 1
ESs Thresh Trap
Init Failure Trap
: 1
Rate Change Trap : 0
Gs OpState Trap
: 1
PM State Trap
Command Failure Trap : 2
: 1
: 2
Output Fields
242
FIELD
Description
Ifname
The IfIndex of DSL port.
Lofs Thresh Trap
Loss of Framing 15-minute interval threshold
reached (length = 4 bytes).
Loss Thresh Trap
Loss of Signal 15-minute interval threshold
reached (length = 4 bytes).
Lols Thresh Trap
Loss of Link 15-minute interval threshold reached
(length = 4 bytes).
Lprs Thresh Trap
Loss of Power 15-minute interval threshold
reached (length = 4 bytes).
ESs Thresh Trap
Errored Second 15-minute interval threshold
reached (length = 4 bytes).
Init Failure Trap
ATU-C initialization failed. Refer to
adslAtucCurrStatus for potential reasons (length =
4 bytes).
8.9.10
8.9.10.1
Rate Change Trap
The ATU-Cs transmit rate has changed (RADSL
mode only) (length = 4 bytes).
Gs OpState Trap
Op State change (length = 4 bytes).
PM State Trap
PM state change trap used for ADSL2/ADSL2plus
PM operation. This trap is not valid for ADSL
mode.
Command Failure
Trap
When the APIs fail to send a customer command
to the DSP, the customer is notified by a new trap
and they need to re-issue the command.
ADSL ATUC Trapsext Commands
Get adsl atuc trapsext
Description: Use this command to get.
Command Syntax: get adsl atuc trapsext [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The IfIndex of DSL port.
Type: Get -- Optional
Valid values: dsl-0 – dsl-23
Example
$ get adsl atuc trapsext ifname dsl-0
Output
Ifname
: dsl-0
Failed FastR Thresh 15Min Trap : 1 SesL Thresh 15Min Trap:1
UasL Thresh 15Min Trap
: 1 FecsL Thresh 15Min Trap:0
Lofs Thresh 1Day Trap
: 0 Loss Thresh 1Day Trap : 1
Lols Thresh 1Day Trap
: 1 Lprs Thresh 1Day Trap: 1
ESs Thresh 1Day Trap
: 0 SesL Thresh 1Day Trap: 0
UasL Thresh 1Day Trap
: 1 FecsL Thresh 1Day Trap: 0
Output Fields
243
FIELD
Description
Ifname
The IfIndex of DSL port.
Failed FastR Thresh
15Min Trap
SesL Thresh 15Min
Trap
UasL Thresh 15Min
Trap
FecsL Thresh 15Min
Trap
Lofs Thresh 1Day
Trap
Loss Thresh 1Day
Trap
Lols Thresh 1Day
Trap
Lprs Thresh 1Day
Trap
ESs Thresh 1Day
Trap
SesL Thresh 1Day
Trap
UasL Thresh 1Day
Trap
FecsL Thresh 1Day
Trap
Failed retrains 15-minute interval threshold
reached.
Severely Errored Seconds 15-minute interval
threshold reached.
Unavailable Error Seconds 15-minute interval
threshold reached.
Forward error correction Seconds 15-minute
interval threshold reached.
Loss of Frames 1-day interval threshold reached.
Loss of Signal 1-day interval threshold reached.
Loss of Link 1-day interval threshold reached.
Loss of Power 1-day interval threshold reached.
Errored Seconds 1-day interval threshold reached.
Severely Errored Seconds 1-day interval threshold
reached.
Unavailable Errored Seconds 1-day interval
threshold reached.
Forward error correction Seconds 1-day interval
threshold reached.
8.9.11
8.9.11.1
ADSL ATUR ChanIntrvl Commands
Get adsl atur chanintrvl
Description Use this command to get.
Command Syntax get adsl atur chanintrvl [ifname <interface-name>]
[nintrvl <nintrvl-val>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name
Type: Get - Mandatory
Valid values: dsli-0 - dsli-23
Count from 1 through 96, of 15 minute intervals.
Type: Get - Mandatory
Valid values: 1 - 96
nintrvl <nintrvl-val>
Example
$ get adsl atur chanintrvl ifname dsli-0 nintrvl 2
Output
Ifname
: dsli-0
IntervalNumber
: 2
Rx Blocks
: 10
Tx Blocks
: 10
Corrected Blocks
: 10
Uncorrected Blocks : 10
GsNoCellDelineation : 10
GsHeaderErrorCheck : 10
Valid Data
: true
AturChanIntvlNcds
AturChanIntvlLcds
: 20
: 20
Output Fields
FIELD
Description
Ifname
The ADSL interface name
IntervalNumber
Rx Blocks
Count from 1 through 96, of 15 minute intervals.
Count of all encoded blocks received on this
channel, during this interval.
Count of all encoded blocks transmitted on this
channel, during this interval.
Count of all encoded blocks received with errors
that were corrected on this channel, during this
interval.
Count of all encoded blocks received with errors
that cannot be corrected, on this channel, during
this interval.
GlobespanVirata parameter. Count of no cell
delineation (ncd) on this channel during this
interval.
Conexant parameter. Header error check counter
(HEC) on this channel, during this interval.
This indicates if the data for this interval is valid.
Count of all blocks received with NCD errors on
this channel during this interval.(length = 4 bytes).
Count of all blocks received with LCD errors on
this channel during this interval.(length = 4 bytes).
Tx Blocks
Corrected Blocks
Uncorrected Blocks
GsNoCellDelineation
GsHeaderErrorCheck
Valid Data
AturChanIntvlNcds
AturChanIntvlLcds
References
• atur interval related commands
8.9.12
8.9.12.1
ADSL ATUR Channel Commands
Get adsl atur channel
Description: Use this command to get.
Command Syntax: get adsl atur channel [ifname <interface-name>]
244
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name
Type: Get - Mandatory
Valid values: dsli-0 - dsli-23
Example
$ get adsl atur channel ifname dsli-0
Output
Ifname
: dslf-0
Interleave Delay(ms) : 10
Curr Tx Rate(bps)
: 10
Prev Tx Rate(bps)
: 10
Crc Block Length(byte)
: 10
Gs Curr Atm Status
: 1
GsSymbolsPerRsWord
: 10
GsRsDepth
: 10
GsRedundantBytesPerRsCode : 10
AturChanPerfAtmCD
: 10
AturChanPerfAtmCU
: 10
AturChanGsINPup
: 10
AturChanGsL0up
: 10
AturChanGsM0up
: 10
AturChanGsT0up
: 10
AturChanGsB0up
: 10
Output Fields
245
FIELD
Description
Ifname
The ADSL Interface Name
Interleave Delay(ms)
Interleave delay for this channel. Interleave delay
applies only to the interleave channel and defines
the mapping (relative spacing) between
subsequent input bytes at the interleaver input and
their placement in the bit stream at the interleaver
output. Larger numbers provide greater separation
between consecutive input bytes in the output bit
stream, allowing for improved impulse noise
immunity at the expense of payload latency.
Curr Tx Rate(bps)
Actual transmit rate on this channel
Prev Tx Rate(bps)
The rate at the time of the last
adslAturRateChangeTrap event.
Crc Block
Length(byte)
Indicates the length of the channel data-block on
which the CRC operates.
Gs Curr Atm Status
Indicates an ncd or lcd failure if the counter
surpasses 127. If neither ATM counter surpasses
127, the return value will be NoAtmDefect.
GsSymbolsPerRsWor
d
Indicates number of DMT symbols per ReedSolomon code word (S) in the upstream direction
Note that S is not restricted to interleaved mode
only. Even in fast mode, S is a valid constant
value and is equal to 1.
GsRsDepth
Indicates interleaving depth (D) in the upstream
direction Note that D is not restricted to
interleaved mode only. Even in fast mode, D is a
valid constant value and is equal to 1.
GsRedundantBytesPe
rRsCode
Indicates number of redundant bytes (R) per
Reed-Solomon code in the upstream direction
AturChanPerfAtmCD
Provides a count of the total number of cells
passed through the cell delineation and HEC
function process operating on the ATM Data Path
while in the SYNC state.(length = 4 bytes).
AturChanPerfAtmCU
Provides a count of the total number of cells in the
ATM Data Path delivered at the interface(s)
between ATU-R and ATM switching layer.(length
= 4 bytes).
AturChanGsINPup
The actual number of Impulse Noise
Protection(INP) symbols for the upstream
interleaved channel. One symbol equals 250 µs,
so an INP of 1 correlates to a correction time of
250 µs.
AturChanGsL0up
The number of bits from the upstream latency path
function #0 included per DMT symbol.(length = 4
bytes). It is not available for ADSL.
AturChanGsM0up
The number of Mux Data Frames per FEC Data
Frame in upstream latency path function
#0.(length = 4 bytes). It is not available for ADSL.
AturChanGsT0up
The ratio of the number of Mux Data Frames to
the number of sync octets in the upstream latency
path function #0.(length = 4 bytes). It is not
available for ADSL.
AturChanGsB0up
The nominal number of octets from frame bearer
#0 per Mux Data Frame at Reference Point A in
upstream latency path function #0.(length = 4
bytes). It is not available for ADSL.
References
• ADSL commands
8.9.13
8.9.13.1
ADSL ATUR Chanperf Commands
Get adsl atur chanperf
Description: This command is used to get.
Command Syntax: get adsl atur chanperf [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Optional
Valid values: dsli-0 – dsli-23
Example
$ get adsl atur chanperf ifname dsli-0
Output
Ifname
: dsli-0
Perf Valid Intervals
: 10
Perf Invalid Intervals
: 10
Perf valid 1Day Intvl
: 20
Perf Invalid 1Day Intvl
: 20
PerfData
Curr15Min
Curr1Day
Prev1Day
Time Elapsed
/Monitored(sec)
-
10
10
10
Rx Blocks
10
10
10
10
Tx Blocks
10
10
10
10
Corrected Blocks
10
10
10
10
Uncorrected Blocks 10
10
10
10
NCD Count
10
10
10
10
HEC Count
10
10
10
10
NCD Failure Count
20
20
20
20
LCD Failure Count
20
20
20
20
Output Fields
246
FIELD
Description
Ifname
The ADSL interface name.
Perf Valid Intervals
Number of previous 15-minute intervals, for which
the data was collected.
Perf Invalid Intervals
Number of previous 15- minute intervals, for which
no data is available.
Perf valid 1Day Intvl
The number of previous 1-day intervals in the
interval table for which data was collected.(length
= 4 bytes).
Perf Invalid 1Day Intvl
The number of intervals in the range from 0 to the
value of adslAturChanPerfValid1DayIntervals for
which no data is available. This object will typically
be zero except in cases where the data for some
intervals are not available (e.g., in proxy
situations).(length = 4 bytes).
Time
Elapsed/Monitored(se
c)
Total elapsed seconds in the intervals –
Curr15Min,
Curr1Day and Monitored seconds in Prev1Day.
Rx Blocks
Performance Data :
Count of all encoded blocks received on this
channel, since agent was reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received on this
channel in the current 15 minute/ current 1 day/
previous 1 day interval.
Tx Blocks
Performance Data :
Count of all encoded blocks transmitted on this
Channel, since agent reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks transmitted on this
channel in the current 15-minute/ current 1-day/
previous 1-day interval.
Corrected Blocks
Performance Data :
Count of all encoded blocks received with
corrected errors on this channel, since agent
reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received with
corrected errors on this channel, in the current 15
minute/ current 1 day/ previous 1 day interval.
Uncorrected Blocks
Performance Data :
Count of all encoded blocks received with
uncorrected errors on this channel, since agent
was reset.
Curr15Min/Curr1Day/Prev1Day :
Count of all encoded blocks received with
uncorrected errors on this channel, in the current
15 minute/ current 1 day/ previous 1 day interval.
NCD Count
Performance Data :
Number of packets with NCD (No Cell Delineation)
errors.
Curr15Min/Curr1Day/Prev1Day :
Number of packets with NCD error, received in the
247
current 15-minute/ current 1-day/ previous 1-day
interval.
HEC Count
Performance Data :
Number of packets with HEC error.
Curr15Min/Curr1Day/Prev1Day :
Number of packets with HEC error received in the
current 15 minute/ current 1 day/ previous 1 day
interval.
NCD Failure Count
Performance Data :
Count of all blocks received with no cell
delineation (NCD) failures since agent reset. An
NCD failure is declared when an NCD defect is
present for 2-3 seconds after SHOWTIME.(length
= 4 bytes).
Curr15Min/Curr1Day/Prev1Day :
Count of all blocks received with no cell
delineation(NCD) failures in the current 15 minute/
current 1 day/ previous 1 day interval.
LCD Failure Count
Performance Data :
Count of all blocks received with loss of cell
delineation (LCD) failures since agent reset. An
LCD failure is declared when an LCD defect
persists for more than 2 - 3 seconds.(length = 4
bytes) Curr15Min/Curr1Day/Prev1Day :
Count of all blocks received with loss of cell
delineation (LCD) failures in the current 15 minute/
current 1 day/ previous 1 day interval.
References
• ADSL commands
8.9.14
8.9.14.1
ADSL ATUR Interval Commands
Get adsl atur interval
Description This command is used to get.
Command Syntax: get adsl atur interval ifname <interface-name>
[nintrvl <nintrvl-val>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Mandatory
Valid values: dsl-0 – dsl-23
Number of 15 minutes intervals.
Type: Get - Optional
Valid values: 1 - 96
nintrvl <nintrvl-val>
Example
$ get adsl atur interval ifname dsl-0 nintrvl 1
Output
Ifname
: dsl-0
IntervalNumber
: 1
IntervalLofs(sec) : 10
IntervalLprs(sec) : 10
IntervalLESs(sec) : 10
Output Fields
248
IntervalValidData : true
IntervalLoss(sec) : 10
8.9.15
8.9.15.1
FIELD
Description
Ifname
The IfIndex of DSL port
IntervalNumber
Count from 1 through 96 of 15 minute intervals.
Performance Data Interval number 1 is the most
recent previous interval; interval 96 is 24 hours
ago.
IntervalValidData
This variable indicates if the data for this interval is
valid.
IntervalLofs(sec)
Count of seconds in the interval when there was
Loss of Framing.
IntervalLoss(sec)
Count of seconds in the interval when there was
Loss of Signal.
IntervalLprs(sec)
Count of seconds in the interval when there was
Loss of Power.
IntervalESs(sec)
Count of Errored Seconds in the interval. The
errored second parameter is a count of onesecond intervals containing one or more crc
anomalies, or one or more los or sef defects.
Adsl atur intervalext Commands
Get adsl atur intervalext
Description: This command is used to get.
Command Syntax: get adsl atur intervalext [ifname <interfacename>] [nintrvl <nintrvl-val>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Mandator
Valid values: dsl-0 – dsl-23
nintrvl <nintrvl-val>
Count from 1 through 96, of 15 minute intervals.
Type: Get -- Mandatory
Valid values: 1 - 96
Example
$ get adsl atur intervalext IFNAME dsl-0 NINTRVL 1
Output
Ifname
: dsl-0
IntervalNumber
: 1
IntervalSesl(sec)
: 10
IntervalUasL(sec) : 10
IntervalFecsL(sec) : 10
Output Fields
249
FIELD
Description
Ifname
The ADSL interface name.
IntervalNumber
Count from 1 through 96, of 15 minute intervals.
IntervalSesl(sec)
Count of seconds in the interval when there was
severely errored seconds.
IntervalUasL(sec)
Count of seconds in the interval when there was
unavailable errored seconds.
IntervalFecsL(sec)
Count of seconds in the interval when there was
Forward error correction seconds.
References
• atur interval related commands
8.9.16
8.9.16.1
ADSL ATUR Perf Commands
Get adsl atur perf
Description: This command is used to get.
Command Syntax: get adsl atur perf [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Mandatory
Valid values: dsl-0 – dsl-23.
Example
$ get adsl atur perf ifname dsl-0
Output
Ifname
: dsl-0
Perf Valid Intervals
: 10
Perf Invalid Intervals
: 10
PerfData
Curr15Min
Curr1Day
Time Elapsed/Monitored(sec) 10
10
10
LOFS (sec)
10
10
10
10
LOSS (sec)
10
10
10
10
LPRS (sec)
10
10
10
10
ES (sec)
10
10
10
10
Prev1Day
Output Fields
FIELD
Description
Ifname
Ifindex of the type Adsl port
Perf Valid Intervals
The number of previous 15-minute intervals in the
interval table for which data was collected.
Perf Invalid Intervals
The number of intervals in the range from 0 to the
value of 'adslAturPerfValid-Intervals' for which no
data is available. This object will typically be zero
except in cases where the data for some intervals
are not available (e.g., in proxy situations).
Time
Elapsed/Monitored(se
c)
Total elapsed seconds in the intervals –
Curr15Min,
Curr1Day and Monitored seconds in Prev1Day.
LOFS (sec)
Performance Data : Count of number of Loss of
Framing failures since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds
in the current 15-minute/ current 1-day/ previous
1-day interval, when there was Loss of Framing.
LOSS (sec)
Performance Data : Count of number of Loss of
signal failures since agent was reset.
250
Curr15Min/Curr1Day/Prev1Day : Count of
seconds
in the current 15-minute/ current 1-day/ previous
1-day interval, when there was Loss of signals.
LPRS (sec)
Performance Data: Count of number of Loss of
power failures, since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds
in the current 15-minute/ current 1-day/ previous
1- day interval, when there was Loss of power.
ES (sec)
Performance Data : Count of number of errored
seconds since agent was reset.
Curr15Min/Curr1Day/Prev1Day : Count of
errored seconds in the current 15-minute/ current
1-day/ previous 1-day interval.
8.9.17
8.9.17.1
Adsl atur perfext Commands
Get adsl atur perfext
Description: Use this command to get.
Command Syntax: get adsl atur perfext [ifname <interface-name>]
Parameters
Name
Description
ifname <interface-name>
Ifindex of the type Adsl port
Type: Get -- Mandatory
Valid values: dsl-0 – dsl-23
Example
$ get adsl atur perfext ifname dsl-0
Output
Ifname
: dsl-0
AturPerfStatLossL : 14
PerfData
Curr15Min
Curr1Day
Prev1Day
Perf Stat SESL
10
10
10
10
Perf Stat UASL
10
10
10
10
Perf Stat FecsL
11
13
19
21
Output Fields
FIELD
Description
Ifname
Ifindex of the type Adsl port
AturPerfStatLossL
Count of 1-second intervals containing one or
more far end loss of signal (LOS) defects (Not
available for ADSL)
Perf Stat SESL
Performance Data : Count of severely errored
second line.
Curr15Min/Curr1Day/Prev1Day : Count of
seconds
in the current 15-minute/ current 1-day/ previous
1- day interval, when there was severely errored
second.
Perf Stat UASL
Performance Data : Count of unavailable errored
seconds.
Curr15Min/Curr1Day/Prev1Day : Count of
251
seconds
in the current 15-minute/ current 1-day/ previous
1- day interval, when there was unavailable
errored seconds.
Perf Stat FecsL
Performance Data:
Count of 1-second intervals, with one or more
forward error correction (FEC) anomalies, since
agent reset. (Not available for ADSL)
Curr15Min/Curr1Day/Prev1Day:
Count of 1-second intervals, in the current 15minute/current 1-day/previous 1-day interval, with
one or more forward error correction (FEC)
anomalies. (Not available for ADSL)
References
• atur perfdata related commands
8.9.18
8.9.18.1
ADSL ATUR Physical Commands
Get adsl atur physical
Description: Use this command to get.
Command Syntax: get adsl atur physical [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Mandatory
Valid values: dsl-0 – dsl-23
Example
$ get adsl atur physical ifname dsl-0
Output
Ifname
: dsl-0
Serial Number
: CO123456
Vendor ID
: Vendor123
Version Number
: VerNo98114
Curr Status
: LossOfFraming
Curr Snr Margin(dB/10)
: 10
Atn(dB/10)
: 10
CurrAttainable Rate(bps)
: 10
Pwr(dB/10) : 10
AturGsConfig
: 0x0121020203
Chan Perf CD
: 5
CU
: 5
Chan Perf BE
: 5
Overhead Channel
: 4000
ID
: 12345678
ATU-R Self Test Result
: 0x10
Vendor ID
: 12345678
Atur ACTPSDds (dB/10)
: 90
BitSwapCount
: 90
PSDMaskMode
: CoMsk2
DownStream Gains per bin
----------------------------[ 0]
15
Transmit Spectrum Shaping info
----------------------------------[ 0]
90
252
Curr
Curr Output
Chan Perf
System Vendor
ATUR G9941
Delt HLINSCds
: 2
Delt HLOGMTds
: 8
QLNMTds
: 5
DELT Last Tx State
: dmtaturg9941
SnrmtDs
: 100
Delt HLINpsds
-----------------[ 0]
18
Delt HLOGpsds
-----------------[ 0]
20
Delt QLNpsds
----------------[ 0] 22
Delt DMT Bin SNR
--------------------[ 0] 22
Signal Atn(dB/10)
: 40
Bin Number
Number of bits/bin
------------------------------------[ 0] 0110030607
Delt
Delt
Output Fields
253
FIELD
Description
Ifname
The ADSL Interface Name
Serial Number
The vendor specific string that identifies the
vendor equipment (EOC - read 5 seconds after
data mode).
Vendor ID
Vendor ID code (EOC - read 5 seconds after
data mode).
Version Number
The vendor specific version number sent by this
ATU,as part of the initialization messages (EOC
- read 5 seconds after data mode).
Curr Status
Indicates current State of ATUR Line. This is a
bitmap of possible conditions. Due to the
isolation of the ATU-R when line problems
occur, many state conditions such as loss of
power, loss of quality signal, and initialization
errors, cannot be determined.
Curr Snr
Margin(dB/10)
Noise Margin as seen by this ATU, with respect
to its received signal, in tenth dB.
Curr Atn(dB/10)
Measured difference in the total power
transmitted by the peer ATU, and the total power
received by this ATU.
CurrAttainable
Rate(bps)
Indicates the maximum currently attainable data
rate by the ATU. This value will be equal to, or
greater than, the current line rate.
Curr Output
Pwr(dB/10)
Measured total output power transmitted by this
ATU.This is the measurement that was reported
during the last activation sequence.
AturGsConfig
The upstream and downstream ATU-R
configuration data (EOC - read 5 sec after data
mode).
Chan Perf CD
The far-end delineated total cell count
performance parameter is a count of the total
number of cells passed through the cell
delineation and HEC function process, operating
on the ATM Data Path, while in the SYNC state.
(Not available for ADSL)
254
Chan Perf CU
The far-end user total cell count performance
parameter is a count of the total number of cells
in the ATM Data Path delivered at the V-C (for
ATU-C) or TR (for ATUR) interface. (Not
available for ADSL)
Chan Perf BE
The far-end idle bit error count performance
parameter is a count of the number of bit errors
in the idle cell payload received in the ATM Data
Path at the far-end. (Not available for ADSL)
Overhead Channel
Indicates the Overhead Channel. This feature is
not supported by DSLPHY as yet.
System Vendor ID
Indicates the Vendor ID as inserted by the ATUR in the Embedded Operations Channel(ADSL).
Typically identiies the ATU-R system integrator
which usually refers to the vendor of the smallest
field-replaceable unit. ATU-R System Vendor ID
may not be the same as ATU-R G.994.1 Vendor
ID. For ADSL2, provides the Vendor ID as
inserted by the ATU-R in the Overhead
Messages. It is not available for ADSL. This is
string of 8 octets containing 2 octet country
code , 4 octet vendor id and 2 octet vendor
revision number.
ATU-R Self Test
Result
Defines the ATU-R selftest result. The most
significant octet is: 00 hex if the self-test passed
or 01 hex if the self-test failed. Interpretation of
the other octets is vendor discretionary and can
be interpreted in combination with G.994.1 and
system Vendor IDs.
ATUR G9941 Vendor
ID
Indicates the Vendor ID as inserted by the ATUR in the G.994.1 CLR message.The G.994.1
Vendor ID typically identifies the vendor of the
ATU-R G.994.1 functionality. This is string of 8
octets containing 2 octet country code , 4 octet
vendor id and 2 octet vendor revision number.
Atur ACTPSDds
(dB/10)
This parameter defines the average downstream
transmit power spectrum density over the used
subcarriers delivered by the ATU-C at the U-C
reference point, at the instant of measurement.
It's value ranges from -90 to 0, in 0.1 dB/Hz
steps. It is available only for ADSL2/ADSL2plus.
BitSwapCount
This Conexant parameter indicates the bit swap
count. It can read only in data mode
PSDMaskMode
This conexant parameter that indicates the
actual PSD Mask currently being used by ATU-R
Gain Spsds
This parameter defines the downstream gains
allocation table per bin. It is supported for
ADSL2/ADSl2plus only.
Atur TSSpsds
This parameter provides the Downstream
Transmit Spectrum Shaping parameter
expressed as the set of break points exchanged
during G994.1. Value of this parameter is in
range 0 - 127, in multiples of -0.5 dB. 127 is a
special value indicating the subcarrier is not
transmitted. It is available only for
ADSL2/ADSL2plus.
Delt HLINSCds
The DELT-related parameter that provides the
scale factor to be applied to the downstream Hlin
(f) values. (Not available for ADSL and
ADSL2plus)
Delt HLOGMTds
The DELT-related parameter that provides the
number of symbols used to measure the
downstream Hlog (f). (Not available for ADSL
and ADSL2plus)
Delt QLNMTds
The DELT-related parameter that provides the
number of symbols used to measure the
downstream QLN (f) values. (Not available for
ADSL and ADSL2plus)
DELT Last Tx State
The DELT-related parameter that provides the
last successful transmitted initialization state by
ATU-R. (Not available for ADSL and ADSL2plus)
Delt SnrmtDs
DELT-number of symbols to measure DS SNR
Delt HLINpsds
The DELT-related parameter that provides an
array of complex downstream Hlin (f) values in
linear scale. (Not available for ADSL and
ADSL2plus)
Delt HLOGpsds
The DELT-related parameter that provides an
array of real downstream Hlog (f) values in dB.
(Not available for ADSL and ADSL2plus)
Delt QLNpsds
The DELT-related parameter that provides an
array of real downstream QLN (f) values in dB.
(Not available for ADSL and ADSL2plus)
DMT Bin SNR
The DELT-related parameter that provides an
array of real downstream SNR (f) values in dB
(Not available for ADSL and ADSL2plus)
Signal Atn(dB/10)
DELT-related parameter that provides the
downtream signal attenuation (length = 4 bytes).
(Not available for ADSL and ADSL2plus).
AturDMTBinBits
Number of bits per bin for the bin indexed by this
element of the string. The 0th element contains
the number of bits for bin 0 through to the 255th
element, which contains the number of bits for
bin 255. The range of expected values is from 0
to 15 bits per bin (256 bytes for Annex A and
Annex B, 512 bytes for G.Span/Adsl+, 1024
bytes for G.Span Plus).
References
• ADSL commands
8.9.19
ADSL ATUR Traps Commands
8.9.19.1
Get adsl atur traps
Description: This command is used to get.
Command Syntax: get adsl atur traps [ifname <interface-name]
Parameters
Name
Description
ifname <interfacename>
The ADSL interface name.
Type : Get – Mandatory
Valid values: dsl-0 – dsl-23
Example
$ get adsl atur traps ifname dsl-0
Output
Ifname
: dsl-0
Lofs Thresh Trap : 1
Loss Thresh Trap : 1
Lprs Thresh Trap : 1
ESs Thresh Trap
Rate Change Trap : 0
Output Fields
255
: 0
FIELD
Description
Ifname
The ADSL Interface Name
Lofs Thresh Trap
Loss of Framing 15-minute interval threshold
reached
Loss of Signal 15-minute interval threshold
reached
Loss of Power 15-minute interval threshold
reached
Errored Second 15-minute interval threshold
reached
The ATU-Rs transmit rate has changed (RADSL
mode only).
Loss Thresh Trap
Lprs Thresh Trap
ESs Thresh Trap
Rate Change Trap
References
• ADSL Commands
8.9.20
DSL ATUR Trapsext Commands
8.9.20.1
Get adsl atur trapsext
Description: Use this command to get.
Command Syntax: get adsl atur trapsext [ifname <interface-name]
Parameters
Name
Description
ifname <interfacename>
The ADSL Interface Name
Type: Get -- Optional
Valid values: dsl-0 – dsl-23
Example
$ get adsl atur trapsext ifname dsl-0
Output
Ifname
: dsl-0
SesL Thresh 15Min Trap : 1
0
UasL Thresh 15Min Trap :
FecsL Thresh 15Min Trap: 0
Lofs Thresh 1Day Trap
0
: 1
Loss Thresh 1Day Trap
:
Lprs Thresh 1Day Trap
1
: 1
ESs Thresh 1Day Trap
:
SesL Thresh 1Day Trap
0
: 1
UasL Thresh 1Day Trap
:
FecsL Thresh 1Day Trap : 0
Output Fields
256
FIELD
Description
Ifname
The ADSL Interface Name.
SesL Thresh 15Min
Trap
UasL Thresh 15Min
Trap
FecsL Thresh 15Min
Trap
Lofs Thresh 1Day
Trap
Loss Thresh 1Day
Trap
Lprs Thresh 1Day
Trap
ESs Thresh 1Day
Trap
Severely Error Seconds 15-minute interval
threshold reached.
Unavailable Error Seconds 15-minute interval
threshold reached.
Forward error correction Seconds 15-minute
interval threshold reached.
Loss of Frames 1-day interval threshold reached.
Loss of Signal 1-day interval threshold reached.
Loss of Power 1-day interval threshold reached.
Error Seconds 1-day interval threshold reached.
SesL Thresh 1Day
Trap
UasL Thresh 1Day
Trap
FecsL Thresh 1Day
Trap
Severely Error Seconds 1-day interval threshold
reached.
Unavailable Error Seconds 1-day interval
threshold reached.
Forward error correction Seconds 1-day interval
threshold reached.
References
• ADSL Commands
8.9.21
ADSL Cap Commands
8.9.21.1
Get adsl cap
Description:
Use this command to view DSL transmission capability.
Command Syntax:
get adsl cap
Parameters
None
Example
$ get adsl cap
Output
Tx Capability : q9921potsOverlapped q9921potsNonOverlapped
Output Fields
Field
Tx Capability
Description
This bitmap specifies which all transmission
modes, which the ATU-C is capable of supporting.
Right now support for Annex A, Annex B,
G.Span/ADSL+ and G.Span Plus is present. This
value depends on the DSL PHY firmware present
on Columbia MxU.
References
• create dsl system
• get dsl system.
8.9.22
ADSL Line Intf Commands
8.9.22.1
Get adsl line intf
Description: Use this command to view ADSL line configuration.
Command Syntax: get adsl line intf [ifname <interface-name>]
8.9.22.2
Modify adsl line intf
Description: Use this command to modify.
Command Syntax: modify adsl line intf ifname <interface-name>
[ lineconfgsaction startup | spectrumReverb | analogLb | digitalLb |
atmLp | spectrumMedley | spectrumPilot | spectrumCMtpr |
spectrumRMtpr | hybridLossTest | rcvLinearityTest | rcvFilterTest |
rcvPowerPerBinTest | idleNoisePerBinTest | totalIdleNoiseTest | selt |
shutdown | wakeup | AbortReq ] [ linepmconfpmsf L3ToL0StateForce
| L0ToL2StateForce | L3StateForce | L2ToL0StateForce ]
[ linedeltconfldsf inhibit | force ] [ linetransatucconfig ansit1413 | etsi
| q9921PotsNonOverlapped | q9921PotsOverlapped |
q9921IsdnNonOverlapped | q9921isdnOverlapped |
q9921tcmIsdnNonOverlapped | q9921tcmIsdnOverlapped |
q9922potsNonOverlapeed | q9922potsOverlapped |
q9922tcmIsdnNonOverlapped | q9922tcmIsdnOverlapped |
q9921tcmIsdnSymmetric | adslPlusPotsNonOverlapped |
257
q9921GspanPlusPotsNonOverlapped |
q9921GspanPlusPotsOverlapped | q9923Adsl2PotsOverlapped |
q9923Adsl2PotsNonOverlapped | q9925Adsl2PlusPotsOverlapped |
q9925Adsl2PlusPotsNonOverlapped | q9923Readsl2PotsOverlapped |
q9923Readsl2PotsNonOverlapped | adslPlusPotsOverlapped |
q9921GspanPlusPlusPotsNonOverlapped |
q9921GspanPlusPlusPotsOverlapped | q9923IsdnNonOverlapped |
q9923IsdnOverlapped | q9925IsdnNonOverlapped |
q9925IsdnOverlapped | q9923AnnexMPotsExtUsNonOverlapped |
q9923AnnexMPotsExtUsOverlapped |
q9925AnnexMPotsExtUsNonOverlapped |
q9925AnnexMPotsExtUsOverlapped ] [ dsbinsnrupdate Disable |
Enable ] [ enable | disable ]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL port.
Type: Modify -- Mandatory
Get -- Optional
Valid values: dsl-0 – dsl-23
lineconfgsaction
startup |
spectrumReverb |
analogLb | digitalLb |
atmLp |
spectrumMedley |
spectrumPilot |
spectrumCMtpr |
spectrumRMtpr |
hybridLossTest |
rcvLinearityTest |
rcvFilterTest |
rcvPowerPerBinTest |
idleNoisePerBinTest |
totalIdleNoiseTest | selt
| shutdown | wakeup |
AbortReq
linepmconfpmsf
L3ToL0StateForce |
L0ToL2StateForce |
L3StateForce |
L2ToL0StateForce
linedeltconfldsf inhibit
| force
Allows action on per-line basis.
Type: Modify -- Optional
PM-related parameter used by ATU-C to force a
change in the line state. (Not available for
ADSL/ADSL2Plus)
Type: Modify -- Optional
The DELT-related parameter used by ATU-C to
force the line into the loop diagnostics mode. (Not
available for ADSL and ADSL2plus)
Type: Modify -- Optional
linetransatucconfig
ansit1413 | etsi |
q9921PotsNonOverlap
ped |
q9921PotsOverlapped |
q9921IsdnNonOverlapp
ed |
q9921isdnOverlapped |
q9921tcmIsdnNonOverl
apped |
q9921tcmIsdnOverlapp
ed |
q9922potsNonOverlape
ed |
q9922potsOverlapped |
q9922tcmIsdnNonOverl
apped |
q9922tcmIsdnOverlapp
258
The transmission modes that the ATU-C is
capable of supporting. The modes available are
limited by the design of the equipment.
REFERENCE"Section 7.3.2 ITU G.997.1" (length
= 4 bytes).
Type: Modify -- Optional
ed |
q9921tcmIsdnSymmetri
c|
adslPlusPotsNonOverla
pped |
q9921GspanPlusPotsN
onOverlapped |
q9921GspanPlusPotsO
verlapped |
q9923Adsl2PotsOverla
pped |
q9923Adsl2PotsNonOv
erlapped |
q9925Adsl2PlusPotsOv
erlapped |
q9925Adsl2PlusPotsNo
nOverlapped |
q9923Readsl2PotsOver
lapped |
q9923Readsl2PotsNon
Overlapped |
adslPlusPotsOverlappe
d|
q9921GspanPlusPlusP
otsNonOverlapped |
q9921GspanPlusPlusP
otsOverlapped |
q9923IsdnNonOverlapp
ed |
q9923IsdnOverlapped |
q9925IsdnNonOverlapp
ed |
q9925IsdnOverlapped |
q9923AnnexMPotsExtU
sNonOverlapped |
q9923AnnexMPotsExtU
sOverlapped |
q9925AnnexMPotsExtU
sNonOverlapped |
q9925AnnexMPotsExtU
sOverlapped
dsbinsnrupdate
Disable | Enable
Conexant parameter to enable or disable
collection of downstream SNR bin status
Type: Modify -- Optional
enable | disable
Administrative status of the interface.
Type: Create -- Optional
Modify -- Optional
Valid values: enable, disable
Default value: enable
Example
$ get adsl line intf ifname dsl-0
Output
IfName
: dsl-0
Line Type
Type
GsUtopia
L2RxAddr
L2TxAddr
: 10
GsUtopia L2RxAddr2nd
L2TxAddr2nd : 11
Gs Clock Type
Action
Trans Atuc Cap
259
: noChannel
Coding
: 23
GsUtopia
: 11
GsUtopia
: dmt
: oscillator
: analoglb
: ansit1413
Gs
Trans Atuc Actual
: q9921PotsNonOverlapped
Trans Atuc Config
: ansit1413
GsDmtTrellis
: trellisOn
Trans Atur Cap
: ansit1413
PM Conf PMSF
: idleop
Line DELT Conf LDSF
: inhibit
Curr Output Pwr(dBm/10)
Update
: Enable
: 10
Bin Number
DS Bin SNR
SNR Margin/bin
--------------------------------[ 0]
16
Oper Status
Status
: Up
Admin
: Enable
Output Fields
260
FIELD
Description
IfName
The interface name of the DSL port.
Line Type
Line type used by the DSL port.
Coding Type
Line coding type used by the port.
GsUtopia L2TxAddr
UTOPIA Level 2 Tx address for a line.
GsUtopia L2RxAddr
UTOPIA Level 2 Rx address.
GsUtopia
L2RxAddr2nd
Conexant parameter to set UTOPIA Level 2 Rx
address for the secondary bearer channel in case
of Dual Latency. (length = 4 bytes)
GsUtopia
L2TxAddr2nd
Conexant parameter to set UTOPIA Level 2 Tx
address for the secondary bearer channel in case
of Dual Latency. (length = 4 bytes)
Gs Clock Type
Indicates use of crystal or oscillator.
Gs Action
Allows action on per-line basis.
Trans Atuc Cap
Transmission modes that ATU-C is capable of.
Trans Atuc Actual
Transmission modes
Trans Atuc Config
The transmission modes that the ATU-C is
capable of supporting. The modes available are
limited by the design of the equipment.
REFERENCE"Section 7.3.2 ITU G.997.1" (length
= 4 bytes).
GsDmtTrellis
Indicates whether trellis coding has been enabled
or not.
Trans Atur Cap
The transmission modes that the ATU-R is
capable of supporting. The modes available are
limited by the design of the equipment (length = 4
bytes).
PM Conf PMSF
PM-related parameter used by ATU-C to force a
change in the line state. (Not available for
ADSL/ADSL2Plus)
Line DELT Conf LDSF
The DELT-related parameter used by ATU-C to
force the line into the loop diagnostics mode. (Not
available for ADSL and ADSL2plus)
Curr Output
Pwr(dBm/10)
This conexant parameter indicates the measure of
total output power transmitted by this ATU. The
value of this parameter is dynamic and will also
show the change in Tx power due to Power
Management. For example, the value will
decrease in L2 low power mode. This value can
be negative.
DS Bin SNR Update
Conexant parameter to enable or disable
collection of downstream SNR bin status
Bin SNR
Margin(dB/10)
Oper Status
Bin SNR margin for particular sub carrier
Admin Status
The desired state of the interface. It may be either
Up or Down.
8.9.23
ADSL Line Profile Commands
8.9.23.1
Get adsl line profile
The actual/current state of the interface. It can be
either up or down.
Description: Use this command to get.
Command Syntax: get adsl line profile [ifname <interface-name>]
8.9.23.2
Modify adsl line profile
Description: Use this command to modify.
Command Syntax: modify adsl line profile ifname <interface-name>
[ atucrateadaptation fixed | adaptAtStartup | adaptAtRuntime ]
[ gsparamtestinputfile <gsparamtestinputfile-val> ] [ atuctargetsnr
<atuctargetsnr-val> ] [ atucmaxsnrmargin <atucmaxsnrmargin-val> ]
[ atucgsrsintcorrectionup 125us | 250us | 500us | 1ms | 2ms | 4ms |
disable ] [ atucdnshiftsnrmargin <atucdnshiftsnrmargin-val> ]
[ atucupshiftsnrmargin <atucupshiftsnrmargin-val> ]
[ atucminupshifttime <atucminupshifttime-val> ]
[ atucmindnshifttime <atucmindnshifttime-val> ] [ atucfastmintxrate
<atucfastmintxrate-val> ] [ atucintlmintxrate <atucintlmintxrate-val> ]
[ atucfastmaxtxrate <atucfastmaxtxrate-val> ] [ atucintlmaxtxrate
<atucintlmaxtxrate-val> ] [ atucmaxintldelay <atucmaxintldelay-val> ]
[ type noChannel | fastOnly | interleavedOnly | fastOrInterleaved |
fastAndInterleaved ] [ atucgstxendbin <atucgstxendbin-val> ]
[ atucgstxstartbin <atucgstxstartbin-val> ] [ atucgsmaxbitsperbin
<atucgsmaxbitsperbin-val> ] [ atucgsrxstartbin <atucgsrxstartbin-val> ]
[ atucgsrxendbin <atucgsrxendbin-val> ] [ atucgsrxbinadjust disable ]
[ atucgsltriggermode locCrc | rmtCrc | snrInc | snrDec | disable ]
[ atucgsadi2x standard ] [ atucgsinitiate waitPn | ctone | initiatePn ]
[ atucgstxpoweratten 0 | point1 | point2 | point3 | point4 | point5 |
point6 | point7 | point8 | point9 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12
| 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 ]
[ atucgscodinggain Auto | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 256 ]
[ atucgsrsfastovrhddn 50 | 25 | 12 | 6 | 3 | 1 | Disable ]
[ atucgsrsintcorrectiondn 125Us | 250Us | 500Us | 1Ms | 2Ms | 4Ms |
Disable ] [ atucgsrsfastovrhdup 50 | 25 | 12 | 6 | 3 | 1 | Disable ]
[ atucgsdrstby Disable | Enable ] [ atucgsexpexch Expanded | Short ]
[ atucgsescfastretrain Enable | Disable ] [ atucgsfastretrain Enable |
Disable ] [ atucgsbitswap Disable | Enable ] [ atucgsntr LocalOcs |
Refck8K ] [ atucgsalctlusver Unknown ] [ atucgsusecustombin
Enable | Disable ] [ atucgsdnbinusage <atucgsdnbinusage-val> ]
[ atucgsmaxdco 64 | 128 | 256 | 511 ] [ atucgsfullretrain Enable |
Disable ] [ atucgspsdmasktype CoMsk2 | FlatMsk | CabMsk2 |
CoMsk2Rfi | FlatMskRfi | CabMsk2Rfi | CoMsk2Rfi0 | Adsl2NonovlpM1
| Adsl2NonovlpM2 | Adsl2NonovlpFlat ] [ atucgseraseprofs enable |
disable ] [ atucgsextrsmemory notpresent | present ]
[ paramhybridlossteststart <paramhybridlossteststart-val> ]
[ paramhybridlosstestend <paramhybridlosstestend-val> ] [ dmttrellis
on | off ] [ aturtargetsnrmargin <aturtargetsnrmargin-val> ]
[ aturdnshiftsnrmargin <aturdnshiftsnrmargin-val> ]
[ aturupshiftsnrmargin <aturupshiftsnrmargin-val> ]
[ aturminupshifttime <aturminupshifttime-val> ] [ aturmindnshifttime
261
<aturmindnshifttime-val> ] [ aturfastmintxrate <aturfastmintxrate-val> ]
[ aturintlmintxrate <aturintlmintxrate-val> ] [ aturfastmaxtxrate
<aturfastmaxtxrate-val> ] [ aturintlmaxtxrate <aturintlmaxtxrate-val> ]
[ aturmaxintldelay <aturmaxintldelay-val> ] [ databoost Enable |
Disable ] [ upstreampsd Extended | Standard | Jj100 ]
[ atucconfpmmode pmstatel3enable | pmstatel2enable | disable ]
[ atucconfpml0time <atucconfpml0time-val> ] [ atucconfpml2time
<atucconfpml2time-val> ] [ atucconfpml2atpr <atucconfpml2atpr-val> ]
[ atucconfpml2minrate <atucconfpml2minrate-val> ]
[ atucconfmsgminds <atucconfmsgminds-val> ] [ aturconfmsgminus
<aturconfmsgminus-val> ] [ atucminsnrmgn <atucminsnrmgn-val> ]
[ aturminsnrmgn <aturminsnrmgn-val> ] [ atucfrontenddesigntype
El1508 | El1528 | Le87213 ] [ atuchwpwrreduction Disable | Enable ]
[ atucgsusbitswap Disable | Enable ] [ aturmaxsnrmgn
<aturmaxsnrmgn-val> ] [ atucconfmininp Inp0 | InpPoint5 | Inp1 | Inp2
| InpAuto | Inp4 | Inp8 | Inp16 ] [ atucpml2entrythreshrate
atucpml2entrythreshrate ] [ atucpml2exitthreshrate
<atucpml2exitthreshrate-val> ] [ atucpml2entryratemintime
<atucpml2entryratemintime-val> ] [ atucgscabinethsenable Disable |
Enable ] [ atucgsseltlooptype RealCable | Dls90 | Dls400 ]
[ atucgsrxstartbinu1 <atucgsrxstartbinu1-val> ] [ atucgsrxendbinu1
<atucgsrxendbinu1-val> ] [ gspsdmaskdsenable PsdMaskDisable |
PsdMaskEnable | PsdMaskEnableMod ] [ gspsdmaskusenable
PsdMaskDisable | PsdMaskEnable | PsdMaskEnableMod ]
[ psdmaskdsfallbackenable False | True ]
[ psdmaskusfallbackenable False | True ] [ atucconfmaxnompsdds
<atucconfmaxnompsdds-val> ] [ aturconfmaxnompsdus
<aturconfmaxnompsdus-val> ] [ atucconfmaxnomatpds
<atucconfmaxnomatpds-val> ] [ aturconfmaxnomatpus
<aturconfmaxnomatpus-val> ] [ atucconfpsdmaskds
<atucconfpsdmaskds-val> ] [ aturconfpsdmaskus
<aturconfpsdmaskus-val> ] [ aturratemode fixed | adaptAtStartup |
adaptAtRuntime ] [ aturconfmininp Inp0 | InpPoint5 | Inp1 | Inp2 |
InpAuto | Inp4 | Inp8 | Inp16 ] [ gsannexcoltocxswitch CxSwitch19DB
| CxSwitch20DB | CxSwitch21DB | CxSwitch22DB | CxSwitch23DB |
CxSwitch24DB | CxSwitch25DB | CxSwitch26DB | CxSwitch27DB |
CxSwitch28DB | CxSwitch29DB | CxSwitch30DB ]
[ atucconfgsannexcswitch Gspan19DB | Gspan20DB | Gspan21DB |
Gspan22DB | Gspan23DB | Gspan24DB | Gspan25DB |
GspanPlus7DB | GspanPlus8DB | GspanPlus9DB | GspanPlus10DB |
GspanPlus11DB | GspanPlus12DB | GspanPlus13DB |
GspanPlus14DB | GspanPlus15DB ] [ gsannexctouqswitch
CUqSwitch6DB | CUqSwitch6_5DB | CUqSwitch7DB | CUqSwitch8DB |
CUqSwitch9DB | CUqSwitch10DB | CUqSwitch11DB | CUqSwitch12DB
| CUqSwitch13DB | CUqSwitch14DB | CUqSwitch15DB ]
[ atucminsnrmgntime <atucminsnrmgntime-val> ] [ atuccustomerid
WorldWide | France | China | Portugal ] [ atucmpsdmasktype
Adsl2MEu64 | Adsl2MEu60 | Adsl2MEu56 | Adsl2MEu52 | Adsl2MEu48
| Adsl2MEu44 | Adsl2MEu40 | Adsl2MEu36 | Adsl2MEu32 | Adsl2MAll ]
[ atucgsseltloopgauge 26awg | 24awg ] [ atucconfrateratio
<atucconfrateratio-val> ]
Parameters
Name
Description
ifname<interfacename>
The ADSL line interface name, whose profile is to
bemodified or viewed
Type: Modify - Mandatory
Get - Optional
atucrateadaptation
fixed | adaptAtStartup |
adaptAtRuntime
Defines what form of transmit rate adaptation is
configured on this modem. Refer to ADSL Forum
TR-005 for more information.
Type: Modify -- Optional
262
gsparamtestinputfile
<gsparamtestinputfileval>
Indicates Name of the Input file from which to take
the Mask Array Size, lower and upper mask Array.
Null string means no file is specified
Type: Modify -- Optional
atuctargetsnr
<atuctargetsnr-val>
Configured Target Signal/Noise Margin. This is the
Noise Margin the modem must achieve with a
BER of 10 to the power -7, or better, to
successfully complete initialization.
Type: Modify -- Optional
Valid values: 0 - 310
atucmaxsnrmargin
<atucmaxsnrmarginval>
Configured Maximum acceptable Signal/Noise
Margin. If the Noise Margin is above this, the
modem hould attempt to reduce its power output
to optimize its operation.
Type: Modify -- Optional
Valid values: 0 - 310
atucgsrsintcorrection
up 125us | 250us |
500us | 1ms | 2ms |
4ms | disable
atucdnshiftsnrmargin
<atucdnshiftsnrmarginval>
Sets the correction time for the upstream
interleaved buffer. RS can also be disabled.
Type: Modify -- Optional
Configured Signal/Noise Margin for rate downshift.
If the noise margin falls below this level, the
modem should attempt to decrease its transmit
rate. In the case that RADSL mode is not present,
the value will be 0.
Type: Modify -- Optional
Valid values: 0 - 310
atucupshiftsnrmargin
<atucupshiftsnrmarginval>
Configured Signal/Noise Margin for rate upshift. If
the noise margin rises above this level, the
modem should attempt to increase its transmit
rate. In thecase that RADSL is not present, the
value will be 0.
Type: Modify -- Optional
Valid values: 0 - 310
atucminupshifttime
<atucminupshifttimeval>
Minimum time that the current margin is above
UpshiftSnrMgn before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
Type: Modify -- Optional
Valid values: 0 - 16383
atucmindnshifttime
<atucmindnshifttimeval>
Minimum time that the current margin is above
UpshiftSnrMgn before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
Type: Modify -- Optional
Valid values: 0 - 16383
atucfastmintxrate
<atucfastmintxrate-val>
Configured Minimum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and refer to ATU-R
transmit rate for ATU-C receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
atucintlmintxrate
<atucintlmintxrate-val>
263
Configured Minimum Transmit rate for 'Interleave'
channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and refer to ATU-R
transmit rate for ATU-C receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
atucfastmaxtxrate
<atucfastmaxtxrateval>
Configured Maximum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and ATU-R transmit rate
for ATU-C receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
atucintlmaxtxrate
<atucintlmaxtxrate-val>
Configured Maximum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and ATU-R transmit rate
for ATU-C receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
atucmaxintldelay
<atucmaxintldelay-val>
Configured maximum Interleave Delay for this
channel. Interleave delay applies only to the
interleave channel and defines the mapping
(relative spacing) between subsequent input bytes
at the interleaver input and their placement in the
bit stream at the interleaver output. Larger
numbers provide greater separation between
consecutive input bytes in the output bit stream,
allowing for improved impulse noise immunity at
the expense of payload latency.
Type: Modify -- Optional
Valid values: 0 - 255
type noChannel |
fastOnly |
interleavedOnly |
fastOrInterleaved |
fastAndInterleaved
atucgstxendbin
<atucgstxendbin-val>
This object is used to configure the ADSL
physical line mode.
Type: Modify -- Optional
The highest bin number allowed for Tx signal.
Type: Modify -- Optional
Valid values: 0x06 - 0xff
atucgstxstartbin
<atucgstxstartbin-val>
The lowest bin number allowed for Tx signal.
Type: Modify -- Optional
Valid values: 0x06 - 0xff
atucgsmaxbitsperbin
<atucgsmaxbitsperbinval>
The maximum Rx number of bits per bin.
Type: Modify -- Optional
Valid values: 0 - 15
atucgsrxstartbin
<atucgsrxstartbin-val>
The lowest bin number allowed for Rx signal.
Type: Modify -- Optional
Valid values: 0x01 - 0x1ff
atucgsrxendbin
<atucgsrxendbin-val>
The highest bin number allowed for Rx signal.
Type: Modify -- Optional
Valid values: 0x06 - 0x1ff
atucgsrxbinadjust
disable
This parameter employs Rx Start/End bin settings
Type: Modify -- Optional
atucgsltriggermode
264
The type of event that triggers a fast retrain
locCrc | rmtCrc | snrInc
| snrDec | disable
atucgsadi2x standard
Type: Modify -- Optional
For non-standard compliant ADI CPE
Type: Modify -- Optional
atucgsinitiate waitPn |
ctone | initiatePn
Specifies which end initiates startup. It is also
used to send a C-tone to the remote unit.
Type: Modify -- Optional
atucgstxpoweratten 0
| point1 | point2 | point3
| point4 | point5 | point6
| point7 | point8 | point9
|1|2|3|4|5|6|7|
8 | 9 | 10 | 11 | 12 | 13 |
14 | 15 | 16 | 17 | 18 |
19 | 20 | 21 | 22 | 23 |
24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 | 32 | 33 |
34 | 35 | 36 | 37 | 38 |
39 | 40
atucgscodinggain
Auto | 0 | 1 | 2 | 3 | 4 | 5
| 6 | 7 | 256
atucgsrsfastovrhddn
50 | 25 | 12 | 6 | 3 | 1 |
Disable
The value in dB of Tx power attenuation
Type: Modify -- Optional
Sets the coding gain in dB increments
Type: Modify -- Optional
This parameter sets the percentage overhead for
the downstream fast buffer. RS can also be
disabled.
Type: Modify -- Optional
atucgsrsintcorrection
dn 125Us | 250Us |
500Us | 1Ms | 2Ms |
4Ms | Disable
This parameter sets the correction time for the
downstream interleaved buffer.RS can also be
disabled.
Type: Modify -- Optional
atucgsrsfastovrhdup
50 | 25 | 12 | 6 | 3 | 1 |
Disable
This parameter sets the percentage overhead for
the upstream fast buffer.RS can also be disabled.
Type: Modify -- Optional
atucgsdrstby Disable |
Enable
This parameter provides the ability to disable
power to the line driver
Type: Modify -- Optional
atucgsexpexch
Expanded | Short
T1.413 parameter that Enables/Disables EES
Type: Modify -- Optional
atucgsescfastretrain
Enable | Disable
This parameter enables/disables escape to the
fast retrain capability
Type: Modify -- Optional
atucgsfastretrain
Enable | Disable
This parameter enables/disables the fast retrain
capability. Currently supported only in G.lite mode.
Type: Modify -- Optional
atucgsbitswap Disable
| Enable
This parameter enables/disables bit swapping
Type: Modify -- Optional
atucgsntr LocalOcs |
Refck8K
This parameter enables/disables NTR on a per
chip basis
Type: Modify -- Optional
atucgsalctlusver
Unknown
For T1.413 demo purposes only
Type: Modify -- Optional
atucgsusecustombin
Enable | Disable
265
This parameter enables/disables user selection
which of the 511 bins will be enabled for upstream
and downstream transmission.
Type: Modify -- Optional
atucgsdnbinusage
<atucgsdnbinusageval>
'1' in bit position indicates usage of corresponding
bin,whereas a '0' disables usage of corresponding
bin.
Type: Modify -- Optional
atucgsmaxdco 64 |
128 | 256 | 511
Maximum interleaving depth supported by the
customer's hardware
Type: Modify -- Optional
atucgsfullretrain
Enable | Disable
Indicates enable/disable of auto retrain capability
Type: Modify -- Optional
atucgspsdmasktype
CoMsk2 | FlatMsk |
CabMsk2 | CoMsk2Rfi |
FlatMskRfi |
CabMsk2Rfi |
CoMsk2Rfi0 |
Adsl2NonovlpM1 |
Adsl2NonovlpM2 |
Adsl2NonovlpFlat
atucgseraseprofs
enable | disable
This parameter selects the PSD mask option to be
used
Type: Modify -- Optional
This parameter enables/disables the ability to
erase all fast retrain profiles at startup
Type: Modify -- Optional
atucgsextrsmemory
notpresent | present
Indicates whether customer's Hardware uses
external RS RAM
Type: Modify -- Optional
paramhybridlosstests
tart
<paramhybridlosstestst
art-val>
Start bin for range of bins to be measured. The
default value mentioned is an indicative value
only, for exact value refer to document number
DO-400523-AN and DO-401163-AN.
Type: Modify -- Optional
Valid values: 0x0 - 0x1ff
paramhybridlossteste
nd
<paramhybridlossteste
nd-val>
dmttrellis on | off
End bin for range of bins to be measured.
Type: Modify -- Optional
Valid values: 0x0 - 0x1ff
This parameter enables/disables trellis coding.
Trellis coding should always be enabled for its
clear performance advantage.
Type: Modify -- Optional
aturtargetsnrmargin
<aturtargetsnrmarginval>
Noise Margin the modem must achieve with a
BER of 10 to the power 7 or better to successfully
complete initialization
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturdnshiftsnrmargin
<aturdnshiftsnrmarginval>
Configured Signal/ Noise Margin for rate
downshift. If the noise margin falls below this level,
the modem should attempt to decrease its
transmit rate. In the case that RADSL mode is not
present, the value will be 0.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturupshiftsnrmargin
<aturupshiftsnrmarginval>
266
Configured Signal/ Noise Margin for rate upshift.
If the noise margin rises above this level, the
modem should attempt to increase itís transmit
rate. In the case that RADSL is not present, the
value will be 0.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturminupshifttime
<aturminupshifttimeval>
Minimum time that the current margin is above
UpshiftSnrMgn, before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturmindnshifttime
<aturmindnshifttimeval>
Minimum time that the current margin is below
DownshiftSnrMgn, before a downshift occurs. In
the case that RADSL mode is not present, the
value will be 0.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturfastmintxrate
<aturfastmintxrate-val>
Configured Minimum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and ATU-C transmit rate
for ATU-R receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturintlmintxrate
<aturintlmintxrate-val>
Configured Minimum Transmit rate for 'Interleave'
channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATUR receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturfastmaxtxrate
<aturfastmaxtxrate-val>
Configured Maximum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATUR receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturintlmaxtxrate
<aturintlmaxtxrate-val>
Configured Maximum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATU-R receive rates.
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
aturmaxintldelay
<aturmaxintldelay-val>
Configured maximum Interleave Delay for this
channel. Interleave delay applies only to the
interleave channel and defines the mapping
(relative spacing) between subsequent input bytes
at the interleaver input and their placement in the
bit stream at the interleaver output. Larger
numbers provide greater separation between
consecutive input bytes in the output bit stream,
allowing for improved impulse noise immunity at
the expense of payload latency
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
databoost Enable |
Disable
267
Conexant parameter that enables/disables
DataBoost option.
Type: Modify -- Optional
upstreampsd
Extended | Standard |
Jj100
Conexant parameter that sets the upstream PSD
to be either extended or standard. Used for
GSpan Plus only.
Type: Modify -- Optional
atucconfpmmode
pmstatel3enable |
pmstatel2enable |
disable
PM-related parameter used by the ATU-C to set
the allowed link states. Both bit values can be
given simultaneously in the input. Additional value
to disable pmmode is disable, which is equal to 0.
Type: Modify -- Optional
atucconfpml0time
<atucconfpml0time-val>
PM configuration parameter, related to the L2 low
power state. This parameter represents the
minimum time (in seconds) between an exit from
the L2 state and the next entry into the L2 state. It
ranges from 0 to 255 seconds.
Type: Modify -- Optional
Valid values: 0 - 255
atucconfpml2time
<atucconfpml2time-val>
PM configuration parameter, related to the L2 low
power state. This parameter represents the
minimum time (in seconds) between an Entry into
the L2 state and the first Power Trim in the L2
state and between two consecutive Power Trims
in the L2 State. It ranges from 0 to 255 seconds.
Type: Modify -- Optional
Valid values: 0 - 255
atucconfpml2atpr
<atucconfpml2atpr-val>
PM configuration parameter, related to the L2 low
power state. This parameter represents the
maximum aggregate transmit power reduction (in
dB) that can be performed through a single Power
Trim in the L2 state. It ranges from 0 dB/10 to 310
dB/10.
Type: Modify -- Optional
Valid values: 0 - 310
atucconfpml2minrate
<atucconfpml2minrateval>
PM configuration parameter, related to the L2 low
power state. This parameter specifies the
minimum net data rate during the low power state
(L2). The data rate is coded in bit/s, and can range
from 0x1F40 (8000) bps to 0xFA000 (1024000)
bps.
Type: Modify -- Optional
Valid values: 0x1F40 - 0xFA000
atucconfmsgminds
<atucconfmsgmindsval>
Configures downstream overhead channel
bandwidth. This feature is not supported by
DSLPHY as yet.
Type: Modify -- Optional
Valid values: 4000 - 64000
aturconfmsgminus
<aturconfmsgminusval>
Configures upstream overhead channel
bandwidth.This feature is not supported by
DSLPHY as yet.
Type: Modify -- Optional
Valid values: 4000 - 64000
atucminsnrmgn
<atucminsnrmgn-val>
268
Atuc Configured Minimum Signal/Noise Margin.
This is the Noise Margin, the modem must
achieve with a BER of 10 to the power -7 or better,
to successfully complete initialization. The default
value mentioned is an indicative value only.
Type: Modify -- Optional
Valid values: 0 - 310
aturminsnrmgn
<aturminsnrmgn-val>
Atuc Configured Minimum Signal/Noise Margin.
This is the Noise Margin, the modem must
achieve with a BER of 10 to the power -7 or better,
to successfully complete initialization. The default
value mentioned is an indicative value only.
Type: Modify -- Optional
Valid values: 0 - 310
atucfrontenddesignty
pe El1508 | El1528 |
Le87213
atuchwpwrreduction
Disable | Enable
Front end hardware reference design
Type: Modify -- Optional
Hardware configuration parameter
Type: Modify -- Optional
atucgsusbitswap
Disable | Enable
This parameter enables/disables upstream bit
swapping
Type: Modify -- Optional
aturmaxsnrmgn
<aturmaxsnrmgn-val>
Configured Maximum acceptable downstream
Signal/Noise Margin. If the Noise Margin is above
this the modem attempts to reduce its power
output to optimize its operation. The value set by
the user is in dB/10, and ranges from 0 to 31 dB in
1 dB steps.
Type: Modify -- Optional
Valid values: 0 - 310
atucconfmininp Inp0 |
InpPoint5 | Inp1 | Inp2 |
InpAuto | Inp4 | Inp8 |
Inp16
Parameter used to specify the minimum impulse
noise protection for the downstream bearer
channel.
Type: Modify -- Optional
atucpml2entrythreshr
ate
<atucpml2entrythreshra
te-val>
PM config param. L2 state entry data rate.
atucpml2exitthreshrat
e
<atucpml2exitthreshrat
e-val>
PM config param. L2 state exit data rate.
atucpml2entryratemin
time
<atucpml2entryratemint
ime-val>
PM config param.Min L2 entry rate time
atucgscabinethsenabl
e Disable | Enable
Enable/Disable HS tones in Cabinet mode
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
Type: Modify -- Optional
Valid values: 0 - 0xffffffff
Type: Modify -- Optional
Valid values: 900 - 65535
Type: Modify -- Optional
atucgsseltlooptype
RealCable | Dls90 |
Dls400
Conexant parameter that is used to specify the
loop type for SELT. The default value mentioned
is an indicative value only.
Type: Modify -- Optional
atucgsrxstartbinu1
<atucgsrxstartbinu1val>
Conexant parameter that specifies lowest bin
number allowed for Rx signal in G.Span Plus SUQ
mode. By selecting the receive start and end bin
numbers, the user can limit the bins for special
configurations.(length = 4 bytes)
Type: Modify -- Optional
atucgsrxendbinu1
<atucgsrxendbinu1val>
269
Conexant parameter that specifies highest bin
number allowed for Rx signal in G.Span Plus SUQ
mode. By selecting the receive start and end bin
numbers, the user can limit the bins for special
configurations.(length = 4 bytes)
Type: Modify -- Optional
gspsdmaskdsenable
PsdMaskDisable |
PsdMaskEnable |
PsdMaskEnableMod
Conexant parameter that is used to configure the
switching point between DBM-OL and XOL.(length
= 4 bytes)
Type: Modify -- Optional
gspsdmaskusenable
PsdMaskDisable |
PsdMaskEnable |
PsdMaskEnableMod
Conexant parameter used to enable the Mask on
Demand(MoD) feature in the upstream direction. It
is available only for ADSL2 Annex A ONLY.(length
= 4 bytes)
Type: Modify -- Optional
psdmaskdsfallbacken
able False | True
Conexant parameter used to enable Mask on
Demand (MoD) fallback mode. When enabled, the
system chooses MoD or the base ADSL2
depending upon the downstream rate. It is
avaiable only for ADSL2 Annex A.(length = 4
bytes)
Type: Modify -- Optional
Valid values: False, True
psdmaskusfallbacken
able False | True
Conexant parameter used to enable Mask on
Demand (MoD) fallback mode. When enabled, the
system chooses MoD or the base ADSL2
depending upon the upstream rate. It is avaiable
only for ADSL2 Annex A.(length = 4 bytes)
Type: Modify -- Optional
Valid values: False, True
atucconfmaxnompsd
ds
<atucconfmaxnompsdd
s-val>
This parameter specifies the maximum nominal
transmit PSD(MAXNOMPSD) level during
initialization and showtime. Value depends on CO
MIB element settings and near end transmitter
capabilities and is exchanged in the G.994.1
Phase. It is available only for ADSL2/ADSL2plus.
Value ranges from -60 to -40 in steps of 0.1
dBm/Hz.(length = 4 bytes)
Type: Modify -- Optional
Valid values: (-600) - (-400)
aturconfmaxnompsdu
s
<aturconfmaxnompsdu
s-val>
This parameter specifies the maximum nominal
transmit PSD(MAXNOMPSD) level during
initialization and showtime. Value depends on CO
MIB element settings and near end transmitter
capabilities and is exchanged in the G.994.1
Phase. It is available only for ADSL2/ADSL2plus.
Value ranges from -60 to -38 in steps of 0.1
dBm/Hz.(length = 4 bytes)
Type: Modify -- Optional
Valid values: (-600) - (-380)
atucconfmaxnomatpd
s
<atucconfmaxnomatpd
s-val>
This parameter specifies the maximum nominal
aggregate transmit power(MAXNOMATP) level
during initialization and showtime. Value depends
on CO MIB element settings and local capabilities
and is exchanged in the G.994.1 Phase. It is
available only for ADSL2/ADSL2plus. Value
ranges from 0 to 25.5 in steps of 0.1 dBm.(length
= 4 bytes)
Type: Modify -- Optional
Valid values: 0 - 255
270
aturconfmaxnomatpu
s
<aturconfmaxnomatpus
-val>
This parameter specifies the maximum nominal
aggregate transmit power(MAXNOMATP) level
during initialization and showtime. Value depends
on CO MIB element settings and local capabilities
and is exchanged in the G.994.1 Phase. It is
available only for ADSL2/ADSL2plus. Value
ranges from 0 to 25.5 in steps of 0.1 dBm.(length
= 4 bytes)
Type: Modify -- Optional
Valid values: 0 - 255
atucconfpsdmaskds
<atucconfpsdmaskdsval>
This configuration parameter defines that the
downstream PSD mask applicable at the U-C2
reference point. This MIB PSD mask may impose
PSD restrictions in addition to the Limit PSD mask
defined in the relevant Recommendation (e.g.,
G.992.5). (length = 4 bytes).
Type: Modify -- Optional
aturconfpsdmaskus
<aturconfpsdmaskusval>
This configuration parameter defines that the
upstream PSD mask applicable at the U C2
reference point. This MIB PSD mask may impose
PSD restrictions in addition to the Limit PSD mask
defined in the relevant Recommendation (e.g.,
G.992.5). It is available only for Annexes J and M
of ADSL2/ADSL2plus.(length = 4 bytes)
Type: Modify -- Optional
aturratemode fixed |
adaptAtStartup |
adaptAtRuntime
Defines what form of transmit rate adaptation is
configured on this modem. The default value
mentioned is an indicative value only.
Type: Modify -- Optional
aturconfmininp Inp0 |
InpPoint5 | Inp1 | Inp2 |
InpAuto | Inp4 | Inp8 |
Inp16
Parameter used to specify the minimum impulse
noise protection for the upstream bearer channel.
Supported for ADSL2/ADSL2plus ONLY
Type: Modify -- Optional
gsannexcoltocxswitc
h CxSwitch19DB |
CxSwitch20DB |
CxSwitch21DB |
CxSwitch22DB |
CxSwitch23DB |
CxSwitch24DB |
CxSwitch25DB |
CxSwitch26DB |
CxSwitch27DB |
CxSwitch28DB |
CxSwitch29DB |
CxSwitch30DB
atucconfgsannexcswi
tch Gspan19DB |
Gspan20DB |
Gspan21DB |
Gspan22DB |
Gspan23DB |
Gspan24DB |
Gspan25DB |
GspanPlus7DB |
GspanPlus8DB |
GspanPlus9DB |
GspanPlus10DB |
GspanPlus11DB |
GspanPlus12DB |
GspanPlus13DB |
GspanPlus14DB |
GspanPlus15DB
271
Conexant parameter that is used to configure the
switching point between DBM-OL and XOL.(length
= 4 bytes)
Type: Modify -- Optional
Conexant parameter that is used to configure the
switching point between Annex C and G.Span
(IFM) and between Annex C and G.Span
Plus.(length = 4 bytes)
Type: Modify -- Optional
gsannexctouqswitch
CUqSwitch6DB |
CUqSwitch6_5DB |
CUqSwitch7DB |
CUqSwitch8DB |
CUqSwitch9DB |
CUqSwitch10DB |
CUqSwitch11DB |
CUqSwitch12DB |
CUqSwitch13DB |
CUqSwitch14DB |
CUqSwitch15DB
atucminsnrmgntime
<atucminsnrmgntimeval>
Conexant parameter that is used to configure the
switching point between Annex C and G.Span
Plus SUQ.(length = 4 bytes)
Type: Modify -- Optional
This parameter indicates the time when the snr
margin violation is allowed. After this time expires
and current snr is less than min snr, the DSL line
is dropped by the APIs.
Type: Modify -- Optional
Valid values: 0 - 255
atuccustomerid
WorldWide | France |
China | Portugal
atucmpsdmasktype
Adsl2MEu64 |
Adsl2MEu60 |
Adsl2MEu56 |
Adsl2MEu52 |
Adsl2MEu48 |
Adsl2MEu44 |
Adsl2MEu40 |
Adsl2MEu36 |
Adsl2MEu32 |
Adsl2MAll
atucgsseltloopgauge
26awg | 24awg
This parameter indicates the customer ID.
Type: Modify -- Optional
Conexant parameter that selects the PSD mask
option to be used for Adsl2M.
Type: Modify -- Optional
This parameter should be set to the expected loop
gauge.
Type: Modify -- Optional
atucconfrateratio
<atucconfrateratio-val>
This parameter specifies the latency rate for both
channels in a dual latency configuration. This
parameter must be set the parameter to a value
greater than 0 and less than 100.
Type: Modify -- Optional
Valid values: 0 - 100
Example
$ get adsl line profile ifname dsl-0
Output
IfName
: dsl-0
ADSL ATUC Configuration :
------------------------------
272
Rate Adaptation
: fixed
Target Snr Margin(dB/10)
Mgn(dB/10)
: 40
: 20
Max Snr
GsRsIntCorrectionUp
SnrMargin(dB/10) : 35
: 1ms
Dnshift
Upshift SnrMargin(dB/10)
Time(sec)
: 70
: 50
Min Upshift
Min Dnshift Time(sec)
Rate(bps)
: 0x20
: 10
Fast Min Tx
Intl Min Tx Rate(bps)
Rate(bps)
: 0x50
: 0x40
Fast Max Tx
Intl Max Tx Rate(bps)
Delay(ms)
: 10
: 0x60
Max Intl
GsTxStartBin
GsTxEndBin
: 0x20
: 0x06
GsRxStartBin
GsRxEndBin
: 0x06
: 0x1f
GsMaxBitsPerBin
GsMaxDCo
: 15
: 64
GsRxBinAdjust
GsAdi2x
: enable
: standard
GsInitiate
GsTxPowerAtten
: waitPn
: point6
GsCodingGain
GsRsFastOvrhdDown
: Auto
: 1
GsRsIntCorrectionDown
GsRsFastOvrhdUp
: 125Us
: 50
GsDrStby
GsExpandedExchange
: Disable
: Short
GsEscapeFastRetrain
GsFastRetrain
: Enable
: Enable
GsBitSwap
GsNtr
: Enable
: LocalOcs
GsAlctlUsVer
: Unknown
GsUseCustomBin
GsFullRetrain
: Enable
: Enable
GsPsdMaskType
GsEraseProfiles
: FlatMsk
: enable
GsExtRsMemory
ParamHybridLossTestStart
: ExtRsMemory
: 0x10
GsParamHybridLossTestEnd
GsDmtTrellis
: 0x23
: on
GslTriggerMode
: rmtCrc
Type
: noChannel
GsDnBinUsage
: 0xff
ParametricTestInputFile
: TestFile
Data Boost
: Enable
Upstream PSD
: Extended
Conf PM Mode
: pmstatel3enable
pmstatel3disable
Conf PML0 Time(sec)
Time(sec)
: 255
: 120
Conf PML2
Conf PML2 ATPR (dB/10)
Rate(bps)
: 0xFA00
: 30
Conf PML2 Min
MSG Min Ds
Mrg(dB/10)
: 4000
Min Snr
: 20
FrontEnd H/W Design
: El1508
H/W Pwr Reduction
: Enable
GsUsBitSwap
INP
: Enable
Minimum
PML2 Entry Thresh Rate
Rate
: 0x1000
: 0x1000
PML2 Exit Thresh
PML2 Entry Rate Min Time
CabinetHsEnable
: 1800
: Disable
GsSeltLoopType
: Real Cable
GsRxStartBinU1
: 0x3aa
GsRxEndBinU1
Enable
: Inp0
: 0x4a6
: PsdMaskEnable
PsdMod FallBackEnable
PSD(dB/10)
: -40
: Enable
Max Nom AtpPsd(dB/10)
: 204
Downstream PSD Mask :
-------------------------[ 0]
0
GsAnnexCOlToCxSwitch
273
: CxSwitch19DB
PSD MoD
Max Nom
GsAnnexCSwitch
GsAnnexCToUqSwitch
: Gspan19DB
: CUqSwitch6_5DB
Min SnrMgnTime(sec)
: 20
Customer ID
: WorldWide
GsMPsdMaskType
GsSeltLoopGauge
: Adsl2MEu32
: 26awg
Rate Ratio
: 30
ADSL ATUR Configuration :
-----------------------------Target Snr Margin(dB/10)
SnrMargin(dB/10) : 35
: 20
Dnshift
Upshift SnrMargin(dB/10)
Time(sec)
: 70
: 50
Min Upshift
Min Dnshift Time(sec)
Rate(bps)
: 0x20
: 10
Fast Min Tx
Intl Min Tx Rate(bps)
Rate(bps)
: 0x40
: 0x10
Fast Max Tx
Intl Max Tx Rate(bps)
Delay(ms)
: 10
: 0x60
Max Intl
MSG Min Us
Margin(dB/10) : 20
: 4000
Minimum Snr
Maximum Snr Margin(dB/10) : 20
PSD MoD Enable
: Enable
PsdMod FallBackEnable
PSD(dB/10)
: -38
: PSDFallbackEnable Max Nom
Max Nom AtpPsd(dB/10)
: 125
Adaptation
: fixed
Min INP
Rate
: Inp0
Upstream PSD Mask :
-----------------------[ 0]
0
Output Fields
274
FIELD
Description
IfName
The ADSL line interface name, whose profile is
to be modified or viewed
Rate Adaptation
Defines what form of transmit rate adaptation is
configured on this modem. Refer to ADSL
Forum TR-005 for more information.
Target Snr
Margin(dB/10)
Configured Target Signal/Noise Margin. This is
the Noise Margin the modem must achieve with
a BER of 10 to the power -7, or better, to
successfully complete initialization.
Max Snr Mgn(dB/10)
Configured Maximum acceptable Signal/Noise
Margin. If the Noise Margin is above this, the
modem hould attempt to reduce its power output
to optimize its operation.
GsRsIntCorrectionUp
Sets the correction time for the upstream
interleaved buffer. RS can also be disabled.
Dnshift
SnrMargin(dB/10)
Configured Signal/Noise Margin for rate
downshift. If the noise margin falls below this
level, the modem should attempt to decrease its
transmit rate. In the case that RADSL mode is
not present, the value will be 0.
Upshift
SnrMargin(dB/10)
Configured Signal/Noise Margin for rate upshift.
If the noise margin rises above this level, the
modem should attempt to increase its transmit
rate. In thecase that RADSL is not present, the
value will be 0.
Min Upshift Time(sec)
Minimum time that the current margin is above
UpshiftSnrMgn before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
275
Min Dnshift Time(sec)
Minimum time that the current margin is above
UpshiftSnrMgn before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
Fast Min Tx Rate(bps)
Configured Minimum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and refer to ATU-R
transmit rate for ATU-C receive rates.
Intl Min Tx Rate(bps)
Configured Minimum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and refer to ATU-R
transmit rate for ATU-C receive rates.
Fast Max Tx Rate(bps)
Configured Maximum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and ATU-R transmit
rate for ATU-C receive rates.
Intl Max Tx Rate(bps)
Configured Maximum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAtucConfRateChanRatio' for information
regarding RADSL mode and ATU-R transmit
rate for ATU-C receive rates.
Max Intl Delay(ms)
Configured maximum Interleave Delay for this
channel. Interleave delay applies only to the
interleave channel and defines the mapping
(relative spacing) between subsequent input
bytes at the interleaver input and their placement
in the bit stream at the interleaver output. Larger
numbers provide greater separation between
consecutive input bytes in the output bit stream,
allowing for improved impulse noise immunity at
the expense of payload latency.
GsTxStartBin
The lowest bin number allowed for Tx signal.
GsTxEndBin
The highest bin number allowed for Tx signal.
GsRxStartBin
The lowest bin number allowed for Rx signal.
GsRxEndBin
The highest bin number allowed for Rx signal.
GsMaxBitsPerBin
The maximum Rx number of bits per bin.
GsMaxDCo
Maximum interleaving depth supported by the
customer's hardware
GsRxBinAdjust
This parameter employs Rx Start/End bin
settings
GsAdi2x
For non-standard compliant ADI CPE
GsInitiate
Specifies which end initiates startup. It is also
used to send a C-tone to the remote unit.
GsTxPowerAtten
The value in dB of Tx power attenuation
GsCodingGain
Sets the coding gain in dB increments
GsRsFastOvrhdDown
This parameter sets the percentage overhead
for the downstream fast buffer. RS can also be
disabled.
GsRsIntCorrectionDow
n
This parameter sets the correction time for the
downstream interleaved buffer.RS can also be
disabled.
GsRsFastOvrhdUp
This parameter sets the percentage overhead
for the upstream fast buffer.RS can also be
disabled.
276
GsDrStby
This parameter provides the ability to disable
power to the line driver
GsExpandedExchange
T1.413 parameter that Enables/Disables EES
GsEscapeFastRetrain
This parameter enables/disables escape to the
fast retrain capability
GsFastRetrain
This parameter enables/disables the fast retrain
capability. Currently supported only in G.lite
mode.
GsBitSwap
This parameter enables/disables bit swapping
GsNtr
This parameter enables/disables NTR on a per
chip basis
GsAlctlUsVer
For T1.413 demo purposes only
GsUseCustomBin
This parameter enables/disables user selection
which of the 511 bins will be enabled for
upstream and downstream transmission.
GsFullRetrain
Indicates enable/disable of auto retrain capability
GsPsdMaskType
This parameter selects the PSD mask option to
be used
GsEraseProfiles
This parameter enables/disables the ability to
erase all fast retrain profiles at startup
GsExtRsMemory
Indicates whether customer's Hardware uses
external RS RAM
ParamHybridLossTestS
tart
Start bin for range of bins to be measured. The
default value mentioned is an indicative value
only, for exact value refer to document number
DO-400523-AN and DO-401163-AN.
GsParamHybridLossTe
stEnd
GsDmtTrellis
End bin for range of bins to be measured.
This parameter enables/disables trellis coding.
Trellis coding should always be enabled for its
clear performance advantage.
GslTriggerMode
The type of event that triggers a fast retrain
Type
This object is used to configure the ADSL
physical line mode.
GsDnBinUsage
'1' in bit position indicates usage of
corresponding bin,whereas a '0' disables usage
of corresponding bin.
ParametricTestInputFil
e
Indicates Name of the Input file from which to
take the Mask Array Size, lower and upper mask
Array. Null string means no file is specified
Data Boost
Conexant parameter that enables/disables
DataBoost option.
Upstream PSD
Conexant parameter that sets the upstream
PSD to be either extended or standard. Used for
GSpan Plus only.
Conf PM Mode
PM-related parameter used by the ATU-C to set
the allowed link states. Both bit values can be
given simultaneously in the input. Additional
value to disable pmmode is disable, which is
equal to 0.
Conf PML0 Time(sec)
PM configuration parameter, related to the L2
low power state. This parameter represents the
minimum time (in seconds) between an exit from
the L2 state and the next entry into the L2 state.
It ranges from 0 to 255 seconds.
277
Conf PML2 Time(sec)
PM configuration parameter, related to the L2
low power state. This parameter represents the
minimum time (in seconds) between an Entry
into the L2 state and the first Power Trim in the
L2 state and between two consecutive Power
Trims in the L2 State. It ranges from 0 to 255
seconds.
Conf PML2 ATPR
(dB/10)
PM configuration parameter, related to the L2
low power state. This parameter represents the
maximum aggregate transmit power reduction
(in dB) that can be performed through a single
Power Trim in the L2 state. It ranges from 0
dB/10 to 310 dB/10.
Conf PML2 Min
Rate(bps)
PM configuration parameter, related to the L2
low power state. This parameter specifies the
minimum net data rate during the low power
state (L2). The data rate is coded in bit/s, and
can range from 0x1F40 (8000) bps to 0xFA000
(1024000) bps.
MSG Min Ds
Configures downstream overhead channel
bandwidth. This feature is not supported by
DSLPHY as yet.
Min Snr Mrg(dB/10)
Atuc Configured Minimum Signal/Noise Margin.
This is the Noise Margin, the modem must
achieve with a BER of 10 to the power -7 or
better, to successfully complete initialization.
The default value mentioned is an indicative
value only.
FrontEnd H/W Design
Front end hardware reference design
H/W Pwr Reduction
Hardware configuration parameter
GsUsBitSwap
This parameter enables/disables upstream bit
swapping
Minimum INP
Parameter used to specify the minimum impulse
noise protection for the downstream bearer
channel.
PML2 Entry Thresh
Rate
PML2 Exit Thresh Rate
PM config param. L2 state entry data rate.
PML2 Entry Rate Min
Time
CabinetHsEnable
PM config param.Min L2 entry rate time
GsSeltLoopType
Conexant parameter that is used to specify the
loop type for SELT. The default value mentioned
is an indicative value only.
GsRxStartBinU1
Conexant parameter that specifies lowest bin
number allowed for Rx signal in G.Span Plus
SUQ mode. By selecting the receive start and
end bin numbers, the user can limit the bins for
special configurations.(length = 4 bytes)
GsRxEndBinU1
Conexant parameter that specifies highest bin
number allowed for Rx signal in G.Span Plus
SUQ mode. By selecting the receive start and
end bin numbers, the user can limit the bins for
special configurations.(length = 4 bytes)
PSD MoD Enable
Conexant parameter that is used to configure
the switching point between DBM-OL and
XOL.(length = 4 bytes)
PsdMod
FallBackEnable
Conexant parameter used to enable Mask on
Demand (MoD) fallback mode. When enabled,
PM config param. L2 state exit data rate.
Enable/Disable HS tones in Cabinet mode
the system chooses MoD or the base ADSL2
depending upon the downstream rate. It is
avaiable only for ADSL2 Annex A.(length = 4
bytes)
278
Max Nom PSD(dB/10)
This parameter specifies the maximum nominal
transmit PSD(MAXNOMPSD) level during
initialization and showtime. Value depends on
CO MIB element settings and near end
transmitter capabilities and is exchanged in the
G.994.1 Phase. It is available only for
ADSL2/ADSL2plus. Value ranges from -60 to 40 in steps of 0.1 dBm/Hz.(length = 4 bytes)
Max Nom
AtpPsd(dB/10)
This parameter specifies the maximum nominal
aggregate transmit power(MAXNOMATP) level
during initialization and showtime. Value
depends on CO MIB element settings and local
capabilities and is exchanged in the G.994.1
Phase. It is available only for
ADSL2/ADSL2plus. Value ranges from 0 to 25.5
in steps of 0.1 dBm.(length = 4 bytes)
DS PSD Mask
This configuration parameter defines that the
downstream PSD mask applicable at the U-C2
reference point. This MIB PSD mask may
impose PSD restrictions in addition to the Limit
PSD mask defined in the relevant
Recommendation (e.g., G.992.5). (length = 4
bytes).
GsAnnexCOlToCxSwitc
h
Conexant parameter that is used to configure
the switching point between DBM-OL and
XOL.(length = 4 bytes)
GsAnnexCSwitch
Conexant parameter that is used to configure
the switching point between Annex C and
G.Span (IFM) and between Annex C and
G.Span Plus.(length = 4 bytes)
GsAnnexCToUqSwitch
Conexant parameter that is used to configure
the switching point between Annex C and
G.Span Plus SUQ.(length = 4 bytes)
Min SnrMgnTime(sec)
This parameter indicates the time when the snr
margin violation is allowed. After this time
expires and current snr is less than min snr, the
DSL line is dropped by the APIs.
Customer ID
This parameter indicates the customer ID.
GsMPsdMaskType
Conexant parameter that selects the PSD mask
option to be used for Adsl2M.
GsSeltLoopGauge
This parameter should be set to the expected
loop gauge.
Rate Ratio
This parameter specifies the latency rate for
both channels in a dual latency configuration.
This parameter must be set the parameter to a
value greater than 0 and less than 100.
Target Snr
Margin(dB/10)
Noise Margin the modem must achieve with a
BER of 10 to the power 7 or better to
successfully complete initialization
Dnshift
SnrMargin(dB/10)
Configured Signal/ Noise Margin for rate
downshift. If the noise margin falls below this
level, the modem should attempt to decrease its
transmit rate. In the case that RADSL mode is
not present, the value will be 0.
Upshift
SnrMargin(dB/10)
Configured Signal/ Noise Margin for rate upshift.
If the noise margin rises above this level, the
modem should attempt to increase itís transmit
rate. In the case that RADSL is not present, the
value will be 0.
279
Min Upshift Time(sec)
Minimum time that the current margin is above
UpshiftSnrMgn, before an upshift occurs. In the
case that RADSL is not present, the value will be
0.
Min Dnshift Time(sec)
Minimum time that the current margin is below
DownshiftSnrMgn, before a downshift occurs. In
the case that RADSL mode is not present, the
value will be 0.
Fast Min Tx Rate(bps)
Configured Minimum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and ATU-C transmit
rate for ATU-R receive rates.
Intl Min Tx Rate(bps)
Configured Minimum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATUR receive rates.
Fast Max Tx Rate(bps)
Configured Maximum Transmit rate for 'Fast'
channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATUR receive rates.
Intl Max Tx Rate(bps)
Configured Maximum Transmit rate for
'Interleave' channels, in bps. Also refer to
'adslAturConfRateChanRatio' for information
regarding RADSL mode and to ATU-C transmit
rate for ATU-R receive rates.
Max Intl Delay(ms)
Configured maximum Interleave Delay for this
channel. Interleave delay applies only to the
interleave channel and defines the mapping
(relative spacing) between subsequent input
bytes at the interleaver input and their placement
in the bit stream at the interleaver output. Larger
numbers provide greater separation between
consecutive input bytes in the output bit stream,
allowing for improved impulse noise immunity at
the expense of payload latency
MSG Min Us
Configures upstream overhead channel
bandwidth.This feature is not supported by
DSLPHY as yet.
Minimum Snr
Margin(dB/10)
Atuc Configured Minimum Signal/Noise Margin.
This is the Noise Margin, the modem must
achieve with a BER of 10 to the power -7 or
better, to successfully complete initialization.
The default value mentioned is an indicative
value only.
Maximum Snr
Margin(dB/10)
Configured Maximum acceptable downstream
Signal/Noise Margin. If the Noise Margin is
above this the modem attempts to reduce its
power output to optimize its operation. The value
set by the user is in dB/10, and ranges from 0 to
31 dB in 1 dB steps.
PSD MoD Enable
Conexant parameter used to enable the Mask
on Demand(MoD) feature in the upstream
direction. It is available only for ADSL2 Annex A
ONLY.(length = 4 bytes)
PsdMod
FallBackEnable
Conexant parameter used to enable Mask on
Demand (MoD) fallback mode. When enabled,
the system chooses MoD or the base ADSL2
depending upon the upstream rate. It is avaiable
only for ADSL2 Annex A.(length = 4 bytes)
Max Nom PSD(dB/10)
This parameter specifies the maximum nominal
transmit PSD(MAXNOMPSD) level during
initialization and showtime. Value depends on
CO MIB element settings and near end
transmitter capabilities and is exchanged in the
G.994.1 Phase. It is available only for
ADSL2/ADSL2plus. Value ranges from -60 to 38 in steps of 0.1 dBm/Hz.(length = 4 bytes)
Max Nom
AtpPsd(dB/10)
This parameter specifies the maximum nominal
aggregate transmit power(MAXNOMATP) level
during initialization and showtime. Value
depends on CO MIB element settings and local
capabilities and is exchanged in the G.994.1
Phase. It is available only for
ADSL2/ADSL2plus. Value ranges from 0 to 25.5
in steps of 0.1 dBm.(length = 4 bytes)
Rate Adaptation
Defines what form of transmit rate adaptation is
configured on this modem. The default value
mentioned is an indicative value only.
Min INP
Parameter used to specify the minimum impulse
noise protection for the upstream bearer
channel. Supported for ADSL2/ADSL2plus
ONLY
US PSD Mask
This configuration parameter defines that the
upstream PSD mask applicable at the U C2
reference point. This MIB PSD mask may
impose PSD restrictions in addition to the Limit
PSD mask defined in the relevant
Recommendation (e.g., G.992.5). It is available
only for Annexes J and M of
ADSL2/ADSL2plus.(length = 4 bytes)
References
• ADSL Commands
8.9.24
Dsl chip Commands
8.9.24.1
Get dsl chip
Description: Use this command to get.
Command Syntax: get dsl chip [chipid <chipid-val>]
8.9.24.2
Create dsl chip
Description: Use this command to get.
Command Syntax: create dsl chip chipid <chipid-val> [ dsltype
Adsl | Sdsl | Shdsl | Vdsl ] [ linecoding Other | Dmt | Cap | Qam | Mcm
| Scm ] [ adsltxcfg ansit1413 | etsi | q9921PotsNonOverlapped |
q9921PotsOverlapped | q9921IsdnNonOverlapped |
q9921IsdnOverlapped | q9921TcmIsdnNonOverlapped |
q9921TcmIsdnOverlapped | q9922PotsNonOverlapped |
q9922PotsOverlapped | q9922TcmIsdnNonOverlapped |
q9922TcmIsdnOverlapped | q9921TcmIsdnSymmetric |
adslPlusPotsNonOverlapped | q9921GspanPlusPotsNonOverlapped |
q9921GspanPlusPotsOverlapped | q9923Adsl2PotsOverlapped |
q9923Adsl2PotsNonOverlapped | q9925Adsl2PlusPotsOverlapped |
q9925Adsl2PlusPotsNonOverlapped | q9923Readsl2PotsOverlapped |
q9923Readsl2PotsNonOverlapped | adslPlusPotsOverlapped |
q9921GspanPlusPlusPotsNonOverlapped |
q9921GspanPlusPlusPotsOverlapped | q9923IsdnNonOverlapped |
q9923IsdnOverlapped | q9925IsdnNonOverlapped |
q9925IsdnOverlapped | q9923AnnexMPotsExtUsNonOverlapped |
q9923AnnexMPotsExtUsOverlapped |
280
q9925AnnexMPotsExtUsNonOverlapped |
q9925AnnexMPotsExtUsOverlapped ] [ shdsltxmode Region1 |
Region2 ]
8.9.24.3
Delete dsl chip
Description: Use this command to get.
Command Syntax: delet dsl chip chipid <chipid-val>
Parameters
Name
Description
chipid <chipid-val>
Identifies the chip to be build and initialized.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 9
dsltype Adsl | Sdsl |
Shdsl | Vdsl
Identifies the firmware to be downloaded.
Type: Create -- Optional
linecoding Other | Dmt
| Cap | Qam | Mcm |
Scm
adsltxcfg ansit1413 |
etsi |
q9921PotsNonOverlap
ped |
q9921PotsOverlapped |
q9921IsdnNonOverlapp
ed |
q9921IsdnOverlapped |
q9921TcmIsdnNonOver
lapped |
q9921TcmIsdnOverlap
ped |
q9922PotsNonOverlap
ped |
q9922PotsOverlapped |
q9922TcmIsdnNonOver
lapped |
q9922TcmIsdnOverlap
ped |
q9921TcmIsdnSymmetr
ic |
adslPlusPotsNonOverla
pped |
q9921GspanPlusPotsN
onOverlapped |
q9921GspanPlusPotsO
verlapped |
q9923Adsl2PotsOverla
pped |
q9923Adsl2PotsNonOv
erlapped |
q9925Adsl2PlusPotsOv
erlapped |
q9925Adsl2PlusPotsNo
nOverlapped |
q9923Readsl2PotsOver
lapped |
q9923Readsl2PotsNon
Overlapped |
adslPlusPotsOverlappe
d|
q9921GspanPlusPlusP
otsNonOverlapped |
281
ADSL line coding type. Not valid for SHDSL.
Type: Create -- Optional
Transmission capabilities with which the DSL
system is configured. Its default value depends on
the Annex Type supported. Not valid for SHDSL.
Type: Create -- Optional
q9921GspanPlusPlusP
otsOverlapped |
q9923IsdnNonOverlapp
ed |
q9923IsdnOverlapped |
q9925IsdnNonOverlapp
ed |
q9925IsdnOverlapped |
q9923AnnexMPotsExtU
sNonOverlapped |
q9923AnnexMPotsExtU
sOverlapped |
q9925AnnexMPotsExtU
sNonOverlapped |
q9925AnnexMPotsExtU
sOverlapped
shdsltxmode Region1
| Region2
Annexure Type, specifies the regional settings for
the SHDSL line. Only valid for SHDSL.
Type: Create -- Optional
Example
$ create dsl chip chipid 1 dsltype Adsl linecoding Dmt adsltxcfg
ansit1413 q9921PotsOverlapped q9921PotsNonOverlapped
shdsltxmode region1 Region2
Output
Verbose Mode On
Entry Created
Chip Id
: 1
DSL Type
: Adsl
Line coding
: Dmt
Adsl Tx Config : ansit1413 q9921PotsOverlapped
q9921PotsNonOverlapped
Shdsl Tx Mode
: region1 Region2
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Chip Id
Identifies the chip to be build and initialized.
DSL Type
Identifies the firmware to be downloaded.
Line coding
ADSL line coding type. Not valid for SHDSL.
Adsl Tx Config
Transmission capabilities with which the DSL
system is configured. Its default value depends on
the Annex Type supported. Not valid for SHDSL.
Shdsl Tx Mode
Annexure Type, specifies the regional settings for
the SHDSL line. Only valid for SHDSL.
8.9.25
Dsl dsp chip Commands
8.9.25.1
Get dsl dsp chip
Description: Use this command to get.
Command Syntax: get dsl dsp chip [chipid <chipid-val>]
8.9.25.2
Reset dsl dsp chip
Description: Use this command to get.
Command Syntax: reset dsl dsp chip
282
Parameters
Name
Description
chipid chipid
This object is the Index of Dsl Chip for which reset
is to be done.
Type: Reset -- Mandatory
Get -- Optional
Valid values: 1 - 9
Example
$ get dsl dsp chip chipid 1
Output
ChipId
----------------------------------------------------------------------1
Output Fields
FIELD
Description
ChipId
This object is the Index of Dsl Chip for which reset
is to be done.
8.9.26
Dsl dsp port Commands
8.9.26.1
Get dsl dsp port
Description: Use this command to get.
Command Syntax: get dsl dsp port [ifname <interface-name>]
8.9.26.2
Reset dsl dsp port
Description: Use this command to get.
Command Syntax: reset dsl dsp port ifname <interface-name>
Parameters
Name
Description
ifname <interfacename>
This object is the Index of Dsl Port for which reset
is to be done.
Type: Reset -- Mandatory
Get -- Optional
Valid values: dsl-0 – dsl-23
Example
$ get dsl dsp port ifname dsl-0
Output
Ifname
----------------------------------------------------------------------dsl-0
Output Fields
283
FIELD
Description
Ifname
This object is the Index of Dsl Port for which reset
is to be done.
8.9.27
Dsl system Commands
8.9.27.1
Get dsl system
Description: Use this command to get.
Command Syntax: get dsl system
8.9.27.2
Create dsl system
Description: Use this command to create.
Command Syntax: create dsl system [dsltype Adsl | Sdsl | Shdsl |
Vdsl] [linecoding Other | Dmt | Cap | Qam | Mcm | Scm] [adsltxcfg
ansit1413 | etsi | q9921PotsNonOverlapped | q9921PotsOverlapped |
q9921IsdnNonOverlapped | q9921IsdnOverlapped |
q9921TcmIsdnNonOverlapped | q9921TcmIsdnOverlapped |
q9922PotsNonOverlapped | q9922PotsOverlapped |
q9922TcmIsdnNonOverlapped | q9922TcmIsdnOverlapped |
q9921TcmIsdnSymmetric | adslPlusPotsNonOverlapped |
q9921GspanPlusPotsNonOverlapped |
q9921GspanPlusPotsOverlapped | q9923Adsl2PotsOverlapped |
q9923Adsl2PotsNonOverlapped | q9925Adsl2PlusPotsOverlapped |
q9925Adsl2PlusPotsNonOverlapped | q9923Readsl2PotsOverlapped |
q9923Readsl2PotsNonOverlapped | adslPlusPotsOverlapped |
q9921GspanPlusPlusPotsNonOverlapped |
q9921GspanPlusPlusPotsOverlapped | q9923IsdnNonOverlapped |
q9923IsdnOverlapped | q9925IsdnNonOverlapped |
q9925IsdnOverlapped | q9923AnnexMPotsExtUsNonOverlapped |
q9923AnnexMPotsExtUsOverlapped |
q9925AnnexMPotsExtUsNonOverlapped |
q9925AnnexMPotsExtUsOverlapped ] [ shdsltxmode Region1 |
Region2 ]
8.9.27.3
Delete dsl system
Description: Use this command to get.
Command Syntax: delet dsl system
Parameters
Name
Description
dsltype Adsl | Sdsl
|Shdsl | Vdsl
Identifies the firmware to be downloaded.
Type: Create - Optional
Default value: Adsl
ADSL line code type.
Type: Create - Optional
Default value: Dmt
Transmission capabilities with which the DSL
system is configured. Its default value depends on
the Annex Type supported. Not valid for SHDSL.
Type: Create - Optional
linecoding Other | Dmt
|Cap | Qam | Mcm |
Scm
adsltxcfg ansit1413 |
etsi|
q9921PotsNonOverlap
ped |
q9921PotsOverlapped
|q9921IsdnNonOverlap
ped
|q9921IsdnOverlapped
|q9921TcmIsdnNonOve
rlapped|
q9921TcmIsdnOverlap
ped |
q9922PotsNonOverlap
ped
|q9922PotsOverlapped
|q9922TcmIsdnNonOve
rlapped|
284
q9922TcmIsdnOverlap
ped |
q9921TcmIsdnSymmetr
ic
|adslPlusPotsNonOverl
apped|q9921GspanPlu
sPotsNonOverlapped
|q9921GspanPlusPots
Overlapped
|q9923Adsl2PotsOverla
pped|q9923Adsl2PotsN
onOverlapped
|q9925Adsl2PlusPotsO
verlapped
|q9925Adsl2PlusPotsN
onOverlapped
|q9923Readsl2PotsOve
rlapped
|q9923Readsl2PotsNon
Overlapped
|adslPlusPotsOverlapp
ed
|q9921GspanPlusPlusP
otsNonOverlapped
|q9921GspanPlusPlusP
otsOverlapped
|q9923IsdnNonOverlap
ped
|q9923IsdnOverlapped
|q9925IsdnNonOverlap
ped
|q9925IsdnOverlapped
|q9923AnnexMPotsExt
UsNonOverlapped
|q9923AnnexMPotsExt
UsOverlapped
|q9925AnnexMPotsExt
UsNonOverlapped
|q9925AnnexMPotsExt
UsOverlapped
shdsltxmode Region1
|Region2
Annexure Type specifies the regional settings for
the SHDSL line. Only valid for SHDSL.
Type: Create - Optional
Default value: Region1 |Region2
Example
$ create dsl system dsltype Adsl linecoding Dmt adsltxcfg ansit1413
shdsltxmode region1 Region2
Output
Verbose Mode On
Entry Created
DSL Type
: Adsl
Line coding
: Dmt
Adsl Tx Config : ansit1413
Shdsl Tx Mode
: region1 Region2
Verbose Mode Off:
Entry Created
Output Fields
285
FIELD
Description
DSL Type
Identifies the firmware to be downloaded.
Line coding
Adsl Tx Config
ADSL line code type.
Transmission capabilities with which the DSL
system is configured. Its default value depends on
the Annex Type supported. Not valid for SHDSL.
Annexure Type specifies the regional settings for
the SHDSL line. Only valid for SHDSL.
Shdsl Tx Mode
8.9.28
Shdsl cap Commands
8.9.28.1
Get shdsl cap
Description: Use this command to get.
Command Syntax: get shdsl cap
Example
$ get shdsl cap
Output
Tx Cap: Region1
Output field
Field
Description
Tx Cap
Annexure Type, specifies the regional settings for
the SHDSL line.
8.9.29
Shdsl endpoint alarmprofile Commands
8.9.29.1
Get shdsl endpoint alarmprofile
Description: Use this command to get.
Command Syntax: get shdsl endpoint alarmprofile [ifname
<interface-name]
8.9.29.2
Modify shdsl endpoint alarmprofile
Description: Use this command to modify.
Command Syntax: modify shdsl endpoint alarmprofile ifname
<interface-name> [ threshloopattn <threshloopattn-val> ]
[ threshsnrmargin <threshsnrmargin-val> ] [ threshes <threshes-val> ]
[ threshses <threshses-val> ] [ threshcrcanom <threshcrcanom-val> ]
[ threshlosws <threshlosws-val> ] [ threshuas <threshuas-val> ]
Parameters
Name
Description
ifname <interfacename>
Name of the end point alarm configuration profile.
Type: Modify -- Mandatory
Get -- Optional
threshloopattn
<threshloopattn-val>
This object configures the loop attenuation alarm
threshold.The only range supported is 1 to 127.
Type: Modify -- Optional
Valid values: (-127) - 128
threshsnrmargin
<threshsnrmarginval>
This object configures the SNR margin alarm
threshold.The only range supported is 0 to 15.
Type: Modify -- Optional
Valid values: (-127) - 128
286
threshes <threshesval>
This object configures the threshold for the number
of errored seconds (ES) within any given 15-minute
performance data collection interval.
Type: Modify -- Optional
Valid values: 0 - 900
threshses
<threshses-val>
This object configures the threshold for the number
of severely errored seconds (SES) within any given
15-minute performance data collection interval.
Type: Modify -- Optional
Valid values: 0 - 900
threshcrcanom
<threshcrcanomval>
This object configures the threshold for the number
of CRC anomalies within any given 15-minute
performance data collection interval.
Type: Modify -- Optional
Valid values: 0 - 0xFFFFFFFF
threshlosws
<threshlosws-val>
This object configures the threshold for the number
of Loss of Sync Word (LOSW) Seconds within any
given 15-minute performance data collection interval.
Type: Modify -- Optional
Valid values: 0 - 900
threshuas
<threshuas-val>
This object configures the threshold for the number
of unavailable seconds (UAS) within any given 15minute performance data collection interval.
Type: Modify -- Optional
Valid values: 0 - 900
Example
$ get shdsl endpoint alarmprofile ifname dsl-0
Output
IfName
: dsl-0
ThreshLoopAttn : 10
ThreshSNRMrgn : 10
ThreshES
: 2
ThreshSES
: 10
ThreshCRCAnom
: 10
ThreshLOSWS
: 10
ThreshUAS
: 10
Output field
287
Field
Description
IfName
Name of the end point alarm configuration profile.
ThreshLoopAttn
This object configures the loop attenuation alarm
threshold.The only range supported is 1 to 127.
ThreshSNRMrgn
This object configures the SNR margin alarm
threshold.The only range supported is 0 to 15.
ThreshES
This object configures the threshold for the number
of errored seconds (ES) within any given 15-minute
performance data collection interval.
ThreshSES
This object configures the threshold for the number
of severely errored seconds (SES) within any given
15-minute performance data collection interval.
ThreshCRCAnom
This object configures the threshold for the number
of CRC anomalies within any given 15-minute
performance data collection interval.
ThreshLOSWS
This object configures the threshold for the number
of Loss of Sync Word (LOSW) Seconds within any
given 15-minute performance data collection
interval.
ThreshUAS
This object configures the threshold for the number
of unavailable seconds (UAS) within any given 15minute performance data collection interval.
References
• DSL Commands
8.9.30
Shdsl endpoint currentry Commands
8.9.30.1
Get shdsl endpoint currentry
Description: Use this command to get.
Command Syntax: get shdsl endpoint currentry [ifname <interfacename>] [ unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8 ] [ side network | customer ] [ wirepair one | two ]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port
Type: Get -- Optional
Valid values: 5 - 28
unitid stuc | stur |
sru1 | sru2 | sru3 |
sru4 | sru5 | sru6 |
sru7 | sru8
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If the
unitid is 'stuc' then side index can't take the value
'Network', and if the unitid is 'stur' then side index
can't take the value 'Customer'.
Type: Get -- Optional
side network |
customer
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side facing
the Customer is the Customer side. If the endpoint
side is 'network' then unitid can't have the value
'stuc', and if the endpoint side is 'customer' then
unitid can't have the value 'stur'.
Type: Get -- Optional
wirepair one | two
This is the referenced pair of wires in an SHDSL
Segment.
Type: Get -- Optional
Example
$ get shdsl endpoint currentry ifname dsl-0 unitid stuc side customer
wirepair one
Output
288
IfName
: dsl-0
Unit Index
: stuc
EndPointSide
: customer
EndPointWirePair
: one
Curr Attenuation
: 10
Curr SNRMargin
: 6
Curr Status
: LoopbackActive NoDefect
Curr ES
: 12
Curr SES
: 22
Curr CRCAnom
: 11
Curr LOSWS
: 8
Curr UAS
: 12
Curr 15minTimeElapsed : 10
Curr 15minES
: 16
Curr 15minSES
: 15
Curr 15minCRCAnom : 14
Curr 15minLOSWS
: 11
Curr 15minUAS
: 11
Curr 1DayTimeElapsed
: 2500
Curr 1DayES
: 12
Curr 1DaySES
: 1
Curr 1DayCRCAnom
: 18
Curr 1DayLOSWS
: 20
Curr 1DayUAS
: 9
Output field
289
Field
Description
IfName
The interface name of the DSL Port
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then
side index can't take the value 'Customer'.
EndPointSide
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side
facing the Customer is the Customer side. If the
endpoint side is 'network' then unitid can't have
the value 'stuc', and if the endpoint side is
'customer' then unitid can't have the value 'stur'.
EndPointWirePair
This is the referenced pair of wires in an SHDSL
Segment.
Curr Attenuation
The current loop attenuation for this endpoint as
reported in a Network or Customer Side
Performance Status message.The only range
supported is 1 to 127.
Curr SNRMargin
The current SNR margin for this endpoint as
reported in a Status Response/SNR
message.The only range supported is 0 to 15.
Curr Status
Contains the current state of this endpoint.
Curr ES
Count of Errored Seconds (ES) on this endpoint
since the xU was last restarted.
Curr SES
Count of Severely Errored Seconds (SES) on
this endpoint since the xU was last restarted.
Curr CRCAnom
Count of CRC anomalies on this endpoint since
the xU was last restarted.
Curr LOSWS
Count of Loss of Sync Word (LOSW) Seconds
on this endpoint since the xU was last restarted.
Curr UAS
Count of Unavailable Seconds (UAS) on this
endpoint since the xU was last restarted.
Curr
15minTimeElapsed
Total elapsed seconds in the current 15-minute
interval.
Curr 15minES
Count of Errored Seconds (ES) in the current
15-minute interval.
Curr 15minSES
Count of Severely Errored Seconds (SES) in the
current 15-minute interval.
Curr 15minCRCAnom
Count of CRC anomalies in the current 15minute interval.
Curr 15minLOSWS
Count of Loss of Sync Word (LOSW) Seconds in
the current 15-minute interval.
Curr 15minUAS
Count of Unavailable Seconds (UAS) in the
current 15-minute Interval.
Curr 1DayTimeElapsed
Number of seconds that have elapsed since the
beginning of the current 1-day interval.
Curr 1DayES
Count of Errored Seconds (ES) in the current 1Day interval.
Curr 1DaySES
Count of Severely Errored Seconds (SES) in the
current 1-Day interval.
Curr 1DayCRCAnom
Count of CRC anomalies in the current 1-Day
interval.
Curr 1DayLOSWS
Count of Loss of Sync Word (LOSW) Seconds in
the current 1-Day interval.
Curr 1DayUAS
Count of Unavailable Seconds (UAS) in the
current 1-Day Interval.
References
• DSL Commands
8.9.31
Shdsl endpoint maint Commands
8.9.31.1
Get shdsl endpoint maint
Description: Use this command to get.
Command Syntax: get shdsl endpoint maint [ifname <interfacename>] [unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8] [side network | customer]
8.9.32
Modify shdsl endpoint maint
Description: Use this command to modify.
Command Syntax: modify shdsl endpoint maint ifname <interfacename> unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8 side network | customer [loopbackconfig NoLoopback |
NormalLoopback | SpecialLoopback | DigitalLoopback |
AnalogLoopback | InterfaceLoopback | LocalFramerLoopback |
NormalLoopbackEocId9 | SpecialLoopbackEocId9] [powerbackoff
Default | Enhanced | Disable] [softrestart Ready | Restart]
Parameters
Name
Description
ifname <interface-name>
The interface name of the DSL Port.
Type: Modify -- Mandatory
Get -- Optional
Valid values: 5 - 28
unitid stuc | stur | sru1 |
sru2 | sru3 | sru4 | sru5 |
sru6 | sru7 | sru8
This is the unique identification for all units in
an SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC.
If the unitid is 'stuc' then side index can't take
the value 'Network', and if the unitid is 'stur'
then side index can't take the value 'Customer'.
Type: Modify -- Mandatory
Get -- Optional
side network | customer
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side
facing the Customer is the Customer side. If
the endpoint side is 'network' then unitid can't
have the value 'stuc', and if the endpoint side is
'customer' then unitid can't have the value
'stur'.
Type: Modify -- Mandatory
Get -- Optional
290
loopbackconfig
NoLoopback |
NormalLoopback |
SpecialLoopback |
DigitalLoopback |
AnalogLoopback |
InterfaceLoopback |
LocalFramerLoopback |
NormalLoopbackEocId9 |
SpecialLoopbackEocId9
powerbackoff Default |
Enhanced | Disable
This object controls configuration of loopbacks
for the associated segment endpoint.
Additional values are DigitalLoopback,
AnalogLoopback, InterfaceLoopback and
LocalFramerLoopback.
Type: Modify -- Optional
This object configures the receiver at the
associated segment endpoint to operate in
default or enhanced power backoff mode.
Enhanced power backoff is not supported for
CO. Additional value supported is Disable.
Type: Modify -- Optional
softrestart Ready |
Restart
This object enables the manager to trigger a
soft restart of the modem at the associated
segment endpoint. Value 'Restart' is NOT
supported at CP side.
Type: Modify -- Optional
Example
$ get shdsl endpoint maint ifname dsl-0 unitid stuc side customer
Output
IfName
stuc
: dsl-0
Unit Index
EndPointSide
NoLoopback
: customer
Loopback Config :
Tip Ring Reversal : Normal
Disable
Soft Restart
Power Backoff
:
:
: Ready
Output field
291
Field
Description
IfName
The interface name of the DSL Port.
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then side
index can't take the value 'Customer'.
EndPointSide
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side facing
the Customer is the Customer side. If the endpoint
side is 'network' then unitid can't have the value
'stuc', and if the endpoint side is 'customer' then
unitid can't have the value 'stur'.
Loopback Config
This object controls configuration of loopbacks for
the associated segment endpoint. Additional
values are DigitalLoopback, AnalogLoopback,
InterfaceLoopback and LocalFramerLoopback.
Tip Ring Reversal
This object indicates the state of the tip/ring pair at
the associated segment endpoint. This object is
supported for CO only.
Power Backoff
This object configures the receiver at the
associated segment endpoint to operate in default
or enhanced power backoff mode. Enhanced
power backoff is not supported for CO. Additional
value supported is Disable.
Soft Restart
This object enables the manager to trigger a soft
restart of the modem at the associated segment
endpoint. Value 'Restart' is NOT supported at CP
side.
References
• ADSL Commands
8.9.33
Shdsl interval 15min Commands
8.9.33.1
Get shdsl interval 15min
Description: Use this command to get.
Command Syntax: get shdsl interval 15min ifname <interfacename> [unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8] [side network | customer] [wirepair one | two] [intrvlnumber
intrvlnumber]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port
Type: Get -- Mandatory
Valid values: 5 - 28
unitid stuc | stur | sru1
| sru2 | sru3 | sru4 |
sru5 | sru6 | sru7 | sru8
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then side
index can't take the value 'Customer'.
Type: Get -- Optional
side network |
customer
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side facing
the Customer is the Customer side. If the endpoint
side is 'network' then unitid can't have the value
'stuc', and if the endpoint side is 'customer' then
unitid can't have the value 'stur'.
Type: Get -- Optional
wirepair one | two
This is the referenced pair of wires in an SHDSL
Segment.
Type: Get -- Optional
intrvlnumber
intrvlnumber
Performance Data Interval number. 1 is the most
recent previous interval. In the current
implementation, only 1 value is supported.
Type: Get -- Optional
Valid values: 1 - 96
Example
$ get shdsl interval 15min ifname dsl-0 unitid stuc side customer
wirepair one intrvlnumber 1
Output
Ifname
: dsl-0
Unit Index
EndPointSide
: customer
EndPointWirePair : one
IntervalNumber : 1
ES Count
: 22
SES Count
: 15
CRC AnomCount
: 12
LOSWS Count
: 16
UAS Count
: 5
Output field
292
: stuc
Field
Description
Ifname
The interface name of the DSL Port
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then
side index can't take the value 'Customer'.
EndPointSide
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side
facing the Customer is the Customer side. If the
endpoint side is 'network' then unitid can't have
the value 'stuc', and if the endpoint side is
'customer' then unitid can't have the value 'stur'.
EndPointWirePair
This is the referenced pair of wires in an SHDSL
Segment.
IntervalNumber
Performance Data Interval number. 1 is the most
recent previous interval. In the current
implementation, only 1 value is supported.
ES Count
Count of Errored Seconds (ES) during the
interval.
SES Count
Count of Severely Errored Seconds (SES)
during the interval.
CRC AnomCount
Count of CRC anomalies during the interval.
LOSWS Count
Count of Loss of Sync Word (LOSW) Seconds
during the interval.
UAS Count
Count of Unavailable Seconds (UAS) during the
interval.
References
• ADSL Commands
8.9.34
Shdsl interval 1day Commands
8.9.34.1
Get shdsl interval 1day
Description: Use this command to get.
Command Syntax: get shdsl interval 1day ifname <interface-name>
[unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 | sru8]
[side network | customer] [wirepair one | two] [intrvlnumber
intrvlnumber]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port
Type: Get -- Mandatory
Valid values: 5 - 28
unitid stuc | stur | sru1 |
sru2 | sru3 | sru4 | sru5 |
sru6 | sru7 | sru8
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then
side index can't take the value 'Customer'.
Type: Get -- Optional
293
side network | customer
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side
facing the Customer is the Customer side. If the
endpoint side is 'network' then unitid can't have
the value 'stuc', and if the endpoint side is
'customer' then unitid can't have the value 'stur'.
Type: Get -- Optional
wirepair one | two
This is the referenced pair of wires in an SHDSL
Segment.
Type: Get -- Optional
intrvlnumber
intrvlnumber
Performance Data Interval number. 1 is the most
recent previous interval. In the current
implementation, only 1 value is supported.
Type: Get -- Optional
Valid values: 1 - 30
Example
$ get shdsl interval 1day ifname dsl-0 unitid stuc side customer wirepair
one intrvlnumber 1
Output
Ifname
: dsl-0
Unit Index
EndPointSide
: customer
EndPointWirePair : one
: stuc
Interval Number : 1
MonitoredSecs
: 200
ES Count
: 12
SES Count
: 11
CRC Anom
: 12
LOSWS Count
: 10
UAS Count
: 8
Output field
294
Field
Description
Ifname
The interface name of the DSL Port
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC. If
the unitid is 'stuc' then side index can't take the
value 'Network', and if the unitid is 'stur' then
side index can't take the value 'Customer'.
EndPointSide
This is the referenced side of an SHDSL unit Network or Customer side. The side facing the
Network is the Network side, while the side
facing the Customer is the Customer side. If the
endpoint side is 'network' then unitid can't have
the value 'stuc', and if the endpoint side is
'customer' then unitid can't have the value 'stur'.
EndPointWirePair
This is the referenced pair of wires in an SHDSL
Segment.
Interval Number
Performance Data Interval number. 1 is the most
recent previous interval. In the current
implementation, only 1 value is supported.
MonitoredSecs
The amount of time in the 1-day interval over
which the performance monitoring information is
actually counted.
ES Count
Count of Errored Seconds (ES) during the
interval.
SES Count
Count of Severely Errored Seconds (SES)
during the interval.
CRC Anom
Count of CRC anomalies during the interval.
LOSWS Count
Count of Loss of Sync Word (LOSW) Seconds
during the interval.
UAS Count
Count of Unavailable Seconds (UAS) during the
interval.
References
• ADSL Commands
8.9.35
Shdsl line intf Commands
8.9.35.1
Get shdsl line intf
Description: Use this command to get.
Command Syntax: get shdsl line intf [ifname <interface-name>]
8.9.35.2
Modify shdsl line intf
Description: Use this command to modify.
Command Syntax: modify shdsl line intf ifname <interface-name>
[ action StartUp | AbortReq | GearShiftReq | DownloadReq |
BertStartTxReq | BertStartRxReq | BertStopReq | HybridLossTestReq |
SpectrumDownReq | SpectrumUpReq | SpectrumTxRxReq |
ResidualEchoReq | TotalEchoReq | NextPsdReq | AutoRetrainOnReq |
AutoRetrainOffReq | PropEocOnReq | PropEocOffReq |
RmtAtmCellStatusReq | RmtFullStatusReq ] [ mode Co | Cpe ]
[ powerscale DefaultScale ] [ encodecoeffa Default ] [ encodecoeffb
Default ] [ txeocbufferlen 5 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55
| 60 ] [ rxeocbufferlen 5 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 |
60 ] [ ntr Disable | RefClkIp8k | RefClkOp4096k ] [ rxupstrmfrmsync
<rxupstrmfrmsync-val> ] [ rxdwnstrmfrmsync <rxdwnstrmfrmsyncval> ] [ rxupstrmstuffbits <rxupstrmstuffbits-val> ]
[ rxdwnstrmstuffbits <rxdwnstrmstuffbits-val> ] [ initiate default | co |
cpe ] [ frmrrxclkmode Slave | Internal ] [ frmrrxpllmode Disable |
Enable ] [ serialatmciubuffsz 24 | 53 ] [ txfrmrpulsedelay 0 | 1 | 2 | 3 |
4 | 5 | 6 | 7 ] [ rxfrmrpulsedelay 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 ]
[ multifrmmode Enable | Disable ] [ 4_6mbpsbitrate Disable | Enable ]
[ tomdata1 <tomdata1-val> ] [ tomdata2 <tomdata2-val> ] [ tomdata3
<tomdata3-val> ] [ tomdata4 <tomdata4-val> ] [ setreqsilencemode
Enable | Disable ] [ individualrates1 <individualrates1-val> ]
[ individualrates2 <individualrates2-val> ] [ individualrates3
<individualrates3-val> ] [ atmcelldelineation Disable | Enable ]
[ frmrcelldroponerr Enable | Disable ] [ gearshifttype 0 | 1 ] [ hsnsf
Disable | Enable ] [ hsmaxbitsperbaud default | 2bits | 1bits ]
[ hscustid <hscustid-val> ] [ hscustdata0 <hscustdata0-val> ]
[ hscustdata1 <hscustdata1-val> ] [ hsannexbtype Default | Anfp |
AnnexbOrAnfp ] [ autoretrain disable | enable ] [ arcrcchk disable |
enable ] [ arfrmrsynchk disable | enable ] [ arsnrmarginchk disable |
enable ] [ arcrcthresh <arcrcthresh-val> ] [ arsnrmarginthresh 1 | 2 |
3 | 4 | 5 | 6 ] [ artime 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 ] [ opstatetrap
enable | disable ] [ txfrmrdataclkedge Negative | Positive ]
[ rxfrmrdataclkedge Negative | Positive ] [ txfrmrpulseclkedge
Negative | Positive ] [ rxfrmrpulseclkedge Negative | Positive ]
[ txfrmrpulselvl Low | High ] [ rxfrmrpulselvl Low | High ] [ frmroh
<frmroh-val> ] [ latrapenable enable | disable ] [ snrmgntrapenable
enable | disable ] [ frmrohtrapenable enable | disable ]
[ gsparamtestinputfile <gsparamtestinputfile-val> ]
[ paramhybridlossteststart <paramhybridlossteststart-val> ]
[ paramhybridlosstestend <paramhybridlosstestend-val> ] [ pammode
16Tc | 32Tc | AutoTc ] [ enable | disable ]
Parameters
295
Name
Description
ifname <interface-name>
The interface name of the DSL Port.
Type: Modify -- Mandatory
Get -- Optional
Valid values: 5 - 28
action StartUp | AbortReq
| GearShiftReq |
DownloadReq |
BertStartTxReq |
BertStartRxReq |
BertStopReq |
HybridLossTestReq |
SpectrumDownReq |
SpectrumUpReq |
SpectrumTxRxReq |
ResidualEchoReq |
TotalEchoReq |
NextPsdReq |
AutoRetrainOnReq |
AutoRetrainOffReq |
PropEocOnReq |
PropEocOffReq |
RmtAtmCellStatusReq |
RmtFullStatusReq
mode Co | Cpe
This object specifies actions that are used to
control transceiver operation, including abort,
startup and tests.
Type: Modify -- Optional
This object specifies the operational mode of
the transceiver.
Type: Modify -- Optional
powerscale DefaultScale
This object is used to compensate for minor
differences in transmit power between
designs.
Type: Modify -- Optional
encodecoeffa Default
This object determines the value of encoder
coefficient A, as defined in ITU-T G.991.2.
Type: Modify -- Optional
encodecoeffb Default
This object determines the value of encoder
coefficient B, as defined in ITU-T G.991.2.
Type: Modify -- Optional
txeocbufferlen 5 | 10 | 15
| 20 | 25 | 30 | 35 | 40 | 45 |
50 | 55 | 60
This object determines the number of bytes of
EOC data that is buffered by the DSP in the
transmit direction.
Type: Modify -- Optional
rxeocbufferlen 5 | 10 | 15
| 20 | 25 | 30 | 35 | 40 | 45 |
50 | 55 | 60
This object determines the number of bytes of
EOC data that is buffered by the DSP in the
receive direction.
Type: Modify -- Optional
ntr Disable | RefClkIp8k |
RefClkOp4096k
This object defines how network-timing
recovery is performed.
Type: Modify -- Optional
rxupstrmfrmsync
<rxupstrmfrmsync-val>
Customer-defined value. This object defines
the upstream frame sync word.
Type: Modify -- Optional
rxdwnstrmfrmsync
<rxdwnstrmfrmsync-val>
This object defines the downstream frame
sync word.
Type: Modify -- Optional
296
rxupstrmstuffbits
<rxupstrmstuffbits-val>
Customer-defined value. This object defines
the upstream.
Type: Modify -- Optional
rxdwnstrmstuffbits
<rxdwnstrmstuffbits-val>
This object defines the downstream stuff bits.
Type: Modify -- Optional
initiate default | co | cpe
This object defines which STU initiates a
startup. The default is STU-R initiates and
STU-C waits.
Type: Modify -- Optional
frmrrxclkmode Slave |
Internal
This object determines the source of the
receive clock.
Type: Modify -- Optional
frmrrxpllmode Disable |
Enable
This object enables or disables the internal
PLL.
Type: Modify -- Optional
serialatmciubuffsz 24 |
53
This object enables the user to set the size of
the framer buffer for serial ATM operation.
Type: Modify -- Optional
txfrmrpulsedelay 0 | 1 | 2
|3|4|5|6|7
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
a delay of up to 7 clock cycles can be specified
for the transmit frame pulse.
Type: Modify -- Optional
rxfrmrpulsedelay 0 | 1 | 2
|3|4|5|6|7
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
a delay of up to 7 clock cycles can be specified
for the receive frame pulse.
Type: Modify -- Optional
multifrmmode Enable |
Disable
This object specifies the multi frame
operational mode of the transceiver.
Type: Modify -- Optional
4_6mbpsbitrate Disable |
Enable
This object specifies the operational state of
the 4_6Mbps bit rate.
Type: Modify -- Optional
tomdata1 <tomdata1-val>
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Type: Modify -- Optional
tomdata2 <tomdata2-val>
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Type: Modify -- Optional
tomdata3 <tomdata3-val>
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Type: Modify -- Optional
tomdata4 <tomdata4-val>
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Type: Modify -- Optional
297
setreqsilencemode
Enable | Disable
This object enables a silent mode for the STU
at the opposite end of the loop for
approximately one minute. During the silent
period, the STU that requested the silent mode
could perform whatever operations it wants
and the STU at the opposite end will remain in
handshake.
Type: Modify -- Optional
individualrates1
<individualrates1-val>
This item enables the user to individually
enable or disable base rates for N=1 through
N=16. The default is all rates enabled.
Type: Modify -- Optional
individualrates2
<individualrates2-val>
This item enables the user to individually
enable or disable base rates for N=17 through
N=32. The default is all rates enabled.
Type: Modify -- Optional
individualrates3
<individualrates3-val>
This item enables the user to individually
enable or disable base rates for N=33 through
N=36. The default is all rates enabled.
Type: Modify -- Optional
atmcelldelineation
Disable | Enable
This object enables the user to enable or
disable cell delineation for serial ATM
operation. This parameter should be set before
a startup.
Type: Modify -- Optional
frmrcelldroponerr Enable
| Disable
This object determines whether cells are
dropped, i.e., not passed to the host, or not
dropped, i.e., passed to the host. This object
must be set prior to startup.
Type: Modify -- Optional
gearshifttype 0 | 1
This object specifies the Gear Shift Type.
Type: Modify -- Optional
hsnsf Disable | Enable
This object enables or disables nonstandard
Information fields for MP, MS, CL, and CLR
messages, as defined in ITU-T G.994.1.bis.
Type: Modify -- Optional
hsmaxbitsperbaud
default | 2bits | 1bits
This object specifies the maximum bit per
baud.
Type: Modify -- Optional
hscustid <hscustid-val>
This object identifies the customer
identification during handshaking, as described
in ITU-T G.994.1.bis.
Type: Modify -- Optional
hscustdata0
<hscustdata0-val>
This object identifies two words of customer
data during handshaking, as defined in ITU-T
G.994.1.bis.
Type: Modify -- Optional
hscustdata1
<hscustdata1-val>
This object identifies two words of customer
data during handshaking, as defined in ITU-T
G.994.1.bis.
Type: Modify -- Optional
298
hsannexbtype Default |
Anfp | AnnexbOrAnfp
This object allows the customer to choose
between support for Annex B, Annex B with
Access Network Frequency Plan (ANFP), or
both.
Type: Modify -- Optional
autoretrain disable |
enable
Enables or disables auto-retrain.
Type: Modify -- Optional
arcrcchk disable | enable
Enables or disables auto-retrain based on
CRC errors.
Type: Modify -- Optional
arfrmrsynchk disable |
enable
Enables or disables auto-retrain based on
framer synchronization.
Type: Modify -- Optional
arsnrmarginchk disable |
enable
Enables or disables auto-retrain based on
whether the S/N margin falls below a preset
threshold.
Type: Modify -- Optional
arcrcthresh <arcrcthreshval>
Sets the threshold for the number of frames
with CRC errors for autoretrain.
Type: Modify -- Optional
Valid values: 0 - 0x400
arsnrmarginthresh 1 | 2 |
3|4|5|6
Set the margin threshold for autoretrain.
Type: Modify -- Optional
artime 1 | 2 | 3 | 4 | 5 | 6 |
7 | 8 | 9 | 10
Sets the time over which the autoretrain
parameters must be outside their normal
ranges, so that an auto-retrain occurs.
Type: Modify -- Optional
opstatetrap enable |
disable
Enables/disables trap indicating a change in
op state.
Type: Modify -- Optional
txfrmrdataclkedge
Negative | Positive
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
transmit data can be sampled upon either
rising or falling edge of the transmit clock.
Type: Modify -- Optional
rxfrmrdataclkedge
Negative | Positive
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
receive data can be valid upon either rising or
falling edge of the receive clock.
Type: Modify -- Optional
txfrmrpulseclkedge
Negative | Positive
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
the transmit frame pulse can be active upon
either rising or falling edge.
Type: Modify -- Optional
rxfrmrpulseclkedge
Negative | Positive
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
the transmit frame pulse can be active upon
either rising or falling edge.
Type: Modify -- Optional
299
txfrmrpulselvl Low | High
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
the transmit frame pulse can be either active
high (1) or active low (0).
Type: Modify -- Optional
rxfrmrpulselvl Low | High
This parameter is for Serial ATM applications
only. It is recommended that the default value
be used. For special customer configurations,
the transmit frame pulse can be either active
high (1) or active low (0).
Type: Modify -- Optional
frmroh <frmroh-val>
This parameter is used to set the overhead
bits at startup or by using the command
GS_SHDSL_TX_FRAMER_OH_REQ during
data mode.
Type: Modify -- Optional
Valid values: 0 - 0xFFFF
latrapenable enable |
disable
This Parameter enables or disables the Trap
for Loop Attenuation Threshold crossing.
Type: Modify -- Optional
snrmgntrapenable enable
| disable
This Parameter enables or disables the Trap
for SNR Margin Threshold crossing.
Type: Modify -- Optional
frmrohtrapenable enable
| disable
This Parameter enables or disables the Trap
for Framer Overhead and Defects.
Type: Modify -- Optional
gsparamtestinputfile
<gsparamtestinputfile-val>
Indicates Name of the Input file from which to
take the Mask Array Size, lower and upper
mask Array. Null string means no file is
specified.
Type: Modify -- Optional
paramhybridlossteststart
<paramhybridlossteststartval>
Start bin for range of bins to be measured. The
default value mentioned is an indicative value
only.
Type: Modify -- Optional
Valid values: 0x0 - 0xff
paramhybridlosstestend
<paramhybridlosstestendval>
End bin for range of bins to be measured. The
default value mentioned is an indicative value
only.
Type: Modify -- Optional
Valid values: 0x0 - 0xff
pammode 16Tc | 32Tc |
AutoTc
This parameter is used to configure the PAM
mode value for startup.
Type: Modify -- Optional
enable | disable
Administrative status of the interface.
Type: Create -- Optional
Modify -- Optional
Valid values: enable, disable
Default value: enable
Example
$ get shdsl line intf ifname dsl-0
300
Output
IfName
StartUp
: dsl-0
Action
:
Mode
DefaultScale
: Co
PowerScale
:
Frmr Type
Saturn
: unframed
AFE Type
:
Encode CoeffA
Default
: Default
Encode CoeffB
:
TxEOCBufferLen
5
: 5
RxEOCBufferLen
:
NTR
0x359f
: Disable
RxUSFrameSync
:
RxDSFrameSync
0x0f
: 0x359f
RxUSStuffBits
:
RxDSStuffBits
default
: 0x0f
Initiate
:
FrmRxClkMode
Disable
: Slave
FrmrRxPllMode
:
SrlAtmCiuBuffSize
10
: 53
UL2TxAddr
:
UL2RxAddr
5
: 10
TxFrmrPulseDelay
:
RxFrmrPulseDelay
Enable
: 5
Multi Frame Mode
:
4_6Mbps Bit Rate
0x00000000
: Enable
Tom Data Word1
:
Tom Data Word2
0x00000000
: 0x00000000
Tom Data Word3
:
Tom Data Word4
Enable
: 0x00000000
ReqSilenceMode
:
Individual Rates1
0xffff
: 0xffff
Individual Rates2
:
IndividualRates3
Disable
: 0x000f
SrlAtmCellDelineation :
FrmrCellDropOnErr
1
: Disable
Gear Shift Type
:
Hs Nsf
default
: Disable
Hs Max Bits Per Baud
:
Hs Customer Id
0
: 0
Hs Customer Data0
:
Hs Customer Data1
Default
: 0
Hs AnnexB Type
:
Auto Retrain
disable
: disable
AR CRCChk
:
AR FrmrSyncChk
disable
: disable
AR SNRMarginChk
:
AR CRCThresh
1
: 1
AR SNRMrgnThresh(dB)
:
AR Time (sec)
enable
: 3
Op State Trap
:
Tx FrmrDataClkEdge
Positive
: Negative
Rx FrmrDataClkEdge
:
Tx FrmrPulseClkEdge
Negative
: Negative
RxFrmrPulseClk
:
Tx Frmr Pulse Level
High
: High
Rx Frmr Pulse Level
:
Frmr OH
:
Utopia Data Bus Width : Tx16Rx16
0x0f
301
LoopAttenTrap
: enable
SNRMarginTrap
: enable
FrmrOH-DefectsTrap
: enable
ParamTestInputFile
: TestFile
ParamHybrdLossTstStrt : 0x10
0x23
PamMode
: 16Tc
Oper Status
Enable
: Up
ParamHybrdLossTstEnd
:
Admin Status
:
Output field
302
Field
Description
IfName
The interface name of the DSL Port.
Action
This object specifies actions that are used to
control transceiver operation, including abort,
startup and tests.
Mode
This object specifies the operational mode of the
transceiver.
PowerScale
This object is used to compensate for minor
differences in transmit power between designs.
Frmr Type
This object defines which type of data interface
type is used. Note that the non-default values
only apply to Conexant chips that support serial
interfaces.
AFE Type
This object defines which AFE is being used.
Encode CoeffA
This object determines the value of encoder
coefficient A, as defined in ITU-T G.991.2.
Encode CoeffB
This object determines the value of encoder
coefficient B, as defined in ITU-T G.991.2.
TxEOCBufferLen
This object determines the number of bytes of
EOC data that is buffered by the DSP in the
transmit direction.
RxEOCBufferLen
This object determines the number of bytes of
EOC data that is buffered by the DSP in the
receive direction.
NTR
This object defines how network-timing recovery
is performed.
RxUSFrameSync
Customer-defined value. This object defines the
upstream frame sync word.
RxDSFrameSync
This object defines the downstream frame sync
word.
RxUSStuffBits
Customer-defined value. This object defines the
upstream.
RxDSStuffBits
This object defines the downstream stuff bits.
Initiate
This object defines which STU initiates a startup.
The default is STU-R initiates and STU-C waits.
FrmRxClkMode
This object determines the source of the receive
clock.
FrmrRxPllMode
This object enables or disables the internal PLL.
SrlAtmCiuBuffSize
This object enables the user to set the size of
the framer buffer for serial ATM operation.
UL2TxAddr
This object selects the appropriate UTOPIA
Level 2 address for the transmit interface.
UL2RxAddr
This object selects the appropriate UTOPIA
Level 2 address for the receive interface.
303
TxFrmrPulseDelay
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, a
delay of up to 7 clock cycles can be specified for
the transmit frame pulse.
RxFrmrPulseDelay
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, a
delay of up to 7 clock cycles can be specified for
the receive frame pulse.
Multi Frame Mode
This object specifies the multi frame operational
mode of the transceiver.
4_6Mbps Bit Rate
This object specifies the operational state of the
4_6Mbps bit rate.
Tom Data Word1
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Tom Data Word2
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Tom Data Word3
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
Tom Data Word4
This object identifies one of four words of
proprietary vendor data, as described in the
Vendor Data section of ITU-T G.994.1.bis.
ReqSilenceMode
This object enables a silent mode for the STU at
the opposite end of the loop for approximately
one minute. During the silent period, the STU
that requested the silent mode could perform
whatever operations it wants and the STU at the
opposite end will remain in handshake.
Individual Rates1
This item enables the user to individually enable
or disable base rates for N=1 through N=16. The
default is all rates enabled.
Individual Rates2
This item enables the user to individually enable
or disable base rates for N=17 through N=32.
The default is all rates enabled.
IndividualRates3
This item enables the user to individually enable
or disable base rates for N=33 through N=36.
The default is all rates enabled.
SrlAtmCellDelineation
This object enables the user to enable or disable
cell delineation for serial ATM operation. This
parameter should be set before a startup.
FrmrCellDropOnErr
This object determines whether cells are
dropped, i.e., not passed to the host, or not
dropped, i.e., passed to the host. This object
must be set prior to startup.
Gear Shift Type
This object specifies the Gear Shift Type.
Hs Nsf
This object enables or disables nonstandard
Information fields for MP, MS, CL, and CLR
messages, as defined in ITU-T G.994.1.bis.
Hs Max Bits Per Baud
This object specifies the maximum bit per baud.
Hs Customer Id
This object identifies the customer identification
during handshaking, as described in ITU-T
G.994.1.bis.
Hs Customer Data0
This object identifies two words of customer data
during handshaking, as defined in ITU-T
G.994.1.bis.
304
Hs Customer Data1
This object identifies two words of customer data
during handshaking, as defined in ITU-T
G.994.1.bis.
Hs AnnexB Type
This object allows the customer to choose
between support for Annex B, Annex B with
Access Network Frequency Plan (ANFP), or
both.
Auto Retrain
Enables or disables auto-retrain.
AR CRCChk
Enables or disables auto-retrain based on CRC
errors.
AR FrmrSyncChk
Enables or disables auto-retrain based on
framer synchronization.
AR SNRMarginChk
Enables or disables auto-retrain based on
whether the S/N margin falls below a preset
threshold.
AR CRCThresh
Sets the threshold for the number of frames with
CRC errors for autoretrain.
AR
SNRMrgnThresh(dB)
AR Time (sec)
Set the margin threshold for autoretrain.
Op State Trap
Enables/disables trap indicating a change in op
state.
Tx FrmrDataClkEdge
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations,
transmit data can be sampled upon either rising
or falling edge of the transmit clock.
Rx FrmrDataClkEdge
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations,
receive data can be valid upon either rising or
falling edge of the receive clock.
Tx FrmrPulseClkEdge
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, the
transmit frame pulse can be active upon either
rising or falling edge.
RxFrmrPulseClk
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, the
transmit frame pulse can be active upon either
rising or falling edge.
Tx Frmr Pulse Level
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, the
transmit frame pulse can be either active high
(1) or active low (0).
Rx Frmr Pulse Level
This parameter is for Serial ATM applications
only. It is recommended that the default value be
used. For special customer configurations, the
transmit frame pulse can be either active high
(1) or active low (0).
Utopia Data Bus Width
This parameter is used to specify width of
UTOPIA data bus.
Frmr OH
This parameter is used to set the overhead bits
at startup or by using the command
Sets the time over which the autoretrain
parameters must be outside their normal ranges,
so that an auto-retrain occurs.
GS_SHDSL_TX_FRAMER_OH_REQ during
data mode.
LoopAttenTrap
This Parameter enables or disables the Trap for
Loop Attenuation Threshold crossing.
SNRMarginTrap
This Parameter enables or disables the Trap for
SNR Margin Threshold crossing.
FrmrOH-DefectsTrap
This Parameter enables or disables the Trap for
Framer Overhead and Defects.
ParamTestInputFile
Indicates Name of the Input file from which to
take the Mask Array Size, lower and upper mask
Array. Null string means no file is specified.
ParamHybrdLossTstStr
t
Start bin for range of bins to be measured. The
default value mentioned is an indicative value
only.
ParamHybrdLossTstEn
d
End bin for range of bins to be measured. The
default value mentioned is an indicative value
only.
PamMode
This parameter is used to configure the PAM
mode value for startup.
Oper Status
The actual/current state of the interface. It can
be either up or down.
Admin Status
The desired state of the interface. It may be
either Up or Down.
References
• ADSL Commands
8.9.36
Shdsl line status Commands
8.9.36.1
Get shdsl line status
Description: Use this command to get.
Command Syntax: get shdsl line status [ifname <interface-name>]
Parameters
Name
Description
Ifname <interfacename>
The interface name of the DSL Port.
Type: Get -- Optional
Valid values: 5 - 28
Example
$ get shdsl line status ifname dsl-0
Output
IfName
Start Progress
Unswapped
FwRelease
Rem CountryCode
RemEncoderA
RemProviderCode
Loc Detect
Tx Power
InSync
RemTomData
RecvGain
OutOfSync
305
: dsl-0
: PreActivation
:
:
:
:
:
:
E250
USA
366
GSPN
21
75
: 0
: 12
Op State
Line Swap
: Data
:
RemEncoderB
: 817
FrmrSync
:
Drift Alarm
Bert Error
: 34816
:
RemFwVer
:
InSync
UtopiaRxCellCnt
:
UtopiaRxHECErrCnt :
RemNsfCusId
:
RemPowerBackoff
:
Eoc State
:
Absent
ParamTestResult
:
Startup Info
:
------------[0 ]
24
FrmrOH-Defects
-------------[0 ]
30768
LocalHS
------[0 ]
30768
0
0
0
[8 ]
0
0
0
0
[16]
0
0
0
0
[24]
0
RemoteHS
-------[0 ]
30768
0
1
0
[8 ]
3
0
1
0
[16]
0
0
0
0
[24]
15
ActualHS
-------[0 ]
30768
0
3
0
[8 ]
3
0
2
0
[16]
0
0
0
0
[24]
0
Frmr1SecCnt
----------[0 ]
30768
ParamInfo
--------[0 ]
0
[4 ]
0
[8 ]
0
[12]
0
[16]
0
[20]
0
[24]
0
[28]
0
[32]
0
[36]
0
[40]
0
[44]
0
[48]
0
[52]
0
[56]
0
[60]
0
306
0025
Utopia CD
:
0
8
23
Enable
Online
UtopiaCellDropCnt
UtopiaTxCellCnt
RemTxPower
AutoRetrainCnt
Ntr Fault
:
:
:
:
:
Pass
Bis
Last failed Status : 1
10
220
0
3
0
0
0
12336
70
0
0
17990
17990
17990
17990
0
0
0
3
0
0
0
1
17990
17990
17990
17990
0
2
0
0
0
1
0
1
17990
17990
17990
17990
0
20
0
20
0
0
0
0
0
0
0
70
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
[64]
[68]
[72]
[76]
[80]
[84]
[88]
[92]
[96]
[100]
[104]
[108]
[112]
[116]
[120]
[124]
[128]
[132]
[136]
[140]
[144]
[148]
[152]
[156]
[160]
[164]
[168]
[172]
[176]
[180]
[184]
[188]
[192]
[196]
[200]
[204]
[208]
[212]
[216]
[220]
[224]
[228]
[232]
[236]
[240]
[244]
[248]
[252]
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
BisModeLocalHS
------------------[0 ]
30768
0
0
0
[8 ]
0
0
0
0
[16]
0
0
0
0
[24]
0
0
0
0
[32]
0
0
0
0
307
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
17990
17990
17990
17990
0
0
0
3
0
0
0
1
0
0
0
0
0
0
0
0
[40]
0
[48]
0
0
0
0
0
0
0
0
17990
17990
17990
17990
0
2
0
0
0
1
0
1
0
0
0
0
0
0
0
0
0
0
0
0
17990
17990
17990
17990
0
20
0
20
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
BisModeRemoteHS
-------------------[0 ]
30768
0
1
0
[8 ]
3
0
1
0
[16]
0
0
0
0
[24]
0
0
0
0
[32]
0
0
0
0
[40]
0
0
0
0
[48]
0
BisModeActualHS
-------------------[0 ]
30768
0
3
0
[8 ]
3
0
2
0
[16]
0
0
0
0
[24]
0
0
0
0
[32]
0
0
0
0
[40]
0
0
0
0
[48]
0
0
0
Output field
308
Field
Description
IfName
The interface name of the DSL Port.
Op State
This object identifies the high level operational
state for the STU.
Start Progress
This object identifies the current detailed
operational state of the STU.
Line Swap
This object indicates if the physical lines are
swapped, i.e., logical channel A is connected to
physical channel B. This applies to 4-wire
operation only.
FwRelease
Transceiver firmware release number.
Rem CountryCode
This object provides the country code word, as
defined in ITU-T G.991.2, for the STU at the
other end of the loop. GlobespanVirata sets this
to USA.
RemEncoderA
This object identifies the 21-bit value
corresponding to encoder coefficient A, as
defined in ITU-T G.991.2, for the STU at the
other end of the loop.
RemEncoderB
This object identifies the 21-bit value
corresponding to encoder coefficient B, as
defined in ITU-T G.991.2, for the STU at the
other end of the loop.
309
RemProviderCode
This object identifies the provider code word, as
defined in ITU-T G.991.2, for the STU at the
other end of the loop.
Loc Detect
This object is used to determine if carrier has
been lost.
Tx Power
This object identifies the local STU transmit
power in tenths of a dBm.
FrmrSync
This object returns information regarding the
framer synchronization status.
RemTomData
This object provides vendor-provided data, as
defined in ITU-T G.991.2, for the STU at the
other end of the loop.
Drift Alarm
This object identifies if the receive clock is in or
out of range.
RecvGain
This object provides the total receiver gain in
dB.
Bert Error
This object provides the count of bit errors since
the last time the object was read, as well as the
type of synchronization.
RemFwVer
This object provides the transceiver firmware
release number of the STU at the other end of
the loop.
Utopia CD
This object indicates whether cell delineation
has been found.
UtopiaRxCellCnt
This object indicates the number of UTOPIA
cells received since the last time the object has
been called. The maximum value is 0xFFFF.
UtopiaCellDropCnt
This object indicates the number of UTOPIA
cells dropped since the last time the object has
been called. The maximum value is 0xFF.
UtopiaRxHECErrCnt
This object indicates the number of UTOPIA
cells with HEC errors since the last time the
object has been called. The maximum value is
0xFF.
UtopiaTxCellCnt
This object indicates the number of UTOPIA
cells transmitted since the last time the object
has been called. The maximum value is 0xFFFF.
RemNsfCusId
This object returns the customer identification
that was sent by the STU at the other end of the
loop.
RemTxPower
This object provides the transmit power of the
STU at the other end of the loop.
RemPowerBackoff
This object indicates whether power backoff is
enabled or disabled at the STU at the other end
of the loop.
AutoRetrainCnt
This object indicates the number of automatic
retrains. This counter is only reset when a
startup is initiated.
Eoc State
This object provides status information about
the eoc stage.
Ntr Fault
This object identifies the Network Timing
Recovery Fault.
ParamTestResult
Indicates the Result of the Parametric Test
conducted on the Xcvr.
Last failed Status
Conexant parameter that indicates the last failed
status.
Startup Info
This conexant parameter indicates the startup
mode, whether the lines comes up in bis mode
or legacy mode (non bis).
RemNsfCusData
This object returns non-standard format
customer data that was sent by the STU at the
other end of the loop.
FrmrOH-Defects
This object returns overhead data. The four
least significant bits contain the overhead data in
the following format: bit 0 is losd, bit 1 is sega,
bit 2 is ps, and bit 3 is segd.
LocalHS
This object provides a way to see what
capabilities are supported by the local STU. A
total of 26 handshake parameters are supported.
RemoteHS
This object provides a way to see what
capabilities are supported by the STU at the
other end of the loop. A total of 26 handshake
parameters are supported.
ActualHS
This object provides the results of capabilities
exchanged during handshake. A total of 26
handshake parameters are supported.
Frmr1SecCnt
This object provides CRC, SEGA, and LOSW
defect one second error counts, and should be
called every second.
ParamInfo
Conexant parameter that indicates the
Parametric Test Array.
BisModeLocalHS
This conexant parameter provides a way to see
what rates are supported by the local STU in the
form of tuples.
BisModeRemoteHS
This conexant parameter provides a way to see
what rates are supported by the STU at other
end of the loop in the form of tuples.
BisModeActualHS
This conexant parametetr provides the results of
rates exchanged during handshake in the form
of tuples.
References
• DSL Commands
8.9.37
Shdsl span conf Commands
8.9.37.1
Get shdsl span conf
Description: Use this command to get.
Command Syntax: get shdsl span conf [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port
Type: Get -- Optional
Valid values:5 - 28
Example
$ get shdsl span conf ifname dsl-0
Output
IfName
310
: dsl-0
Repeaters : 0
SpanConfProfile : dsl-0
AlarmProfile
: dsl-0
Output field
Field
Description
IfName
The interface name of the DSL Port
Repeaters
This object provisions the number of
repeaters/regenerators in the HDSL2/SHDSL
Span. This Parameter is currently NOT
supported and only value it can have is 0,
deviation from standard RFC.
SpanConfProfile
This object is a pointer to 'ifname' (span
configuration profile) in the 'shdsl span
confprofile' command, which applies to this
span. The value of this object is the index of the
referenced profile in the 'shdsl span confprofile'
command. This parameter is RO because
dynamic profiles are not supported right now and
only value supported is DEFVAL, deviation from
standard RFC.
AlarmProfile
This object is a pointer to 'ifname' (Alarm
configuration profile) in the 'shdsl endpoint
alarmprofile' command. This parameter is RO
because dynamic profiles are not supported right
now and only value supported is DEFVAL,
deviation from standard RFC.
References
• DSL Commands
8.9.38
Shdsl span confprofile Commands
8.9.38.1
Get shdsl span confprofile
Description: Use this command to get.
Command Syntax: get shdsl span confprofile [ifname <interfacename>]
8.9.38.2
Modify shdsl span confprofile
Description: Use this command to modify.
Command Syntax: modify shdsl span confprofile ifname
<interface-name> [ wireintf TwoWire | FourWire |
FourWireBitInterleave | FourWireByteInterleaveEnhanced |
FourWireBitInterleaveEnhanced ] [ minlinerate <minlinerate-val> ]
[ maxlinerate <maxlinerate-val> ] [ psd Symmetric | Asymmetric |
R1asymmetric | R2asymmetric ] [ txmode Region1 | Region2 ]
[ rmtenabled Enabled | Disabled ] [ currcondtgtmgndown
<currcondtgtmgndown> ] [ worstcasetgtmgndown
<worstcasetgtmgndown> ] [ currcondtgtmgnup <currcondtgtmgnupval> ] [ worstcasetgtmgnup <worstcasetgtmgnup> ] [ usedtgtmgns
CurrentCondDown | WorstCaseDown | CurrentCondUp | WorstCaseUp ]
[ lineprobe Disable | Enable ]
Parameters
Name
311
Description
ifname <interfacename>
Name of the span configuration profile.
Type: Modify -- Mandatory
Get -- Optional
wireintf TwoWire |
FourWire |
FourWireBitInterleave |
FourWireByteInterleaveE
nhanced |
FourWireBitInterleaveEn
hanced
minlinerate
<minlinerate-val>
This object configures the two-wire or optional
four-wire operation for SHDSL Lines.
FourWireBitInterleave are extensions over
standard RFC.
Type: Modify -- Optional
This object configures the minimum transmission
rate for the associated SHDSL Line in bits-persecond (bps). If the 'minlinerate' equals the
'maxlinerate', the line rate is considered 'fixed'. If
the 'minlinerate' is less than the 'maxlinerate',
the line rate is considered 'rate-adaptive'.
Type: Modify -- Optional
maxlinerate
<maxlinerate-val>
This object configures the maximum
transmission rate for the associated SHDSL Line
in bits-per-second (bps). If the 'minlinerate'
equals the 'maxlinerate', the line rate is
considered 'fixed'. If the 'minlinerate' is less than
the 'maxlinerate', the line rate is considered
'rate-adaptive'.
Type: Modify -- Optional
psd Symmetric |
Asymmetric |
R1asymmetric |
R2asymmetric
This object configures use of
symmetric/asymmetric PSD (PowerSpectral
Density) Mask for the associated SHDSL Line.
Type: Modify -- Optional
txmode Region1 |
Region2
This object specifies the regional setting for the
SHDSL line.
Type: Modify -- Optional
rmtenabled Enabled |
Disabled
This object enables/disables support for remote
management of the units in an SHDSL line from
the STU-R via the EOC. Default value supported
is the deviation from standard RFC.
Type: Modify -- Optional
currcondtgtmgndown
<currcondtgtmgndownval>
This object specifies the downstream current
condition target SNR margin for an SHDSL line.
The Only range supported is 0 to 10. Default
value supported is also deviation from standard
RFC.
Type: Modify -- Optional
Valid values: 0 - 10
worstcasetgtmgndown
<worstcasetgtmgndownval>
This object specifies the downstream worst case
target SNR margin for an SHDSL line. The Only
range supported is -10 to 10. Default value
supported is also deviation from standard RFC.
Type: Modify -- Optional
Valid values: (-10) - 10
currcondtgtmgnup
<currcondtgtmgnup-val>
This object specifies the upstream current
condition target SNR margin for an SHDSL line.
The Only range supported is 0 to 10. Default
value supported is also deviation from standard
RFC.
Type: Modify -- Optional
Valid values: 0 - 10
312
worstcasetgtmgnup
<worstcasetgtmgnupval>
This object specifies the upstream worst case
target SNR margin for an SHDSL line. The Only
range supported is -10 to 10. Default value
supported is also deviation from standard RFC.
Type: Modify -- Optional
Valid values: (-10) - 10
usedtgtmgns
CurrentCondDown |
WorstCaseDown |
CurrentCondUp |
WorstCaseUp
lineprobe Disable |
Enable
Indicates whether a target SNR margin is
enabled or disabled. This is a bit-map of
possible settings.
Type: Modify -- Optional
This object enables/disables support for Line
Probe of the units in an SHDSL line. When Line
Probe is enabled, the system performs Line
Probing to find the best possible rate. If Line
probe is disabled, the rate adaptation phase is
skipped to shorten set up time.
Type: Modify -- Optional
Example
$ get shdsl span confprofile ifname dsl-0
Output
IfName
: dsl-0
Wire Interface
: TwoWire
Min Line Rate
: 1552000
Max Line Rate
: 1552000
PSD
: Symmetric
Remote Enabled
: Disabled
Power Feeding
: NoPower
CurrTrgtMrgnDown : 6
WorstTrgtMrgnDown : 8
CurrTrgtMrgnUp
: 5
WorstTrgtMrgnUp
RefClock
: LocalClock
Line Probe
: Disable
TxMode
: Region1 Region2
UsedTrgtMrgns
: CurrentCondDown WorstCaseDown
: 7
Output field
313
Field
Description
IfName
Name of the span configuration profile.
Wire Interface
This object configures the two-wire or optional
four-wire operation for SHDSL Lines.
FourWireBitInterleave are extensions over
standard RFC.
Min Line Rate
This object configures the minimum transmission
rate for the associated SHDSL Line in bits-persecond (bps). If the 'minlinerate' equals the
'maxlinerate', the line rate is considered 'fixed'. If
the 'minlinerate' is less than the 'maxlinerate', the
line rate is considered 'rate-adaptive'.
Max Line Rate
This object configures the maximum transmission
rate for the associated SHDSL Line in bits-persecond (bps). If the 'minlinerate' equals the
'maxlinerate', the line rate is considered 'fixed'. If
the 'minlinerate' is less than the 'maxlinerate', the
line rate is considered 'rate-adaptive'.
PSD
This object configures use of
symmetric/asymmetric PSD (PowerSpectral
Density) Mask for the associated SHDSL Line.
Remote Enabled
This object enables/disables support for remote
management of the units in an SHDSL line from
the STU-R via the EOC. Default value supported
is the deviation from standard RFC.
Power Feeding
This object enables/disables support for optional
powerfeeding in an SHDSL line. This is NONModifiable Parameter, only default value is
supported. This is the deviation from standard
RFC.
CurrTrgtMrgnDown
This object specifies the downstream current
condition target SNR margin for an SHDSL line.
The Only range supported is 0 to 10. Default value
supported is also deviation from standard RFC.
WorstTrgtMrgnDown
This object specifies the downstream worst case
target SNR margin for an SHDSL line. The Only
range supported is -10 to 10. Default value
supported is also deviation from standard RFC.
CurrTrgtMrgnUp
This object specifies the upstream current
condition target SNR margin for an SHDSL line.
The Only range supported is 0 to 10. Default value
supported is also deviation from standard RFC.
WorstTrgtMrgnUp
This object specifies the upstream worst case
target SNR margin for an SHDSL line. The Only
range supported is -10 to 10. Default value
supported is also deviation from standard RFC.
RefClock
This object configures the clock reference for the
STU-Cin an SHDSL Line. This is a NONModifiable parameter. Only default value is
supported, deviation from standard RFC.
Line Probe
This object enables/disables support for Line
Probe of the units in an SHDSL line. When Line
Probe is enabled, the system performs Line
Probing to find the best possible rate. If Line probe
is disabled, the rate adaptation phase is skipped
to shorten set up time.
TxMode
This object specifies the regional setting for the
SHDSL line.
UsedTrgtMrgns
Indicates whether a target SNR margin is enabled
or disabled. This is a bit-map of possible settings.
References
• DSL Commands
8.9.39
Shdsl span status Commands
8.9.39.1
Get shdsl span status
Description: Use this command to get.
Command Syntax: get shdsl span status [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port.
Type: Get -- Optional
Valid values: 5 - 28
Example
$ get shdsl span status ifname dsl-0
Output
IfName
314
: dsl-0
Repeaters
: 2
MaxAttainLineRate
1552000
: 2111000
ActualLineRate
:
MaxAttainPMMSLineRate : 2111000
Standard
FourWireHSMode
:
CurrentTxMode
: Region1 Region2
MaxAtnPayloadRate
1544000
: 2103000
ActualPayloadRate :
Output field
Field
Description
IfName
The interface name of the DSL Port.
Repeaters
Contains the actual number of
repeaters/regenerators discovered in this
HDSL2/SHDSL span.
MaxAttainLineRate
This object provides the maximum rate the line
is capable of achieving.
ActualLineRate
Contains the actual line rate in this
HDSL2/SHDSL span. This should equal
ifSpeed.
MaxAttainPMMSLineRate
Contains the maximum achievable line rate in
PMMS of this SHDSL span.
FourWireHSMode
Contains the 4 wire handshake mode.
CurrentTxMode
Contains the current Power Spectral Density
(PSD) regional setting of the HDSL2/SHDSL
span.
MaxAtnPayloadRate
This conexant parameter contains the
maximum attainable payload rate in this
SHDSL span. This is based upon
measurements made during line probing
without including any framing overhead
ActualPayloadRate
This conexant parameter contains the actual
payload rate in this SHDSL span. This is
based upon measurements made during line
probing without including any framing
overhead.
References
• DSL Commands
8.9.40
Shdsl unit inventory Commands
8.9.40.1
Get shdsl unit inventory
Description: Use this command to get.
Command Syntax: get shdsl unit inventory [ifname <interfacename>] [unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8]
Parameters
Name
Description
ifname <interfacename>
The interface name of the DSL Port.
Type: Get -- Optional
Valid values: 5 - 28
315
unitid stuc | stur | sru1
| sru2 | sru3 | sru4 |
sru5 | sru6 | sru7 | sru8
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC.
Type: Get -- Optional
Example
$ get shdsl unit inventory ifname dsl-0 unitid stuc
Output
IfName
: dsl-0
Vendor Id
: FFB5GSPN
Unit Index : stuc
VendorModel Num : Z3219
VendorSerialNum : <co-0123456
VendorEOCSW Ver : 250
InvenStd Ver
: 181
VendorList Num
: C252
VendorIssue Num : 6261
VendorSW Ver
: E252
Equipment Code
: CNXT-12345
InvVendor Other : CNXT-250ABCD
Output field
Field
Description
IfName
The interface name of the DSL Port.
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC.
Vendor Id
Vendor ID as reported in an Inventory Response
message.
VendorModel Num
Vendor model number as reported in an Inventory
Response message.
VendorSerialNum
Vendor serial number as reported in an Inventory
Response message.
VendorEOCSW Ver
Vendor EOC version as reported in a Discovery
Response message.
InvenStd Ver
Version of the HDSL2/SHDSL standard
implemented, as reported in an Inventory
Response message.
VendorList Num
Vendor list number as reported in an Inventory
Response message.
VendorIssue Num
Vendor issue number as reported in an Inventory
Response message.
VendorSW Ver
Vendor software version as reported in an
Inventory Response message.
Equipment Code
Equipment code conforming to ANSI T1.213,
Coded Identification of Equipment Entities.
InvVendor Other
Other vendor information as reported in an
Inventory Response message.
References
• DSL Commands
316
8.9.41
Shdsl unit maintinfo Commands
8.9.41.1
Get shdsl unit maintinfo
Description: Use this command to get.
Command Syntax: get shdsl unit maintinfo [ifname <interfacename>] [unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8]
8.9.41.2
Modify shdsl unit maintinfo
Description: Use this command to modify.
Command Syntax: modify shdsl unit maintinfo ifname<interfacename> unitid stuc | stur | sru1 | sru2 | sru3 | sru4 | sru5 | sru6 | sru7 |
sru8 [loopbacktimeout <loopbacktimeout-val>]
Parameters
Name
Description
Ifname <interfacename>
The interface name of the DSL Port
Type: Modify -- Mandatory
Get -- Optional
Valid values: 5 - 28
unitid stuc | stur | sru1
| sru2 | sru3 | sru4 |
sru5 | sru6 | sru7 | sru8
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC.
Type: Modify -- Mandatory
Get -- Optional
loopbacktimeout
<loopbacktimeout-val>
This object configures the timeout value for
loopbacks initiated at segments endpoints
contained in the associated unit. A value of 0
disables the timeout.
Type: Modify -- Optional
Valid values: 0 - 4095
Example
$ get shdsl unit maintinfo ifname dsl-0 unitid stuc
Output
IfName
: dsl-0
Loopback Timeout : 10
Unit Index
: stuc
Power Source : Local
Output field
Field
Description
IfName
The interface name of the DSL Port
Unit Index
This is the unique identification for all units in an
SHDSL Span. It is based on the EOC unit
addressing scheme with reference to the xtuC.
Loopback Timeout
This object configures the timeout value for
loopbacks initiated at segments endpoints
contained in the associated unit. A value of 0
disables the timeout.
Power Source
This object indicates the DC power source being
used by the associated unit.This parameter is
NOT supported.
References
317
• DSL Commands
318
8.10
EHDLC Commands
8.10.1
Ehdlc intf Commands
8.10.1.1
Get ehdlc intf
Description: Use this command to get.
Command Syntax: get ehdlc intf [ifname <interface-name>]
8.10.1.2
Create ehdlc intf
Description: Use this command to create.
Command Syntax: create ehdlc intf ifname <interface-name>lowif
<lowif-val> [sarstatus Enable | Disable] [enable | disable]
8.10.1.3
Delete ehdlc intf
Description: Use this command to delete
Command Syntax: delete ehdlc intf [ifname <interface-name>]
8.10.1.4
Modify ehdlc intf
Description: Use this command to modify
Command Syntax: modify ehdlc intf ifname <interface-name>lowif
<lowif-val> [sarstatus Enable | Disable] [enable | disable]
Parameters
Name
Description
ifname <interfacename>
This parameter specifies the name assigned to
this interface. Valid Values starts from ehdlc-0
and continues to ehdlc-*
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: IAD_MIN_EHDLC_IFINDEX IAD_MAX_EHDLC_IFINDEX
lowif<lowif-val>
This specifies the lower interface index. This is
the ifindex of the DSL port on which EHDLC is
being created. Valid Values start from dsl-0 and
continues to dsl-*
Type: Create -- Mandatory
Valid values: dsl-0 – dsl-23
sarstatus Enable |
Disable
This defines the segmentation and reassembly
status of the hdlc/dsl interface. HDLC supports
only 508 as frame size, to support longer snmp
messages, it should be turn off. By default, the
option taken is 'disable'.
Type: Create -- Optional
Modify -- Optional
Default value: disable
enable | disable
Administrative status of the Ehdlc interface
Type: Optional
Example
319
$ create ehdlc intf ifname ehdlc-0 lowif dsl-0 SarStatus Enable enable
Output
Verbose Mode On
Entry Created
IfName
: ehdlc-0
EHDLC Sar Status : enable
LowIfName
: dsl-0
Admin Status : Enable
Verbose Mode Off:
Entry Created
Output field
320
Field
Description
IfName
This parameter specifies the name assigned to
this interface. Valid Values starts from ehdlc-0
and continues to ehdlc-*
LowIfName
This specifies the lower interface index. This is
the ifindex of the DSL port on which EHDLC is
being created. Valid Values start from dsl-0 and
continues to dsl-*
EHDLC Sar Status
This defines the segmentation and reassembly
status of the hdlc/dsl interface. HDLC supports
only 508 as frame size, to support longer snmp
messages, it should be turned off. By default,
the option taken is 'disable'.
Admin Status
Administrative status of the Ehdlc interface
8.11
Ethernet Commands
8.11.1
Dot3 stats Commands
8.11.1.1
Get dot3 stats
Description: Use this command to get.
Command Syntax: get dot3 stats [ifname <interface-name>]
Parameters
Name
Description
ifname <interfacename>
An index name that uniquely identifies an
interface to an ethernet-like medium.
Type: Get -- Optional
Valid values:eth-0 – eth01
Example
$ get dot3 stats Ifname eth-0
Output
IfName
: eth-0
Alignment Errors
Errors
: 11
: 12
Single Collision Frames
Frames : 14
Deferred Tx Frames
Collisions
: 13
: 15
: 16
FCS
Multiple Collision
Late
Excess Collisions Frames : 17
Frames
: 18
Mac Tx Errors
Carrier Sense Errors
Frames
: 19
Too Long
: 18
Mac Rx Error Frames
: 20
Status
: FullDuplex
Duplex
Output field
Field
Description
IfName
An index name that uniquely identifies an
interface to an ethernet-like medium.
A count of frames received on a particular
interface that are not an integral number of
octets in length and do not pass the FCS
check. The count represented by an instance
of this object is incremented when the
alignmentError status is returned by the MAC
service to the LLC (or other MAC user).
Received frames for which multiple error
conditions pertain are, according to the
conventions of IEEE 802.3 Layer
Management, counted exclusively according to
the error status presented to the LLC. This
counter does not increment for group encoding
schemes greater than 4 bits per group. For
interfaces operating at 10 Gb/s, this counter
can roll over in less than 5 minutes if it is
incrementing at its maximum rate. Since that
amount of time could be less than a
management station's poll cycle time, in order
to avoid a loss of information, a management
station is advised to poll the
dot3HCStatsAlignmentErrors object for 10
Gb/s or faster interfaces. Discontinuities in the
value of this counter can occur at re-
Alignment Errors
321
FCS Errors
Single Collision
Frames
Multiple Collision
Frames
Deferred Tx Frames
Late Collisions
322
initialization of the management system, and at
other times as indicated by the value of
ifCounterDiscontinuityTime.
A count of frames received on a particular
interface that are an integral number of octets
in length but do not pass the FCS check. This
count does not include frames received with
frame-too-long or frame-too-short error. The
count represented by an instance of this object
is incremented when the frameCheckError
status is returned by the MAC service to the
LLC (or other MAC user). Received frames for
which multiple error conditions pertain are,
according to the conventions of IEEE 802.3
Layer Management, counted exclusively
according to the error status presented to the
LLC. For interfaces operating at 10 Gb/s, this
counter can roll over in less than 5 minutes if it
is incrementing at its maximum rate. Since
that amount of time could be less than a
management station's poll cycle time, in order
to avoid a loss of information, a management
station is advised to poll the
dot3HCStatsFCSErrors object for 10 Gb/s or
faster interfaces. Discontinuities in the value of
this counter can occur at e-initialization of the
management system, and at other times as
indicated by the value of
ifCounterDiscontinuityTime.
A count of frames that are involved in a single
collision, and are subsequently transmitted
successfully. A frame that is counted by an
instance of this object is also counted by the
corresponding instance of the ifOutUcastPkts,
ifOutMulticastPkts, or ifOutBroadcastPkts, and
is not counted by the corresponding instance
of the dot3StatsMultipleCollisionFrames object.
This counter does not increment when the
interface is operating in full-duplex mode.
Discontinuities in the value of this counter can
occur at re-initialization of the management
system, and at other times as indicated by the
value of ifCounterDiscontinuityTime.
A count of frames that are involved in more
than one collision and are subsequently
transmitted successfully. A frame that is
counted by an instance of this object is also
counted by the corresponding instance of
either the ifOutUcastPkts, ifOutMulticastPkts,
or ifOutBroadcastPkts, and is not counted by
the corresponding instance of the
dot3StatsSingleCollisionFrames object. This
counter does not increment when the interface
is operating in full-duplex mode. Discontinuities
in the value of this counter can occur at reinitialization of the management system, and at
other times as indicated by the value of
ifCounterDiscontinuityTime.
A count of frames for which the first
transmission attempt on a particular interface
is delayed because the medium is busy. The
count represented by an instance of this object
does not include frames involved in collisions.
This counter does not increment when the
interface is operating in full-duplex mode.
Discontinuities in the value of this counter can
occur at re-initialization of the management
system, and at other times as indicated by the
value of ifCounterDiscontinuityTime.
The number of times that a collision is
Excess Collisions
Frames
Mac Tx Errors Frames
Carrier Sense Errors
Too Long Frames
323
detected on a particular interface later than
one slotTime into the transmission of a packet.
A (late) collision included in a count
represented by an instance of this object is
also considered as a (generic) collision for
purposes of other collision-related statistics.
This counter does not increment when the
interface is operating in full-duplex mode.
Discontinuities in the value of this counter can
occur at re-initialization of the management
system, and at other times as indicated by the
value of ifCounterDiscontinuityTime.
A count of frames for which transmission on a
particular interface fails due to excessive
collisions. This counter does not increment
when the interface is operating in full-duplex
mode. Discontinuities in the value of this
counter can occur at re-initialization of the
management system, and at other times as
indicated by the value of
ifCounterDiscontinuityTime.
A count of frames for which transmission on a
particular interface fails due to an internal MAC
sublayer transmit error. A frame is only
counted by an instance of this object if it is not
counted by the corresponding instance of
either the dot3StatsLateCollisions object, the
dot3StatsExcessiveCollisions object, or the
dot3StatsCarrierSenseErrors object. The
precise meaning of the count represented by
an instance of this object is implementationspecific. In particular, an instance of this
object may represent a count of transmission
errors on a particular interface that are not
otherwise counted. For interfaces operating at
10 Gb/s, this counter can roll over in less than
5 minutes if it is incrementing at its maximum
rate. Since that amount of time could be less
than a management station's poll cycle time, in
order to avoid a loss of information, a
management station is advised to poll the
dot3HCStatsInternalMacTransmitErrors object
for 10 Gb/s or faster interfaces. Discontinuities
in the value of this counter can occur at reinitialization of the management system, and at
other times as indicated by the value of
ifCounterDiscontinuityTime.
The number of times that the carrier sense
condition was lost or never asserted when
attempting to transmit a frame on a particular
interface. The count represented by an
instance of this object is incremented at most
once per transmission attempt, even if the
carrier sense condition fluctuates during a
transmission attempt. This counter does not
increment when the interface is operating in
full-duplex mode. Discontinuities in the value of
this counter can occur at re-initialization of the
management system, and at other times as
indicated by the value of
ifCounterDiscontinuityTime.
A count of frames received on a particular
interface that exceed the maximum permitted
frame size. The count represented by an
instance of this object is incremented when the
frameTooLong status is returned by the MAC
service to the LLC (or other MAC user).
Received frames for which multiple error
conditions pertain are, according to the
conventions of IEEE 802.3 Layer
Mac Rx Error Frames
Duplex Status
8.11.2
Ethernet Commands
8.11.2.1
Create ethernet intf
Management, counted exclusively according to
the error status presented to the LLC. For
interfaces operating at 10 Gb/s, this counter
can roll over in less than 80 minutes if it is
incrementing at its maximum rate. Since that
amount of time could be less than
management station's poll cycle time, in order
to avoid a loss of information, a management
station is advised to poll the
dot3HCStatsFrameTooLongs object for 10
Gb/s or faster interfaces. Discontinuities in the
value of this counter can occur at reinitialization of the management system, and at
other times as indicated by the value of
ifCounterDiscontinuityTime.
A count of frames for which reception on a
particular interface fails due to an internal MAC
sublayer receive error. A frame is only counted
by an instance of this object if it is not counted
by the corresponding instance of either the
dot3StatsFrameTooLongs object, the
dot3StatsAlignmentErrors object, or the
dot3StatsFCSErrors object. The precise
meaning of the count represented by an
instance of this object is implementationspecific. In particular, an instance of this
object may represent a count of receive errors
on a particular interface that are not otherwise
counted. For interfaces operating at 10 Gb/s,
this counter can roll over in less than 5 minutes
if it is incrementing at its maximum rate. Since
that amount of time could be less than a
management station's poll cycle time, in order
to avoid a loss of information, a management
station is advised to poll the
dot3HCStatsInternalMacReceiveErrors object
for 10 Gb/s or faster interfaces. Discontinuities
in the value of this counter can occur at reinitialization of the management system, and at
other times as indicated by the value of
ifCounterDiscontinuityTime.
The current mode of operation of the MAC
entity.'unknown' indicates that the current
duplex mode could not be determined.
Management control of the duplex mode is
accomplished thrugh 'duplexmode' in ethernet
command. Note that this object provides
redundant information with
etherActualDuplexMode inetherIfTable.
Description: Use this command to create a physical Ethernet interface.
Command Syntax: create ethernet intf ifname <interface-name> [ip
<ip-address>] [mask <net-mask>][usedhcp true|false] [speed
{auto|100BT|1000BT}] [type uplink|downlink][enable | disable] [pkttype
Mcast|Bcast|UnknownUcast|All|None] [orl decvalue][duplex half|
full|auto] [profilename <profilename-val>] [mgmtvlanid <mgmtvlanidval>] [priority <priority-val>] [trfclassprofileid <trfclassprofileid-val> ]
[Ctlpktinstid <ctlpktinstid-val>] [ ctlpktgroupid <ctlpktgroupid-val> |
none ] [mgmtsvlanid <mgmtsvlanid-val>] [m2vmacdbid
<m2vmacdbid-val> |none] [ mgmttvlanid <mgmttvlanid-val> ]
8.11.2.2
Delete ethernet intf
Description: Use this command to delete a physical Ethernet interface.
324
Command Syntax: delete ethernet intf ifname <interface-name>
8.11.2.3
Get ethernet intf
Description: Use this command to get information about a particular
physical Ethernet interface, or about all the interfaces.
Command Syntax: get ethernet intf [ifname <interface-name>]
8.11.2.4
Modify ethernet intf
Description: Use this command to modify physical Ethernet interface
configuration.
Command Syntax: modify ethernet intf ifname <interface-name> [ip
<ip-address>] [mask <net-mask>][usedhcp true|false] [speed
{auto|100BT|1000BT}] [type uplink|downlink][enable | disable] [pkttype
Mcast|Bcast|UnknownUcast|All|None] [orl decvalue][duplex half|
full|auto] [profilename <profilename-val>] [mgmtvlanid <mgmtvlanidval>] [priority <priority-val>] [trfclassprofileid <trfclassprofileid-val> ]
[Ctlpktinstid <ctlpktinstid-val>] [ ctlpktgroupid <ctlpktgroupid-val> |
none ] [mgmtsvlanid <mgmtsvlanid-val>] [m2vmacdbid
<m2vmacdbid-val> |none] [ mgmttvlanid <mgmttvlanid-val> ]
Parameters
Name
Description
ifname <interfacename>
This parameter specifies the interface index
used for the Ethernet type of interfaces. Valid
Values starts from eth-0 and continues to eth-*
Type
: Create – Mandatory
Delete – Mandatory
Get
– Optional
Modify – Mandatory
Valid values : eth-0 - *
ip <ip-address>
This parameter specifies the IP address
configured for the interface. This is required to
be configured only if this interface is used for
management IP traffic. If it is not configured and
'etherUseDhcp' is configured as GS_FALSE,
then management IP traffic will not flow through
this interface. ‘Modify’ of IP Address for an
Ethernet interface shall be supported only if
some IP address is configured on the interface
or 'etherUseDhcp' was configured to
"GS_TRUE" previously. If Usedhcp is GS_TRUE
and ‘modify’ is done for this field, then Usedhcp
field shall be set to GS_FALSE. Both ‘Usedhcp’
and this field shall not be specified together.
Type
: Create - Optional.
Modify - Optional
Valid Values: Any valid class A/B/C /
Classless IP address.
Default Value: None
325
Mask <net-mask>
This parameter specifies the network mask
configured for the interface. This is given in
conjunction with IP Address configured and shall
be given only if IP address has been given. This
shall be removed whenever IP Address is
removed. ’Modify’ of network mask for an
Ethernet interface shall be supported only if
some IP address is configured on the interface
or 'etherUseDhcp' was configured to
"GS_TRUE" previously. If Usedhcp is GS_TRUE
and ’modify’ is done for this field, then usedhcp
field shall be set to GS_FALSE. Both usedhcp
and this field shall not be specified together.
Type : This field is not allowed when a physical
interface is specified and IP is 0.0.0.0. In all
other cases the field is mandatory.
Valid Values : 255.0.0.0 - 255.255.255.255
Default Value: None
usedhcp true | false
This parameter specifies whether a DHCP client
is to be triggered to obtain an IP address for this
interface. If this is configured as GS_FALSE and
‘etherIfIpAddress’ is not configured, then
management IP traffic will not flow through the
interface. If an IP address is configured
and ’modify’ is done for this field, then
‘tEtherIfIpAddress’ and ‘tAggrIfNetMask’ fields
shall be set to Zero (0.0.0.0). Both Usedhcp and
‘tEtherIfIpAddress’ shall not be specified
together. In case Iftype is ‘slave’, then this field
can not be set to GS_TRUE.
Type
: Optional
Valid value
: true or false
Default value: false
speed {auto |100 BT|
1000BT}+
The Ethernet speed for the net-side
interfaces.
Type
: Optional.
Valid Values : auto, 100BT, 1000BT.
Default Value : auto.
type uplink|downink
This parameter specifies the type of the Ethernet
interfaces. The Net is towards the NET side (2 at
most) and slave means the physical interface
connected to the slave device.
Type
: Optional.
Valid Values : uplink, downlink.
Default Value : uplink.
enable|disable
Administrative status of the Ethernet interface.
Type
: Modify - Mandatory
Valid values : enable or disable
Default value: enable
326
Duplex auto|half|full
This parameter defines the modes, in which the
Ethernet Interface can come up. It can be
configured as ‘auto’, ‘half’, ‘full duplex’ or a
combination of these. Based on the values
configured, the Ethernet interface negotiates
with the peer entity.
Type
: optional
Valid values: auto, half, full
Default value: auto
Pkttype
Mcast|Bcast|UnknownUc
ast | All|None
This parameter defines the packet type
supported by the interface.
‘etherPktTypeSupported’ shall be configured for
every Ethernet interface. By default, all packets
will be transmitted. The interface shall not
transmit any other packet type than that
configured.
Type: Create - optional
Modify - optional
Valid values : Mcast, Ucast, UnknownUcast,
All
Default Value: All
Orl decvalue
This parameter specifies the output rate limiting
value to be applied on this Interface. The unit for
the same is in Mbits/sec.
Type: Create - Optional
Modify - Optional
Valid Values: 1 -100
Default Value: 100
ProfileName
<profilename-val>
This parameter specifies the scheduling profile
to be associated with the Ethernet interface.
Type
: Optional.
Default Value : SPROFILE
mgmtvlanid
<mgmtvlanid>
This parameter specifies the VLAN (C-Vlan) for
management traffic on this interface. Non-zero
value of this field is valid only if either 'ip' field is
non-zero or 'usedhcp' field is true. If no
Management VLAN id is specified (in the create
operation) or its value is set to zero (either in
create or modify operation), then the system
shall use the value of 'portvlanid' associated with
the bridge port created on this interface as the
Management VLAN Index. In case the
management VLAN (i.e. 'mgmtvlanid' or the
associated 'portvlanid', if 'mgmtvlanid' is zero)
does not exist on the system, then IP-based
management on this management VLAN shall
not happen on the interface till the
corresponding VLAN is created with the Net-side
port as its member. In stacked-VLAN mode, the
VLAN filtering mentioned above is based on
virtual-VLAN mapped to C-Vlan and S-Vlan for
the frame.
Type : Create - optional
Modify - optional
Valid values:
327
0 -4095
priority <priority-val>
This parameter specifies the priority to be set in
Tagged Ethernet PDUs sent on Management
VLAN over this interface. This field is valid only if
either 'ip' field is non-zero or 'usedhcp' field is
true. In Native-VLAN mode, this priority shall be
used for C-Vlan tag, while in stacked-VLAN
mode it shall be used for S-Vlan tag.
Type: Create - optional
Modify - optional
Valid values: 0 -7
trfclassprofileid
This parameter specifies the traffic class profile
identifier to be associated with the Ethernet
interface.
Type: Optional
Valid values:1 to 10
Default Value: 1
Ctlpktinstid
This specifies the control packet instance
identifier associated with this interface. If the
user does not provide any instance identifier
while creating an interface, an instance is
created internally from the default profile
governed by the macro 2 and associated to the
interface. This will reduce the total number to
instances that can be now created by one. The
default instance is governed by the macro 0.
TYPE: Create -- Optional
Valid Values:1 - 26
Default Value: 0
ctlpktgroupid
<ctlpktgroupid-val> |
none
This parameter specifies the Control packet
instance group associated with this Ethernet
interface. The flows for this interface shall be
mapped to control packet instances as mapped
for the flows corresponding to the groupid
configured in ctlpkt group info command. If this
group does not have entries for all of the flows,
then those flows shall be mapped to the
ctlpktinstid. If groupid is 0, then all the flows shall
be mapped to ctlpktinstid.
Type: Create -- Optional
Valid values: 0 -50
Default value: 0
328
mgmtsvlanid
This parameter specifies the S-VLAN for
management traffic on this interface. It is
applicable only in stacked-VLAN Mode. Nonzero value of this field is valid only if either
'etherIfIpAddress' field is non-zero or
'etherUseDhcp' field is true. If no management
S-Vlan id is specified (in the create operation) or
its value is set to zero (either in create or modify
operation), then the system shall use the value
of 'psvlanid' associated with the bridge port
created on this interface as the management
VLAN id. In case the management VLAN (virtual
VLAN mapped to S-VLAN and C-VLAN for the
frame) does not exist (ie. Virtual VLAN mapped
to 'mgmtsvlanid' or the associated 'psvlanid', if
'mgmtsvlanid' is zero) on the system, then IPbased management shall not happen on the
interface till the corresponding virtual-VLAN is
created with the Net-side port as its member.
Type : Create - optional
Modify - optional
Valid values: 0 - 4095
m2vmacdbid
This field specifies the M2VMac Database Id
associated with this interface. The value 0
means Virtual MAC feature is disabled on this
interface. This field can be modified only when
the interface is disabled.
Type: Create - optional
Modify - optional
Valid values: 1 GS_CFG_MAX_M2VMAC_DATABASES
mgmttvlanid
<mgmttvlanid-val>
This specifies the value to be used for inserting
TVLAN id or vlan id of the third Vlan tag in the
transmitted Ethernet frames and that is expected
in received frames over this interface. Currently
this is configurable and supported only for
management Ethernet interface. For data
Ethernet interface, the value of TVLAN id is
configurable and used from the system sizing
table. If the value for TVLAN id configured on a
management Ethernet interface is zero then
third vlan tag shall not be added neither shall it
be supported in received frames. This attribute is
applicable only in stacked-VLAN mode.
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 4095
Default value: 0
Example
create ethernet intf ifname eth-0 ip 192.168.1.1 mask 255.255.255.0
speed 100bt profilename sprofile mgmtvlanid 2 priority 2
trfclassprofileid 1 Ctlpktinstid 1 ctlpktgroupid 1
Output
Verbose Mode On
Entry Created
329
Interface
: eth-0
Type
: Uplink
UseDhcp
: False
IP Address
255.255.0.0
: 192.168.1.1
Mask
:
Pkt Type
: Mcast
Orl(mbps)
: 100
Configured Duplex
: Auto
Configured Speed
: Auto
Profile Name
: SPPROFILE
Mgmt VLAN Index
: 2
Mgmt S-VLAN Index
: 2
Mgmt T-VLAN Index
: 2
Duplex
: None
Tagged Mgmt PDU Prio: 2
trfclassprofileid
: 1
Ctl Pkts Instance Id:1
Ctl Pkts Group Id : 1
Speed
: -
Operational Status
: Down
Admin Status
: Up
Verbose Mode Off:
Entry Created
Output field
330
Field
Description
If-Name
This parameter specifies the interface index
used for the Ethernet type of interfaces. Valid
Values starts from eth-0 and continues to eth-*
Type
This parameter specifies the type of the Ethernet
interfaces. The Net is towards the NET side (2 at
most) and slave means the physical interface
connected to the slave device.
UseDhcp
This parameter specifies whether a DHCP client
is to be triggered to obtain an IP address for this
interface. If this is configured as GS_FALSE and
‘etherIfIpAddress’ is not configured, then
management IP traffic will not flow through the
interface. If an IP address is configured
and ’modify’ is done for this field, then
‘tEtherIfIpAddress’ and ‘tAggrIfNetMask’ fields
shall be set to Zero (0.0.0.0). Both Usedhcp and
‘tEtherIfIpAddress’ shall not be specified
together. In case Iftype is ‘slave’, then this field
can not be set to GS_TRUE.
Ip Address
This parameter specifies the IP address
configured for the interface. This is required to
be configured only if this interface is used for
management IP traffic. If it is not configured and
'etherUseDhcp' is configured as GS_FALSE,
then management IP traffic will not flow through
this interface. ‘Modify’ of IP Address for an
Ethernet interface shall be supported only if
some IP address is configured on the interface
or 'etherUseDhcp' was configured to
"GS_TRUE" previously. If Usedhcp is GS_TRUE
and ‘modify’ is done for this field, then Usedhcp
field shall be set to GS_FALSE. Both ‘Usedhcp’
and this field shall not be specified together.
Mask
This parameter specifies the network mask
configured for the interface. This is given in
conjunction with IP Address configured and shall
be given only if IP address has been given. This
shall be removed whenever IP Address is
removed. ’Modify’ of network mask for an
Ethernet interface shall be supported only if
some IP address is configured on the interface
or 'etherUseDhcp' was configured to
"GS_TRUE" previously. If Usedhcp is GS_TRUE
and ’modify’ is done for this field, then usedhcp
field shall be set to GS_FALSE. Both usedhcp
and this field shall not be specified together.
331
pkttype
This parameter defines the packet type
supported by the interface.
‘etherPktTypeSupported’ shall be configured for
every Ethernet interface. By default, all packets
will be transmitted. The interface shall not
transmit any other packet type than that
configured.
Orl
This parameter specifies the output rate limiting
value to be applied on this Interface.The units for
the same is in Mbits/sec
Configured Duplex
The duplex mode to be used by the interface, as
configured by the user.
Duplex
This parameter defines the modes, in which the
Ethernet Interface can come up. It can be
configured as ‘auto’, ‘half’, ‘full duplex’ or a
combination of these. Based on the values
configured, the Ethernet interface negotiates
with the peer entity.
Configured Speed
The Ethernet speed for the net-side interfaces.
Mgmt VLAN Index
This parameter specifies the VLAN (C-Vlan) for
management traffic on this interface. Non-zero
value of this field is valid only if either 'ip' field is
non-zero or 'usedhcp' field is true. If no
Management VLAN id is specified (in the create
operation) or its value is set to zero (either in
create or modify operation), then the system
shall use the value of 'portvlanid' associated with
the bridge port created on this interface as the
Management VLAN Index. In case the
management VLAN (i.e. 'mgmtvlanid' or the
associated 'portvlanid', if 'mgmtvlanid' is zero)
does not exist on the system, then IP-based
management on this management VLAN shall
not happen on the interface till the
corresponding VLAN is created with the Net-side
port as its member. In stacked-VLAN mode, the
VLAN filtering mentioned above is based on
virtual-VLAN mapped to C-Vlan and S-Vlan for
the frame.
Mgmt S-VLAN Index
This parameter specifies the S-VLAN for
management traffic on this interface. It is
applicable only in stacked-VLAN Mode. Nonzero value of this field is valid only if either
'etherIfIpAddress' field is non-zero or
'etherUseDhcp' field is true. If no management
S-Vlan id is specified (in the create operation) or
its value is set to zero (either in create or modify
operation), then the system shall use the value
of 'psvlanid' associated with the bridge port
created on this interface as the management
VLAN id. In case the management VLAN (virtual
VLAN mapped to S-VLAN and C-VLAN for the
frame) does not exist (ie. Virtual VLAN mapped
to 'mgmtsvlanid' or the associated 'psvlanid', if
'mgmtsvlanid' is zero) on the system, then IPbased management shall not happen on the
interface till the corresponding virtual-VLAN is
created with the Net-side port as its member.
Tagged Mgmt PDU Prio
This parameter specifies the priority to be set in
Tagged Ethernet PDUs sent on Management
VLAN over this interface. This field is valid only if
either 'ip' field is non-zero or 'usedhcp' field is
true. In Native-VLAN mode, this priority shall be
used for C-Vlan tag, while in stacked-VLAN
mode it shall be used for S-Vlan tag.
ProfileName
This parameter specifies the scheduling profile
to be associated with the Ethernet interface.
Speed
The actual speed of the interface.
Operational Status
The operational status of the interface.
Admin Status
The administrative status of the interface.
trfclassprofileid
This parameter specifies the traffic class profile
identifier to be associated with the Ethernet
interface.
Ctl Pkts Instance Id
This specifies the control packet instance
identifier associated with this interface. If the
user does not provide any instance identifier
while creating an interface, an instance is
created internally from the default profile
governed by the macro 2 and associated to the
interface. This will reduce the total number to
instances that can be now created by one. The
default instance is governed by the macro 0.
Ctl Pkts Group Id
This parameter specifies the Control packet
instance group associated with this Ethernet
interface. The flows for this interface shall be
mapped to control packet instances as mapped
for the flows corresponding to the groupid
configured in ctlpkt group info command. If this
group does not have entries for all of the flows,
then those flows shall be mapped to the
ctlpktinstid. If groupid is 0, then all the flows shall
be mapped to ctlpktinstid.
M2VMacDbId
This field specifies the M2VMac Database Id
associated with this interface. The value 0
means Virtual MAC feature is disabled on this
interface. This field can be modified only when
the interface is disabled.
Mgmt T-VLAN Index
This specifies the value to be used for inserting
TVLAN id or vlan id of the third Vlan tag in the
transmitted Ethernet frames and that is expected
in received frames over this interface. Currently
this is configurable and supported only for
management Ethernet interface. For data
Ethernet interface, the value of TVLAN id is
configurable and used from the system sizing
table. If the value for TVLAN id configured on a
management Ethernet interface is zero then
third vlan tag shall not be added neither shall it
be supported in received frames. This attribute is
applicable only in stacked-VLAN mode.
References
• Ethernet stats command.
332
8.12
EOA Commands
8.12.1
EOA Commands
8.12.1.1
Create eoa intf
Description: Use this command to create an EoA interface towards the
CPE side.
Command Syntax: create eoa intf ifname <interface-name> lowif
<low-interface-name> [pkttype {multicast |broadcast |unknownunicast} + | all|None] [fcs false | true] [enable|disable]
[inactivitytmrintrvl <inactivitytmrintrvl-val>] [m2vmacdbid
<m2vmacdbid-val> |none] [configstatus normal | config]
8.12.1.2
Delete eoa intf
Description: Use this command to delete an EoA interface.
Command Syntax: delete eoa intf ifname <interface-name>
8.12.1.3
Get eoa intf
Description: Use this command to get information on a particular EoA
interface, or on all the EoA interfaces.
Command Syntax: get eoa intf [ifname <interface-name>]
8.12.1.4
Modify eoa intf
Description: Use this command to modify the properties of an eoa
interface.
Command Syntax: modify eoa intf ifname <interface-name>
[pkttype {multicast |broadcast |unknown- unicast} + | all| none] [fcs
false | true] [m2vmacdbid <m2vmacdbid-val> | none] [enable|disable]
[inactivitytmrintrvl <inactivitytmrintrvl>]
Parameters
Name
Description
ifname<interfacename>
This parameter specifies the name assigned to
this interface.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Modify - Mandatory
Valid values: eoa-0,eoa-1….
This parameter specifies the lower interface index.
It contains ifindex of the AAL5 or VC Aggregation
interface.
Type: Mandatory
Valid Values : aal5-0 - *
This parameter defines the packet type supported
by the interface. ‘EoAPktTypeSupported’ shall be
configured for every CPE side Ethernet interface.
By default, the option taken is 'ALL' and it means
that all packets will be transmitted. The value
'None' means that normal Ucast packets will be
transmitted. The interface shall not transmit any
other packet type than the ones configured.
Type: Optional.
Valid Values: {multicast |broadcast
|unknown-unicast}+ | all
Default Value: all.
This specifies whether Ethernet FCS needs to be
computed for the CPE side Ethernet interfaces.
lowif <low-interfacename>
pkttype {multicast
|broadcast
|unknownunicast}+ |
all|none
fcs false | true
333
Enable|disable
inactivitytmrintrvl
<inactivitytmrintrvl-val>
configstatus normal |
config
m2vmacdbid
<m2vmacdbid-val> |
none
This can be set to true only if encaptype of the
lower interface is Ethernet.
Type: Optional
Valid Values: false or true
Default Value: false.
Administrative status of the interface
Type: Optional
Valid values : enable or disable
Default Values: enable
This field specifies the time (in seconds) after
which interfaces shall be marked inactive if there
is no data activity on this interface during this
interval. This is used only when the bit
corresponding to "ConfigEntry" is set for
gsvEoaConfigStatus field. A value of zero means
the timer is not running. In Aautosensing scenario,
an inactive interface is a candidate to deletion in
case another protocol is sensed on Atm Vc
Interface on which this interface is created.
Type: Optional
Valid Values: 0 to 0xffffffff
Default Value: 0
This parameter describes the configuration mode
for this interface.The value of this parameter can
be normal or config. If the value is config, then this
interface shall be created, but will have a dormant
status. Only after the receipt of an EoA packet
from the CPE side, this interface shall become
active.
Type: Optional
Valid Values: normal | config
Default Value: normal
This field specifies the M2VMac Database Id
associated with this interface. The value 0 means
Virtual MAC feature is disabled on this interface.
This field can be modified only when the interface
is disabled.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 1154
Default value: 0
Example
$create eoa intf ifname eoa-0 lowif aal5-0 m2vmacdbid 1 enable fcs
false
Output
Verbose Mode On
Entry Created
IfName
aal5-0
: eoa-0
FCS
: False
Pkt Type
: ALL
InActivity Tmr Interval
: 3
M2VMac Database Id
: 1
Config Status
: Normal
Oper Status
: Down
LowIfName
:
Admin Status : Up
Output Fields
334
FIELD
Description
IfName
The name of the interface that has been created.
LowIfName
This parameter specifies the lower interface index.
It contains ifindex of the AAL5 or VC Aggregation
interface.
FCS
Pkt Type
Admin Status
Oper Status
InActivity Tmr Interval
Config Status
M2VMac Database Id
This specifies whether Ethernet FCS needs to be
computed for the CPE side Ethernet interfaces.
This can be set to true only if encaptype of the
lower interface is Ethernet.
This parameter defines the packet type supported
by the interface. ‘EoAPktTypeSupported’ shall be
configured for every CPE side Ethernet interface.
By default, the option taken is 'ALL' and it means
that all packets will be transmitted. The value
'None' means that normal Ucast packets will be
transmitted. The interface shall not transmit any
other packet type than the ones configured.
The desired state of the interface. It may be either
Up or Down
The actual/current state of the interface. It can be
either up or down.
This field specifies the time (in seconds) after
which interfaces shall be marked inactive if there
is no data activity on this interface during this
interval. This is used only when the bit
corresponding to "ConfigEntry" is set for
gsvEoaConfigStatus field. A value of zero means
the timer is not running. In Aautosensing scenario,
an inactive interface is a candidate to deletion in
case another protocol is sensed on Atm Vc
Interface on which this interface is created.
This parameter describes the configuration mode
for this interface.The value of this parameter can
be Normal, Config, NotInUse, or InUse. If the
value is Config, then this interface shall be
created, but will have a dormant status. Only after
the receipt of an EoA packet from the CPE side,
this interface shall become active. The 'InUse' and
'NotInUse' bits are read-only bits. The 'NotInUse'
bit indicates that the entry is dormant and the
'InUse' bit indicates that the entry is activated.
This field specifies the M2VMac Database Id
associated with this interface. The value 0 means
Virtual MAC feature is disabled on this interface.
This field can be modified only when the interface
is disabled.
References
• Ethernet commands
• Ethernet Stats commands.
335
8.13
Filtering Commands
8.13.1
ACL Global Macentry Commands
8.13.1.1
Get acl global macentry
Description: Use this command to get.
Command Syntax: get acl global macentry [macaddr <macaddr-val
>]
8.13.1.2
Create acl global macentry
Description: Use this command to create.
Command Syntax: create acl global macentry macaddr <macaddrval > [deny disable |enable] [track disable | enable]
8.13.1.3
Delete acl global macentry
Description: Use this command to delete.
Command Syntax: delete acl global macentry macaddr <macaddrval >
8.13.1.4
Modify acl global macentry
Description: Use this command to modify.
Command Syntax: modify acl global macentry macaddr <macaddrval > [deny disable | enable] [track disable | enable]
Parameters
Name
macaddr
val >
Description
<macaddr-
deny disable | enable
track disable | enable
Unicast Source MAC Address, which needs to be
tracked/denied access
Type: Create --Mandatory
Delete --Mandatory
Modify -- Mandatory
Get Optional
This flag specifies if the MAC address is to be
denied access.
Type: Create --Optional
Modify -- Optional
Default value: enable
This flag specifies if the MAC address is to be
tracked accross different ports. A trap is raised
when packet from the address comes over a port
for the first time and when it changes the port.
Type: Create --Optional
Modify -- Optional
Default value: disable
Example
$ create acl global macentry macaddr 00:01:34:a0:d1:34 deny enable
track enable
Output
Verbose Mode On
Entry Created
Mac Address
: 00:01:34:a0:d1:34
Deny
: true
Number of times Port changed : 2
336
Track : enable
Verbose Mode Off:
Entry Created
Output field
Field
Mac Address
Deny
Track
Number of times Port
changed
8.13.2
Clfr list genentry commands
8.13.2.1
Get clfr list genentry
Description
Unicast Source MAC Address, which needs to be
tracked/denied access
This flag specifies if the MAC address is to be
denied access.
This flag specifies if the MAC address is to be
tracked accross different ports. A trap is raised in
case packet from the address comes over a port
for the first time and when it changes the port.
This specifies the number of times port has been
changed by the MAC address.
Description: Use this command to get.
Command Syntax:
8.13.2.2
Create clfr list genentry
Description: Use this command to create.
Command Syntax: create clfr list genentry ifname <interfacename>value <value-val> [valtype U8|U16|U32]
8.13.2.3
Delete clfr list genentry
Description: Use this command to delete.
Command Syntax: delete clfr list genentry ifname <interface-name>
[value <value-val>
Parameter
Name
Description
ifname <interfacename>
Name of ethernet, eoa, ipoe or pppoe interface,
for which the classifier generic list is created. Valid
values for the field are between EOA-0 and EOA23 or between eth-0 and eth-1or between IPOE-0
and IPOE-191 or between PPPOE-0 and PPPOE192.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: eth-*, eoa-*, pppoe-*,ipoe*
value <value-val>
List Entry Value, of the classifier generic list
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valtype U8|U16|U32
337
This field specifies value type of the entry. The
value type for all entries on an interface should be
same. Value type should match value type of
matchingenlist nodes in case a tree attached on
same interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is attached
on same interface. Currently only 'U32' value is
supported.Create -- Optional.
Create -- Optional
Example
$ create clfr list genentry Ifname eoa-1 value 0xAC1901AA valtype u8
Output
Verbose Mode On
Entry Created
If Name
: eoa-1
Value
: 0xAC1901AA
Value Type : U32
Verbose Mode Off:
Entry Created
Output field description
Field
Description
If Name
Name of ethernet, eoa, ipoe or pppoe interface,
for which the classifier generic list is created. Valid
values for the field are between EOA-0 and EOA23 or between eth-0 and eth-1or between IPOE-0
and IPOE-191 or between PPPOE-0 and PPPOE192.
Value
List Entry Value, of the classifier generic list
Value Type
This field specifies value type of the entry. The
value type for all entries on an interface should be
same. Value type should match value type of
matchingenlist nodes in case a tree attached on
same interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is attached
on same interface. Currently only 'U32' value is
supported.
8.13.3
ACL Port Macentry Commands
8.13.3.1
Get acl port macentry
Description: Use this command to get.
Command Syntax: get acl port macentry [portid <portid-val >]
[macaddr <macaddr-val >]
8.13.3.2
Create acl port macentry
Description: Use this command to create.
Command Syntax: create acl port macentry portid <portid-val >
macaddr <macaddr-val >
8.13.3.3
Delete acl port macentry
Description: Use this command to delete.
Command Syntax: delete acl port macentry portid <portid-val >
macaddr <macaddr-val>
Parameter
Name
338
Description
portid <portid-val>
macaddr
val>
<macaddr-
Bridge Port Id, for which the port MAC Address
entry is created
Type: Create --Mandatory
Delete --Mandatory
Get -- Optional
Valid values: 1-578
Unicast Source MAC Address, which is to be
allowed access over the particular port.
Type: Create --Mandatory
Delete --Mandatory
Get -- Optional
Example $ create acl port macentry portId 2 macaddr
00:01:34:a0:d1:34
Output
Verbose Mode On
Entry Created
PortId
: 2
Mac Address : 00:01:34:a0:d1:34
Verbose Mode Off:
Entry Created
Output field description
Field
PortId
Mac Address
Description
Bridge Port Id, for which the port MAC Address
entry is created
Unicast Source MAC Address, which is to be
allowed access over the particular port.
Caution
• An entry in this table shall not be applicable for a bridge port created
over PPPOE/IPOE interface.
8.13.4
Clfr namedlist genentry Commands
8.13.4.1
Get clfr namedlist genentry
Description: Use this command to get.
Command Syntax: get clfr namedlist genentry [listid <listid-val>]
[value <value-val>]
8.13.4.2
Create clfr namedlist genentry
Description: Use this command to create.
Command Syntax: create clfr namedlist genentry listid <listidval>value <value-val>
8.13.4.3
Delete clfr namedlist genentry
Description: Use this command to delete.
Command Syntax: delete clfr namedlist genentry listid <listidval>value <value-val>
Parameter
Name
Description
listid <listid-val>
This field stores the list identifier value. There
must be a row indexed on the same id in the
Classifier Named List Table.
Type: Create -- Mandatory
339
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 65535
value <value-val>
This field specifies the list entry value. The
value range depends upon value type of list, as
specified in Classifier Named List table.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Example
$ create clfr namedlist genentry listid 2 value 0xAC1901AA
Output
Verbose Mode On
Entry Created
ListId : 2
Value
: 0xAC1901AA
Verbose Mode Off:
Entry Created
Output field
Field
Description
ListId
This field stores the list identifier value. There
must be a row indexed on the same id in the
Classifier Named List Table.
Value
This field specifies the list entry value. The value
range depends upon value type of list, as
specified in Classifier Named List table.
8.13.5
Clfr namedlist info Commands
8.13.5.1
Get clfr namedlist info
Description: Use this command to get.
Command Syntax: get clfr namedlist info [listid <listid-val>]
8.13.5.2
Create clfr namedlist info
Description: Use this command to create.
Command Syntax: create clfr namedlist info listid <listid-val>
[valtype U8 | U16 | U32]
8.13.5.3
Delete clfr namedlist info
Description: Use this command to delete.
Command Syntax: delete clfr namedlist info listid <listid-val>
8.13.5.4
Modify clfr namedlist info
Description: Use this command to modify.
Command Syntax: modify clfr namedlist info listid <listid-val>
[valtype U8 | U16 | U32]
Parameter
Name
340
Description
listid listid
This field stores the list identifier value.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
valtype U8 | U16 | U32
This field specifies the value type of list. Value
type should match value type of matchingenlist
nodes in case a tree attached on same interface
as the list. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is
attached on same interface. Currently only 'U32'
value is supported.
Type: Create -- Optional
Modify -- Optional
Default value: U32
Example
$ create clfr namedlist info listid 2 valtype u32
Output
Verbose Mode On
Entry Created
ListId
: 2
Value Type : u32
Verbose Mode Off:
Entry Created
Output field
Field
Description
ListId
This field stores the list identifier value.
Value Type
This field specifies the value type of list. Value
type should match value type of matchingenlist
nodes in case a tree attached on same interface
as the list. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is
attached on same interface. Currently only 'U32'
value is supported.
8.13.6
Clfr namedlist map Commands
8.13.6.1
Get clfr namedlist map
Description: Use this command to get.
Command Syntax: get clfr namedlist map [ifname <interface-name>]
8.13.6.2
Create clfr namedlist map
Description: Use this command to create.
Command Syntax: create clfr namedlist map ifname <interfacename>listid <listid-val>
8.13.6.3
Delete clfr namedlist map
Description: Use this command to delete.
341
Command Syntax: delete clfr namedlist map ifname <interfacename>
Parameter
Name
Description
ifname <interface-name>
This specifies the eoa ,pppoe, ipoe or ethernet
interface to which named generic list is
attached. Valid values for the field are between
EOA-0 and EOA-23 or between eth-0 and eth1or between IPOE-0 and IPOE-191 or between
PPPOE-0 and PPPOE-192.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
listid <listid-val>
This field stores the list identifier value.
Type: Create -- Mandatory
Valid values: 1 - 65535
Example
$ create clfr namedlist map ifname eoa-1 listid 2
Output
Verbose Mode On
Entry Created
IfName : eoa-1
ListId : 2
Verbose Mode Off:
Entry Created
Output field
Field
Description
IfName
This specifies the eoa ,pppoe, ipoe or ethernet
interface to which named generic list is attached.
Valid values for the field are between EOA-0 and
EOA-23 or between eth-0 and eth-1or between
IPOE-0 and IPOE-191 or between PPPOE-0
and PPPOE-192.
ListId
This field stores the list identifier value.
8.13.7
Clfr profile branch Commands
8.13.7.1
Get clfr profile branch
Description: Use this command to get.
Command Syntax: get clfr profile branch [pname <pname-val>]
[nodeid <nodeid-val>] [brtype <brtype-val>]
8.13.7.2
Create clfr profile branch
Description: Use this command to create.
Command Syntax: create clfr profile branch pname <pnameval>nodeid <nodeid-val>brtype <brtype-val> [cnodeid <cnodeid-val>]
342
8.13.7.3
Delete clfr profile branch
Description: Use this command to delete.
Command Syntax: delete clfr profile branch pname <pname-val>
nodeid <nodeid-val>brtype <brtype-val>
Parameter
Name
Description
pname <pname-val>
Name of the classifier profile
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
nodeid <nodeid-val>
Node Id of the node, with which the branch is to
be attached.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 4
brtype <brtype-val>
This specifies the branch types. For a unary
type node, only onlybr(0xfffffffffffffff9) branch
type is allowed. For binary type and Linear/NonLinear(Access Deny only) type,
TrueBr(0xfffffffffffffffd) and
FalseBr(0xfffffffffffffffe) are allowed. For ternary
type nodes LtBr(0xfffffffffffffffc), GtBr
(0xfffffffffffffffb), EqBr (0xfffffffffffffffa) are
allowed. For Linear, Non-Linear (match in list)
the actual value is allowed. The actual value
can be U8, U16, U32, U64, atmIf, ethernetIf,
aal5vc.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
cnodeid <cnodeid-val>
Child Node Id
Type: Create -- Optional
Default value: 0
Example
$ create clfr profile branch pname IGMP nodeid 3 brtype truebr
Output
Verbose Mode On
Entry Created
Profile Name : IGMP
Node Id
: 3
Branch type : true
Child NodeId : 5
Verbose Mode Off:
Entry Created
Output field
343
Field
Description
Profile Name
Name of the classifier profile
Node Id
Node Id of the node, with which the branch is to
be attached.
Branch type
This specifies the branch types. For a unary type
node, only onlybr(0xfffffffffffffff9) branch type is
allowed. For binary type and Linear/NonLinear(Access Deny only) type,
TrueBr(0xfffffffffffffffd) and FalseBr(0xfffffffffffffffe)
are allowed. For ternary type nodes
LtBr(0xfffffffffffffffc), GtBr (0xfffffffffffffffb), EqBr
(0xfffffffffffffffa) are allowed. For Linear, NonLinear (match in list) the actual value is allowed.
The actual value can be U8, U16, U32, U64,
atmIf, ethernetIf, aal5vc.
Child NodeId
Child Node Id
8.13.8
Clfr profile info Commands
8.13.8.1
Get clfr profile info
Description: Use this command to get.
Command Syntax: get clfr profile info [pname <pname-val>]
8.13.8.2
Create clfr profile info
Description: Use this command to create.
Command Syntax: create clfr profile info pname <pname-val>
8.13.8.3
Delete clfr profile info
Description: Use this command to delete.
Command Syntax: delete clfr profile info pname <pname-val>
8.13.8.4
Modify clfr profile info
Description: Use this command to modify.
Command Syntax: modify clfr profile info pname <pname-val>
[descr <descr-val>] [rnode <rnode-val>] [enable | disable]
Parameter
Name
Description
pname <pname-val>
Name of the classifier profile
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Default value: -----
descr <descr-val>
A brief description can be given with profile, to
identify the profile
Type: Create -- Optional
Modify -- Optional
Default value: 0
rnode <rnode-val>
Root node Id of the profile. Each profile can
have only one root node id
Type: Create -- Optional
Modify -- Optional
Default value: 0
344
enable | disable
A Profile can only be modified, if it is disabled. A
tree can only use a profile, if it is enabled. A
profile cannot be disabled, if a tree is using it.
Type: Create -- Optional
Modify -- Optional
Default value: 2
Example
$ create clfr profile info pname IGMP
Output
Verbose Mode On
Entry Created
Profile Name : IGMP
Root NodeId
: 0
Status :
Enable
Description
: Profile to match the IGMP packet
Verbose Mode Off:
Entry Created
Output field
Field
Description
Profile Name
Name of the classifier profile
Root NodeId
Root node Id of the profile. Each profile can
have only one root node id
Status
A Profile can only be modified, if it is disabled. A
tree can only use a profile, if it is enabled. A
profile cannot be disabled, if a tree is using it.
Description
A brief description can be given with profile, to
identify the profile
8.13.9
Clfr profile node Commands
8.13.9.1
Get clfr profile node
Description: Use this command to get.
Command Syntax: get clfr profile node [pname <pname-val>]
[nodeid <nodeid-val>]
8.13.9.2
Create clfr profile node
Description: Use this command to create.
Command Syntax: create clfr profile node pname <pnameval>nodeid <nodeid-val> [ descr <descr-val> ] [export true|false ]
Ntype Leaf|Unary|Binary|Ternary|Linear|NonLinear modmask
Act|ValType|Offset|Mask|Val|ValueEnd|SBType|SBShiftCnt|SBMplr|De
scrip|None [actval
Drop|Fwd|FwdToCtl|CpToCtl|Eq|Gt|Lt|InRange|TerCmp|SetPrio|MatchI
nList|AccDeny|SetBase|Count|Retagprio |
MatchIngenlist|GoToNextRule|allow ] [ valuetype
U8|U16|U32|U64|AtmIf|Aal5Vc|EoaIf|EthIf|Dir|Prio|Len|VlanId ][ offsetv
al <offsetval-val> ] [ maskval <maskval-val> ] [ value <value-val> ]
[ valend <valend-val> ] [ sbasetype Abs|Add|Compute|SetFromVar ]
[shiftcnt <shiftcnt-val>] [ mplr <mplr-val> ] [ sbvarindex l2start|l3start ]
[ nodeprio low|high|asintree ]
8.13.9.3
Delete clfr profile node
Description: Use this command to delete.
345
Command Syntax: delete clfr profile node pname <pname-val>
nodeid <nodeid-val>
8.13.9.4
Modify clfr profile node
Description: Use this command to modify.
Command Syntax: modify clfr profile node pname <pnameval>nodeid <nodeid-val> [ descr descr ] [export true|false ] Ntype
Leaf|Unary|Binary|Ternary|Linear|NonLinear modmask
Act|ValType|Offset|Mask|Val|ValueEnd|SBType|SBShiftCnt|SBMplr|De
scrip|None [actval
Drop|Fwd|FwdToCtl|CpToCtl|Eq|Gt|Lt|InRange|TerCmp|SetPrio|MatchI
nList|AccDeny|SetBase|Count|Retagprio |
MatchIngenlist|GoToNextRule|allow ] [ valuetype
U8|U16|U32|U64|AtmIf|Aal5Vc|EoaIf|EthIf|Dir|Prio|Len|VlanId ][ offsetv
al <offsetval-val> ] [ maskval <maskval-val> ] [ value <value-val> ]
[ valend <valend-val> ] [ sbasetype Abs|Add|Compute|SetFromVar ]
[shiftcnt <shiftcnt-val>] [ mplr <mplr-val> ] [ sbvarindex l2start|l3start ]
[ nodeprio low|high|asintree ]
Parameter
Name
Description
pname <pname-val>
Name of the classifier profile
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Default value: -----
nodeid <nodeid-val>
Node Id, should be unique within a profile
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 0xffffffff
Default value: -----
descr <descr-val>
A brief description can be given with node, to
identify the node. If the ActVal is FwdToCtl or
CpToCtl then this field is mandatory and it can
be used by the applications to receive the
packets coming from control plane because of
this node.
Type: Create -- Optional
Modify -- Optional
Default value: 0
export true|false
Some of the nodes of a profile can be exported.
This flag tells whether this node is exported or
not
Type: Create -- Optional
Modify -- Optional
Default value: FALSE
Ntype
Leaf|Unary|Binary|Ternar
y|Linear|NonLinear
maskval <maskval-val>
346
This specifies the type of the Classifier node.
Type: Create -- Optional
Mask, used to select the individual bits to be
matched in a packet. If gsvClfrProfileNodeAction
is SetBase and gsvClfrProfileNodeSetBaseType
is Compute, then this value is used to specify
the mask, which shall be used to identify the
individual bits of the field of the packet used to
compute the new base offset. This field is valid
only if the gsvClfrProfileNodeValType is U8,
U16, U32 or U64.
This field is also valid if the g
gsvClfrProfileNodeAction is MatchInGenList.
Type : Create --Optional
Default Value : -value <value-val>
Value, to be matched. For NonLinear node
types,
this field is not valid. For Linear node types, this
value is used to specify the start of the range. If
gsvClfrProfileNodeAction is SetBase and
gsvClfrProfileNodeSetBaseType is Compute
then
this field is used to specify the value, which is to
be
added to base offset to calculate new base
offset. If
the gsvClfrProfileNodeAction is SetPrio or
RetagPrio then this field is used to specify the
priority which is to be assigned to the packet. If
the
gsvClfrProfileNodeAction is MatchInGenList then
this field is not valid. If the
gsvClfrProfileNodeAction is Count then this field
is read only and specifies total number of octets
of the packets hitting this node.
Type: Create -- Optional
Default value: ---
valend <valend-val>
For Linear nodes this field is used to specify the
end
of
the range. If the gsvClfrProfileNodeAction is
InRange then this field is used to specify the end
of
the
range. If the gsvClfrProfileNodeAction is count
then this field is used to specify the total number
of
packet hitting this node. For other actions this
field is not valid.
Type: Create -- Optional
Default value: -----
sbasetype Abs | Add |
Compute |
This field is valid only for the SET_BASE action
type. It is used to specify, whether the base off
set is to be set to an absolute value, or some
value is to be added to existing base offset value
to calculate new base offset value, or the new
base offset value is to be computed using some
value in the packet.
Type: Create -- Optional
Modify -- Optional
Default value: ---
shiftcnt <shiftcnt-val>
347
ShiftCount, is the number of times the Value in
the
packet is to be shifted before multiplying it with
the
gsvClfrProfileNodeMultiplier. This field is valid
only if the gsvClfrProfileNodeAction is SetBase.
Value 32 is meant for internal purpose and
Agents should not pass this value to GAG. GAG
may return 32 value to Agent, in which case
Agent should treat it as invalid.
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 31
Default value: --mplr <mplr-val>
Multiplier, is used to multiply the value shifted by
ShiftCount. It is used to calculate the new base
offset. This field is valid only if the
gsvClfrProfileNodeAction is SetBase.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 32
Default value: ----
Modmask
Act|ValType|Offset|Mask
|Val|None|ValueEnd|Sbt
ype|SBShiftCnt|SBMlpr|
Descrip
This specifies what fields of an exported node
are modifiable and can be modified while the
profile is part of a classifier tree.
Type: Create -- Optional
Modify -- Optional
Actval
Drop|Fwd|FwdToCtl|CpT
oCtl|Eq|Gt|Lt|InRange|Te
rCmp|
SetPrio|MatchInList|Acc
Deny|SetBase|Count|
Retagprio |
MatchIngenlist
|GoToNextRule|allow
348
Action tells what is to be done by a node. 'Drop'
means drop the packet. 'Fwd' means Forward
the packet. 'FwdToCtl' means Forward the
packet to control plane. 'CpToCtl' means forward
the packet and also send a copy of the packet to
control plane.'Allow' means give the packet to
the next stage. 'GoToNextRule' means go to the
next rule (ruleid) attached on that interface and if
no next rule is attached on that interface then
forward the packet. 'Eq' means check if value
specified in the packet is equal to 'Value'. 'Gt'
means check if the value at the location
specified in the packet is greater than 'Value'. 'Lt'
means check if the value at the location
specified in the packet is Less than 'Value'.
'InRange' means check if the value at the
location specified in the packet is in the range
specified by 'Value' and 'ValEnd'. 'TerCmp'
means check if the value at the location
specified in the packet is less than, equals to or
greater than the 'Value'. 'MatchInList' means
take the branch of the node whose value is
equals to the value at the location specified in
the packet. 'AccDeny' means check if the value
at the location specified in the packet is equals
to any of the value of the branches of this node.
'SetBase' means set the base address as
specified by 'setbase action'. 'SetPrio' means set
the internal priority, which is used along with
egress port traffic class mapping table, to
determine the output queue. 'Count' means
count the number of packet and bytes in the
packets reaching this nodes. 'RetagPrio' means
set the priority in the outgoing packet, which is
also used along with egress port traffic class
mapping table, to determine the output queue.
'MatchInGenList' means match value in packet
with values in genlist. For Leaf node, Drop, Fwd,
FwdToCtl, CpToCtl, Allow and GoToNextRule
are valid actions. For Unary node, Count,
SetPrio and RetagPrio are valid actions. For
Binary node, Eq, Gt, Lt, SetBase and
MatchInGenList are valid actions. For Ternary
node, TerCmp and InRange are valid actions.
For Linear node, only MatchInList is a valid
action. For NonLinear node, MatchinList and
AccDeny are valid actions.
Type: Create -- Mandatory
Modify -- Optional
Default value: ----Ntype
Leaf|Unary|Binary|Ternar
y|Linear|NonLinear
This specifies the type of the Classifier node.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 0xffffffff
Default value: -----
Offsetval offsetval
OffSet, in the packet with respect to the base
offset,
from
where we have to take the value, which is to be
matched. If gsvClfrProfileNodeAction is SetBase
and gsvClfrProfileNodeSetBaseType is Compute
then this value is used to specify the offset with
respect to the base offset, which shall be used to
specify the field of the packet used to compute
the new base offset. If the
gsvClfrProfileNodeValType is U8 the offset can
be odd or even. If the
gsvClfrProfileNodeValType is U16, U32 or U64
then
the
offset can only be even. This field is not valid for
any other value type.
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 64
Default value: -----
Valuetype valuetype
Value type tells, the type of value which is to be
matched/set. For leaf type nodes this field is not
valid. If gsvClfrProfileNodeAction is SetBase and
gsvClfrProfileNodeSetBaseType is Compute
then
this
value is used to specify the value type (U8, U16,
U32), which shall be used to compute the new
base offset. This field is not valid for other values
of
gsvClfrProfileNodeSetBaseType.
Type: Create -- Optional
Modify -- Optional
Default value: ----sbvarindex
L2Start|L3Start
This specifies setbase variable index. This field
is valid only if 'SetBaseType' is 'SetFromVar'.
'L2Start' is read-only containing Layer 2 header
start offset. 'L3Start' is read-only containing
Layer 3 header start offset. It should be ensured
that packet is IP packet before using 'L3Start'
value
.Type: Create -- Optional
Modify -- Optional
Default value: Invalid
349
nodeprio
Low|High|AsInTree
This specifies the priority of profile node. Based
on this priority value, the profile node is created
in fast or slow memory. In case priority is
specified as 'AsInTree', node priority will be
same as specified in the tree.
Type: Create -- Optional
Modify -- Optional
Default value: AsInTree
Example
$ create clfr profile node pname IGMP nodeid 1 ntype binary actval eq
valuetype u16 value 0xffff offsetval 12 maskval 0xffff
Output
Verbose Mode On
Entry Created
Profile Name
: IGMP
Node Id
: 3
Exported
Type
: true
: Binary
Node
Modification Mask : Act
Action
: eq
Value Type
Offset
: u16
: 12
Mask
: 0xffff
Value
: 0x800
Value End
: None
Set Base type
: none
Shift Count
Multiplier
: none
: none
Description
: Node to match the ip address
Verbose Mode Off:
Entry Created
Output field
350
Field
Description
Profile Name
Name of the classifier profile
Node Id
Node Id, should be unique within a profile
Exported
This specifies what fields of an exported node
are modifiable and can be modified while the
profile is part of a classifier tree.
Node Type
This specifies the type of the Classifier node
Modification Mask
This specifies what fields of this nodes can be
modified, if this node is an exported node.
Action
Action tells what is to be done by a node.
Value Type
Value type tells the type of value, which is to be
matched/set. For leaf type nodes this field is not
valid. if ActVal is SetBase and SBaseType is
Compute then this value is used to specify the
value type (U8, U16, U32), which shall be used
to compute the new base offset. This field is not
valid for other values of SBaseType.
Offset
OffSet, in the packet with respect to the base
offset, from where we have to take the value,
which is to be matched. If ActVal is SetBase and
SBaseType is Compute then this value is used
to specify the offset with respect to the base
offset, which shall be used to specify the field of
the packet used to compute the new base offset.
if the valuetype is U8 the offset can be odd or
even. If the ValueType is U16, U32 or U64 then
the offset can only be even. This field is not valid
for any other value type.
Mask
Mask, used to select the individual bits to be
matched in a packet. If ActVal is SetBase and
SBaseType is Compute then this value is used
to specify the mask, which shall be used to
identify the individual bits of the field of the
packet used to compute the new base offset.
This field is valid only if the ValueType is U8,
U16, U32 or U64. This field is also valid if the
ActVal is MatchInGenList.
Value
Value, to be matched. For NonLinear node
types, this field is not valid. For Linear node
types, this value is used to specify the start of
the range. if ActVal is SetBase and SBaseTypeis
Compute then this field is used to specify the
value,
which is to be added to base offset to calculate
new base offset. If the ActVal is SetPrio or
RetagPrio then this field is used to specify the
priority which is to be assigned to the packet. If
the ActVal is MatchInGenList then this field is
not
valid. If the ActVal is Count then this field is read
only and specifies total number of octet of the
packets hitting this node.
351
Value End
For Linear nodes this field is used to specify the
end of the range. If the ActVal is InRange then
this field is used to specify the end of the range.
If the ActVal is count then this field is used to
specify the total number of packet hitting this
node. For other actions this field is not valid.
Set Base type
SetBaseType is used to specify whether the
base off set is to be set to an absolute value, or
some value is to be added to existing base offset
value to calculate new base offset value or the
new base offset value is to be computed using
some value in the packet. This field is valid only
if the ActVal is SetBase.
Shift Count
ShiftCount, is the number of times the Value in
the packet is to be shifted before multiplying it
with the Mplr. This field is valid only if the ActVal
is SetBase. Value 32 is used to set shift count to
an invalid value.
Multiplier
Multiplier is used to multiply the value shifted by
ShiftCount. It is used to calculate the new base
offset. This field is valid only if the ActVal is
SetBase.
Description
Description of the profile node. If the ActVal is
FwdToCtl or CpToCtl then this field is mandatory
and it can be used by the applications to receive
the packets coming from control plane because
of this node.
SBVar Index
This specifies setbase variable index. This field
is valid only if 'SetBaseType' is 'SetFromVar'.
'L2Start' is read-only containing Layer 2 header
start offset. 'L3Start' is read-only containing
Layer 3 header start offset. It should be ensured
that packet is IP packet before using 'L3Start'
value
Node Priority
8.13.10
Clfr tree branch Commands
8.13.10.1
Get clfr tree branch
This specifies the priority of profile node. Based
on this priority value, the profile node is created
in fast or slow memory. In case priority is
specified as 'AsInTree', node priority will be
same as specified in the tree.
Description: Use this command to get.
Command Syntax: get clfr tree branch [tname <tname-val>] [pid
<pid-val>] [nodeid <nodeid-val>] [brtype <brtype-val>]
8.13.10.2
Create clfr tree branch
Description: Use this command to create.
Command Syntax: create clfr tree branch tname <tname-val>pid
<pid-val>nodeid <nodeid-val>brtype <brtype-val>childpid <childpidval>
8.13.10.3
Delete clfr tree branch
Description: Use this command to delete.
Command Syntax: create clfr tree branch tname <tname-val>pid
<pid-val>nodeid <nodeid-val>brtype <brtype-val>
Parameter
Name
Description
tname <tname-val>
Name of the classifier tree
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: ND - ND
pid <pid-val>
Profile Id. It should be unique within a tree
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 4
nodeid <nodeid-val>
Node Id, should be unique within a profile
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 4
brtype <brtype-val>
352
This specifies the branch types. For a unary
type node, only onlybr (0xfffffffffffffff9) branch
type is allowed. For binary type and Linear/NonLinear(Access Deny only) type,
TrueBr(0xfffffffffffffffd) and
FalseBr(0xfffffffffffffffe) are allowed. For ternary
type nodes LtBr(0xfffffffffffffffc), GtBr
(0xfffffffffffffffb), EqBr (0xfffffffffffffffa) are
allowed. For Linear, Non-Linear (match in list)
the actual value is allowed. The actual value
can be U8, U16, U32, U64, atmIf, ethernetIf,
aal5vc.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
childpid <childpid-val>
This object specifies Child Profile Id. The Child
Profile Id value 0 is used to add true and false
branches to a AccessDeny type node.
Type: Create -- Mandatory
Default value: 0
Example
$ create clfr tree branch tname t1 pid 2 nodeid 1 brtype truebr childpid 1
Output
Verbose Mode On
Entry Created
Tree Name
: tree1
Profile Id
: 3
Branch type : eq
Node Id
: 2
Child Profile Id : 4
Verbose Mode Off:
Entry Created
Output field
Field
Description
Tree Name
Name of the classifier tree
Profile Id
Profile Id. It should be unique within a tree
Node Id
Node Id, should be unique within a profile
Branch type
This specifies the branch types. For a unary type
node, only onlybr(0xfffffffffffffff9) branch type is
allowed. For binary type and Linear/NonLinear(Access Deny only) type,
TrueBr(0xfffffffffffffffd) and FalseBr(0xfffffffffffffffe)
are allowed. For ternary type nodes
LtBr(0xfffffffffffffffc), GtBr (0xfffffffffffffffb), EqBr
(0xfffffffffffffffa) are allowed. For Linear, NonLinear (match in list) the actual value is allowed.
The actual value can be U8, U16, U32, U64,
atmIf, ethernetIf, aal5vc.
Child Profile Id
This object specifies Child Profile Id. The Child
Profile Id value 0, is used to add true and false
branches to a AccessDeny type node.
8.13.11
Clfr tree info Commands
8.13.11.1
Get clfr tree info
Description: Use this command to get.
Command Syntax: get clfr tree info [tname <tname-val>]
8.13.11.2
Create clfr tree info
Description: Use this command to create.
Command Syntax: create clfr tree info tname <tname-val> [descr
<descry-val>] [enable | disable] [treeprio low | high]
353
8.13.11.3
Delete clfr tree info
Description: Use this command to delete.
Command Syntax: delete clfr tree info tname <tname-val>
8.13.11.4
Modify clfr tree info
Description: Use this command to create.
Command Syntax: modify clfr tree info tname <tname-val> [descr
<descry-val>] [enable | disable] [treeprio low | high]
Parameter
Name
Description
tname <tname-val>
Name of the classifier tree which is to be
included as subrule of this rule. This classifier
tree should exist and be enabled. A classifier
tree can be used only in one subrule. The
Maximum length of Name should be 32.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Default value: -----
descr <descry-val>
A brief description can be given with tree, to
identify the tree
Type: Create -- Optional
Modify -- Optional
Default value: 0
enable | disable
A tree cannot be deleted or modified, if it is
enabled. A tree can only be used, if it is
enabled. A tree can not be disabled, if it is being
used.
Type: Create -- Optional
Modify -- Optional
Default value: 2
treeprio low | high
Tells the priority of the tree. Based on this
priority value, the tree is created in fast or slow
memory.
Type: Create -- Optional
Modify -- Optional
Default value: low
Example
$ create clfr tree info tname tree1
Output
Verbose Mode On
Entry Created
354
Tree Name
: tree1
Status
: disable
Description
: tree1
Tree Priority
: High
Verbose Mode Off:
Entry Created
Output field
Field
Description
Tree Name
Name of the classifier tree
Status
A tree cannot be deleted or modified, if it is
enabled. A tree can only be used, if it is enabled.
A tree can not be disabled, if it is being used.
Description
A brief description can be given with tree, to
identify the tree
TreePriority
Tells the priority of the tree. Based on this
priority value, the tree is created in fast or slow
memory.
8.13.12
Clfr tree map Commands
8.13.12.1
Get clfr tree map
Description: Use this command to get.
Command Syntax: get clfr tree map [ifname <interface-name>]
8.13.12.2
Create clfr tree map
Description: Use this command to create.
Command Syntax: create clfr tree map ifname <interfacename>tname <tname-val> entrypid <entrypid-val>
8.13.12.3
Delete clfr tree map
Description: Use this command to delete.
Command Syntax: delete clfr tree map ifname <interface-name>
Parameter
Name
Description
ifname <interfacename>
Interface name, with which the tree is to be
associated
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Mandatory
tname <tname-val>
Type: Create -- Mandatory
entrypid <entrypid-val>
Type: Create -- Mandatory
Valid values: 1 - 0xffffffff
Example
$ create clfr tree map Ifname aal5-3 tname tree1 EntryPId 5
Output
Verbose Mode On
Entry Created
If Name
: aal5-3
Tree Name : tree1
Verbose Mode Off:
Entry Created
355
Entry Profile Id : 5
Output field
Field
Description
If Name
Interface name, with which the tree is to be
associated
Tree Name
Entry Profile Id
8.13.13
Clfr tree node Commands
8.13.13.1
Get clfr tree node
Description: Use this command to get.
Command Syntax: get clfr tree node [tname <tname-val>] [pid <pidval>] [nodeid <nodeid-val>]
8.13.13.2
Modify clfr tree node
Description: Use this command to get.
Command Syntax: modify clfr tree node tname <tname-val>pid
<pid-val>nodeid <nodeid-val> [ descr <descry-val> ] [ offset <offsetval> ] [ mask <mask-val> ] [ value <value-val> ] [act
Drop|Fwd|FwdToCtl|CpToCtl|Eq|Gt|Lt|InRange |TerCmp|
SetPrio|MatchInList|AccDeny|SetBase|Count| Retagprio |
MatchIngenlist|GoToNextRule| allow] [valend valend ] [sbasetype Abs |
Add | Compute] [ shiftcnt <shiftcnt-val> ] [ mplr <mplr-val> ] [valtype
U8|U16|U32|U64|AtmIf|Aal5Vc|EoaIf|EthIf|Dir|Prio|Len|vlanid][ sbvarin
dex l2start|l3start ] [nodeprio low]
Parameter
Name
Description
tname tname
Name of the classifier tree
Type: Modify -- Mandatory
Get -- Optional
Default value: -----
pid pid
Profile Id. It should be unique within a tree.
Type: Modify -- Mandatory
Get -- Optional
Valid values: 1 - 0xffffffff
Default value: -----
nodeid nodeid
Node Id, should be unique within a profile
Type: Modify -- Mandatory
Get -- Optional
Valid values: 1 - 0xffffffff
Default value: -----
descr descr
Description of the tree node. If the ActVal is
FwdToCtl or CpToCtl then this field is mandatory
and it can be used by the applications to receive
the packets coming from control plane because of
this node.
Type: Modify -- Optional
Default value: -----
offset offset
356
OffSet, in the packet with respect to the base
offset, from where we have to take the value,
which is to be matched. If ActVal is SetBase and
SBaseType is Compute then this value is used to
specify the offset with respect to the base offset,
which shall be used to specify the field of the
packet used to compute the new base offset. If the
ValueType is U8 the offset can be odd or even. If
the ValueType is U16, U32 or U64 then the offset
can only be even. This field is not valid for any
other value type.
Type: Modify -- Optional
Valid values: 0 - 65
Default value: ----mask mask
Mask, used to select the individual bits to be
matched in a packet. If gsvClfrTreeNodeAction is
SetBase and gsvClfrTreeNodeSetBaseType is
Compute, then this value is used to specify the
mask, which shall be used to identify the individual
bits of the field of the packet used to compute the
new base offset. This field is valid only if the
gsvClfrTreeNodeValType is U8, U16, U32 or U64.
This field is also valid if the
gsvClfrTreeNodeAction is MatchInGenList.
Type: Modify -- Optional
Default value: -----
value value
Value, to be matched. For NonLinear node types,
this field is not valid. For Linear node types, this
value is used to specify the start of the range. If
gsvClfrTreeNodeAction is SetBase and
NodeSetBaseType is Compute then this field is
used to specify the value, which is to be added to
base offset to calculate new base offset. If the
gsvClfrTreeNodeAction is SetPrio or RetagPrio
then this field is used to specify the priority which
is to be assigned to the packet. If the
gsvClfrTreeNodeAction is MatchInGenList then
this
field is not valid. If the gsvClfrTreeNodeAction is
Count, then this field is read only and specifies
total
number of octets of the packets hitting this node.
Type: Modify -- Optional
Default value: -----
act
Drop|Fwd|FwdToCtl|
CpToCtl|Eq|Gt|Lt|InR
ange|TerCmp|
SetPrio|MatchInList|A
ccDeny|SetBase|Cou
nt| Retagprio |
MatchIngenlist|
GoToNextRule|allow
357
Action tells what is to be done by a node. 'Drop'
means drop the packet. 'Fwd' means Forward the
packet. 'FwdToCtl' means Forward the packet to
control plane. 'CpToCtl' means forward the packet
and also send a copy of the packet to control
plane.'Allow' means give the packet to the next
stage. 'GoToNextRule' means go to the next rule
(ruleid) attached on that interface and if no next
rule is attached on that interface then forward the
packet. 'Eq' means check if value specified in the
packet is equal to 'Value'. 'Gt' means check if the
value at the location specified in the packet is
greater than 'Value'. 'Lt' means check if the value
at the location specified in the packet is Less than
'Value'. 'InRange' means check if the value at the
location specified in the packet is in the range
specified by 'Value' and 'ValEnd'. 'TerCmp' means
check if the value at the location specified in the
packet is less than, equals to or greater than the
'Value'. 'MatchInList' means take the branch of the
node whose value is equals to the value at the
location specified in the packet. 'AccDeny' means
check if the value at the location specified in the
packet is equals to any of the value of the
branches of this node. 'SetBase' means set the
base address as specified by setbase action.
'SetPrio' means set the internal priority, which is
used along with egress port traffic class mapping
table, to determine the output queue. 'Count'
means count the number of packet and bytes in
the packets reaching this nodes. 'RetagPrio'
means set the prirority in the outgoing packet,
which is also used along with egress port traffic
class mapping table, to determine the output
queue. 'MatchInGenList' means match value in
packet with values in genlist. For Leaf node, Drop,
Fwd, FwdToCtl, CpToCtl, Allow and
GoToNextRule are valid actions. For Unary node,
Count, SetPrio and RetagPrio are valid actions.
For Binary node, Eq, Gt, Lt, SetBase and
MatchInGenList are valid actions. For Ternary
node, TerCmp and InRange are valid actions. For
Linear node, only MatchInList is a valid action. For
NonLinear node, MatchinList and AccDeny are
valid actions.
Type: Modify -- Optional
valend valend
For Linear nodes this field is used to specify the
end of the range. If the gsvClfrTreeNodeAction is
InRange then this field is used to specify the end
of the range. If the gsvClfrTreeNodeAction is
count then this field is used to specify the total
number of packets hitting this node. For other
actions this field is not valid.
Type: Modify -- Optional
Default value: -----
sbasetype Abs | Add |
Compute
SetBaseType, is used to specify, whether the
base off set is to be set to an absolute value, or
some value is to be added to existing base offset
value to calculate new base offset value or the
new base offset value is to be computed using
some value in the packet.This field is valid only if
the ActVal is SetBase.
Type: Modify -- Optional
Default value: 4
shiftcnt shiftcnt
ShiftCount, is the number of times the Value in the
packet is to be shifted before multiplying it with the
gsvClfrTreeNodeMultiplier. This field is valid only if
the gsvClfrTreeNodeAction is SetBase.
Type: Modify -- Optional
Valid values: 0 – 31
Default value: ----
mplr mplr
Multiplier, is used to multiply the value shifted by
ShiftCount. It is used to calculate the new base
offset. This field is valid only if the
gsvClfrTreeNodeAction is SetBase.
Type: Modify -- Optional
Valid values: 1 - 32
Default value: ----
valtype
U8|U16|U32|U64|AtmI
f|Aal5Vc|EoaIf|EthIf|D
ir|Prio|Len|vlanid
Sbvarindex
l2start|l3start
358
Value type tells the type of value that is to be
matched/set.
This specifies the setbase variable index. 'L2Start'
is read-only, containing Layer 2 header start
offset. 'L3Start' is read-only, containing Layer 3
header start offset.
Nodeprio
low|high|asintree
This specifies the priority of the tree node. Based
on this priority value, the tree node is created in
fast or slow memory.
Example
$ get clfr tree node tname tree1 pid 2 nodeid 3
Output
Tree Name
: tree1
Profile Id
: 2
Node Id
: 3
Exported
: true
Node Type
: Binary
Offset
: 12
Multiplier
: NA
Modification Mask : act offset
Action
: eq
Value Type
: u32
Mask
: 0x0000000f
Value
: 0x0000000f
ValueEnd
: NA
Set Base type
: NA
Shift Count
: NA
Description
: Node to match the ip address
Output field
Field
Description
Tree Name
Name of the classifier tree.
Profile Id
Profile Id. It should be unique within a tree
Node Id
Node Id, should be unique within a profile
Exported
This specifies what fields of an exported node
are modifiable and can be modified while the
profile is part of a classifier tree.
Node Type
This specifies the type of the Classifier node
Modification Mask
This specifies what fields of this nodes can be
modified, if this node is an exported node.
Action
Action tells what is to be done by a node.
Value Type
Value type tells, the type of value which is to be
matched/set. For leaf type nodes this field is not
valid. If ActVal is SetBase and SBaseType is
Compute then this value is used to specify the
value type (U8, U16, U32), which shall be used
to compute the new base offset. This field is not
valid for other values of SBaseType.
Offset
OffSet, in the packet with respect to the base
offset, from where we have to take the value,
which is to be matched. If ActVal is SetBase and
SBaseType is Compute then this value is used
to specify the offset with respect to the base
offset,
which shall be used to specify the field of the
packet used to compute the new base offset. If
the valuetype is U8 the offset can be odd or
even. If the ValueType is U16, U32 or U64 then
the offset can only be even. This field is not valid
for any other value type.
Mask
359
Mask, used to select the individual bits to be
match in a packet. If ActVal is SetBase and
SBaseTypeis Compute then this value is used to
specify the mask, which shall be used to identify
the individual bits of the field of the packet used
to compute the new base offset.This field is valid
only if the ValueType is U8, U16, U32 or U64.
This field is also valid if the ActVal is
MatchInGenList.
Value
Value, to be matched. For NonLinear node
types, this field is not valid. For Linear node
types, this value is used to specify the start of
the range. if ActVal is SetBase and SBaseTypeis
Compute then this field is used to specify the
value, which is to be added to base offset to
calculate new base offset. If the ActVal is
SetPrio or RetagPrio then this field is used to
specify the priority which is to be assigned to the
packet. If the ActVal is MatchInGenList then this
field is not valid. If the ActVal is Count then this
field is read only and specifies total number of
octet of the packets hitting this node.
ValueEnd
For Linear nodes this field is used to specify the
end of the range. If the ActVal is InRange then
this field is used to specify the end of the range.
If the ActVal is count then this field is used to
specify the total number of packet hitting this
node. For other actions this field is not valid.
Set Base type
SetBaseTyp, is used to specify whether the base
off set is to be set to an absolute value, or some
value is to be added to existing base offset value
to calculate new base offset value or the new
base offset value is to be computed using some
value in the packet. This field is valid only if the
ActVal is SetBase.
Shift Count
ShiftCount is the number of times the Value in
the packet is to be shifted before multiplying it
with the Mplr. This field is valid only if the ActVal
is SetBase. Value 32 is used to set shift count to
an invalid value.
Multiplier
Multiplier is used to multiply the value shifted by
ShiftCount. It is used to calculate the new base
offset. This field is valid only if the ActVal is
SetBase.
Description
Description of the profile node. If the ActVal is
FwdToCtl or CpToCtl then this field is mandatory
and it can be used by the applications to receive
the packets coming from control plane because
of this node.
8.13.14
Clfr tree profile Commands
8.13.14.1
Get clfr tree profile
Description: Use this command to get.
Command Syntax: get clfr tree profile [tname <tname-val>] [pid
<pid-val>]
8.13.14.2
Create clfr tree profile
Description: Use this command to create.
Command Syntax: create clfr tree profile tname <tname-val>pid
<pid-val>pname <pname-val> [isroot <isroot-val>]
8.13.14.3
Delete clfr tree profile
Description: Use this command to delete.
360
Command Syntax: get clfr tree profile tname <tname-val> pid <pidval>
8.13.14.4
Modify clfr tree profile
Description: Use this command to modify.
Command Syntax: modify clfr tree profile tname <tname-val>pid
<pid-val> [isroot true|false]
Parameter
Name
Description
tname <tname-val>
Name of the classifier tree
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Default value: ----Profile Id. It should be unique within a tree
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 0xffffffff
Default value: ----Name of the profile which is to be added
Type: Create -- Mandatory
Delete -- Optional
Modify -- Optional
Get -- Optional
Default value: ----This specifies whether this profile is exported as
a root profile or not. Only root profiles of the
nodes can be specified as an entry point on an
interface.
Type: Create -- Optional
Delete -- Optional
Modify -- Optional
Get -- Optional
Valid values: true, false
Default value:FALSE
pid <pid-val>
pname <pname-val>
isroot <isroot-val>
Example
$ create clfr tree profile tname tree1 pid 4 pname srcip
Output
Verbose Mode On
Entry Created
Tree Name
: tree1
Profile Id : 4
Profile Name : srcip
Is Root
: false
Verbose Mode Off:
Entry Created
Output field
361
Field
Description
Tree Name
Name of the classifier tree
Profile Id
Profile Id. It should be unique within a tree
Profile Name
Name of the profile which is to be added
Is Root
This specifies whether this profile is exported as
a root profile or not. Only root profiles of the
nodes can be specified as an entry point on an
interface.
8.13.15
Filter expr entry Commands
8.13.15.1
Get filter expr entry
Description: Use this command to get.
Command Syntax: get filter expr entry [exprid <exprid-val>]
8.13.15.2
Create filter expr entry
Description: Use this command to create.
Command Syntax: create filter expr entry exprid <expridval>exprstring <exprstring-val>
8.13.15.3
Delete filter expr entry
Description: Use this command to delete.
Command Syntax: delete filter expr entry exprid <exprid-val>
Parameter
Name
Description
exprid <exprid-val>
Unique identifier for a filter expression.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 -65535
exprstring <exprstringval>
Expression string contains the expression
relating the subrules of a rule using the &
(AND), | (OR), ! (NOT) operators, parenthesis
(for precedance) and actions to be executed.
Valid actions are drop, allow, setprio,
sendtocontrol, retagprio, copytocontrol,
gotonextrule, forwardexit. If 'ruleDir' value is
'out', only drop, allow, gotonextrule and
forwardexit action types are valid. For eg.
"(1|2):drop" will be used to drop all packets
which match subrules 1 or 2.
Type: Create -- Mandatory
Example
$ create filter expr entry exprid 1 exprstring “(1|2):drop”
Output
Verbose Mode On
Entry Created
Expr Id
: 1
Exprstring : (1|2):drop
Verbose Mode Off:
Entry Created
Output field
362
Field
Description
Expr Id
Unique identifier for a filter expression.
Exprstring
Expression string contains the expression
relating the subrules of a rule using the & (AND),
| (OR), ! (NOT) operators, parenthesis (for
precedance) and actions to be executed. Valid
actions are drop, allow, setprio, sendtocontrol,
retagprio, copytocontrol, gotonextrule,
forwardexit. If 'ruleDir' value is 'out', only drop,
allow, gotonextrule and forwardexit action types
are valid. For eg. "(1|2):drop" will be used to
drop all packets which match subrules 1 or 2.
8.13.16
Filter list genentry Commands
8.13.16.1
Get filter list genentry
Description: Use this command to get.
Command Syntax:
8.13.16.2
Create filter list genentry
Description: Use this command to create.
Command Syntax: create filter list genentry ifname <interfacename>value <value-val>] [valtype U8 | U16 | U32]
8.13.16.3
Delete filter list genentry
Description: Use this command to delete.
Command Syntax: delete filter list genentry ifname <interfacename> value <value-val>
Parameter
Name
Description
ifname <interface-name>
Name of ethernet, eoa, ipoe or pppoe interface,
for which the generic filter generic list is created.
Valid values for the field are between EOA-0
and EOA-23 or between eth-0 and eth-1or
between IPOE-0 and IPOE-191 or between
PPPOE-0 and PPPOE-191.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
value <value-val>
List Entry Value, for the generic filter generic
list. This value must be consistent with the
mentioned valuetype of generic list.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
valtype U8 | U16 | U32
This field specifies value type of the entry. The
value type for all entries on an interface should
be same. Value type should match value type of
subrule field for which comparsion type is
ingenlist or notingenlist incase the rule
containing the subrule is attached on the same
interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is
attached on same interface. Currently only 'U32'
value is supported.
Type: Create -- Optional
Default value: U32
Example
363
$ create filter list genentry ifname eoa-1 value 0xAC1901AA valtype
u32
Output
Verbose Mode On
Entry Created
IfName
: eoa-1
Value
: 0xAC1901AA
Value Type : u32
Verbose Mode Off:
Entry Created
Output field
Field
Description
IfName
Name of ethernet, eoa, ipoe or pppoe interface,
for which the generic filter generic list is created.
Valid values for the field are between EOA-0 and
EOA-23 or between eth-0 and eth-1or between
IPOE-0 and IPOE-191 or between PPPOE-0
and PPPOE-191.
Value
List Entry Value, for the generic filter generic list.
This value must be consistent with the
mentioned valuetype of generic list.
Value Type
This field specifies value type of the entry. The
value type for all entries on an interface should
be same. Value type should match value type of
subrule field for which comparsion type is
ingenlist or notingenlist incase the rule
containing the subrule is attached on the same
interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as InGenList or NotInGenList is
attached on same interface. Currently only 'U32'
value is supported.
8.13.17
Filter namedlist genentry Commands
8.13.17.1
Get filter namedlist genentry
Description: Use this command to get.
Command Syntax: get filter namedlist genentry [listid <listid-val>]
[value <value-val>]
8.13.17.2
Create filter namedlist genentry
Description: Use this command to create.
Command Syntax: create filter namedlist genentry listid <listid-val>
value value-val>] [valueto <valueto-val>]
8.13.17.3
Delete filter namedlist genentry
Description: Use this command to delete.
Command Syntax: delete filter namedlist genentry listid <listid-val>
value <value-val>
Parameter
Name
364
Description
listid <listid-val>
This field stores the list identifier value. There
must be a row indexed on the same id in the
Generic Filter Named List Table.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 65535
value <value-val>
This value is mandatory for all list types. The
interpretation of value depends upon the type
of the list. If the list type is discrete, then this
value is the list entry value. If the list type is
range, then this value is the lower limit of
range. The upper limit of range is specified in
valueto field.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
valueto <valueto-val>
This value is not required for discrete lists but
is mandatory for lists of type range. For range
type lists this value specifies the upper limit of
range.
Type: Create -- Optional
Default value: 0
Example
$ create filter namedlist genentry listid 2 value 0xAC1901AA valueto
0xAC1901AA
Output
Verbose Mode On
Entry Created
ListId
: 2
Value
: 0xAC1901AA
ValueTo : 0xAC1901AA
Verbose Mode Off:
Entry Created
Output field
365
Field
Description
ListId
This field stores the list identifier value. There
must be a row indexed on the same id in the
Generic Filter Named List Table.
Value
This value is mandatory for all list types. The
interpretation of value depends upon the type
of the list. If the list type is discrete, then this
value is the list entry value. If the list type is
range, then this value is the lower limit of
range. The upper limit of range is specified in
valueto field.
ValueTo
This value is not required for discrete lists but
is mandatory for lists of type range. For range
type lists this value specifies the upper limit of
range.
8.13.18
Filter namedlist info Commands
8.13.18.1
Get filter namedlist info
Description: Use this command to get.
Command Syntax: get filter namedlist info [listid <listid-val>]
8.13.18.2
Create filter namedlist info
Description: Use this command to get.
Command Syntax: create filter namedlist info listid <listid-val>
[listtype discrete | range] [valtype U8 | U16 | U32]
8.13.18.3
Delete filter namedlist info
Description: Use this command to get.
Command Syntax: delete filter namedlist info listid <listid-val>
8.13.18.4
Modify filter namedlist info
Description: Use this command to get.
Command Syntax: modify filter namedlist info listid <listid-val>
[valtype U8 | U16 | U32]
Parameter
Name
Description
listid <listid-val>
This field stores the list identifier value.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
listtype discrete | range
This field identifies the type of list. If the type is
discrete, then list can contain max. of 8 discrete
entries. If the type is range, then list can contain
max 4 entries. Lists of type range cannot be
specified with subrules having cmptype as
innamedlist or notinnamedlist. It can only be
used for mapping to create genlist of an
interface.
Type: Create -- Optional
Default value: discrete
valtype U8 | U16 | U32
This field specifies the value type of list. Value
type should match value type of subrule field for
which comparsion type is innamedlist or
notinnamedlist. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
comparision type (srcaddrcmp / gencmp) as
'ingenlist' or 'notingenlist' is attached on same
interface. Currently only 'U32' value is
supported.
Type: Create -- Optional
Modify -- Optional
Default value: U32
Example
$ create filter namedlist info listid 2 listtype discrete valtype u32
Output
366
Verbose Mode On
Entry Created
ListId
: 2
List Type
: discrete
Value Type : u32
Verbose Mode Off:
Entry Created
Output field
Field
Description
ListId
This field stores the list identifier value.
List Type
This field identifies the type of list. If the type is
discrete, then list can contain max. of 8 discrete
entries. If the type is range, then list can contain
max 4 entries. Lists of type range cannot be
specified with subrules having cmptype as
innamedlist or notinnamedlist. It can only be
used for mapping to create genlist of an
interface.
Value Type
This field specifies the value type of list. Value
type should match value type of subrule field for
which comparsion type is innamedlist or
notinnamedlist. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
comparision type (srcaddrcmp / gencmp) as
'ingenlist' or 'notingenlist' is attached on same
interface. Currently only 'U32' value is
supported.
8.13.19
Filter namedlist map Commands
8.13.19.1
Get filter namedlist map
Description: Use this command to get.
Command Syntax: get filter namedlist map [ifname <interfacename>]
8.13.20
Create filter namedlist map
Description: Use this command to create.
Command Syntax: create filter namedlist map ifname <interfacename> listid <listid-val>
8.13.20.1
Delete filter namedlist map
Description: Use this command to delete.
Command Syntax: delete filter namedlist map ifname <interfacename>
Parameter
Name
Description
ifname <interface-name>
This specifies the eoa ,pppoe, ipoe or ethernet
interface to which named generic list is
attached. Valid values for the field are between
EOA-0 and EOA-23 or between eth-0 and eth1or between IPOE-0 and IPOE-191 or between
PPPOE-0 and PPPOE-191.
Type: Create -- Mandatory
367
Delete -- Mandatory
Get -- Optional
listid <listid-val>
This field stores the list identifier value. A row
indexed by this id must exist in Generic Filter
Named List Table. Value type of the list should
match subrule field for which comparsion type is
ingenlist or notingenlist incase the rule
containing the subrule is attached on the same
interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as ingenlist or notingenlist is attached
on same interface. The list type can either
discrete or range.
Type: Create -- Mandatory
Valid values: 1 - 65535
Example
$ create filter namedlist map ifname eoa-1 listid 2
Output
Verbose Mode On
Entry Created
IfName : eoa-1
ListId : 2
Verbose Mode Off:
Entry Created
Output field
Field
Description
IfName
This specifies the eoa, pppoe, ipoe or ethernet
interface to which named generic list is attached.
Valid values for the field are between EOA-0 and
EOA-23 or between eth-0 and eth-1or between
IPOE-0 and IPOE-191 or between PPPOE-0
and PPPOE-191.
ListId
This field stores the list identifier value. A row
indexed by this id must exist in Generic Filter
Named List Table. Value type of the list should
match subrule field for which comparsion type is
ingenlist or notingenlist incase the rule
containing the subrule is attached on the same
interface. It should be 'U32' in case a rule
containing IP subrule or Generic subrule with
cmptype as ingenlist or notingenlist is attached
on same interface. The list type can either
discrete or range.
8.13.21
Filter rule actionmap Commands
8.13.21.1
Get filter rule actionmap
Description: Use this command to get.
Command Syntax: get filter rule actionmap [ruleid <ruleid-val >]
[orderindex <orderindex-val >]
8.13.21.2
Create filter rule actionmap
Description: Use this command to create.
368
Command Syntax: create filter rule actionmap ruleid <ruleid-val >
orderindex <orderindex-val> action SetPrio | RetagPrio |
CopyToControl | ModifyTos | SetBacLevel | PktVlanId | RetagVlanId |
PktServiceVlanId | RetagServiceVlanId | RetagServicePrio | Mirror
[priority <priority-val>] [actionval <actionval-val>] [actionmask
<actionmask-val>]
8.13.21.3
Delete filter rule actionmap
Description: Use this command to delete.
Command Syntax: delete filter rule actionmap ruleid <ruleid-val>
orderindex <orderindex-val>
8.13.21.4
Modify filter rule actionmap
Description: Use this command to modify.
Command Syntax: modify filter rule actionmap ruleid <ruleid-val>
orderindex <orderindex-val> [action SetPrio | RetagPrio |
CopyToControl | ModifyTos | SetBacLevel | PktVlanId | RetagVlanId |
PktServiceVlanId | RetagServiceVlanId | RetagServicePrio | Mirror]
[priority <priority-val>] [actionval <actionval-val>] [actionmask
<actionmask-val>]
Parameter
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule entry for which this
mapping is being created
Type: Create -- Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 65535
This is the order index to allow creation of multiple
entries in this table with a single rule identified by
'ruleid'. Multiple actions of the rule are applied in
the increasing order of this field
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 -255
This field specifies the action of the rule
Type: Create - Mandatory
Modify - Optional
orderindex
<orderindex-val>
action SetPrio |
RetagPrio|
CopyToControl
|ModifyTos |
SetBacLevel
|PktVlanId |
RetagVlanId
|PktServiceVlanId
|RetagServiceVlanId
|RetagServicePrio |
Mirror
priority <priority-val>
actionval <actionvalval>
369
This field specifies the priority to be set for the
matching packets. It is valid only if 'action' is either
'setprio' or 'retagprio'or 'retagserviceprio'.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 0
The parameter should contain valid value for
some actions that require an additional input,
other than setprio, retagprio, and retagserviceprio
actions. For copytocontrol action this parameter
should contain trap level 0 (trap disabled) or 1
(trap enabled). Other values are invalid for this
actionmask
<actionmask -val>
action. For modifytos action this parameter should
contain value to be set in TOS field in the packet
in the range 0 to 255. Other values are invalid for
this action. The application of this value is
dependent on the mask parameter. For
setbaclevel action this parameter should contain
valid Buffer Admission Control level value of 0 or
1. For pktvlanid, retagvlanid, pktservicevlanid and
retagservicevlanid actions this parameter should
be filled with VLAN ID value in the range 1 to
4094. For mirror action this parameter should be
filled with valid mirror context id.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 0xffffffff
Default value: 0
This field is valid for modifytos action only. Only
lower 8-bits are taken into consideration for
modifytos action and other bits are ignored. In the
mask if a bit location contains 1, then the
corresponding bit in the TOS field is overwritten
with the corresponding bit in action value. In the
mask if a bit location contains 0, then the
corresponding bit in the TOS field remains
unchanged.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 0xffffffff
Default value: 0xffffffff
Example
$ create filter rule actionmap ruleid 1 orderindex 1 action SetPrio priority 3
actionval 0x00000000 actionmask 0xffffffff
Output
Verbose Mode On
Entry Created
Rule Id
: 1
Order Index : 1
Action
: SetPrio
Priority
: 3
ActionValue : 0x00000000
Action Mask : 0xffffffff
Verbose Mode Off:
Entry Created
Output field
370
Field
Description
Rule Id
Unique identifier of a filter rule entry for which
this mapping is being created
Order Index
This is the order index to allow creation of
multiple entries in this table with a single rule
identified by 'ruleid'. Multiple actions of the rule
are applied in the increasing order of this field
Action
This field specifies the action of the rule
Priority
This field specifies the priority to be set for the
matching packets. It is valid only if 'action' is
either 'setprio' or 'retagprio'or 'retagserviceprio'.
ActionValue
The parameter should contain valid value for
some actions that require an additional input,
other than setprio, retagprio, and
retagserviceprio actions. For copytocontrol
action this parameter should contain trap level 0
(trap disabled) or 1 (trap enabled). Other values
are invalid for this action. For modifytos action
this parameter should contain value to be set in
TOS field in the packet in the range 0 to 255.
Other values are invalid for this action. The
application of this value is dependent on the
mask parameter. For setbaclevel action this
parameter should contain valid Buffer Admission
Control level value of 0 or 1. For pktvlanid and
pktservicevlanid actions this parameter should
be filled with VLAN ID value in the range 1 to
4094. For mirror action this parameter should
be filled with valid mirror context id.
Action Mask
8.13.22
Filter rule entry Commands
8.13.22.1
Get filter rule entry
This field is valid for modifytos action only. Only
lower 8-bits are taken into consideration for
modifytos action and other bits are ignored. In
the mask if a bit location contains 1, then the
corresponding bit in the TOS field is overwritten
with the corresponding bit in action value. In the
mask if a bit location contains 0, then the
corresponding bit in the TOS field remains
unchanged.
Description: Use this command to get.
Command Syntax: get filter rule entry [ruleid <ruleid-val>]
8.13.22.2
Create filter rule entry
Description: Use this command to create.
Command Syntax: create filter rule entry ruleid r<ruleid-val>
[ action drop | allow | setprio | sendtocontrol | retagprio | copytocontrol |
clfrdef | gotonextrule | forwardexit| exprdef | modifytos | setbaclevel |
pktvlanid | retagvlanid | pktservicevlanid | retagservicevlanid |
retagserviceprio | ratelimiter | Mirror ] [ description <description-val> ]
[ priority <priority-val> ] [ status enable | disable ] [ statsstatus enable
| disable ] [ ruleprio low | high ] [ ruledir in | out ] [ applywhenreq
enable | disable ] [ pkttype Mcast | Bcast | Ucast ] [ snooplevel
interface | bridge ] [ exprid <exprid-val> ] [ actionval <actionval-val> ]
[ actionmask <actionmask-val> ]
8.13.22.3
Delete filter rule entry
Description: Use this command to delete.
Command Syntax: delete filter rule entry ruleid <ruleid-val >
8.13.22.4
Modify filter rule entry
Description: Use this command to modify.
Command Syntax: modify filter rule entry ruleid <ruleid-val>
[ action drop | allow | setprio | sendtocontrol | retagprio | copytocontrol |
clfrdef | gotonextrule | forwardexit | exprdef | modifytos | setbaclevel |
pktvlanid | retagvlanid | pktservicevlanid | retagservicevlanid |
retagserviceprio | ratelimiter | Mirror ] [ description <description-val> ]
[ priority <priority-val> ] [ status enable | disable ] [ statsstatus enable
| disable ] [ ruleprio low | high ] [ applywhenreq enable | disable ]
[ pkttype Mcast | Bcast | Ucast ] [ snooplevel interface | bridge ]
[ exprid <exprid-val> ] [ actionval <actionval-val> ] [ actionmask
<actionmask-val> ]
Parameters
371
Name
Description
ruleid <ruleid-val >
Unique identifier of a filter rule.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1-65535
Action to be applied for the packets matching
this filter rule. This field can be modified only if
'ruleStatus' has the value 'disable'. 'exprdef(10)'
action has a special significance that action is
defined in the expression. In this case the
'ExprId' field must be specified. For other types
of actions, the default relationship between
subrules is all ANDed. If 'ruleDir' value is 'out',
'clfrdef' and 'ratelimiter' action types are invalid.
If the action is 'clfrdef', then the rule can have at
most one subrule, that too of type 'clfrtree'. The
actions setprio, retagprio and setserviceprio
require priority value to be specified in
ruleSetPrio parameter. The actions
sendtocontrol, copytocontrol, modifytos,
setbaclevel, setvlanid, retagvlanid,
setservicevlanid, retagservicevlanid, ratelimiter
and mirror require an additional value to be
specified in ruleActionVal parameter. The
actions sendtocontrol, copytocontrol and
modifytos also require ruleActionMask
parameter to be specified.
Type: Create - Optional
Modify - Optional
Default value: drop
Description of the application that receives
packets matching this rule. This field is valid and
mandatory only if RuleAction is 'sendtocontrol' or
RuleApplyWhenReq is 'enable'. This field can be
modified only if 'status' has the value 'disable'
Type: Create - Optional
Modify - Optional
Default value: "\0"
Priority to be set for packets matching this rule.
This field is valid only if RuleAction is 'setprio' or
'retagprio'. If the RuleAction is 'setprio' then this
value is internal priroity and is used along with
egress port traffic class mapping table, to
determine the output queue. If the RuleAction is
'retagprio' then this value is priority which is to
be tagged into the outgoing packet and it is also
used along with egress port traffic class mapping
table, to determine the output queue. This field
can be modified only if 'status' has the value
'disable'.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 0
Admin status of the rule
Type: Create - Optional
Modify - Optional
Default value: disable
Admin status of rule statistics. Statitics of a rule
are collected only when this field is set to
'enable'. This field can be modified only if 'status'
has the value 'disable'. NOTE - Statistics may
not reflect correctly the number of egress mcast,
bcast and unknown unicast packets hitting the
rule.
action drop | allow
|setprio | sendtocontrol
|retagprio | copytocontrol|
clfrdef | gotonextrule
|forwardexit | exprdef
|modifytos | setbaclevel
|pktvlanid | retagvlanid
|pktservicevlanid
|retagservicevlanid
|retagserviceprio
|ratelimiter | Mirror
description
<description-val>
priority <priority-val>
status enable | disable
statsstatus enable
|disable
372
ruleprio low | high
ruledir in | out
applywhenreq enable
|disable
pkttype Mcast | Bcast
|Ucast
snooplevel interface
|bridge
exprid <exprid-val>
Type: Create - Optional
Modify - Optional
Default value: disable
Tells the priority of the rule. Based on this
priority value, the rule is created in fast or slow
memory. This field can be modified only if
'status' has the value 'disable'. This field is
ignored if the 'ruleAction' has value 'clfrdef'
Type: Create - Optional
Modify - Optional
Default value: high
Specifies whether the rule will be applied on
incoming interfaces (ingress)or outgoing
interfaces(egress).
Type: Create - Optional
Default value: in
This specifies whether this rule is to be applied
only when required. Rule description field is
mandatory if this field is set to value 'enable'.
This field can be modified only if 'status' has the
value 'disable'. This field is ignored if the
'ruleAction' has value 'clfrdef'.
Type: Create - Optional
Modify - Optional
Default value: disable
This field specifies the types of packets on which
this rule is to be applied. 'Mcast' means this rule
is valid for multicast packets, 'Bcast' means this
rule is valid for broadcast packets and 'Ucast'
means this rule is valid for unicast packets. This
field is valid only if 'ruleDir' is 'out'. This field can
be modified only if 'status' has the value
'disable'. Type: Create - Optional
Modify - Optional
Default value: Ucast
Snoop level specifies whether packet will be
snooped directly from Interface or from Bridge
after applying Bridging functionality .If none of
the Rule actions is 'sendtoControl' or
'copytocontrol', then this field has no
significance. This field can be modified only if
'status' has the value 'disable'. Type: Create -
Optional
Modify - Optional
Default value: interface
Identifies the expression id from the Generic
Filter Expression Table to be used. This field is
used only if 'ruleAction' is 'exprdef'. In absence
of this field, the default relationship between all
subrules is all ANDed.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 65535
Default value: 0
Example
$ create filter rule entry ruleid 1 action setprio description lacp priority 7
status enable statsstatus disable ruleprio high ruledir in applywhenreq
disable pkttype Ucast snooplevel interface exprid exprid 1 actionval
0x00000000 actionmask 0xffffffff
Output
Verbose Mode On
Entry Created
Rule Id
373
: 1
Rule Action
: setprio
Set Priority
: 7
Admin status
Stats admin status
: disable
Rule Priority : high
: enable
Rule Direction
: in
ApplyWhenReq
Pkt Type
: Ucast
: disable
Application Description : lacp
Snoop Level
: interface
Expression Id
: exprid 1
Action Value
: 0x00000000
Action Mask
: 0xffffffff
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule.
Rule Action
Action to be applied for the packets matching this
filter rule. This field can be modified only if
'ruleStatus' has the value 'disable'. ‘exprdef (10)'
action has a special significance that action is
defined in the expression. In this case the 'ExprId'
field must be specified. For other types of actions,
the default relationship between subrules is all
ANDed. If 'ruleDir' value is 'out', 'clfrdef' and
'ratelimiter' action types are invalid. If the action is
'clfrdef', then the rule can have at most one
subrule, that too of type 'clfrtree'. The actions
setprio, retagprio and setserviceprio require
priority value to be specified in ruleSetPrio
parameter. The actions sendtocontrol,
copytocontrol, modifytos, setbaclevel, setvlanid,
retagvlanid, setservicevlanid, retagservicevlanid,
ratelimiter and mirror require an additional value to
be specified in ruleActionVal parameter. The
actions sendtocontrol, copytocontrol and
modifytos also require ruleActionMask parameter
to be specified.
Priority to be set for packets matching this rule.
This field is valid only if RuleAction is 'setprio' or
'retagprio'. If the RuleAction is 'setprio' then this
value is internal priroity and is used along with
egress port traffic class mapping table, to
determine the output queue. If the RuleAction is
'retagprio' then this value is priority which is to be
tagged into the outgoing packet and it is also used
along with egress port traffic class mapping table,
to determine the output queue. This field can be
modified only if 'status' has the value 'disable'.
Admin status of the rule
Admin status of rule statistics. Statitics of a rule
are collected only when this field is set to 'enable'.
This field can be modified only if 'status' has the
value 'disable'. NOTE - Statistics may not reflect
correctly the number of egress mcast, bcast and
unknown unicast packets hitting the rule.
Tells the priority of the rule. Based on this priority
value, the rule is created in fast or slow memory.
This field can be modified only if 'status' has the
value 'disable'. This field is ignored if the
'ruleAction' has value 'clfrdef'
Specifies whether the rule will be applied on
incoming interfaces (ingress)or outgoing
interfaces(egress).
Set Priority
Admin status
Stats admin status
Rule Priority
Rule Direction
374
ApplyWhenReq
Pkt Type
Application
Description
Snoop Level
Expression Id
Action Value
Action Mask
375
This specifies whether this rule is to be applied
only when required. Rule description field is
mandatory if this field is set to value 'enable'. This
field can be modified only if 'status' has the value
'disable'. This field is ignored if the 'ruleAction' has
value 'clfrdef'.
This field specifies the types of packets on which
this rule is to be applied. 'Mcast' means this rule is
valid for multicast packets, 'Bcast' means this rule
is valid for broadcast packets and 'Ucast' means
this rule is valid for unicast packets. This field is
valid only if 'ruleDir' is 'out'. This field can be
modified only if 'status' has the value 'disable'.
Description of the application that receives
packets matching this rule. This field is valid and
mandatory only if RuleAction is 'sendtocontrol' or
RuleApplyWhenReq is 'enable'. This field can be
modified only if 'status' has the value 'disable'
Snoop level specifies whether packet will be
snooped directly from Interface or from Bridge
after applying Bridging functionality .If none of the
Rule actions is 'sendtoControl' or 'copytocontrol',
then this field has no significance. This field can
be modified only if 'status' has the value 'disable'.
Identifies the expression id from the Generic Filter
Expression Table to be used. This field is used
only if 'ruleAction' is 'exprdef'. In absence of this
field, the default relationship between all subrules
is all ANDed.
The parameter should contain valid value for
some actions that require an additional input,
other than setprio, retagprio, and retagserviceprio
actions. For sendtocontrol and copytocontrol
actions this parameter should contain control flow
id (0-3). Other values are invalid for this action.
For modifytos action this parameter should contain
value to be set in TOS field in the packet in the
range 0 to 255. Other values are invalid for this
action. The application of this value is dependent
on the mask parameter. For setbaclevel action this
parameter should contain valid Buffer Admission
Control level value of 0 or 1. For pktvlanid,
retagvlanid, pktservicevlanid and
retagservicevlanid actions this parameter should
be filled with VLAN ID value in the range 1 to
4094. For ratelimiter action this parameter should
be filled with the valid user-defined flow type
value. For mirror action this parameter should be
filled with valid mirror context id. This parameter is
ignored for other actions. Specifying an invalid
value for an action would result in error when the
rule is enabled.
This field is valid for sendtocontrol, copytocontrol
and modifytos actions only. For sendtocontrol and
copytocontrol actions this parameter should
contain trap level 0xffffffff (trap disabled) or
0x00000000(trap enabled). Other values are
invalid for this action. For modifytos action, only
lower 8-bits are taken into consideration and other
bits are ignored. In the mask if a bit location
contains 1, then the corresponding bit in the TOS
field is overwritten with the corresponding bit in
action value. In the mask if a bit location contains
0, then the corresponding bit in the TOS field
remains unchanged.
8.13.23
Filter rule map Commands
8.13.23.1
Get filter rule map
Description: Use this command to get.
Command Syntax: get filter rule map [ifname <interface-name> | all
| alleoa | alleth | allpppoe | allcpe | allipoe] [stageid <stageid-val>]
[ruleid <ruleid-val>]
8.13.23.2
Create filter rule map
Description: Use this command to create.
Command Syntax: create filter rule map ifname <interface-name>|
all | alleoa | alleth | allpppoe | allcpe | allipoe stageid <stageid-val>
ruleid <ruleid-val> [orderid <orderid-val>]
8.13.23.3
Delete filter rule map
Description: Use this command to delete.
Command Syntax: delete filter rule map ifname <interface-name>|
all | alleoa | alleth | allpppoe | allcpe | allipoe stageid <stageid-val>
ruleid <ruleid-val>
8.13.23.4
Modify filter rule map
Description: Use this command to modify.
Command Syntax: modify filter rule map ifname <interface-name>|
all | alleoa | alleth | allpppoe | allcpe | allipoe stageid <stageid-val>
ruleid <ruleid-val> [orderid <orderid-val>]
Parameters
Name
Description
Ifname <interfacename>| all |alleoa |
alleth | allpppoe| allcpe
| allipoe
Name of the interface whose mapping is being
created. Only EOA, PPPoE, IPOE and ethernet
interfaces are allowed. If the value of this field is
'All', it indicates all interfaces, 'AllEoa' indicates all
'eoa' interfaces, and 'AllEth' indicates all
'ethernet'interfaces. AllPppoe' indicates all
'PPPoE'interfaces, 'AllIpoe' indicates all 'IPOE'
interfaces and 'AllCpe' indicates all eoa , all ipoe
and pppoe interfaces. If a bridge port on
aggregated interface is created then this field can
not have ifIndex of any specific ethernet interface.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: , all , alleoa, alleth, allpppoe, allcpe,|
allipoe
This field specifies the stage on the interface to
which the rule in the mapping belongs
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1
Rule Id of the rule in the mapping
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 65535
This field indicates the order of the rule in the
attached sequence. The default value for this field
stageid <stageid-val>
ruleid <ruleid-val>
orderid <ordered-val>
376
will be same as the ruleid of the entry.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 65535
Default value: Same As Ruleid
Example
$ create filter rule map ifname eoa-0 stageid 1 ruleid 1 orderId 1
Output
Verbose Mode On
Entry Created
Interface : eoa-0
Stage Id : 1
Rule Id
Order Id : 1
: 1
Verbose Mode Off:
Entry Created
Output field
Field
Description
Interface
Name of the interface whose mapping is being
created. Only EOA, PPPoE, IPOE and ethernet
interfaces are allowed. If the value of this field is
'All', it indicates all interfaces, 'AllEoa' indicates all
'eoa' interfaces, and 'AllEth' indicates all
'ethernet'interfaces. AllPppoe' indicates all
'PPPoE'interfaces, 'AllIpoe' indicates all 'IPOE'
interfaces and 'AllCpe' indicates all eoa , all ipoe
and pppoe interfaces. If a bridge port on
aggregated interface is created then this field can
not have ifIndex of any specific ethernet interface.
This field specifies the stage on the interface to
which the rule in the mapping belongs
Rule Id of the rule in the mapping
This field indicates the order of the rule in the
attached sequence. The default value for this field
will be same as the ruleid of the entry.
Stage Id
Rule Id
Order Id
8.13.24
Filter rule stats Commands
8.13.24.1
Get filter rule stats
Description: Use this command to get.
Command Syntax: get filter rule stats [ruleid <ruleid-val>]
Parameter
Name
Description
ruleid <ruleid>
Unique identifier of a filter rule
Type: Get -- Optional
Valid values: 1- 65535
Example $ get filter rule stats ruleid 1
Output
Rule Id : 1
Num Hits : 4354
Output field
377
Field
Description
Rule Id
Unique identifier of a filter rule
Num Hits
Number of packets that hit this rule
References
•
Generic Filter Commands
8.13.25
Filter seq entry Commands
8.13.25.1
Get filter seq entry
Description: Use this command to get.
Command Syntax: get filter seq entry [seqid <seqid-val >] [ruleid
<ruleid-val >]
8.13.25.2
Create filter seq entry
Description: Use this command to create.
Command Syntax: create filter seq entry seqid <seqid-val > ruleid
<ruleid-val > [orderid <ordered-val >]
8.13.25.3
Delete filter seq entry
Description: Use this command to delete.
Command Syntax: delete filter seq entry seqid <seqid-val > ruleid
<ruleid-val >
8.13.25.4
Modify filter seq entry
Description: Use this command to modify.
Command Syntax: modify filter seq entry seqid <seqid-val > ruleid
<ruleid-val > [orderid <ordered-val >]
Parameters
Name
Description
seqid <seqid-val >
Sequence Id of the sequence
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get – Optional
Valid Values: 1-65535
Rule Id of the rule
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid Values: 1-65535
This field indicates the order of the rule in the
sequence. The default value for this field will be
same as the ruleid of the entry.
Type: Create -- Optional
Modify -- Optional
Valid Values: 1-65535
ruleid <ruleid-val >
orderid <ordered-val >
Example $ create filter seq entry seqid 1 ruleid 1 orderId 1
Output
Verbose Mode On
Entry Created
Sequence Id : 1
Order Id
: 1
Verbose Mode Off:
Entry Created
378
Rule Id : 1
Output field
Field
Description
Sequence Id
Sequence Id of the sequence
Rule Id
Rule Id of the rule
Order Id
This field indicates the order of the rule in the
sequence. The default value for this field will be
same as the ruleid of the entry.
References
• Generic filter related commands
8.13.26
Filter seq info Commands
8.13.26.1
Get filter seq info
Description: Use this command to get.
Command Syntax: get filter seq info [seqid <seqid-val >]
8.13.26.2
Create filter seq info
Description: Use this command to create.
Command Syntax: create filter seq info seqid seqid [ifname
<interface-name> | alleth] [stageid <stageid-val>] [seqdir in | out]
8.13.26.3
Delete filter seq info
Description: Use this command to delete.
Command Syntax: delete filter seq info seqid <seqid-val>
8.13.26.4
Modify filter seq info
Description: Use this command to modify.
Command Syntax: modify filter seq info seqid <seqid-val > [ifname
<interface-name>| alleth] [stageid <stageid-val>] [seqdir in | out]
Parameters
Name
Description
seqid <seqid-val>
Sequence Id of the sequence
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get --Optional
Valid Values: 1-65535
The name of the interface whose mapping is
being created. Only EoA, PPPoE, and Ethernet
interfaces are allowed. If the value of this field is
'alleth', it indicates all 'Ethernet' interfaces. If the
bridge port is created over the aggregated
interface, then this field cannot have IfIndex of
any specific Ethernet interface. If the bridge port
over the aggregated interface is not created,
then this field cannot have the value 'alleth'. This
field should not be specified during creation of
an entry in this table and must be specified
during modify of an entry in this table.
Type: Create -- Optional
Modify -- Optional
Identifier of the stage on the interface for which
the sequence is being applied.This field should
not be specified during creation of an entry in
this table and must be specified during modify of
an entry in this table
Type: Create -- Optional
ifname <interfacename>
stageid <stageid-val>
379
seqdir in | out
Modify -- Optional
Valid values: 1-2
Default Value:1
This field specifies whether the sequence to be
applied in ingress direction or egress direction
on the interface.This field should not be
specified during creation of an entry in this table
and must be specified during modify of an entry
in this table.
Type: Create -- Optional
Modify -- Optional
Default value: In
Example
$ create filter seq info seqid 1 ifname eoa-0 stageid 1 seqdir 1
Output
Verbose Mode On
Entry Created
Sequence Id : 1
Verbose Mode Off:
Entry Created
Output field
Field
Description
Sequence Id
Sequence Id of the sequence
References
• Generic filter related commands
8.13.27
Filter subrule arp Commands
8.13.27.1
Get filter subrule arp
Description: Use this command to get.
Command Syntax: get filter subrule arp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
8.13.27.2
Create filter subrule arp
Description: Use this command to create.
Command Syntax: create filter subrule arp ruleid <ruleidval>subruleid <subruleid-val>] [ opcode request | reply | any ]
[ srcmacaddrfrom <srcmacaddrfrom-val> ] [ srcmacaddrto
<srcmacaddrto-val> ] [ dstmacaddrfrom <dstmacaddrfrom-val> ]
[ dstmacaddrto <dstmacaddrto-val> ] [ srcipaddrfrom
<srcipaddrfrom-val> ] [ srcipaddrto <srcipaddrto-val> ]
[ dstipaddrfrom <dstipaddrfrom-val> ] [ dstipaddrto <dstipaddrto-val> ]
[ srcmacaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange ]
[ dstmacaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange ]
[ srcipaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange |
ingenlist | notingenlist ] [ dstipaddrcmp eq | neq | lt | leq | gt | geq | any
| inrange | exrange | ingenlist | notingenlist ] [ ipsrcaddrmask
<ipsrcaddrmask-val> ] [ ipdstaddrmask <ipdstaddrmask-val> ]
[ subruleprio low | high | asinrule ]
8.13.27.3
Delete filter subrule arp
Description: Use this command to get.
380
Command Syntax: delete filter subrule arp ruleid <ruleidval>subruleid <subruleid-val>
8.13.27.4
Modify filter subrule arp
Description: Use this command to create.
Command Syntax: modify filter subrule arp ruleid <ruleidval>subruleid <subruleid-val>] [ opcode request | reply | any ]
[ srcmacaddrfrom <srcmacaddrfrom-val> ] [ srcmacaddrto
<srcmacaddrto-val> ] [ dstmacaddrfrom <dstmacaddrfrom-val> ]
[ dstmacaddrto <dstmacaddrto-val> ] [ srcipaddrfrom
<srcipaddrfrom-val> ] [ srcipaddrto <srcipaddrto-val> ]
[ dstipaddrfrom <dstipaddrfrom-val> ] [ dstipaddrto <dstipaddrto-val> ]
[ srcmacaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange ]
[ dstmacaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange ]
[ srcipaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange |
ingenlist | notingenlist ] [ dstipaddrcmp eq | neq | lt | leq | gt | geq | any
| inrange | exrange | ingenlist | notingenlist ] [ ipsrcaddrmask
<ipsrcaddrmask-val> ] [ ipdstaddrmask <ipdstaddrmask-val> ]
[ subruleprio low | high | asinrule ]
Parameters
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
subruleid <subruleidval>
Unique identifier of a filter subrule.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4294967295
opcode request | reply |
any
The opcode identifies whether the packet is ARP
request or reply. This field specifies the type of
packets on which the subrule is to be applied. If
'any' is specified, both request and reply packets
are filtered.
Type: Create -- Optional
Modify -- Optional
Default value: any
srcmacaddrfrom
<srcmacaddrfrom-val>
Start source Mac address of the range of source
Mac addresses. This field is invalid if
srcmacaddrcmp is 'any'. This field and the
srcmacaddrto field specify a range of source
Mac addresses if srcmacaddrcmp is either
'inrange' or'exrange'.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
381
srcmacaddrto
<srcmacaddrto-val>
End source Mac address of the range of source
Mac addresses. This field and the
srcmacaddrfrom field specify a range of source
Mac addresses, if srcmacaddrcmp is either
'inrange' or'exrange'.Otherwise this field is
invalid.
Type: Create -- Optional
Modify -- Optional
Default value: "\xff\xff\xff\xff\xff\xff"
dstmacaddrfrom
<dstmacaddrfrom-val>
Start destination Mac address of the range of
destination Mac addresses. This field is invalid
if'dstmacaddrcmp'is 'any'.This field and the
dstmacaddrto field specify a range of destination
Mac addresses if dstmacaddrcmp is either
'inrange' or'exrange'.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
dstmacaddrto
<dstmacaddrto-val>
End destination Mac address of the range of
destination Mac addresses. This field and the
dstmacaddrfrom field specify a range of
destination Mac addresses, if dstmacaddrcmp is
either'inrange' or'exrange'.Otherwise this field is
invalid.
Type: Create -- Optional
Modify -- Optional
Default value: "\xff\xff\xff\xff\xff\xff"
srcipaddrfrom
<srcipaddrfrom-val>
Start source IP address of the range of source
IP addresses. This field is invalid if srcaddrcmp
is 'any','ingenlist' or'notingenlist'.If srcaddrcmp is
either 'inrange' or 'exrange', this field and
srcipaddrto field specify a range of source IP
addresses.
Type: Create -- Optional
Modify -- Optional
Default value: 0.0.0.0
srcipaddrto
<srcipaddrto-val>
End source IP address of the range of source IP
addresses. This field is invalid if srcaddrcmp is
'any','ingenlist' or 'notingenlist'.If srcaddrcmp is
either 'inrange' or 'exrange', this field and
srcipaddrfrom field specify a range of source IP
addresses.
Type: Create -- Optional
Modify -- Optional
Default value: 255.255.255.255
dstipaddrfrom
<dstipaddrfrom-val>
Start destination IP address of the range of
destination IP addresses. This field is invalid if
dstaddrcmp is 'any','ingenlist' or 'notingenlist'.If
dstaddrcmp is either 'inrange' or 'exrange', this
field and dstipaddrto field specify a range of
destination IP addresses.
Type: Create -- Optional
Modify -- Optional
Default value: 0.0.0.0
382
dstipaddrto
<dstipaddrto-val>
End destination IP address of the range of
destination IP addresses. This field is invalid if
dstaddrcmp is 'any','ingenlist' or
'notingenlist'.This field and the previous field
specifiy a range of destination IP addresses, if
dstaddrcmp is either 'inrange' or
'exrange'.Otherwise this field is invalid.
Type: Create -- Optional
Modify -- Optional
Default value: 255.255.255.255
srcmacaddrcmp eq |
neq | lt | leq | gt | geq |
any | inrange | exrange
Source Mac address comparison type.
Type: Create -- Optional
Modify -- Optional
Default value: any
dstmacaddrcmp eq |
neq | lt | leq | gt | geq |
any | inrange | exrange
Destination Mac address comparison type.
Type: Create -- Optional
Modify -- Optional
Default value: any
srcipaddrcmp eq | neq |
lt | leq | gt | geq | any |
inrange | exrange |
ingenlist | notingenlist
Source IP address comparison type.'Ingenlist'
means check if source IP address present in
interface classifier generic list.'Notingenlist'
means check if source IP address not present in
interface classifier generic list. 'Ingenlist' and
'Notingenlist' are invalid if the direction of the
rule for which this subrule is being created is
'out'.
Type: Create -- Optional
Modify -- Optional
Default value: any
dstipaddrcmp eq | neq |
lt | leq | gt | geq | any |
inrange | exrange |
ingenlist | notingenlist
Destination IP address comparison
type.'Ingenlist' means check if destination IP
address present in interface classifier generic
list.'Notingenlist' means check if destination IP
address not present in interface classifier
generic list.'Ingenlist' and 'Notingenlist' are
invalid if the direction of the rule for which this
subrule is being created is 'out'.
Type: Create -- Optional
Modify -- Optional
Default value: any
ipsrcaddrmask
<ipsrcaddrmask-val>
The mask value for source IP address. The
mask is applied over the source IP address
before checking against a value.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 0xffffffff
Default value: 0xffffffff
383
ipdstaddrmask
<ipdstaddrmask-val>
The mask value for destination IP address. The
mask is applied over the destination IP address
before checking against a value.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 0xffffffff
Default value: 0xffffffff
subruleprio low | high |
asinrule
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
Example
$ create filter subrule arp ruleid 1 subruleid 2 opcode request
srcmacaddrfrom 00:01:02:03:04:05 srcmacaddrto 00:01:02:03:04:10
dstmacaddrfrom 00:02:03:04:05:11 dstmacaddrto 00:02:03:04:05:15
srcipaddrfrom 172.25.1.125 srcipaddrto 172.25.5.125 dstipaddrfrom
172.25.6.125 dstipaddrto 172.25.10.125 srcmacaddrcmp inrange
dstmacaddrcmp exrange srcipaddrcmp inrange dstipaddrcmp exrange
ipsrcaddrmask 0xffff0000 ipdstaddrmask 0xffff0000 subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
2
: 1
Subrule Id
Opcode
: request
Start Src Mac Addr
00:01:02:03:04:10
: 00:01:02:03:04:05 End Src Mac Addr
:
:
Start Dest Mac Addr : 00:02:03:04:05:11 End Dest Mac Addr :
00:02:03:04:05:15
Start Src Ip Addr
172.25.5.125
: 172.25.1.125
End Src Ip Addr
:
Start Dest Ip Addr
172.25.10.125
: 172.25.6.125
End Dest Ip Addr
:
Src Mac Addr Cmp
: inrange
Dest Mac Addr Cmp
: exrange
Src Ip Addr Cmp
: inrange
Dest Ip Addr Cmp
: exrange
Ip Src Addr Mask
: 0xffff0000
Ip Dest Addr Mask
: 0xffff0000
Subrule Prio
: high
Verbose Mode Off:
Entry Created
Parameters
384
Name
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created.
Subrule Id
Unique identifier of a filter subrule.
385
Opcode
The opcode identifies whether the packet is ARP
request or reply. This field specifies the type of
packets on which the subrule is to be applied. If
'any' is specified, both request and reply packets
are filtered.
Start Src Mac Addr
Start source Mac address of the range of source
Mac addresses. This field is invalid if
srcmacaddrcmp is 'any'. This field and the
srcmacaddrto field specify a range of source
Mac addresses if srcmacaddrcmp is either
'inrange' or'exrange'.
End Src Mac Addr
End source Mac address of the range of source
Mac addresses. This field and the
srcmacaddrfrom field specify a range of source
Mac addresses, if srcmacaddrcmp is either
'inrange' or'exrange'.Otherwise this field is
invalid.
Start Dest Mac Addr
Start destination Mac address of the range of
destination Mac addresses. This field is invalid
if'dstmacaddrcmp'is 'any'.This field and the
dstmacaddrto field specify a range of destination
Mac addresses if dstmacaddrcmp is either
'inrange' or'exrange'.
End Dest Mac Addr
End destination Mac address of the range of
destination Mac addresses. This field and the
dstmacaddrfrom field specify a range of
destination Mac addresses, if dstmacaddrcmp is
either'inrange' or'exrange'.Otherwise this field is
invalid.
Start Src Ip Addr
Start source IP address of the range of source
IP addresses. This field is invalid if srcaddrcmp
is 'any','ingenlist' or'notingenlist'.If srcaddrcmp is
either 'inrange' or 'exrange', this field and
srcipaddrto field specify a range of source IP
addresses.
End Src Ip Addr
End source IP address of the range of source IP
addresses. This field is invalid if srcaddrcmp is
'any','ingenlist' or 'notingenlist'.If srcaddrcmp is
either 'inrange' or 'exrange', this field and
srcipaddrfrom field specify a range of source IP
addresses.
Start Dest Ip Addr
Start destination IP address of the range of
destination IP addresses. This field is invalid if
dstaddrcmp is 'any','ingenlist' or 'notingenlist'.If
dstaddrcmp is either 'inrange' or 'exrange', this
field and dstipaddrto field specify a range of
destination IP addresses.
End Dest Ip Addr
End destination IP address of the range of
destination IP addresses. This field is invalid if
dstaddrcmp is 'any','ingenlist' or
'notingenlist'.This field and the previous field
specifiy a range of destination IP addresses, if
dstaddrcmp is either 'inrange' or
'exrange'.Otherwise this field is invalid.
Src Mac Addr Cmp
Source Mac address comparison type.
Dest Mac Addr Cmp
Destination Mac address comparison type.
Src Ip Addr Cmp
Source IP address comparison type.'Ingenlist'
means check if source IP address present in
interface classifier generic list.'Notingenlist'
means check if source IP address not present in
interface classifier generic list. 'Ingenlist' and
'Notingenlist' are invalid if the direction of the
rule for which this subrule is being created is
'out'.
Dest Ip Addr Cmp
Destination IP address comparison
type.'Ingenlist' means check if destination IP
address present in interface classifier generic
list.'Notingenlist' means check if destination IP
address not present in interface classifier
generic list.'Ingenlist' and 'Notingenlist' are
invalid if the direction of the rule for which this
subrule is being created is 'out'.
Ip Src Addr Mask
The mask value for source IP address. The
mask is applied over the source IP address
before checking against a value.
Ip Dest Addr Mask
The mask value for destination IP address. The
mask is applied over the destination IP address
before checking against a value.
Subrule Prio
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
8.13.28
Filter subrule clfrtree Commands
8.13.28.1
Get filter subrule clfrtree
Description: Use this command to get.
Command Syntax: get filter subrule clfrtree [ruleid <ruleid-val>]
[subruleid <subruleid-val >]
8.13.28.2
Create filter subrule clfrtree
Description: Use this command to create.
Command Syntax: create filter subrule clfrtree ruleid <ruleid-val >
subruleid <subruleid-val > tname <tname-val > entrypid <entrypid-val
>
8.13.28.3
Delete filter subrule clfrtree
Description: Use this command to delete.
Command Syntax: delete filter subrule clfrtree ruleid <ruleid-val >
subruleid <subruleid-val >
8.13.28.4
Modify filter subrule clfrtree
Description: Use this command to modify.
Command Syntax: modify filter subrule clfrtree ruleid <ruleid-val >
subruleid <subruleid-val > [tname <tname-val >] [entrypid <entrypidval >]
Parameter
Name
386
Description
ruleid <ruleid>
Subruleid <subruleid>
tname <tname>
entrypid <entrypid>
Unique identifier of a filter rule of which this sub
rule is being created.
Type: Create -- Mandatory
Delete -- Mandatory
Modify --Mandatory
Get -- Optional
Valid values: 1- 65535
Unique identifier of a filter subrule.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get --Optional
Valid values: 1 - 4294967295
Name of the classifier tree which is to be included
as subrule of this rule. This classifier tree should
exist and be enabled. A classifier tree can be used
only in one subrule. The Maximum length of Name
should be 32.
Type: Create -- Mandatory
Modify -- Optional
Profile Id of the tree, which shall be treated as an
entry point for it.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 0xffffffff
Example $ create filter subrule clfrtree ruleid 1 subruleid 2 tname igmp
entrypid 2
Output
Verbose Mode On
Entry Created
Rule Id
: 1
Tree Name
: igmp
Subrule Id : 2
Entry Profile Id : 2
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created.
Unique identifier of a filter subrule.
Name of the classifier tree which is to be included
as subrule of this rule. This classifier tree should
exist and be enabled. A classifier tree can be used
only in one subrule. The Maximum length of Name
should be 32.
Profile Id of the tree, which shall be treated as an
entry point for it.
Subrule Id
Tree Name
Entry Profile Id
References
• see generic filter related commands
8.13.29
Filter subrule ether Commands
8.13.29.1
Get filter subrule ether
Description: Use this command to get.
Command Syntax: get filter subrule ether [ruleid <ruleid-val >]
[subruleid <subruleid-val >]
387
8.13.29.2
Create filter subrule ether
Description Use this command to create.
Command Syntax: create filter subrule ether ruleid <ruleid-val >
subruleid <subruleid-val >[ srcmacaddrfrom <srcmacaddrfrom-val> ]
[ srcmacaddrto <srcmacaddrto-val> ] [ dstmacaddrfrom
<dstmacaddrfrom-val> ] [ dstmacaddrto <dstmacaddrto-val> ]
[ ethertypefrom <ethertypefrom-val> ] [ ethertypeto <ethertypeto-val> ]
[ vlanidfrom <vlanidfrom-val> ] [ vlanidto <vlanidto-val> ]
[ priotagfrom <priotagfrom-val> ] [ priotagto <priotagto-val> ]
[ dsapfrom <dsapfrom-val> ] [ dsapto <dsapto-val> ] [ ssapfrom
<ssapfrom-val> ] [ ssapto <ssapto-val> ] [ srcmacaddrcmp eq | neq |
lt | leq | gt | geq | any | inrange | exrange ] [ dstmacaddrcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ ethertypecmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ vlanidcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ priotagcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ dsapcmp eq | neq
| lt | leq | gt | geq | any | inrange | exrange ] [ ssapcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange ] [ subruleprio low | high |
asinrule ] [ servicevlanidfrom <servicevlanidfrom-val> ]
[ servicevlanidto <servicevlanidto-val> ] [ servicepriotagfrom
<servicepriotagfrom-val> ] [ servicepriotagto <servicepriotagto-val> ]
[ servicevlanidcmp eq | neq | lt | leq | gt | geq | any | inrange |
exrange ] [ servicepriotagcmp eq | neq | lt | leq | gt | geq | any |
inrange | exrange ]
8.13.29.3
Delete filter subrule ether
Description: Use this command to delete.
Command Syntax: delete filter subrule ether ruleid <ruleid-val >
subruleid <subruleid-val >
8.13.29.4
Modify filter subrule ether
Description: Use this command to modify.
Command Syntax: modify filter subrule ether ruleid <ruleid-val >
subruleid <subruleid-val >[ srcmacaddrfrom <srcmacaddrfrom-val> ]
[ srcmacaddrto <srcmacaddrto-val> ] [ dstmacaddrfrom
<dstmacaddrfrom-val> ] [ dstmacaddrto <dstmacaddrto-val> ]
[ ethertypefrom <ethertypefrom-val> ] [ ethertypeto <ethertypeto-val> ]
[ vlanidfrom <vlanidfrom-val> ] [ vlanidto <vlanidto-val> ]
[ priotagfrom <priotagfrom-val> ] [ priotagto <priotagto-val> ]
[ dsapfrom <dsapfrom-val> ] [ dsapto <dsapto-val> ] [ ssapfrom
<ssapfrom-val> ] [ ssapto <ssapto-val> ] [ srcmacaddrcmp eq | neq |
lt | leq | gt | geq | any | inrange | exrange ] [ dstmacaddrcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ ethertypecmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ vlanidcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ priotagcmp eq |
neq | lt | leq | gt | geq | any | inrange | exrange ] [ dsapcmp eq | neq
| lt | leq | gt | geq | any | inrange | exrange ] [ ssapcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange ] [ subruleprio low | high |
asinrule ] [ servicevlanidfrom <servicevlanidfrom-val> ]
[ servicevlanidto <servicevlanidto-val> ] [ servicepriotagfrom
<servicepriotagfrom-val> ] [ servicepriotagto <servicepriotagto-val> ]
[ servicevlanidcmp eq | neq | lt | leq | gt | geq | any | inrange |
exrange ] [ servicepriotagcmp eq | neq | lt | leq | gt | geq | any |
inrange | exrange ]
Parameter
Name
388
Description
ruleid <ruleid-val>
subruleid <subruleidval>
srcmacaddrfrom
<srcmacaddrfrom-val>
srcmacaddrto
<srcmacaddrto-val>
dstmacaddrfrom
<dstmacaddrfrom-val>
dstmacaddrto
<dstmacaddrto-val>
ethertypefrom
<ethertypefrom-val>
ethertypeto
<ethertypeto-val>
vlanidfrom
<vlanidfrom-val>
389
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 65535
Unique identifier of a filter subrule
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 4294967295
Start source MAC address of the range of source
MAC addresses. This field is invalid if
'srcmacaddrcmp' is 'any'. This field and
'srcmacaddrto' specify a range of source MAC
addresses if 'srcmacaddrcmp' is either 'inrange'
or 'exrange'
Type: Create - Optional
Modify - Optional
Default value: "\0"
End source MAC address of the range of source
MAC addresses. This field and 'srcmacaddrfrom'
specify a range of source MAC addresses, if
'srcmacaddrcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid
Type: Create - Optional
Modify - Optional
Default value: "\xff\xff\xff\xff\xff\xff"
Start destination MAC address of the range of
destination MAC addresses. This field is invalid if
'dstmacaddrcmp' is 'any'. This field and the next
field specify a range of destination MAC
addresses if 'dstmacaddrcmp' is either 'inrange'
or 'exrange'
Type: Create - Optional
Modify - Optional
Default value: "\0"
End destination MAC address of the range of
destination MAC addresses. This field and the
previous field specify a range of destination MAC
addresses if 'dstmacaddrcmp' is either 'inrange'
or 'exrange'. Otherwise this field is invalid
Type: Create - Optional
Modify - Optional
Default value: "\xff\xff\xff\xff\xff\xff"
Start ether type of the range of ether types. This
field is invalid if 'ethertypecmp' is 'any'. This field
and the next field specify a range of ether types,
if 'ethertypecmp' is either 'inrange' or 'exrange'
Type: Create - Optional
Modify - Optional
Default value: 0
End ether type of the range of ether types. This
field and the previous field specify a range of
ether types, if 'ethertypecmp' is either 'inrange' or
'exrange'. Otherwise this field is invalid
Type: Create - Optional
Modify - Optional
Default value: 0xFFFF
Start VLAN Id of the range of VLAN IDs. Invalid, if
the direction of the rule for which this subrule is
being created is 'out'. This field is invalid if
'vlanidcmp' is 'any'(7). This field and the vlanidto
field specify a range of VLAN Ids, if 'vlanidcmp' is
either 'inrange'(8) or'exrange'(9).In VLAN
vlanidto <vlanidto-val>
priotagfrom
<priotagfrom-val>
priotagto <priotagtoval>
dsapfrom <dsapfromval>
dsapto <dsapto-val>
ssapfrom <ssapfromval>
ssapto <ssapto-val>
390
stacking mode this parameter maps to customer
VLAN ID. Type: Create - Optional
Modify - Optional
Valid values: 1 - 4094
Default value: 1
End VLAN Id of the range of VLAN IDs.Invalid, if
the direction of the rule for which this subrule is
being created is 'out'. This field and the
vlanidfrom field specify a range of VLAN Ids, if
'vlanidcmp' is either 'inrange'(8) or 'exrange'(9).
Otherwise, this field is invalid. In VLAN stacking
mode this parameter maps to customer VLAN ID.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 4094
Default value: 4094
Start priority tag of the range of priority tags.
Invalid, if the direction of the rule for which this
subrule is being created is 'out'. This field is
invalid if 'priotagcmp' is 'any'(7). This field and the
priotagto field specify a range of priority tags, if
'priotagcmp' is either 'inrange'(8) or
'exrange'(9).In VLAN stacking mode this
parameter maps to priority in the customer VLAN
tag.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 0
End priority tag of the range of priority tags.
Invalid, if the direction of the rule for which this
subrule is being created is 'out'. This field and the
priotagfrom field specify a range of priority tags, if
'priotagcmp' is either 'inrange'(8) or 'exrange'(9).
Otherwise this field is invalid. In VLAN stacking
mode this parameter maps to priority in the
customer VLAN tag.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 7
Start DSAP of the range of DSAPs. This object is
invalid if 'dsapcmp' is 'any'. This object and the
next object specify a range of DSAPs, if
'dsapcmp' is either 'inrange' or 'exrange'
Type: Create - Optional
Modify - Optional
Default value: 0x00
End DSAP of the range of DSAPs. This object is
invalid if 'dsapcmp' is 'any'. This object and the
previous object specify a range of DSAPs, if
'dsapcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid.
Type: Create - Optional
Modify - Optional
Default value: 0xff
Start SSAP of the range of SSAPs. This object is
invalid if 'ssapcmp' is 'any'. This object and the
next object specify a range of SSAPs, if
'ssapcmp' is either 'inrange' or 'exrange'
Type: Create - Optional
Modify - Optional
Default value: 0x00
End SSAP of the range of SSAPs. This object is
invalid if 'ssapcmp' is 'any'. This object and the
previous object specify a range of SSAPs, if
'ssapcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid
srcmacaddrcmp eq |
neq |lt | leq | gt | geq |
any| inrange | exrange
dstmacaddrcmp eq |
neq |lt | leq | gt | geq |
any| inrange | exrange
ethertypecmp eq | neq
| lt| leq | gt | geq | any
|inrange | exrange
vlanidcmp eq | neq | lt
|leq | gt | geq | any
|inrange | exrange
priotagcmp eq | neq |
lt |leq | gt | geq | any
|inrange | exrange
ssapcmp eq | neq | lt |
leq| gt | geq | any |
inrange| exrange
subruleprio low | high
|asinrule
servicevlanidfrom
<servicevlanidfrom-val>
servicevlanidto
<servicevlanidto-val>
servicepriotagfrom
<servicepriotagfromval>
391
Type: Create - Optional
Modify - Optional
Default value: 0xff
Source mac address comparison type
Type: Create - Optional
Modify - Optional
Default value: any
Destination mac address comparison type
Type: Create - Optional
Modify - Optional
Default value: any
Ether type comparison type
Type: Create - Optional
Modify - Optional
Default value: any
VLAN Id comparison type. This field must be
'any', if 'priotagcmp' is not equal to 'any'
Type: Create - Optional
Modify - Optional
Default value: any
Priority tag comparison type. This field must be
'any', if 'vlanidcmp' is not equal to 'any'"
Type: Create - Optional
Modify - Optional
Default value: any
SSAP comparison type.
Type: Create - Optional
Modify - Optional
Default value: any
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the rule.
Type: Create - Optional
Modify - Optional
Default value: asinrule
Start service VLAN Id of the range of service
VLAN IDs. Invalid, if the direction of the rule for
which this subrule is being created is 'out'. This
field is invalid if 'vlanidcmp' is 'any'(7). This field
and the servicevlanidto field specify a range of
service VLAN Ids, if 'servicevlanidcmp' is either
'inrange'(8) or 'exrange'(9).In native mode
configuring this parameter will result in error.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 4094
Default value: 1
End service VLAN Id of the range of service
VLAN IDs.Invalid, if the direction of the rule for
which this subrule is being created is 'out'. This
field and the servicevlanidfrom field specify a
range of service VLAN Ids, if 'servicevlanidcmp' is
either 'inrange'(8) or 'exrange'(9).Otherwise, this
field is invalid In native mode configuring this
parameter will result in error.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 4094
Default value: 4094
Start service priority tag of the range of priority
tags. Invalid, if the direction of the rule for which
this subrule is being created is 'out'. This field is
invalid if 'etherhPrioTagCmpType' is 'any'(7). This
field and the etherPriorityTagTo field specify a
range of priority tags, if 'etherhPrioTagCmpType'
servicepriotagto
<servicepriotagto-val>
servicevlanidcmp eq |
neq| lt | leq | gt | geq |
any| inrange | exrange
servicepriotagcmp eq
| neq| lt | leq | gt | geq |
any| inrange | exrange
is either 'inrange'(8) or 'exrange'(9).In native
mode configuring this parameter will result in
error. Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 0
End service priority tag of the range of priority
tags. Invalid, if the direction of the rule for which
this subrule is being created is 'out'. This field and
the etherhPriorityTagFrom field specify a range of
service priority tags, if
'etherhServicePrioTagCmpType' is either
'inrange'(8) or 'exrange'(9). Otherwise this field is
invalid. In native mode configuring this parameter
will result in error.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 7
Default value: 7
Service VLAN Id comparison type. This field must
be ‘any (7)', if etherhPrioTagCmpType is not
equal to ‘any (7)'In native mode configuring this
parameter will result in error.
Type: Create - Optional
Modify - Optional
Default value: any
Service Priority tag comparison type.This field
must be ‘any (7)', if vlanidcmp is not equal to ‘any
(7)'.In native mode configuring this parameter will
result in error.
Type: Create - Optional
Modify - Optional
Default value: any
Example
$ create filter subrule ether ruleid 1 subruleid 2 srcmacaddrfrom
00:01:02:03:04:05 srcmacaddrto 00:01:02:03:04:10 dstmacaddrfrom
00:02:03:04:05:11 dstmacaddrto 00:02:03:04:05:15 ethertypefrom
0x0800 ethertypeto 0x0810 vlanidfrom 2 vlanidto 5 priotagfrom 2
priotagto 5 dsapfrom 0xf0 dsapto 0xff ssapfrom 0xf0 ssapto 0xff
srcmacaddrcmp inrange dstmacaddrcmp exrange ethertypecmp
inrange vlanidcmp exrange priotagcmp inrange dsapcmp inrange
ssapcmp inrange subruleprio high servicevlanidfrom 2 servicevlanidto 5
servicepriotagfrom 2 servicepriotagto 5 servicevlanidcmp exrange
servicepriotagcmp inrange
Output
Verbose Mode On
Entry Created
Rule Id
Id
392
: 1
Subrule
: 2
Start source mac address
: 00:01:02:03:04:05
End source mac address
: 00:01:02:03:04:10
Start destination MAC address
: 00:02:03:04:05:11
End destination MAC address
: 00:02:03:04:05:15
Start ethernet type
type : 0x0810
: 0x0800
End ethernet
Start VLAN Id
Id
: 5
: 2
End VLAN
Start priority tag
tag : 5
: 2
End priority
Start DSAP
DSAP
: 0xf0
End
: 0xff
Start SSAP
SSAP
: 0xf0
End
: 0xff
Source MAC addrees comparison
: inrange
Desination MAC addr comparison
: exrange
Ether type comparison
: inrange
Vlan Id comparison
: exrange
Priority tag comparison
: inrange
DSAP comparison
: inrange
SSAP comparison
: inrange
Subrule Priority
: high
Start service VLAN Id
: 2
End
service VLAN Id
: 5
Start service priority tag
: 2
End service priority tag
: 5
service Vlan Id comparison
: exrange
Service Priority tag comparison : inrange
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created
Unique identifier of a filter subrule
Start source MAC address of the range of
source MAC addresses. This field is invalid if
'srcmacaddrcmp' is 'any'. This field and
'srcmacaddrto' specify a range of source MAC
addresses if 'srcmacaddrcmp' is either 'inrange'
or 'exrange'
End source MAC address of the range of source
MAC addresses. This field and 'srcmacaddrfrom'
specify a range of source MAC addresses, if
'srcmacaddrcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid
Start destination MAC address of the range of
destination MAC addresses. This field is invalid
if 'dstmacaddrcmp' is 'any'. This field and the
next field specify a range of destination MAC
addresses if 'dstmacaddrcmp' is either 'inrange'
or 'exrange'
End destination MAC address of the range of
destination MAC addresses. This field and the
previous field specify a range of destination
MAC addresses if 'dstmacaddrcmp' is either
'inrange' or 'exrange'. Otherwise this field is
invalid
Start ether type of the range of ether types. This
field is invalid if 'ethertypecmp' is 'any'. This field
and the next field specify a range of ether types,
if 'ethertypecmp' is either 'inrange' or 'exrange'
End ether type of the range of ether types. This
field and the previous field specify a range of
ether types, if 'ethertypecmp' is either 'inrange'
or 'exrange'. Otherwise this field is invalid
Start VLAN Id of the range of VLAN IDs. Invalid,
if the direction of the rule for which this subrule is
being created is 'out'. This field is invalid if
'vlanidcmp' is 'any'(7). This field and the vlanidto
field specify a range of VLAN Ids, if 'vlanidcmp'
is either 'inrange'(8) or'exrange'(9).In VLAN
stacking mode this parameter maps to customer
Subrule Id
Start source mac
address
End source mac
address
Start destination MAC
address
End destination MAC
address
Start ethernet type
End ethernet type
Start VLAN Id
393
End VLAN Id
Start priority tag
End priority tag
Start DSAP
End DSAP
Start SSAP
End SSAP
Source MAC addrees
comparison
Desination MAC addr
comparison
Ether type comparison
Vlan Id comparison
Priority tag
comparison
DSAP comparison
SSAP comparison
Subrule Priority
Start service VLAN Id
End service VLAN Id
394
VLAN ID.
End VLAN Id of the range of VLAN IDs.Invalid, if
the direction of the rule for which this subrule is
being created is 'out'. This field and the
vlanidfrom field specify a range of VLAN Ids, if
'vlanidcmp' is either 'inrange'(8) or 'exrange'(9).
Otherwise, this field is invalid. In VLAN stacking
mode this parameter maps to customer VLAN
ID.
Start priority tag of the range of priority tags.
Invalid, if the direction of the rule for which this
subrule is being created is 'out'. This field is
invalid if 'priotagcmp' is 'any'(7). This field and
the priotagto field specify a range of priority tags,
if 'priotagcmp' is either 'inrange'(8) or
'exrange'(9).In VLAN stacking mode this
parameter maps to priority in the customer
VLAN tag.
End priority tag of the range of priority tags.
Invalid, if the direction of the rule for which this
subrule is being created is 'out'. This field and
the priotagfrom field specify a range of priority
tags, if 'priotagcmp' is either 'inrange'(8) or
'exrange'(9). Otherwise this field is invalid. In
VLAN stacking mode this parameter maps to
priority in the customer VLAN tag.
Start DSAP of the range of DSAPs. This object
is invalid if 'dsapcmp' is 'any'. This object and the
next object specify a range of DSAPs, if
'dsapcmp' is either 'inrange' or 'exrange'
End DSAP of the range of DSAPs. This object is
invalid if 'dsapcmp' is 'any'. This object and the
previous object specify a range of DSAPs, if
'dsapcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid.
Start SSAP of the range of SSAPs. This object is
invalid if 'ssapcmp' is 'any'. This object and the
next object specify a range of SSAPs, if
'ssapcmp' is either 'inrange' or 'exrange'
End SSAP of the range of SSAPs. This object is
invalid if 'ssapcmp' is 'any'. This object and the
previous object specify a range of SSAPs, if
'ssapcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid
Source mac address comparison type
Destination mac address comparison type
Ether type comparison type
VLAN Id comparison type. This field must be
'any', if 'priotagcmp' is not equal to 'any'
Priority tag comparison type. This field must be
'any', if 'vlanidcmp' is not equal to 'any'"
DSAP comparison type.
SSAP comparison type.
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
Start service VLAN Id of the range of service
VLAN IDs. Invalid, if the direction of the rule for
which this subrule is being created is 'out'. This
field is invalid if 'vlanidcmp' is 'any'(7). This field
and the servicevlanidto field specify a range of
service VLAN Ids, if 'servicevlanidcmp' is either
'inrange'(8) or 'exrange'(9).In native mode
configuring this parameter will result in error.
End service VLAN Id of the range of service
Start service priority
tag
End service priority tag
service Vlan Id
comparison
Service Priority tag
comparison
VLAN IDs.Invalid, if the direction of the rule for
which this subrule is being created is 'out'. This
field and the servicevlanidfrom field specify a
range of service VLAN Ids, if 'servicevlanidcmp'
is either 'inrange'(8) or 'exrange'(9).Otherwise,
this field is invalid In native mode configuring this
parameter will result in error.
Start service priority tag of the range of priority
tags. Invalid, if the direction of the rule for which
this subrule is being created is 'out'. This field is
invalid if 'etherhPrioTagCmpType' is 'any'(7).
This field and the etherPriorityTagTo field
specify a range of priority tags, if
'etherhPrioTagCmpType' is either 'inrange'(8) or
'exrange'(9).In native mode configuring this
parameter will result in error.
End service priority tag of the range of priority
tags. Invalid, if the direction of the rule for which
this subrule is being created is 'out'. This field
and the etherhPriorityTagFrom field specify a
range of service priority tags, if
'etherhServicePrioTagCmpType' is either
'inrange'(8) or 'exrange'(9). Otherwise this field is
invalid. In native mode configuring this
parameter will result in error.
Service VLAN Id comparison type. This field
must be 'any(7)', if etherhPrioTagCmpType is
not equal to 'any(7)'In native mode configuring
this parameter will result in error.
Service Priority tag comparison type.This field
must be 'any(7)', if vlanidcmp is not equal to
'any(7)'.In native mode configuring this
parameter will result in error.
References
• Generic filter commands
8.13.30
Filter subrule generic Commands
8.13.30.1
Get filter subrule generic
Description: Use this command to get.
Command Syntax: get filter subrule generic [ruleid <ruleid-val>]
[subruleid <subruleid-val >]
8.13.30.2
Create filter subrule generic
Description: Use this command to create.
Command Syntax: create filter subrule generic ruleid <ruleid-val>
subruleid <subruleid-val> [ offsethdr <Ethernet-val> | ip | tcp | udp |
icmp | igmp | l3Hdr | ppp | pppoe ] [ offset <offset-val> ] [ mask <maskval> ] [ valuefrom <valuefrom-val> ] [ valueto <valueto-val> ]
[ gencmp eq | neq | lt | leq | gt | geq | any | inrange | exrange | ingenlist
| notingenlist | innamedlist | notinnamedlist ] [ subruleprio low | high |
asinrule ] [ namedlistid <namedlistid-val> ] [ transporthdr ethernet |
pppoe ]
8.13.30.3
Delete filter subrule generic
Description: Use this command to delete.
Command Syntax: delete filter subrule generic ruleid <ruleidval>subruleid <subruleid-val>
8.13.30.4
Modify filter subrule generic
Description: Use this command to modify.
395
Command Syntax: modify filter subrule generic ruleid <ruleid-val>
subruleid <subruleid-val> [ offsethdr <Ethernet-val> | ip | tcp | udp |
icmp | igmp | l3Hdr | ppp | pppoe ] [ offset <offset-val> ] [ mask <maskval> ] [ valuefrom <valuefrom-val> ] [ valueto <valueto-val> ]
[ gencmp eq | neq | lt | leq | gt | geq | any | inrange | exrange | ingenlist
| notingenlist | innamedlist | notinnamedlist ] [ subruleprio low | high |
asinrule ] [ namedlistid <namedlistid-val> ] [ transporthdr ethernet |
pppoe ]
Parameter
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 65535
subruleid <subruleidval>
Unique identifier of a filter subrule.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4294967295
offsethdr ethernet | ip |
tcp | udp | icmp | igmp |
l3Hdr | ppp | pppoe
Type of offset header from where 'offset' to be
measured. The value 'ethernet' is invalid if the
rule for which this subrule is being created is of
direction 'out'.
Type: Create -- Optional
Modify -- Optional
Default value: ethernet
offset <offset-val>
Offset value to be added to 'offsethdr' to get the
field value
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 64
Default value: 0
mask <mask-val>
Mask to be applied to the contents of a packet at
'offset'
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 0xffffffff
Default value: 0xffffffff
valuefrom <valuefromval>
Start generic value of the range of generic
values. This field is invalid if 'gencmp' is 'any',
'ingenlist' or
'notingenlist','innamedlist',or'notinnamedlist'.This
field and next field specifiy a range of generic
values,if 'gencmp' is either 'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 0
396
valueto <valueto-val>
End generic value of the range of generic values.
This field and the previous field specifiy a range
of generic values,if 'gencmp' is either 'inrange' or
'exrange'.Otherwise this field is invalid
Type: Create -- Optional
Modify -- Optional
Default value: 0xffffffff
gencmp eq | neq | lt |
leq | gt | geq | any |
inrange | exrange |
ingenlist | notingenlist |
innamedlist |
notinnamedlist
Generic value comparision type.
subruleprio low | high |
asinrule
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: any
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
namedlistid
<namedlistid-val>
This specifies the list identifier value of the
named list which will be used to do the lookup .In
case 'gencmp' is 'innamedlist' or 'notinnamedlist',
this field is manadatory else it is extra.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 65535
Default value: 1
transporthdr ethernet |
pppoe
This specifies the type of Transport header in the
packet in which corresponding IP is being
transported. If value of this field is 'ethernet', then
IP is being carried in ethernet header and if it is
'pppoe' then corresponding IP is being carried in
PPP header.This field is valid only when value of
'offsethdr' is any one of ip, tcp, udp, icmp or
igmp.Otherwise this field is extra
Type: Create -- Optional
Modify -- Optional
Default value: ethernet
Example
$ create filter subrule generic ruleid 1 subruleid 2 offsethdr tcp offset 20
mask 0xFF valuefrom 0x20 valueto 0x40 gencmp inrange subruleprio
high namedlistid - transporthdr ethernet
Output
Verbose Mode On
Entry Created
397
Rule Id
: 1
Subrule Id
: 2
Offset header
: tcp
Offset
: 20
Generic header comparison : inrange
Mask
: 0xFF
Subrule Priority
: high
Start value : 0x20
End value
: 0x40
Transport Header
: ethernet
NamedList Id
: -
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule for which this sub
rule is being created.
Subrule Id
Unique identifier of a filter subrule.
Offset header
Type of offset header from where 'offset' to be
measured. The value 'ethernet' is invalid if the
rule for which this subrule is being created is of
direction 'out'.
Offset
Offset value to be added to 'offsethdr' to get the
field value
Generic header
comparison
Mask
Generic value comparision type.
Mask to be applied to the contents of a packet at
'offset'
Subrule Priority
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
Start value
Start generic value of the range of generic
values. This field is invalid if 'gencmp' is 'any',
'ingenlist' or
'notingenlist','innamedlist',or'notinnamedlist'.This
field and next field specifiy a range of generic
values,if 'gencmp' is either 'inrange' or 'exrange'
End value
End generic value of the range of generic
values. This field and the previous field specifiy
a range of generic values,if 'gencmp' is either
'inrange' or 'exrange'.Otherwise this field is
invalid
Transport Header
This specifies the type of Transport header in
the packet in which corresponding IP is being
transported. If value of this field is 'ethernet',
then IP is being carried in ethernet header and if
it is 'pppoe' then corresponding IP is being
carried in PPP header.This field is valid only
when value of 'offsethdr' is any one of ip, tcp,
udp, icmp or igmp.Otherwise this field is extra
NamedList Id
This specifies the list identifier value of the
named list which will be used to do the
lookup .In case 'gencmp' is 'innamedlist' or
'notinnamedlist', this field is manadatory else it is
extra.
References
• Generic filter commands
8.13.31
Filter subrule ICMP Commands
8.13.31.1
Get filter subrule icmp
Description: Use this command to get.
Command Syntax: get filter subrule icmp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
398
8.13.31.2
Create filter subrule icmp
Description: Use this command to create.
Command Syntax: create filter subrule icmp ruleid <ruleidval>subruleid <subruleid-val> [ icmptype<icmptype-val> ] [ icmpcode
<icmpcode-val> ] [ icmptypecmp eq | neq | any ] [ icmpcodecmp eq |
neq | any ] [ subruleprio low | high | asinrule] [ transporthdr ethernet |
pppoe ]
8.13.31.3
Delete filter subrule icmp
Description: Use this command to delete.
Command Syntax: delete filter subrule icmp ruleid <ruleid-val>
subruleid <subruleid-val>
8.13.31.4
Modify filter subrule icmp
Description: Use this command to modify.
Command Syntax: modify filter subrule icmp ruleid <ruleidval>subruleid <subruleid-val> [ icmptype<icmptype-val> ] [ icmpcode
<icmpcode-val> ] [ icmptypecmp eq | neq | any ] [ icmpcodecmp eq |
neq | any ] [ subruleprio low | high | asinrule] [ transporthdr ethernet |
pppoe ]
Parameter
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
subruleid <subruleidval>
Unique identifier of a filter subrule
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4294967295
icmptype <icmptypeval>
ICMP type
Type: Create -- Optional
Modify -- Optional
Default value: 0
icmpcode <icmpcodeval>
ICMP code
Type: Create -- Optional
Modify -- Optional
Default value: 0
icmptypecmp eq | neq
| any
ICMP type comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
399
icmpcodecmp eq | neq
| any
ICMP code comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
subruleprio low | high |
asinrule
This specifies the priority of the subrule. Based
on
this priority value, the subrule is created in fast or
slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the
rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
transporthdr ethernet |
pppoe
This specifies the type of the transport header in
the packet in which the corresponding IP is being
transported. If the value of this field is ethernet,
then the IP is being carried in the ethernet
header. If it is ‘pppoe’, then the corresponding IP
is being carried in the PPP header.
Type: Create -- Optional
Modify -- Optional
Default value: ethernet
Example
$ create filter subrule icmp ruleid 1 subruleid 2 icmptype 0 icmpcode 0
icmptypecmp neq icmpcodecmp neq subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
: 1
Subrule Id
: 2
Icmp type
: 0
Icmp code
: 0
ICMP type comparison : neq
Subrule Priority
: high
Transport Header
: Ethernet
ICMP code comparison : neq
Verbose Mode Off:
Entry Created
Output field
400
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created
Subrule Id
Unique identifier of a filter subrule
Icmp type
ICMP type
Icmp code
ICMP code
ICMP type comparison
ICMP type comparison type
ICMP code comparison
ICMP code comparison type
Subrule Priority
This specifies the priority of the subrule. Based
on
this priority value, the subrule is created in fast
or
slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the
rule.
Transport Header
This specifies the type of the transport header in
the packet in which the corresponding IP is
being transported. If the value of this field is
ethernet, then the IP is being carried in the
ethernet header. If it is ‘pppoe’, then the
corresponding IP is being carried in the PPP
header.
References
• Generic Filter commands
8.13.32
Filter subrule IGMP Commands
8.13.32.1
Get filter subrule igmp
Description: Use this command to get.
Command Syntax: get filter subrule igmp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
8.13.32.2
Create filter subrule igmp
Description: Use this command to create.
Command Syntax: create filter subrule igmp ruleid <ruleidval>subruleid <subruleid-val> [ igmptype <igmptype-val> ]
[ igmpcode <igmpcode-val> ] [ groupaddrfrom <groupaddrfrom-val> ]
[ groupaddrto <groupaddrto-val> ] [ igmptypecmp eq | neq | any ]
[ igmpcodecmp eq | neq | any ] [ igmpgroupaddrcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange ] [ subruleprio low | high |
asinrule] [ transporthdr ethernet | pppoe ]
8.13.32.3
Delete filter subrule igmp
Description: Use this command to delete.
Command Syntax: get filter subrule igmp ruleid <ruleidval>subruleid <subruleid-val>
8.13.32.4
Modify filter subrule igmp
Description: Use this command to modify.
Command Syntax: modify filter subrule igmp ruleid <ruleidval>subruleid <subruleid-val> [ igmptype <igmptype-val> ]
[ igmpcode <igmpcode-val> ] [ groupaddrfrom <groupaddrfrom-val> ]
[ groupaddrto <groupaddrto-val> ] [ igmptypecmp eq | neq | any ]
[ igmpcodecmp eq | neq | any ] [ igmpgroupaddrcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange ] [ subruleprio low | high |
asinrule] [ transporthdr ethernet | pppoe ]
Parameter
Name
401
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
subruleid <subruleidval>
Unique identifier of a filter subrule
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4294967295
igmptype <igmptypeval>
IGMP type
Type: Create -- Optional
Modify -- Optional
Default value: 0
igmpcode <igmpcodeval>
This fields specifies the Max Response Code
(time) fields of IGMP packet. This field is invalid
if igmphCodeCmpType is any.
Type: Create -- Optional
Modify -- Optional
Default value: 0
groupaddrfrom
<groupaddrfrom-val>
Start group address of the range of igmp group
addresses.This field is invalid if
'igmpgroupaddrcmp' is 'any'. This field and
'groupaddrto' specify a range of IGMP group
addresses, if 'igmpgroupaddrcmp' is either
'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 0
groupaddrto
<groupaddrto-val>
End group address of the range of igmp group
addresses. This field and 'groupaddrfrom' specify
a range of IGMP group addresses, if
'igmpgroupaddrcmp' is either 'inrange' or
'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 4294967295
igmptypecmp eq | neq
| any
IGMP type comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
igmpcodecmp eq | neq
| any
IGMP code comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
402
igmpgroupaddrcmp
eq | neq | lt | leq | gt |
geq | any | inrange |
exrange
IGMP group address comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
subruleprio low | high |
asinrule
This specifies the priority of the subrule. Based
on
this priority value, the subrule is created in fast or
slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
transporthdr ethernet |
pppoe
This specifies the type of the transport header in
the packet in which the corresponding IP is being
transported. If the value of this field is
Ethernet(0x1), then the IP is being carried in the
ethernet header. If it is pppoe(0x2), then the
corresponding IP is being carried in the PPP
header.
Type: Create -- Optional
Modify -- Optional
Default value: ethernet
Example
$ create filter subrule igmp ruleid 1 subruleid 2 igmptype 0 igmpcode 0
groupaddr from 224.0.2.3 groupaddrto 224.10.20.30 igmptypecmp eq
igmpcodecmp eq igmpgroupaddrcmp inrange subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
Id
: 1
Subrule
: 2
Igmp type
comparison : neq
: 0
IGMP type
Igmp code
comparison : neq
: 0
IGMP code
Start group address
address
: 224.10.20.30
: 224.0.2.3
IGMP group address comparison : inrange
Priority
: high
Transport Header
End group
Subrule
: Ethernet
Verbose Mode Off:
Entry Created
Output field
403
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created
Subrule Id
Unique identifier of a filter subrule
Igmp type
IGMP type
IGMP type comparison
IGMP type comparison type
Igmp code
This field specifies the Max Response Code
(time) fields of IGMP packet. This field is invalid
if igmphCodeCmpType is any.
IGMP code comparison
IGMP code comparison type
Start group address
Start group address of the range of igmp group
addresses.This field is invalid if
'igmpgroupaddrcmp' is 'any'. This field and
'groupaddrto' specify a range of IGMP group
addresses, if 'igmpgroupaddrcmp' is either
'inrange' or 'exrange'
End group address
End group address of the range of igmp group
addresses. This field and 'groupaddrfrom'
specifiy a range of IGMP group addresses, if
'igmpgroupaddrcmp' is either 'inrange' or
'exrange'
IGMP group address
comparison
Subrule Priority
IGMP group address comparison type
Transport Header
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
This specifies the type of the transport header in
the packet in which the corresponding IP is
being transported. If the value of this field is
Ethernet(0x1), then the IP is being carried in the
ethernet header. If it is pppoe(0x2), then the
corresponding IP is being carried in the PPP
header.
References
• Generic Filter commands
8.13.33
Filter subrule IP Commands
8.13.33.1
Get filter subrule ip
Description: Use this command to get.
Command Syntax: get filter subrule ip [ruleid <ruleid-val>]
[subruleid <subruleid-val >]
8.13.33.2
Create filter subrule ip
Description: Use this command to create.
Command Syntax: create filter subrule ip ruleid <ruleid-val >
subruleid <subruleid-val > [ srcipaddrfrom <srcipaddrfrom-val > ]
[ srcipaddrto <srcipaddrto-val > ] [ dstipaddrfrom <dstipaddrfrom-val
> ] [ dstipaddrto <dstipaddrto-val > ] [ prototypefrom <prototypefromval > ] [ prototypeto <prototypeto-val > ] [ srcaddrcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange | ingenlist | notingenlist ]
[ dstaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange |
ingenlist | notingenlist ] [ prototypecmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ ipsrcaddrmask <ipsrcaddrmask-val> ]
[ ipdstaddrmask <ipdstaddrmask-val> ] [ subruleprio low | high |
asinrule ] [ transporthdr ethernet | pppoe ] [ tosfrom <tosfrom-val> ]
[ tosto <tosto-val> ] [ tosmask <tosmask-val> ] [ toscmp eq | neq | lt
| leq | gt | geq | any | inrange | exrange ]
8.13.33.3
Delete filter subrule ip
Description: Use this command to delete.
Command Syntax: delete filter subrule ip ruleid <ruleid-val >
subruleid <subruleid-val >
404
8.13.33.4
Modify filter subrule ip
Description: Use this command to modify.
Command Syntax: modify filter subrule ip ruleid <ruleid-val >
subruleid <subruleid-val > [ srcipaddrfrom <srcipaddrfrom-val > ]
[ srcipaddrto <srcipaddrto-val > ] [ dstipaddrfrom <dstipaddrfrom-val
> ] [ dstipaddrto <dstipaddrto-val > ] [ prototypefrom <prototypefromval > ] [ prototypeto <prototypeto-val > ] [ srcaddrcmp eq | neq | lt |
leq | gt | geq | any | inrange | exrange | ingenlist | notingenlist ]
[ dstaddrcmp eq | neq | lt | leq | gt | geq | any | inrange | exrange |
ingenlist | notingenlist ] [ prototypecmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ ipsrcaddrmask <ipsrcaddrmask-val> ]
[ ipdstaddrmask <ipdstaddrmask-val> ] [ subruleprio low | high |
asinrule ] [ transporthdr ethernet | pppoe ] [ tosfrom <tosfrom-val> ]
[ tosto <tosto-val> ] [ tosmask <tosmask-val> ] [ toscmp eq | neq | lt
| leq | gt | geq | any | inrange | exrange ]
Parameter
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 65535
Unique identifier of a filter subrule.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 1 - 4294967295
Start source IP address of the range of source IP
addresses. This field is invalid if 'srcaddrcmp' is
'any', 'ingenlist' or 'notingenlist'. This field and
'srcipaddrto' specify a range of source IP
addresses if 'srcaddrcmp' is either 'inrange' or
'exrange'.
Type: Create - Optional
Modify - Optional
Default value: 0.0.0.0
End source IP address of the range of source IP
addresses. This field and 'srcipaddrfrom' specify
a range of source IP addresses, if 'srcaddrcmp' is
either 'inrange' or 'exrange'. Otherwise this field is
invalid.
Type: Create - Optional
Modify - Optional
Default value: 255.255.255.255
Start destination IP address of the range of
destination IP addresses. This field is invalid if
'dstaddrcmp' is 'any', 'ingenlist' or 'notingenlist'.
This field and 'dstipaddrto' specify a range of
destination IP addresses, if 'dstaddrcmp' is either
'inrange' or 'exrange'.
Type: Create - Optional
Modify - Optional
Default value: 0.0.0.0
End destination IP address of the range of
destination IP addresses. This field and
'dstipaddrfrom' specifiy a range of destination IP
addresses, if 'dstaddrcmp' is either 'inrange' or
'exrange'. Otherwise this field is invalid
Type: Create - Optional
Modify - Optional
subruleid <subruleidval>
srcipaddrfrom
<srcipaddrfrom-val>
srcipaddrto
<srcipaddrto-val>
dstipaddrfrom
<dstipaddrfrom-val>
dstipaddrto
<dstipaddrto-val>
405
prototypefrom
<prototypefrom-val>
prototypeto
<prototypeto-val>
srcaddrcmp eq | neq |
lt |leq | gt | geq | any
|inrange | exrange
|ingenlist |
notingenlist
dstaddrcmp eq | neq |
lt |leq | gt | geq | any
|inrange | exrange
|ingenlist |
notingenlist
prototypecmp eq | neq
| lt| leq | gt | geq | any
|inrange | exrange
ipsrcaddrmask
<ipsrcaddrmask-val>
ipdstaddrmask
<ipdstaddrmask-val>
subruleprio low | high
|asinrule
transporthdr ethernet |
pppoe
406
Default value: 255.255.255.255
Start IP protocol type of the range of IP protocol
types. This field is invalid if 'prototypecmp' is
'any'.This field and 'prototypeto' specify a range
of IP protocol types, if 'prototypecmp' is either
'inrange' or 'exrange'.
Type: Create - Optional
Modify - Optional
Default value: 0
End IP protocol type of the range of IP protocol
types.This field and 'prototypefrom' specifiy a
range of IP protocol types, if 'prototypecmp' is
either 'inrange' or 'exrange'. Otherwise this field is
invalid.
Type: Create - Optional
Modify - Optional
Default value: 27
Source IP addresss comparison type. 'ingenlist'
means check if source ip address present in
interface classifier generic list. 'notingenlist'
means check if source ip address not present in
interface classifier generic list. 'ingenlist' and
'notingenlist' are invalid if the direction of the rule
for which this subrule is being created is 'out'
Type: Create - Optional
Modify - Optional
Default value: any
Destination IP address comparison type.
'ingenlist' means check if destination ip address
present in interface classifier generic list.
'notingenlist' means check if destination ip
address not present in interface classifier generic
list. 'ingenlist' and 'notingenlist' are invalid if the
direction of the rule for which this subrule is being
created is 'out'.
Type: Create - Optional
Modify - Optional
Default value: any
IP Protocol type comparison type.
Type: Create - Optional
Modify - Optional
Default value: any
The mask value for source ip address. The mask
is applied over the source ip address before
checking against a value.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 0xffffffff
Default value: 0xffffffff
The mask value for destination ip address. The
mask is applied over the destination ip address
before checking against a value.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 0xffffffff
Default value: 0xffffffff
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
asinrule, subrule priority will be same as specified
in the rule.
Type: Create - Optional
Modify - Optional
Default value: asinrule
This specifies the type of Transport header in the
packet in which IP is being transported. If value of
this field is ethernet (1), then IP is being carried in
ethernet header and if it is pppoe (2) then then IP
tosfrom <tosfrom-val>
tosto <tosto-val>
tosmask <tosmaskval>
toscmp eq | neq | lt |
leq| gt | geq | any |
inrange| exrange
is being carried in PPP header.
Type: Create - Optional
Modify - Optional
Default value: ethernet
Start TOS value of the range of TOS values. This
field is invalid if 'TosCmpType' is 'any'(7).This
field and TosTo field specify a range of TOS
values, if 'TosCmpType' is either 'inrange'(8) or
'exrange'(9). Type: Create - Optional
Modify - Optional
Valid values: 0 - 0xff
Default value: 0
End TOS value of the range of TOS values. This
field is invalid if 'toscmp' is 'any'.This field and
'tosfrom' field specify a range of TOS values, if
'toscmp' is either 'inrange' or 'exrange'.
Type: Create - Optional
Modify - Optional
Valid values: 0 - 0xff
Default value: 0xff
The mask value for TOS field. The mask is
applied over the TOS field value before checking
against configured values in 'tosfrom' and 'tosto'.
Type: Create - Optional
Modify - Optional
Valid values: 0x01 - 0xff
Default value: 0xff
TOS comparision type.
Type: Create - Optional
Modify - Optional
Default value: any
Example
$ create filter subrule ip ruleid 1 subruleid 2 srcipaddrfrom 172.25.1.125
srcipaddrto 172.25.5.125 dstipaddrfrom 172.25.6.125 dstipaddrto
172.25.10.125 prototypefrom 1 prototypeto 6 srcaddrcmp inrange
dstaddrcmp inrange prototypecmp inrange ipsrcaddrmask 0xffffffff
ipdstaddrmask 0xffffffff subruleprio high transportHdr ethernet tosfrom
0x01 tosto 0x06 tosmask 0xff toscmp inrange
Output
Verbose Mode On
Entry Created
Rule Id
: 1
Subrule Id
: 2
Start src ip addr
172.25.5.125
: 172.25.1.125
End src ip addr
:
Start dest ip addr : 172.25.6.125
172.25.10.125
End dest ip addr
:
Start IP prot type : 1
End IP prot type
: 6
Start TOS value
0x06
: 0x01
End TOS value
:
Src ip addr comp
inrange
: inrange
Dest ip addr comp :
IP prot type comp
inrange
: inrange
TOS comp type
IP Src Addr Mask
0xffffffff
: 0xffffffff
IP Dest Addr Mask :
Subrule Priority
: high
Transport Header
: ethernet
TOS Mask
: 0xff
Verbose Mode Off:
Entry Created
407
:
Output field
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created.
Unique identifier of a filter subrule.
End source IP address of the range of source IP
addresses. This field and 'srcipaddrfrom' specify
a range of source IP addresses, if 'srcaddrcmp' is
either 'inrange' or 'exrange'. Otherwise this field is
invalid.
Start destination IP address of the range of
destination IP addresses. This field is invalid if
'dstaddrcmp' is 'any', 'ingenlist' or 'notingenlist'.
This field and 'dstipaddrto' specify a range of
destination IP addresses, if 'dstaddrcmp' is either
'inrange' or 'exrange'.
End destination IP address of the range of
destination IP addresses. This field and
'dstipaddrfrom' specifiy a range of destination IP
addresses, if 'dstaddrcmp' is either 'inrange' or
'exrange'. Otherwise this field is invalid
Start IP protocol type of the range of IP protocol
types. This field is invalid if 'prototypecmp' is
'any'.This field and 'prototypeto' specify a range of
IP protocol types, if 'prototypecmp' is either
'inrange' or 'exrange'.
End IP protocol type of the range of IP protocol
types.This field and 'prototypefrom' specifiy a
range of IP protocol types, if 'prototypecmp' is
either 'inrange' or 'exrange'. Otherwise this field is
invalid.
Start TOS value of the range of TOS values. This
field is invalid if 'TosCmpType' is 'any'(7).This
field and TosTo field specify a range of TOS
values, if 'TosCmpType' is either 'inrange'(8) or
'exrange'(9).
End TOS value of the range of TOS values. This
field is invalid if 'toscmp' is 'any'.This field and
'tosfrom' field specify a range of TOS values, if
'toscmp' is either 'inrange' or 'exrange'.
Source IP addresss comparison type. 'ingenlist'
means check if source ip address present in
interface classifier generic list. 'notingenlist'
means check if source ip address not present in
interface classifier generic list. 'ingenlist' and
'notingenlist' are invalid if the direction of the rule
for which this subrule is being created is 'out'
Destination IP address comparison type.
'ingenlist' means check if destination ip address
present in interface classifier generic list.
'notingenlist' means check if destination ip
address not present in interface classifier generic
list. 'ingenlist' and 'notingenlist' are invalid if the
direction of the rule for which this subrule is being
created is 'out'.
IP Protocol type comparison type.
TOS comparision type.
The mask value for source ip address. The mask
is applied over the source ip address before
checking against a value.
The mask value for destination ip address. The
mask is applied over the destination ip address
before checking against a value.
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
asinrule, subrule priority will be same as specified
in the rule.
Subrule Id
End src ip addr
Start dest ip addr
End dest ip addr
Start IP prot type
End IP prot type
Start TOS value
End TOS value
Src ip addr comp
Dest ip addr comp
IP prot type comp
TOS comp type
IP Src Addr Mask
IP Dest Addr Mask
Subrule Priority
408
Transport Header
TOS Mask
This specifies the type of Transport header in the
packet in which IP is being transported. If value of
this field is ethernet (1), then IP is being carried in
ethernet header and if it is pppoe (2) then then IP
is being carried in PPP header.
The mask value for TOS field. The mask is
applied over the TOS field value before checking
against configured values in 'tosfrom' and 'tosto'.
References
• Generic filter commands
8.13.34
Filter subrule PPP Commands
8.13.34.1
Get filter subrule ppp
Description: Use this command to get.
Command Syntax: get filter subrule ppp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
8.13.34.2
Create filter subrule ppp
Description: Use this command to create.
Command Syntax: create filter subrule ppp ruleid <ruleid-val>
subruleid <subruleid-val> [prototypefrom <prototypefrom-val>]
[prototypeto <prototypeto-val>] [prototypecmp eq | neq | lt | leq | gt |
geq | any | inrange | exrange] [subruleprio low | high | asinrule]
8.13.34.3
Delete filter subrule ppp
Description: Use this command to delete.
Command Syntax: delete filter subrule ppp ruleid <ruleidval>subruleid <subruleid-val>
8.13.34.4
Modify filter subrule ppp
Description: Use this command to modify.
Command Syntax: modify filter subrule ppp ruleid <ruleid-val>
subruleid <subruleid-val> [prototypefrom <prototypefrom-val>]
[prototypeto <prototypeto-val>] [prototypecmp eq | neq | lt | leq | gt |
geq | any | inrange | exrange] [subruleprio low | high | asinrule]
Parameter
Name
Description
ruleid <ruleid-val>
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 65535
subruleid <subruleidval>
Unique identifier of a filter subrule
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4294967295
409
prototypefrom
<prototypefrom-val>
Start of range of PPP protocol types. Invalid if
'prototypecmp' is 'any'. This field and the next
field specify a range of protocol types, if
'prototypecmp' is either 'inrange' or 'exrange'.
Otherwise only this field is valid
Type: Create -- Optional
Modify -- Optional
Default value: 0
prototypeto
<prototypeto-val>
End PPP protocol type of the range of PPP
protocol types. This field and 'prototypefrom'
specifiy a range of ppp protocol types if
'prototypecmp' is either 'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 65535
prototypecmp eq | neq
| lt | leq | gt | geq | any |
inrange | exrange
Protocol comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
subruleprio low | high |
asinrule
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
Example
$ create filter subrule ppp ruleid 1 subruleid 2 prototypefrom 0x1
prototypeto 0x5 prototypecmp inrange subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
: 1
Subrule Id
: 2
Start ProtoType
: 0x1
End ProtoType
: 0x5
Protocol comparison : inrange
Subrule Priority : high
Verbose Mode Off:
Entry Created
Output field
410
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created
Subrule Id
Unique identifier of a filter subrule
Start ProtoType
Start of range of PPP protocol types. Invalid if
'prototypecmp' is 'any'. This field and the next
field specify a range of protocol types, if
'prototypecmp' is either 'inrange' or 'exrange'.
Otherwise only this field is valid
End ProtoType
End PPP protocol type of the range of PPP
protocol types. This field and 'prototypefrom'
specifiy a range of ppp protocol types if
'prototypecmp' is either 'inrange' or 'exrange'
Protocol comparison
Protocol comparison type
Subrule Priority
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in fast
or slow memory. In case priority is specified as
'asinrule', subrule priority will be same as
specified in the rule.
References
• see generic filter related commands
8.13.35
Filter subrule TCP Commands
8.13.35.1
Get filter subrule tcp
Description: Use this command to get.
Command Syntax: get filter subrule tcp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
8.13.35.2
Create filter subrule tcp
Description: Use this command to create.
Command Syntax: create filter subrule tcp ruleid <ruleid-val>
subruleid <subruleid-val> [ srcportfrom <srcportfrom-val> ]
[ srcportto <srcportto-val> ] [ dstportfrom <dstportfrom-val> ]
[ dstportto <dstportto-val> ] [ srcportcmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ dstportcmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ subruleprio low | high | asinrule]
[ transporthdr ethernet | pppoe ]
8.13.35.3
Delete filter subrule tcp
Description: Use this command to delete.
Command Syntax: delete filter subrule tcp ruleid <ruleid-val >
subruleid <subruleid-val >
8.13.35.4
Modify filter subrule tcp
Description: Use this command to modify.
Command Syntax: modify filter subrule tcp ruleid <ruleid-val >
subruleid <subruleid-val > [ srcportfrom <srcportfrom-val > ]
[ srcportto <srcportto-val > ] [ dstportfrom <dstportfrom-val > ]
[ dstportto <dstportto-val > ] [ srcportcmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ dstportcmp eq | neq | lt | leq | gt | geq |
any | inrange | exrange ] [ subruleprio low | high | asinrule]
[ transporthdr ethernet | pppoe ]
Parameters
Name
Description
ruleid <ruleid-val >
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get --Optional
Valid values: 1-65535
Unique identifier of a filter subrule
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get --Optional
subruleid <subruleid-val
>
411
srcportfrom
<srcportfrom-val >
srcportto <srcportto-val
>
dstportfrom
<dstportfrom-val >
dstportto <dstportto-val
>
srcportcmp eq | neq | lt
| leq | gt | geq | any |
inrange | exrange
dstportcmp eq | neq | lt
| leq | gt | geq | any |
inrange | exrange
subruleprio low | high |
asinrule
transporthdr ethernet |
pppoe
Valid values: 1 - 4294967295
Start port number of the range of source port
numbers. This field is invalid if 'srcportcmp' is
'any'.This field and 'srcportto' specify a range of
tcp source port numbers if 'srcportcmp' is either
'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 0
End port number of the range of source port
numbers. This field and 'srcportfrom' specifiy a
range of TCP source port numbers if
'srcportcmp' is either 'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 65535
Start port number of the range of destination port
numbers. This field is invalid if 'dstportcmp' is
'any'. This field and 'dstportto' specifiy a range of
tcp destination port numbers if 'dstportcmp' is
either 'inrange' or 'exrange'
Type: Create --Optional
Modify --Optional
Default value: 0
End port number of the range of destination port
numbers. This field and 'dstportfrom' specifiy a
range of tcp destination port numbers if
'dstportcmp' is either 'inrange' or 'exrange'.
Otherwise this field is invalid
Type: Create -- Optional
Modify -- Optional
Default value: 65535
Source port comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
Destination port comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
This specifies the type of the transport header in
the packet in which the corresponding IP is
being transported. If the value of this field is
'Ethernet', then the IP is being carried in the
Ethernet header. If it is 'PPPoE', then the
corresponding IP is being carried in the PPP
header.
Type: Create -- Optional
Modify -- Optional
Default value: Ethernet
Example $ create filter subrule tcp ruleid 1 subruleid 2 srcportfrom 21
srcportto 23 dstportfrom 21 dstportto 23 srcportcmp inrange dstportcmp
inrange subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
Id
412
: 1
: 2
Subrule
Start source port
port
: 23
: 21
Start destination port : 21
port
: 23
End source
End destination
Source port comparison : inrange Destination port
comparison : inrange
Subrule Priority
: high
Transport Header
: Ethernet
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created.
Unique identifier of a filter subrule
Start port number of the range of source port
numbers. This field is invalid if 'srcportcmp' is
'any'. This field and 'srcportto' specifiy a range of
tcp source port numbers if 'srcportcmp' is either
'inrange' or 'exrange'
End port number of the range of source port
numbers. This field and 'srcportfrom' specifiy a
range of tcp source port numbers if 'srcportcmp'
is either 'inrange' or 'exrange'
Start port number of the range of destination port
numbers. This field is invalid if 'dstportcmp' is
'any'. This field and 'dstportto' specifiy a range of
tcp destination port numbers if 'dstportcmp' is
either 'inrange' or 'exrange'
End port number of the range of destination port
numbers. This field and 'dstportfrom' specifiy a
range of tcp destination port numbers if
'dstportcmp' is either 'inrange' or
'exrange'.Otherwise this field is invalid
Subrule Id
Start source port
End source port
Start destination port
End destination port
Source port
comparison
Destination port
comparison
Subrule Priority
Transport Header
Source port comparison type
Destination port comparison type
This specifies the priority of the subrule. Based
on this priority value, the subrule is created in
fast or slow memory. In case priority is specified
as 'asinrule', subrule priority will be same as
specified in the rule.
This specifies the type of the transport header in
the packet in which the corresponding IP is
being transported. If the value of this field is
'Ethernet', then the IP is being carried in the
Ethernet header. If it is 'PPPoE', then the
corresponding IP is being carried in the PPP
header.
References
• Generic Filter Commands
8.13.36
Filter subrule UDP Commands
8.13.36.1
Get filter subrule udp
Description: Use this command to get.
Command Syntax: get filter subrule udp [ruleid <ruleid-val>]
[subruleid <subruleid-val>]
8.13.36.2
Create filter subrule udp
Description: Use this command to create.
413
Command Syntax: create filter subrule udp ruleid <ruleid-val >
subruleid <subruleid-val > [srcportfrom <srcportfrom-val >] [srcportto
<srcportto-val >] [ dstportfrom <dstportfrom-val > ] [ dstportto
<dstportto-val > ] [ srcportcmp eq | neq | lt | leq | gt | geq | any |
inrange | exrange ] [ dstportcmp eq | neq | lt | leq | gt | geq | any |
inrange | exrange ] [ subruleprio low | high | asinrule]
[ transporthdr ethernet | pppoe ]
8.13.36.3
Delete filter subrule udp
Description: Use this command to delete.
Command Syntax: delete filter subrule udp ruleid <ruleid-val >
subruleid <subruleid-val >
8.13.36.4
Modify filter subrule udp
Description Use this command to modify.
Command Syntax: modify filter subrule udp ruleid <ruleid-val>
subruleid <subruleid-val> [ srcportfrom <srcportfrom-val> ] [ srcportto
<srcportto-val> ] [ dstportfrom <dstportfrom-val> ] [ dstportto
<dstportto-val> ] [ srcportcmp eq | neq | lt | leq | gt | geq | any | inrange
| exrange ] [ dstportcmp eq | neq | lt | leq | gt | geq | any | inrange |
exrange ] [ subruleprio low | high | asinrule] [ transporthdr ethernet |
pppoe ] [ transporthdr ethernet | pppoe ]
Parameters
Name
Description
ruleid <ruleid-val >
Unique identifier of a filter rule of which this sub
rule is being created
Type: Create --Mandatory
Delete --Mandatory Modify
Mandatory Get --Optional
Valid values: 1-65535
Unique identifier of a filter subrule
Type: Create --Mandatory
Delete – Mandatory
Modify-- Mandatory
Get --Optional
Valid values: 1 - 4294967295
Start port number of the range of source port
numbers. This field is invalid if 'srcportcmp' is
'any'. This field and 'srcportto' specifiy a range of
udp source port numbers, if 'srcportcmp' is either
'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 0
End port number of the range of source port
numbers.This field and 'srcportfrom' specifiy a
range of udp source port numbers, if 'srcportcmp'
is either 'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 65535
Start port number of the range of destination port
numbers. This field is invalid if 'dstportcmp' is
'any'.This field and 'dstportto' specifiy a range of
udp destination port numbers, if 'dstportcmp' is
either 'inrange' or 'exrange'
Type: Create -- Optional
Modify -- Optional
Default value: 0
End port number of the range of destination port
numbers. This field and 'dstportfrom' specifiy a
range of udp destination port numbers, if
'dstportcmp' is either 'inrange' or
subruleid <subruleidval >
srcportfrom
<srcportfrom-val >
srcportto <srcporttoval >
dstportfrom
<dstportfrom-val >
dstportto <dstporttoval >
414
srcportcmp eq | neq |
lt | leq | gt | geq | any |
inrange | exrange
dstportcmp eq | neq |
lt | leq | gt | geq | any |
inrange | exrange
subruleprio low | high
|asinrule
transporthdr ethernet
| pppoe
'exrange'.Otherwise this field is invalid
Type: Create -- Optional
Modify -- Optional
Default value: 65535
Source port comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
Destination port comparison type
Type: Create -- Optional
Modify -- Optional
Default value: any
This specifies the priority of the subrule. Based on
this priority value, the subrule is created in fast or
slow memory. In case priority is specified as
'asinrule', subrule priority will be same as specified
in the rule.
Type: Create -- Optional
Modify -- Optional
Default value: asinrule
This specifies the type of the transport header in
the packet in which the corresponding IP is being
transported. If the value of this field is Ethernet,
then the IP is being carried in the Ethernet header.
If it is PPPoE, then the corresponding IP is being
carried in the PPP header.
Type: Create -- Optional
Modify -- Optional
Default value: Ethernet
Example
$ create filter subrule udp ruleid 1 subruleid 2 srcportfrom 21 srcportto
23 dstportfrom 21 dstportto 23 srcportcmp inrange dstportcmp inrange
subruleprio high
Output
Verbose Mode On
Entry Created
Rule Id
Id
: 1
: 2
Start source port
port
: 23
: 21
Subrule
End source
Start destination port : 21
port
: 23
End destination
Source port comparison : inrange
comparison : inrange
Destination port
Subrule Priority
: high
Transport Header
: ethernet
Verbose Mode Off:
Entry Created
Output field
Field
Description
Rule Id
Unique identifier of a filter rule of which this sub
rule is being created
Unique identifier of a filter subrule
Start port number of the range of source port
numbers. This field is invalid if 'srcportcmp' is
'any'. This field and 'srcportto' specifiy a range of
udp source port numbers, if 'srcportcmp' is either
'inrange' or 'exrange'
End port number of the range of source port
numbers. This field and 'srcportfrom' specifiy a
range of udp source port numbers, if 'srcportcmp'
Subrule Id
Start source port
End source port
415
Start destination port
End destination port
Source port
comparison
Destination port
comparison
Subrule Priority
Transport Header
is either 'inrange' or 'exrange'
Start port number of the range of destination port
numbers. This field is invalid if 'dstportcmp' is
'any'.This field and 'dstportto' specifiy a range of
udp destination port numbers, if 'dstportcmp' is
either 'inrange' or 'exrange'
End port number of the range of destination port
numbers. This field and 'dstportfrom' specifiy a
range of udp destination port numbers, if
'dstportcmp' is either 'inrange' or
'exrange'.Otherwise this field is invalid
Source port comparison type
Destination port comparison type
This specifies the priority of the subrule. Based on
this priority value, the subrule is created in fast or
slow memory. In case priority is specified as
'asinrule', subrule priority will be same as specified
in the rule.
This specifies the type of the transport header in
the packet in which the corresponding IP is being
transported. If the value of this field is Ethernet,
then the IP is being carried in the Ethernet header.
If it is PPPoE, then the corresponding IP is being
carried in the PPP header.
References
• Generic Filter Commands
416
8.14
IGMP Commands
8.14.1
Igmpsnoop cfg info Commands
8.14.1.1
Get igmpsnoop cfg info
Description: Use this command to get.
Command Syntax: get igmpsnoop cfg info
8.14.1.2
Modify igmpsnoop cfg info
Description: Use this command to modify.
Command Syntax: modify igmpsnoop cfg info [ queryinterval
<queryinterval-val> ] [ anxioustimer <anxioustimer-val> ]
[ v1hosttimer <v1hosttimer-val> ] [ lastmembqryinterval
<lastmembqryinterval-val> ] [ robustness <robustness-val> ] [ status
Enable | Disable ] [ reportsup Enable | Disable ] [ qryrespinterval
<qryrespinterval-val> ] [ proxyreportstatus Enable | Disable ]
[ versionmask v1 | v2 | v3 ] [ startupqryinterval <startupqryintervalval> ] [ startupqrycount <startupqrycount-val> ]
[ lastmemberqrycount <lastmemberqrycount-val> ]
[ unsolicrprtinterval <unsolicrprtinterval-val> ]
Parameters
Name
Description
queryinterval
<queryinterval-val>
This parameter is used to calculate the entry age
out timer, when no reports or queries are received
on the entry. When the value of this parameter
multiplied by 10, it should be greater than the
Query Interval configured at the router. The time
for which an entry created at Igmpsnoop module
exists, if no messages are received for it is
approximately (((QueryInterval*10)*Robustness) +
Query Response Time received in Last Query)
Type: Modify -- Optional
Valid values: 1 - 0xff
anxioustimer
<anxioustimer-val>
This parameter specifies the maximum time (in
seconds) before which the IgmpSnoop module will
forward all IGMP membership reports received. It
is started once, whenever the first membership
report is received for a group, to ensure that
reports are forwarded for a sufficiently long time,
to take care of any lost reports. The unit is
seconds.
Type: Modify -- Optional
Valid values: 1 - 65535
v1hosttimer
<v1hosttimer-val>
This parameter specifies the maximum time (in
seconds), for which the IgmpSnooping module
can assume that there are Version 1 group
members present, for the group for which this
timer is running. The unit of this parameter is
seconds.
Type: Modify -- Optional
Valid values: 1 - 260
417
lastmembqryinterval
<lastmembqryintervalval>
This parameter specifies the Last Member Query
Interval that is the Max Response Time inserted
into Group-Specific Queries sent in response to
Leave Group messages, and is also the amount of
time between Group-Specific Query messages.
The value of this parameter may be tuned to
modify the leave latency of the network. A
reduced value results in reduced time to detect the
loss of the last member of a group. The unit of this
parameter is one-tenth of second.
Type: Modify -- Optional
Valid values: 1 – 255
robustness
<robustness-val>
This parameter allows tuning for the expected
packet loss on a subnet. The IgmpSnooping
module is robust to [RobustnessVar] packet
losses.
Type: Modify -- Optional
Valid values: 2 - 255
status Enable |
Disable
This parameter specifies whether Igmp Snooping
needs to be enabled in the system.
Type: Modify -- Optional
reportsup Enable |
Disable
Report Suppression is enabled or not.
Type: Modify -- Optional
qryrespinterval
<qryrespinterval-val>
This parameter is used to derive Max Response
Code to be filled in General query that will be
initiated from Columbia
Type: Modify -- Optional
Valid values: 1 - 0xff
proxyreportstatus
Enable | Disable
This parameter controls whether proxy reporting
will be supported at the global level.
Type: Modify -- Optional
versionmask v1 | v2 |
v3
This parameter controls which versions of IGMP
are currently supported at Columbia. Depending
on the version mask, IGMP messages of
unsupported version, will be dropped
Type: Modify -- Optional
startupqryinterval
<startupqryintervalval>
This parameter specifies the interval between
General Queries sent on receiving Port Up
topology change trigger.
Type: Modify -- Optional
Valid values: 1 - 0xff
startupqrycount
<startupqrycount-val>
This parameter specifies the number of General
Queries sent on receiving Port Up topology
change trigger, separated by the
StartupQryInterval
Type: Modify -- Optional
Valid values: 0 - 0xff
lastmemberqrycount
<lastmemberqrycountval>
This parameter specifies the number of Groupspecific or Group-and-Source-specific Queries
sent before assuming there are no listener for this
Group or Group-Source pair.
Type: Modify -- Optional
Valid values: 1 - 0xff
418
unsolicrprtinterval
<unsolicrprtintervalval>
This parameter specifies the interval between
unsolicited membership reports of a group sent for
robustness no of times.This field is applicable only
when proxy reporting is enabled.
Type: Modify -- Optional
Valid values: 1 - 0xff
Example
$ get igmpsnoop cfg info
Output
Query Interval
Interval : 10
: 12
StartUp Query Interval
UnSolicRprtInterval
Anxious Timer
Timer
Query Response
: 10
: 10
: 125
V1 Host
: 130
Last Member Query Interval : 125
Variable
: 2
Robustness
Igmp Snoop Status
: Enable
Version Mask
: v3
Report Suppression Status
Status
: Enable
: Enable
Proxy Report
StartUp QryCount
QryCount
: 100
: 2
Last Member
Output field
419
Field
Description
Query Interval
This parameter is used to calculate the entry age
out timer, when no reports or queries are
received on the entry. When the value of this
parameter multiplied by 10, it should be greater
than the Query Interval configured at the router.
The time for which an entry created at
Igmpsnoop module exists, if no messages are
received for it is approximately
(((QueryInterval*10)*Robustness) + Query
Response Time received in Last Query)
Query Response
Interval
This parameter is used to derive Max Response
Code to be filled in General query that will be
initiated from Columbia
StartUp Query Interval
This parameter specifies the interval between
General Queries sent on receiving Port Up
topology change trigger.
UnSolicRprtInterval
This parameter specifies the interval between
unsolicited membership reports of a group sent
for robustness no of times.This field is applicable
only when proxy reporting is enabled.
Anxious Timer
This parameter specifies the maximum time (in
seconds) before which the IgmpSnoop module
will forward all IGMP membership reports
received. It is started once, whenever the first
membership report is received for a group, to
ensure that reports are forwarded for a
sufficiently long time, to take care of any lost
reports. The unit is seconds.
V1 Host Timer
This parameter specifies the maximum time (in
seconds), for which the IgmpSnooping module
can assume that there are Version 1 group
members present, for the group for which this
timer is running. The unit of this parameter is
seconds.
Last Member Query
Interval
This parameter specifies the Last Member
Query Interval that is the Max Response Time
inserted into Group-Specific Queries sent in
response to Leave Group messages, and is also
the amount of time between Group-Specific
Query messages. The value of this parameter
may be tuned to modify the leave latency of the
network. A reduced value results in reduced
time to detect the loss of the last member of a
group. The unit of this parameter is one-tenth of
second.
Robustness Variable
This parameter allows tuning for the expected
packet loss on a subnet. The IgmpSnooping
module is robust to [RobustnessVar] packet
losses.
Igmp Snoop Status
This parameter specifies whether Igmp
Snooping needs to be enabled in the system.
Version Mask
This parameter controls which versions of IGMP
are currently supported at Columbia. Depending
on the version mask, IGMP messages of
unsupported version, will be dropped
Report Suppression
Status
Proxy Report Status
Report Suppression is enabled or not.
StartUp QryCount
This parameter specifies the number of General
Queries sent on receiving Port Up topology
change trigger, separated by the
StartupQryInterval
Last Member QryCount
This parameter specifies the number of Groupspecific or Group-and-Source-specific Queries
sent before assuming there are no listener for
this Group or Group-Source pair.
This parameter controls whether proxy reporting
will be supported at the global level.
8.14.2
Igmpsnoop mvlan config Commands
8.14.2.1
Get igmpsnoop mvlan config
Description: Use this command to get.
Command Syntax: get igmpsnoop mvlan config [grpipaddr
<grpipaddr-val>] [srcipaddr <srcipaddr-val>] [vlanid <vlanid-val> |
none]
8.14.2.2
Create igmpsnoop mvlan config
Description: Use this command to create.
Command Syntax: create igmpsnoop mvlan config grpipaddr
<grpipaddr-val> srcipaddr srcipaddr vlanid <vlanid-val> | none
[mcastvlanstag <mcastvlanstag-val> | none] [mcastvlanctag
<mcastvlanctag-val> | invlan | none] [portlist <portlist-val> | none]
8.14.2.3
Delete igmpsnoop mvlan config
Description: Use this command to delete.
Command Syntax: delete igmpsnoop mvlan config [grpipaddr
<grpipaddr-val>] [srcipaddr <srcipaddr-val>] [vlanid <vlanid-val> |
none]
8.14.2.4
Modify igmpsnoop mvlan config
Description: Use this command to modify.
Command Syntax: modify igmpsnoop mvlan config grpipaddr
<grpipaddr-val> srcipaddr <srcipaddr-val> vlanid <vlanid-val> | none
420
[mcastvlanstag <mcastvlanstag-val> | none] [mcastvlanctag
<mcastvlanctag-val> | invlan | none] [portlist <portlist-val> | none]
Parameters
Name
Description
grpipaddr <grpipaddrval>
This parameter specifies the Destination Group
IP address for a multicast stream. The source
address and destination group address together
define a multicast stream. In case of value 0, this
parameter is ignored while determining Multicast
Vlan
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
srcipaddr <srcipaddrval>
This parameter specifies the source IP address
of the Multicast Server. The source address and
destination group address together define a
multicast stream. In case of value 0, this
parameter is ignored while determining Multicast
Vlan.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
vlanid <vlanid-val> |
none
This parameter specifies the Dot1q tag of an
IGMP packet received. This will be PVID in case
an untagged IGMP packet was received. In case
of value 0, this parameter is ignored while
determining Multicast Vlan.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4095
Additional Values: 0
mcastvlanstag
<mcastvlanstag-val> |
none
This parameter specifies the Multicast SVlanId to
be used in case of stacked mode. In the native
mode, this parameter is not applicable.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 4095
Additional Values: 0
421
mcastvlanctag
<mcastvlanctag-val> |
invlan | none
This parameter specifies the Multicast CVlanId to
be used. Two special values of this parameter
are supported in stacked mode: One value
(4097) to signify that repot/leave shall be
forwarded to querier with the C tag with which it
was received from the subscriber port and the S
tag specified in multicast Vlan's definition One
value (0) to signify that report/leave shall be
forwarded to querier with S tag specified in
multicast Vlan's definition and no C tag. Other
Value shall signify that, report/leave shall be
forwarded to querier with S and C tag specified in
multicast Vlan's definition.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 -4095
Additional Values: 0, 4097
portlist <portlist-val> |
none
This parameter specifies the list of ports on which
a given combination of (Group Address, Source
Address, VlanId) maps to a specified multicast
vlan (STag, CTag)
Type: Create -- Optional
Modify -- Optional
Default value: 0
Example
$ create igmpsnoop mvlan config grpipaddr 224.0.0.7 srcipaddr
12.23.34.45 vlanid 6 mcastvlanstag 5 mcastvlanctag 5 portlist 5 6 10
Output
Verbose Mode On
Entry Created
Grp IPAddress
: 224.0.0.7
Src IPAddres
: 12.23.34.45
VLAN Index
: 6
McastVlan STag : 5
PortList
McastVlan CTag : 5
: 5 6 10
Verbose Mode Off:
Entry Created
Output field
422
Field
Description
Grp IPAddress
This parameter specifies the Destination Group
IP address for a multicast stream. The source
address and destination group address together
define a multicast stream. In case of value 0, this
parameter is ignored while determining Multicast
Vlan
Src IPAddres
This parameter specifies the source IP address
of the Multicast Server. The source address and
destination group address together define a
multicast stream. In case of value 0, this
parameter is ignored while determining Multicast
Vlan.
VLAN Index
This parameter specifies the Dot1q tag of an
IGMP packet received. This will be PVID in case
an untagged IGMP packet was received. In case
of value 0, this parameter is ignored while
determining Multicast Vlan.
McastVlan STag
This parameter specifies the Multicast SVlanId to
be used in case of stacked mode. In the native
mode, this parameter is not applicable.
McastVlan CTag
This parameter specifies the Multicast CVlanId to
be used. Two special values of this parameter
are supported in stacked mode: One value
(4097) to signify that repot/leave shall be
forwarded to querier with the C tag with which it
was received from the subscriber port and the S
tag specified in multicast Vlan's definition One
value (0) to signify that report/leave shall be
forwarded to querier with S tag specified in
multicast Vlan's definition and no C tag. Other
Value shall signify that, report/leave shall be
forwarded to querier with S and C tag specified in
multicast Vlan's definition.
PortList
This parameter specifies the list of ports on which
a given combination of (Group Address, Source
Address, VlanId) maps to a specified multicast
vlan (STag, CTag)
8.14.3
Igmpsnoop port info Commands
8.14.3.1
Get igmpsnoop port info
Description: Use this command to get.
Command Syntax: get igmpsnoop port info [portid <portid-val >]
8.14.3.2
Modify igmpsnoop port info
Description: Use this command to modify.
Command Syntax: modify igmpsnoop port info portid portid
[ status Enable | Disable ] [ leavemode Normal | Fast | FastNormal ]
[ pktpriority <pktpriority-val> | none ] [ maxgrpallowed
<maxgrpallowed-val> ] [ querierstatus Enable | Disable ]
[ mcastvlanstatus Enable | Disable ] [ nomatchaction Drop |
Transparentlyforward | Learn ]
Parameters
Name
Description
portid <portid-val>
This parameter specifies a bridge port for which
IGMP Snooping needs to be enabled or
disabled.
Type: Modify -- Mandatory
Get -- Optional
Valid values: 1 - 194
status Enable | Disable
This parameter specifies whether IGMP
Snooping is to be enabled on the port.
Type: Modify -- Optional
423
leavemode Normal |
Fast | FastNormal
This parameter specifies the Igmp Snooping
Leave message processing mode for the port. If
the mode is set to 'Normal', the Leave message
is forwarded to the Querier. Then, based on the
Query received from Querier, the Leave
processing is triggered. If the mode is set to
'Fast', the port is immediately deleted from that
multicast group on Leave message reception
and then the Leave message is forwarded. The
mode should be set to 'Fast' for a port only if
there is one host behind the port. This is
because if there are multiple hosts behind the
port then it will lead to traffic disruption for other
hosts who might still be listening to that multicast
group. If the mode is set to 'FastNormal', the
Leave message is forwarded and the Leave
processing is triggered immediately without
waiting for any trigger from the Querier. The
'FastNormal' mode, thus, saves the delay (equal
to the time taken for Leave message to reach
router and Querier processing time for it and the
time taken for Query to reach IGMP Snoop
module) in Leave processing.
Type: Modify -- Optional
Valid values: op module) in Leave processing.
pktpriority <pktpriorityval> | none
This parameter specifies the Egress Priority to
be set in case the Ethernet frames carrying
IGMP packets sent over this port need to be
tagged by the control plane. In case the frame
came tagged, priority that came in the tagged
frame will not be changed. The configured
priority will also be used for choice of traffic
class/Queue on outgoing interface whether the
frame is tagged . In case the bridge port is over
an Aggregated ATM VC, this will also be used to
identify the VC, on which the packet is to be
sent. There is an additional support of invalid
value for egress priority in IGMP port info to
indicate that the priority is not to be forced on
egress frame for this port.
Type: Modify -- Optional
Valid values: 0 - 7
maxgrpallowed
<maxgrpallowed-val>
This parameter controls the no. of simultaneous
channels that can be received by this port
Type: Modify -- Optional
Valid values: 0 - 256
querierstatus Enable |
Disable
This parameter controls whether a port can
become querier
Type: Modify -- Optional
mcastvlanstatus
Enable | Disable
This parameter controls the status of Multicast
Vlan option on a port
Type: Modify -- Optional
nomatchaction Drop |
Transparentlyforward |
Learn
This parameter specifies the action to be taken
when multicast vlan can not be determined for a
port where multicast vlan option is enabled
Possible action values will be :Drop,
Transparently forward, and Learn based on
ingress vlan
Type: Modify -- Optional
Example: $ get igmpsnoop port info portid 6
Output
424
Port Index
: 6
Port Igmp Snoop Status
Normal
: Enable
Leave Mode
:
IGMP PacketsPrio:2MaxGroupAllowed:2'
Querier Status
Enable
: Enable
McastVlan Status :
No McastVlan Match Action : Learn
Output field
425
Field
Description
Port Index
This parameter specifies a bridge port for which
IGMP Snooping needs to be enabled or
disabled.
Port Igmp Snoop
Status
This parameter specifies whether IGMP
Snooping is to be enabled on the port.
Leave Mode
This parameter specifies the Igmp Snooping
Leave message processing mode for the port. If
the mode is set to 'Normal', the Leave message
is forwarded to the Querier. Then, based on the
Query received from Querier, the Leave
processing is triggered. If the mode is set to
'Fast', the port is immediately deleted from that
multicast group on Leave message reception
and then the Leave message is forwarded. The
mode should be set to 'Fast' for a port only if
there is one host behind the port. This is
because if there are multiple hosts behind the
port then it will lead to traffic disruption for other
hosts who might still be listening to that multicast
group. If the mode is set to 'FastNormal', the
Leave message is forwarded and the Leave
processing is triggered immediately without
waiting for any trigger from the Querier. The
'FastNormal' mode, thus, saves the delay (equal
to the time taken for Leave message to reach
router and Querier processing time for it and the
time taken for Query to reach IGMP Snoop
module) in Leave processing.
IGMP PacketsPrio'
This parameter specifies the Egress Priority to
be set in case the Ethernet frames carrying
IGMP packets sent over this port need to be
tagged by the control plane. In case the frame
came tagged, priority that came in the tagged
frame will not be changed. The configured
priority will also be used for choice of traffic
class/Queue on outgoing interface whether the
frame is tagged . In case the bridge port is over
an Aggregated ATM VC, this will also be used to
identify the VC, on which the packet is to be
sent. There is an additional support of invalid
value for egress priority in IGMP port info to
indicate that the priority is not to be forced on
egress frame for this port.
MaxGroupAllowed
This parameter controls the no. of simultaneous
channels that can be received by this port
Querier Status
This parameter controls whether a port can
become querier
McastVlan Status
This parameter controls the status of Multicast
Vlan option on a port
No McastVlan Match
Action
This parameter specifies the action to be taken
when multicast vlan can not be determined for a
port where multicast vlan option is enabled
Possible action values will be :Drop,
Transparently forward, and Learn based on
ingress vlan
Caution
• An entry in this table shall not be applicable for a bridge port created
over the PPPoE interface.
8.14.4
Igmpsnoop port stats Commands
8.14.4.1
Get igmpsnoop port stats
Description: Use this command to get.
Command Syntax: get igmpsnoop port stats [vlanid <vlanid-val>]
[mcastaddr <mcastaddr-val>] [portid <portid-val>]
8.14.4.2
Reset igmpsnoop port stats
Description: Use this command to reset.
Command Syntax: reset igmpsnoop port stats [vlanid vlanid]
mcastaddr <mcastaddr-val> portid <portid-val>
Parameters
Name
vlanid <vlanid-val >
Mcastaddr <mcastaddrval >
portid <portid>
Description
The VLAN id for this VLAN. In devices
supporting "Shared Vlan for multicast" capability,
the information for a multicast MAC address is
shared across VLANS. Hence, vlanid is optional
and can be passed as zero or a valid vlanid
value. In devices supporting "Independent Vlan
for multicast" capability, each vlan can have its
own information for a multicast MAC address.
Hence, VLAN id is a mandatory parameter and a
valid value of vlanid must be passed. For the
case when the attribute
"McastDeviceCapabilities" of MO
"sysSizingTable" has value "none", VLAN id is
not required. This feature is not supported for
VLAN with vlanid as 4097.VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1-4095
A multicast MAC Address, learned through Igmp
Snooping, within the Vlan (igmpVlanIndex), to
uniquely identify the entry, for which the
IgmpSnooping statistics are desired. The range
of accepted values is 01:00:5E:00:00:00 to
01:00:5E:7F:FF:FF
Type: Reset - Optional
Get - Optional
Valid values: 01:00:5E:00:00:00 01:00:5E:7F:FF:FF
A Bridge Port belonging to the Vlan
(igmpVlanIndex) and Group
(igmpsnoopMcastAddress), for which the
IgmpSnooping statistics are desired.
Type: Reset --Optional
Get –Optional
Valid values: 1 - 386
Example $ get igmpsnoop port stats vlanid 6 mcastaddr
01:00:5E:0a:00:01 portid 6
Output
426
VLAN Index
: 6
Mcast Group Address : 01:00:5E:0a:00:01
Port Index
: 6
Query Received
: 100
Filter Mode
: Include
Include SrcList
: 10.12.14.16 12.10.45.76
Exclude SrcList
: 10.12.34.56 34.54.76.87
Report Received : 200
Output field
Field
Description
VLAN Index
This parameter specifies the VlanId to uniquely
identify the VlanId of the entry, for which the
IgmpSnooping statistics are desired. In devices
supporting "Shared Vlan for multicast" capability,
the information for a multicast MAC address is
shared across vlans. Therefore, VlanId is an
optional parameter. In devices supporting
"Independent Vlan for multicast" capability, each
vlan can have its own information for a multicast
MAC address. Hence VlanId is a mandatory
parameter in all the commands other than the
get command. For no Vlan case, VlanId is not
required.
Mcast Group Address
This parameter specifies a multicast MAC
address, learnt through Igmp Snooping, within
the Vlan (igmpVlanIndex), to uniquely identify
the entry, for which the IgmpSnooping statistics
are desired. The range of accepted values is
01:00:5E:00:00:00 to 01:00:5E:7F:FF:FF.
Port Index
This parameter specifies a bridge port belonging
to the Vlan (igmpVlanIndex) and Group
(igmpsnoopMcastAddress), for which the
IgmpSnooping statistics are desired.
Query Received
This parameter specifies thenumber of Igmp
queries received on the port belonging to a
particular multicast group and Vlan.
Report Received
This parameter specifies thenumber of
Membership reports received on the port
belonging to a particular multicast group and
Vlan.
Filter Mode
This parameter specifies the current filter mode
on a port for a given group.
Include SrcList
This parameter specifies the Include Source list,
which is the list of sources to be included in case
of Include filter mode and the list of conflicting
sources in case of exclude mode of the port for a
given group
Exclude SrcList
This parameter specifies the Exclude Source list,
which is the list of sources to be excluded in
case of exclude filter mode of the port for a given
group
Caution:
• An entry in this table shall not be applicable for a bridge port created
over the PPPoE interface.
8.14.5
Igmpsnoop querier info Commands
8.14.5.1
Get igmpsnoop querier nfo
Description: Use this command to get.
427
Command Syntax: get igmpsnoop querier info [vlanid <vlanid-val >]
[portid <portid-val>]
8.14.5.2
Create igmpsnoop querier info
Description: Use this command to create.
Command Syntax: create igmpsnoop querier info vlanid <vlanid-val
> portid <portid-val >
8.14.5.3
Delete igmpsnoop querier info
Description: Use this command to delete.
Command Syntax: delete igmpsnoop querier info vlanid <vlanid-val
> portid <portid>
Parameters
Name
Description
vlanid <vlanid-val>
The VLAN id for this VLAN. In devices supporting
"Shared Vlan for multicast" capability, the
information for a multicast MAC address is shared
across VLANS. Hence, vlanid is optional and can
be passed as zero or a valid vlanid value. In
devices supporting "Independent Vlan for
multicast" capability, each vlan can have its own
information for a multicast MAC address. Hence,
VLAN id is a mandatory parameter and a valid
value of vlanid must be passed. For the case
when the attribute "McastDeviceCapabilities" of
MO "sysSizingTable" has value "none", VLAN id is
not required. This feature is not supported for
VLAN with vlanid as 4097.VLAN here means the
802.1q Vlan in case of Native Vlan mode and
Virtual Vlan in case of Stacked Vlan Mode.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1-4095
A Bridge Port, belonging to the Vlan
(dot1qVlanIndex), on which the Querier exists.
Type: Create -- Mandatory
Delete -- Mandatory
Get --Optional
Valid values: 1 - 65535
portid <portid-val>
Example $ create igmpsnoop querier info vlanid 6 portid 6
Output
Verbose Mode On
Entry Created
VLAN Index
: 6
Port Index : 6
Querier Port Status : Mgmt
Verbose Mode Off:
Entry Created
Output field
428
Field
Description
VLAN Index
VlanId to uniquely identify the vlanid of the entry
for which the IgmpSnooping Querier is
configured/ learned. In devices supporting
"Shared Vlan for multicast" capability, the
information for a Querier port is shared across
vlans. Hence vlan id is an optional parameter. In
Port Index
Querier Port Status
devices supporting "Independent Vlan for
multicast" capability, each vlan can have its own
information for a Querier port. Hence vlanid is a
mandatory parameter in all the commands other
than - get. For No Vlan case, vlan id is not
required. This Feature is not supported for VLAN
with vlanid as 4097.
A Bridge Port, belonging to the Vlan
(dot1qVlanIndex), on which the Querier exists.
Specifies whether Querier Port has been learned
dynamically or configured by the user.
Caution
• An entry in this table shall not be applicable for a bridge port created
over the PPPoE interface.
429
8.15
Interface Commands
8.15.1
Interface Commands
8.15.1.1
Get interface stats
Description: Use this command to view statistics for one interface or
all the interfaces.
Command Syntax: get interface stats [ifname <interface-name>]
Parameters:
Name
Description
Ifname <interfacename>
Index of the interface having one to one mapping
with IfTable. Only Ethernet, EOA, Aggregator,
HDLC, PPPOE, IPOE, ABOND, ATM, ATM VC
Aggregation and ATM VC interface index are
supported for reset operation.
Type : Optional
Valid values: aal5-*, eth-0, eth-1,atm-*, eoa-*,
dsl-*, dslf-*, dsli-*, aggr-*, ehdlc-*, pppoe-*, pppr-*,
vdsl-*, ipoe-*, abond-* , vcaggr-*
Example
$ get interface stats ifname eth-0
Output
Verbose Mode On
Entry Created
Interface
eth-0
: eth-0
Description
:
Type
1500
: ETHERNET
Mtu
:
Bandwidth
00:BB:CC:DD:EE:F1
: 100000000
Phy Adddr
:
Last Change(sec)
: 219
Unknown Prot Pkts
: 0
Admin Status
: Up
Operational Status : Up
In Octets
168929
: 396312
Out Octets
:
In Discards
: 0
Out Discards
: 0
In Errors
: 0
Out Errors
: 0
In Ucast Pkts
2518
: 2291
Out Ucast Pkts
:
In Mcast Pkts
: 428
Out Mcast Pkts
: 0
In Bcast Pkts
: 1456
Out Bcast Pkts
: 0
LinkUpDnTrapEnable : Enable
True
Promiscous Mode
:
Connector Present
: True
CounterDiscontTime : 0
HC In Octets
: 0x000060c18
HC OutOctets
: 0x0000293e1
Output Fields
430
Field
Description
Interface
Index of the interface having one to one mapping
with IfTable. Only Ethernet, EOA , Aggregator,
HDLC, PPPOE, IPOE, ABOND, ATM , ATM VC
Aggregation and ATM VC interface index are
supported for reset operation.
Description
Type
Mtu
Bandwidth
Phy Addr
Admin Status
Operational Status
Last Change
Unknown Prot Pkts
In Octets
Out Octets
In Discards
Out Discards
In Errors
Out Errors
In Ucast Pkts
Out Ucast Pkts
HC In Octets
HC OutOctets
In Mcast Pkts
431
This is general information about the interface
The type of interface, distinguished according the
physical/link/network protocol, immediately below
the IP layer. It may be: ATM, ETHERNET, AAL5,
EOA, DSL, FAST, INTERLEAVED, AGGR.
EHDLC, PPP, LOOPBACK, IPOA, PPPR,
PPPOE, SHDSL, ABOND, IPOE, VCAGGR,
VDSL, USB. .
The size (in bytes) of the largest packet, which
can be sent/received on this interface in octets.
The current bandwidth of the interface, in bps.
Interface's address, at its protocol sublayer.
This is the desired state of the interface. It may be:
Up, Down.
The current operational state of the interface. If
ifAdminStatus is disable (2), then ifOperStatus
should be disable (2). If ifAdminStatus is changed
to enable (1), then ifOperStatus should change to
enable (1), if the interface is ready to transmit and
receive network traffic. Interface will have the
OperStatus value as dormant (5) if the
'configstatus' of the entry is 'config' and the
interface is waiting for a packet to be sensed to
get activated.
Value of System UpTime (in seconds) at the time
the interface entered its current operational state.
The number of packets received via the interface,
which were discarded because of an unknown or
unsupported protocol.
The total number of octets received on the
interface, including the framing characters. For
Ethernet interfaces, this will have the lower 32 bits
of HC in octets. Valid for atm-*, eoa-*, aal5-*, eth0, eth-1, dsl-*, dslf-*, dsli-*, aggr-*.
The total number of octets transmitted out of the
interface, including framing characters. For
Ethernet interfaces, this will have the lower 32 bits
of HC Out octets. Valid for atm-*, eoa-*, aal5-*,
eth-0, eth-1, dsl-*, dslf-*, dsli-*, aggr-*.
The number of inbound packets, which were
discarded, though no errors were detected.
The number of outbound packets chosen to be
discarded even though there were no errors.
The number of inbound packets, which were not
delivered to upper layers because of errors.
The number of outbound packets chosen to be
discarded because there were errors.
The number of unicast packets delivered to a
higher layer protocol.
The total number of packets requested to be sent
to unicast addresses, by upper layer protocols.
The total number of octets received on the
interface, including framing characters. This object
is a 64-bit version of ifInOctets. Discontinuities in
the value of this counter can occur at reinitialization of the management system, and at
other times, as indicated by the value of
ifCounterDiscontinuityTime. Valid for eth-*.
The total number of octets transmitted out of the
interface, including framing characters. This
object is a 64-bit version of ifOutOctets.
Discontinuities in the value of this counter can
occur at re-initialization of the management
system, and at other times, as indicated by the
value of ifCounterDiscontinuityTime. Valid for eth*.
The number of multicast packets delivered to a
higher layer protocol.
Out Mcast Pkts
The total number of packets requested to be sent
to multicast addresses, by upper layer protocols.
In Bcast Pkts
The number of broadcast packets delivered to a
higher layer protocol.
Out Bcast Pkts
The total number of packets requested to be sent
to broadcast addresses, by upper layer protocols.
LinkUpDnTrapEnable
Indicates whether linkUp/ linkDown traps should
be generated for this interface.
Promiscous Mode
This object has a value of false if this interface
only accepts packets/frames that are addressed to
this station. This object has a value of true when
the station accepts all packets/frames transmitted
on the media. The value true is legal only for
Ethernet interfaces. The value of
PromiscuousMode does not affect the reception of
broadcast and multicast packets/frames by the
interface.
This indicates whether the interface sublayer has
a physical connector or not. This is true only for
physical Ethernet interfaces.
The value of sysUpTime on the most recent
occasion, at which any one or more of this
interface's counters suffered a discontinuity.
Connector Present
CounterDiscontTime
8.15.1.2
Reset interface stats
Description: Use this command to reset the statistics of Ethernet, EoA,
ATM, AAL5, DSL, DSLF, DSLI, Aggr and EHDLC interfaces.
Command Syntax: reset interface stats ifname<interface-name>
8.15.1.3
Get interface config
Description: Use this command to view Interface Configuration.
Command Syntax: get interface config ifname <interface-name>
8.15.1.4
Modify interface config
Description: Use this command to modify interface configuration.
Command Syntax: modify interface config ifname <interface-name>
[trap enable|disable]
Parameters;
Name
Description
Ifname <interfacename>
Interface name, for which configuration is to be
modified or viewed.
Type: Get -Optional Modify - Mandatory
Valid values: eth-*,atm-*,aal5-*, eoa-*, dsl-*, dslf*, dsli-*, aggr-*, ehdlc-*.
Indicates whether linkUp/linkDown traps should be
generated for this interface.
Type: Modify – Optional
Valid values : enable or disable
trap enable|disable
Example
$ get interface config
Output
Verbose Mode On
IfName
LinkUp/DnTrap
--------------------aal5-0
Enable
Output Fields
FIELD
432
Description
IfName
LinkUp/DnTrap
Interface name, for which configuration is to be
viewed.
Indicates whether linkUp/linkDown traps shall be
generated for this interface.
Caution
• Reset of ATM VC interface stats also result in atm vc stat reset for
the interface and reset of Ethernet interface stats also result in
dot3stats reset for the ethernet interface.
References
• ATM Interface commands
• Ethernet commands
• EoA commands
• DSL commands
8.16
IP Commands
8.16.1
IP Net to Media Table Commands
8.16.1.1
Get arp
Description: Use this command to display either the full ARP table or a
single entry.
Command Syntax: get arp [rid <rid-val>] [ip <ip-address>]
8.16.1.2
Create arp
Description: Use this command to create a static entry in the ARP
Table.
Command Syntax: create arp [rid <rid-val>] ip <ip-address>
macaddr <mac-address>
8.16.1.3
Delete arp
Description: Use this command to delete an entry from the ARP table.
Command Syntax: delete arp [rid <rid-val>] ip <ip-address>
Parameters
433
Name
Description
rid <rid-val>
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that
flow. The RID defines a flow based on the VLAN
Id. The database can be of 2 types, IRD
(Independent Routing Database) where there
are more than one RIDs in the system and each
RID defines separate routes in context of itself. .
If VlanId <X> and RID <X> have been created
and the routing database is configured for IRD,
than routes in RID <X> shall define flow for
packets coming on VLAN Id <X>. The other
mode for the database is SRD (Shared Routing
Database) where there is a single RID in the
system and all flows map to this RID. This RID
has to be explicitly created and no more than
one RID can be created in the system in this
mode. Flows for all created VLANs shall map to
this RID for routing.
Type: Create - Optional
Delete - Mandatory
Get - Optional
Valid values: 0 - 4095
IP address corresponding to the mediadependent physical address.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Valid values: 0.0.0.0 - 223.255.255.255
The media-dependent physical address
Type: Create - Mandatory
Valid values: 0:0:0:0:0:1 - ff:ff:ff:ff:ff:fe
ip <ip-address>
macaddr <mac-address>
Example:
$ create arp rid 1 ip 192.168.161.11 macaddr 00:11:22:33:44:55
Output
Verbose Mode On
Entry Created
RID
: 1
Ifname
Type
: static
Mac Address : 00:11:22:33:44:55
: -
Ip Address. : 192.168.161.11
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
RID
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that flow.
The RID defines a flow based on the VLAN Id.
The database can be of 2 types,
IRD( Independent Routing Database) where there
are more than one RIDs in the system and each
RID defines separate routes in context of itself. . If
VlanId <X> and RID <X> have been created and
the routing database is configured for IRD, than
routes in RID <X> shall define flow for packets
coming on VLAN Id <X>. The other mode for the
database is SRD( Shared Routing Database)
where there is a single RID in the system and all
flows map to this RID. This RID has to be explicitly
created and no more than one RID can be created
in the system in this mode. Flows for all created
VLANs shall map to this RID for routing.
This specifies the physical interface for the media.
It indicates the interface over which the IP address
for which the IP Net to media mapping has been
created can be reached.
IP address corresponding to the media-dependent
physical address.
This defines the type of mapping in use. The value
Invalid has the effect that this entry is not used. It
may be: Static, Dynamic, Other
The media-dependent physical address
Ifname
Ip Address.
Type
Mac Address
Cautions
• The specified interface should pre-exist. Please refer to the create
ethernetintf command.
References
• delete arp command
• get arp command
434
• create ethernet intf command
• ip route related commands
8.16.2
IP Route Commands
8.16.2.1
Get ip route
Description: Use this command to get.
Command Syntax: get ip route [rid <rid-val>] ip <dest-ip-address>
mask <net-mask>
8.16.2.2
Create ip route
Description: Use this command to create.
Command Syntax: create ip route [rid <rid-val>] ip <dest-ipaddress> mask mask <net-mask> gwyip <gwy-ip-address> [ifname
<interface-name> | anywan] [proxyarpstatus enable | disable]
8.16.2.3
Delete ip route
Description: Use this command to create a routing table entry.
Command Syntax: delete ip route [rid <rid-val>] ip <dest-ip-address>
mask mask <net-mask>
Parameters
Name
Description
rid <rid-val>
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that flow.
The RID defines a flow based on the VLAN Id.
The database can be of 2 types, IRD
(Independent Routing Database) where there are
more than one RIDs in the system and each RID
defines separate routes in context of itself. If
VlanId <X> and RID <X> have been created and
the routing database is configured for IRD, than
routes in RID <X> shall define flow for packets
coming on VLAN Id <X>. The other mode for the
database is SRD ( Shared Routing Database)
where there is a single RID in the system and all
flows map to this RID. This RID has to be explicitly
created and no more than one RID can be created
in the system in this mode. Flows for all created
VLANs shall map to this RID for routing.
Type: Create - Optional
Delete - Optional
Modify - Mandatory
Get - Optional
Valid values: 0 - 4095
Destination IP address of this route.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0.0.0.0 - 223.255.255.0
Indicates the mask to be logical-ANDed with the
destination address before being compared to the
value in the ipRouteDest field. Only absolute
routes can be added in the downstream direction
for the IPOE interfaces (gsvIpRouteIfIndex as
ipoe-*). The mask for all such routes has to be
255.255.255.255. The creation of default route in
upstream (gsvIpRouteIfIndex as
GS_CFG_ANY_WAN) can have the mask as
ip <dest-ip-address>
mask<net-mask>
435
0.0.0.0 only.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0.0.0.0 - 255.255.255.0
The IP address of the next hop of this route. Only
absolute routes can be added in the downstream
direction for the IPOE interfaces
(gsvIpRouteIfIndex as ipoe-*). The next hop in
such cases has to be same as the destination IP
address (gsvIpRouteDest) specified.
Type: Create - Mandatory
Valid values: 0.0.0.0 - 223.255.255.0
The index value which uniquely identifies the local
interface through which the next hop of this route
should be reached. If IpRouteRid is not 0, than
u32IpRouteIfIndex shall be mandatory to be
specified in the "create ip route" command. The
ifname value can be either ANYWAN (0xffffffff) or
ifindex of any of the ipoe interface (ipoe-*).
Type: Create - Optional
Modify - Optional
This specifies if the Proxy ARP has to be done for
this iproute table entry.If IpRouteRid value is 0,
then ProxyArpStatus will not be specified while
creating/modifying an entry in IpRoute Table.
Type: Create - Optional
Modify - Optional
Default value: disable
gwyip <gwy-ipaddress>
ifname <interfacename> | anywan
proxyarpstatus enable
|disable
Example
$ create ip route rid 0 ip 192.168.161.12 mask 255.255.0.0 gwyip
172.26.6.100 ifname eth-0 routetype DIR ProxyArpStatus disable
configstatus Auto
Output
Verbose Mode On
Entry Created
Rid
: 0
192.168.161.12
Destination :
Net Mask
: 255.255.0.0
Gateway
: 172.26.6.100
Ifname
: eth-0
Route Type
: DIR
Route Orig
: LCL
Age
: 0
ProxyArpStatus : disable
Verbose Mode Off:
Entry Created
Output Fields
436
FIELD
Description
Rid
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that flow.
The RID defines a flow based on the VLAN Id.
The database can be of 2 types, IRD
(Independent Routing Database) where there are
more than one RIDs in the system and each RID
defines separate routes in context of itself. If
VlanId <X> and RID <X> have been created and
the routing database is configured for IRD, than
routes in RID <X> shall define flow for packets
coming on VLAN Id <X>. The other mode for the
Destination
Net Mask
Gateway
Ifname
Route Type
Route Orig
Age
ProxyArpStatus
database is SRD( Shared Routing Database)
where there is a single RID in the system and all
flows map to this RID. This RID has to be explicitly
created and no more than one RID can be created
in the system in this mode. Flows for all created
VLANs shall map to this RID for routing.
Destination IP address of this route.
Indicates the mask to be logical-ANDed with the
destination address before being compared to the
value in the ipRouteDest field. Only absolute
routes can be added in the downstream direction
for the IPOE interfaces (gsvIpRouteIfIndex as
ipoe-*). The mask for all such routes has to be
255.255.255.255. The creation of default route in
upstreamcan has the mask as 0.0.0.0 only.
The IP address of the next hop of this route. Only
absolute routes can be added in the downstream
direction for the IPOE interfaces
(gsvIpRouteIfIndex as ipoe-*). The next hop in
such cases has to be same as the destination IP
address (gsvIpRouteDest) specified.
The index value which uniquely identifies the local
interface through which the next hop of this route
should be reached. If IpRouteRid is not
GS_CFG_MGMT_RID, than u32IpRouteIfIndex
shall be mandatory to be specified in the "create ip
route" command. The ifname value can be either
ANYWAN or ifindex of any of the ipoe interface
(ipoe-*).
The type of route. It may be: dir (for Direct) or ind
(for Indirect).
The routing mechanism, through which this route
was learned. It may be: NET (for Network
Management), LCL (for Local), RIP, ICMP,DYI
(Dynamic through Interface creation).
The number of seconds since this route was last
updated or otherwise determined to be correct.
This specifies if the Proxy ARP has to be done for
this iproute table entry.If IpRouteRid value is 0,
then ProxyArpStatus will not be specified while
creating/modifying an entry in IpRoute Table.
References
• get ip route command
• delete ip route command
• arp related commands.
8.16.3
Ipoa intf Commands
8.16.3.1
Get ipoa intf
Description: Use this command to get.
Command Syntax: get ipoa intf [ifname <interface-name>]
8.16.3.2
Create ipoa intf
Description: Use this command to create.
Command Syntax: create ipoa intf ifname <interface-name> lowif
<lowif-val> [configstatus Normal | Config] [enable|disable]
8.16.3.3
Delete ipoa intf
Description: Use this command to delete.
Command Syntax: delete ipoa intf ifname <interface-name>
437
8.16.3.4
Modify ipoa intf
Description: Use this command to modify.
Command Syntax: modify ipoa intf ifname <interface-name>
[enable|disable]
Parameters
Name
Description
ifname <interfacename>
The Ipoa Interface
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0 -575
This specifies the name of the lower AAL5
interface.
Type: Create - Mandatory
Valid values: 0 - 574
This mode describes the configuration status for
this interface. If the "config" bit is set then this
interface shall be created but will have a dormant
status. Only after the receipt of an Ipoa packet
from CPE side this interface shall become active.
The "In-Use" and "Not-In-Use" bits are read only
bits. The "Not-In-Use" indicates that the entry is
dormant and "In-Use" indicates that the entry is
activated.
Type: Create - Optional
Default value: NormalEntry
Administrative status of the interface.
Type: Optional
Valid values: enable or disable
lowif <lowif-val>
configstatus Normal
|Config
enable|disable
Example
$ create ipoa intf ifname Ipoa-0 lowif aal5-0 configstatus Normal enable
Output
Verbose Mode On
Entry Created
Ifname
: Ipoa-0
Low IfName
: aal5-0
Config Status : Normal
Oper Status
: Up
Admin Status : Enable
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Ifname
The Ipoa Interface
Low IfName
This specifies the name of the lower AAL5
interface.
This mode describes the configuration status for
this interface. If the "config" bit is set then this
interface shall be created but will have a dormant
status. Only after the receipt of an Ipoa packet
from CPE side this interface shall become active.
The "In-Use" and "Not-In-Use" bits are read only
bits. The "Not-In-Use" indicates that the entry is
dormant and "In-Use" indicates that the entry is
activated.
Administrative status of the interface.
Config Status
Admin Status
438
Oper Status
8.16.4
ipoe intf Commands
8.16.4.1
Get ipoe intf
Operational status of the interface.
Description: Use this command to get.
Command Syntax: get ipoe intf [ifname <interface-name>]
8.16.4.2
Create ipoe intf
Description: Use this command to create.
Command Syntax: create ipoe intf ifname <interface-name> lowif
<lowif-val> macaddrprof <macaddrprof-val> [ethpkttype Type2 |
802_3] [inactivitytmrintrvl <inactivitytmrintrvl-val>] [routingstatus
enable | disable] [enable | disable]
8.16.4.3
Delete ipoe intf
Description Use this command to delete.
Command Syntax: delete ipoe intf ifname <interface-name>
8.16.4.4
Modify ipoe intf
Description Use this command to modify.
Command Syntax: modify ipoe intf ifname <interface-name> lowif
<lowif-val> macaddrprof <macaddrprof-val> [ethpkttype Type2 |
802_3] [inactivitytmrintrvl <inactivitytmrintrvl-val>] [routingstatus
enable | disable] [enable | disable]
Parameters
Name
Description
ifname <interfacename>
The IPOE Tunneling Interface.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0-575
This specifies the lower interface index.It contains
the ifindex of the IPoA interface.
Type: Create - Mandatory
Valid values: 0 - 575
Profile Id corresponding to the MAC address
assigned to this IPOE interface. This Profile is
created using the MacAddrProfileTable.
Type: Create - Mandatory
Modify - Optional
Valid values: 1 -8
This specifies the type of the Packet.
Type: Create - Optional
Modify - Optional
Default value: Type2
This field specifies the time (in seconds) after
which interfaces shall be marked inactive, if there
is no data activity on this interface during this
interval. This is used only when the bit
corresponding to "ConfigEntry" is set for
gsvIpoeConfigStatus field. A value of zero means
the timer is not running. In autosensing scenario,
an inactive interface is a candidate to deletion, if
another protocol is sensed on Atm Vc Interface on
which this interface is created
Type: Create - Optional
Modify - Optional
lowif <lowif-val>
macaddrprof
macaddrprof
ethpkttype Type2 |
802_3
inactivitytmrintrvl
inactivitytmrintrvl
439
routingstatus enable
|disable
enable|disable
Valid values: 0- 0xffffffff
Default value: 0
This specifies if the IP Routing Lookup has to be
done for this interface. By default, for the
downstream traffic destined for IPOE interface, IP
lookup is done based on the downstream route
configured for the IPOE interface.If iproutingstatus
is disabled, layer 2 lookup shall be used instead,
for forwarding the downstream traffic for this IPOE
interface.
Type: Create - Optional
Modify - Optional
Default value:enable
Administrative Status of the interface.
Type: Optional
Valid values: enable or disable
Example
$ create ipoe intf ifname Ipoe-0 lowif Ipoa-0 macaddrprof 1 ethpkttype
Type2 inactivitytmrintrvl 10 routingstatus disable cfgmode Auto enable
Output
Verbose Mode On
Entry Created
Ifname
: Ipoe-0
Low If Name
Mac Addr Prof
: 1
Eth Pkt Type : Type2
: Ipoa-0
InActivity Tmr Interval : 10
RoutingStatus
: disable
Oper Status
: Up
Admin Status : Enable
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Ifname
The IPOE Tunneling Interface.
Low If Name
This specifies the lower interface index.It
contains the ifindex of the IPoA interface.
Profile Id corresponding to the MAC address
assigned to this IPOE interface. This Profile is
created using the MacAddrProfileTable.
This specifies the type of the Packet.
Mac Addr Prof
Eth Pkt Type
InActivity Tmr Interval
RoutingStatus
Admin Status
Oper Status
440
This field specifies the time (in seconds) after
which interfaces shall be marked inactive, if
there is no data activity on this interface during
this interval. This is used only when the bit
corresponding to "ConfigEntry" is set for
gsvIpoeConfigStatus field. A value of zero
means the timer is not running. In autosensing
scenario, an inactive interface is a candidate to
deletion, if another protocol is sensed on Atm Vc
Interface on which this interface is created
This specifies if the IP Routing Lookup has to be
done for this interface. By default, for the
downstream traffic destined for IPOE interface,
IP lookup is done based on the downstream
route configured for the IPOE interface.If
iproutingstatus is disabled, layer 2 lookup shall
be used instead, for forwarding the downstream
traffic for this IPOE interface.
Administrative status of the interface.
Operational status of the interface.
8.16.5
Rid static Commands
8.16.5.1
Create rid static
Description: Use this command to create.
Command Syntax: create rid static rid <rid-val>
8.16.5.2
Delete rid static
Description: Use this command to delete.
Command Syntax: delete rid static rid <rid-val>
Parameters
Name
Description
rid <rid-val>
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that
flow. The RID defines a flow based on the VLAN
Id. The database can be of 2 types, IRD
(Independent Routing Database) where there
are more than one RIDs in the system and each
RID defines separate routes in context of itself. If
VlanId <X> and RID <X> have been created and
the routing database is configured for IRD, than
routes in RID <X> shall define flow for packets
coming on VLAN Id <X>. The other mode for the
database is SRD( Shared Routing Database)
where there is a single RID in the system and all
flows map to this RID.
This RID has to be explicitly created and no
more than one RID can be created in the system
in this mode. Flows for all created VLANs shall
map to this RID for routing. A value of RID as 0
has a special meaning. RID value 0 refers to
management RID and all entries created in
context of RID value 0 shall be for routes related
to the management/control. In Stacked Vlan
Mode the Vlan Corresponding to RID is Virtual
Vlan while in Native Vlan mode this is normal
Vlan(C-VLAN).
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Valid values: 1 - 4095
Example
$ create rid static rid 1
Output
Verbose Mode On
Entry Created
RID : 1
Verbose Mode Off:
Entry Created
Output Fields
441
FIELD
Description
RID
RID refers to the Routing Information Database.
This database contains information about the
routes in the system. Each RID identifies a flow
and defines route related information for that
flow. The RID defines a flow based on the VLAN
Id. The database can be of 2 types, IRD
(Independent Routing Database) where there
are more than one RIDs in the system and each
RID defines separate routes in context of itself. .
If VlanId <X> and RID <X> have been created
and the routing database is configured for IRD,
than routes in RID <X> shall define flow for
packets coming on VLAN Id <X>. The other
mode for the database is SRD( Shared Routing
Database) where there is a single RID in the
system and all flows map to this RID.
This RID has to be explicitly created and no
more than one RID can be created in the system
in this mode. Flows for all created VLANs shall
map to this RID for routing. A value of RID as 0
has a special meaning. RID value 0 refers to
management RID and all entries created in
context of RID value 0 shall be for routes related
to the management/control. In Stacked Vlan
Mode the Vlan Corresponding to RID is Virtual
Vlan while in Native Vlan mode this is normal
Vlan(C-VLAN).
442
8.17
MacProfile Commands
8.17.1
Macprofile global Commands
8.17.1.1
Get macprofile global
Description Use this command to get.
Command Syntax: get macprofile global [profileid <profileid-val>]
8.17.1.2
Create macprofile global
Description Use this command to create.
Command Syntax: create macprofile global profileid <profileidval>macaddr <macaddr-val>
8.17.1.3
Delete macprofile global
Description Use this command to delete.
Command Syntax: get macprofile global profileid <profileid-val>
Parameters
Name
Description
profileid <profileid-val>
Profile Id of the MAC Address configured.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 8
macaddr <macaddr-val>
MAC Address for the profile.
Type: Create -- Mandatory
Example
$ create macprofile global profileid 3 macaddr 00:0E:7F:61:C1:BE
Output
Verbose Mode On
Entry Created
Profile Id MAC Address
----------------------------------------------------------3
00:0E:7F:61:C1:BE
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Profile Id
Profile Id of the MAC Address configured.
MAC Address
MAC Address for the profile.
8.17.2
Resvdmac profile info Commands
8.17.2.1
Get resvdmac profile info
Description Use this command to get.
443
Command Syntax: get resvdmac profile info [profileid <profileidval>]
8.17.2.2
Create resvdmac profile info
Description Use this command to create.
Command Syntax: create resvdmac profile info profileid <profileidval>
8.17.2.3
Delete resvdmac profile info
Description Use this command to delete.
Command Syntax: delete resvdmac profile info profileid <profileidval>
Parameters
Name
Description
profileid <profileid-val>
Profile Id of the MAC Address configured.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 8
Example
$ create resvdmac profile info profileid 4
Output
Verbose Mode On
Entry Created
Profile ID : 4
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Profile Id
Profile Id of the MAC Address configured.
8.17.3
Resvdmac profile param Commands
8.17.3.1
Get resvdmac profile param
Description Use this command to get.
Command Syntax: get resvdmac profile param [profileid <profileidval>] [mcastaddr <mcastaddr-val>]
8.17.3.2
Create resvdmac profile param
Description Use this command to create.
Command Syntax: create resvdmac profile param profileid
<profileid-val>mcastaddr <mcastaddr-val>action Drop |
TransformedBcast | Participate
8.17.3.3
Delete resvdmac profile param
Description Use this command to delete.
444
Command Syntax: get resvdmac profile param profileid <profileidval> mcastaddr <mcastaddr-val>
Parameters
Name
Description
profileid <profileid-val>
Profile Id of the MAC Address configured.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 8
mcastaddr <mcastaddrval>
This is Reserved Multicast address. This
multicast address can only be 01:80:c2:00:00:xx,
where 'xx' lies between 00-0f and 20-2f.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
action Drop |
TransformedBcast |
Participate
This is the action corresponding to reserved
multicast address. 'Drop' action leads to
dropping of corresponding frames.
'TransformedBcast' leads to sending of the
frames broadcasted over all the ports as if for a
broadcast frame (bridging restrictions, filtering,
transformations shall apply). 'Participate' action
leads to frame coming to Control Plane and it
shall be given to the registered protocol module.
Type: Create -- Mandatory
Example
$ create resvdmac profile param Profileid 4 mcastaddr
01:80:c2:00:00:00 action Drop
Output
Verbose Mode On
Entry Created
Profile ID : 4
Action
Multicast address : 01:80:c2:00:00:00
: Drop
Verbose Mode Off:
Entry Created
Output Fields
445
FIELD
Description
Profile Id
Profile Id of the MAC Address configured.
Multicast address
This is Reserved Multicast address. This
multicast address can only be 01:80:c2:00:00:xx,
where 'xx' lies between 00-0f and 20-2f.
Action
This is the action corresponding to reserved
multicast address. 'Drop' action leads to
dropping of corresponding frames.
'TransformedBcast' leads to sending of the
frames broadcasted over all the ports as if for a
broadcast frame (bridging restrictions, filtering,
transformations shall apply). 'Participate' action
leads to frame coming to Control Plane and it
shall be given to the registered protocol module.
8.18
Management Traffic Commands
8.18.1
Ctlpkt group info Commands
8.18.1.1
Get ctlpkt group info
Description: Use this command to get.
Command Syntax: get ctlpkt group info [groupid <groupid-val>]
[ctlflowid <ctlflowid-val>]
8.18.1.2
Create ctlpkt group info
Description Use this command to create.
Command Syntax: create ctlpkt group info groupid <groupidval>ctlflowid <ctlflowid-val>instanceid <instanceid-val>]
8.18.1.3
Delete ctlpkt group info
Description Use this command to delete.
Command Syntax: delete ctlpkt group info groupid <groupidval>ctlflowid <ctlflowid-val>
Parameters
Name
Description
groupid <groupid-val>
The control packet group identifier
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 50
The Control packet flow id.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 0x4
The Control packet instance Id.
Type: Create -- Mandatory
Valid values: 1 - 26
ctlflowid <ctlflowid-val>
instanceid <instanceidval>
Example
$ create ctlpkt group info groupid 1 ctlflowid 1 instanceid 1
Output
Verbose Mode On
Entry Created
Group Id
: 1
Control Flow Id : 1
Instance Id : 1
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Group Id
The control packet group identifier
Control Flow Id
The Control packet flow id.
Instance Id
The Control packet instance Id.
References
• See Control Packet Instance Group related commands
446
8.18.2
Ctlpkt instance info Commands
8.18.2.1
Get ctlpkt instance info
Description: Use this command to get.
Command Syntax: get ctlpkt instance info [instanceid <instanceidval>]
8.18.2.2
Create ctlpkt instance info
Description Use this command to create.
Command Syntax: create ctlpkt instance info instanceid
<instanceid-val>profileid <profileid-val> classid <classid-val>
8.18.2.3
Delete ctlpkt instance info
Description Use this command to delete.
Command Syntax: delete ctlpkt instance info instanceid
<instanceid-val>
8.18.2.4
Modify ctlpkt instance info
Description Use this command to modify.
Command Syntax: modify ctlpkt instance info instanceid
<instanceid-val>profileid <profileid-val> classid <classid-val>
Parameters
Name
Description
instanceid <instanceidval>
The control packets instance id.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 26
profileid <profileid-val>
This field identifies the control packet profile
whose instance is being created.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 8
classid <classid-val>
This field specifies the classid of the Instance.
Class id shall be treated as the service priority of
this instance.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 0x4
Example
$ create ctlpkt instance info instanceid 1 profileid 1 classid 1
Output
Verbose Mode On
Entry Created
Instance Id : 1
Profile Id
447
: 1
Class Id : 1
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Instance Id
The control packets instance id.
Profile Id
This field identifies the control packet profile
whose instance is being created.
Class Id
This field specifies the classid of the Instance.
Class id shall be treated as the service priority of
this instance.
References
• see control packet profile instance related commands
8.18.3
Ctlpkt profile info Commands
8.18.3.1
Get ctlpkt profile info
Description: Use this command to get.
Command Syntax: get ctlpkt profile info [profileid <profileid-val>]
8.18.3.2
Create ctlpkt profile info
Description: Use this command to create.
Command Syntax: create ctlpkt profile info profileid <profileidval>maxctlpkts <maxctlpkts-val> thrshld1 <thrshld1-val>
8.18.3.3
Delete ctlpkt profile info
Description: Use this command to delete
Command Syntax: delete ctlpkt profile info [profileid <profileid-val>]
8.18.3.4
Modify ctlpkt profile info
Description: Use this command to modify.
Command Syntax: modify ctlpkt profile info profileid <profileid-val>
[maxctlpkts <maxctlpkts-val>] [thrshld1 <thrshld1-val>]
Parameters
Name
Description
profileid <profileid-val>
The control packet's profile id.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 8
maxctlpkts <maxctlpktsval>
This specifies the maximum control packets that
can be pending for an instance of this profile.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 63
thrshld1 <thrshld1-val>
448
This specifies the number of outstanding control
packets for each instance, when control plane is
congested.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 -63
Example
$ create ctlpkt profile info profileid 1 maxctlpkts 32 thrshld1 32
Output
Verbose Mode On
Entry Created
Profile Id
: 1
Max Ctl Pkts : 32
Threshold1 : 32
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Profile Id
The control packet's profile id.
Max Ctl Pkts
This specifies the maximum control packets that
can be pending for an instance of this profile.
Threshold1
This specifies the number of outstanding control
packets for each instance, when control plane is
congested.
References
• See control packet profiles related commands.
449
8.19
PPPoE Tunneling Commands
8.19.1
PPPoE Global ACprofile Commands
8.19.1.1
Get pppoe global acprofile
Description: Use this command to get.
Command Syntax: get pppoe global acprofile [profileid <profileidval>]
8.19.1.2
Create pppoe global acprofile
Description Use this command to create.
Command Syntax: create pppoe global acprofile profileid
<profileid-val> acname <acname-val>
8.19.1.3
Delete pppoe global acprofile
Description Use this command to delete.
Command Syntax: delete pppoe global acprofile profileid
<profileid-val>]
Parameters
Name
Description
profileid profileid
Profile Id of the AC Name configured.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Valid values: 1 - 8
AC Name for the Session, based on which, the
AC is selected.
Type: Create - Mandatory
acname acname
Example
$ create pppoe global acprofile profileid 2 acname ABCServer
Output
Verbose Mode On
Entry Created
Profile Id AC Name
-----------------------------------------------------------2
ABCServer
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Profile Id
Profile Id of the AC Name configured.
AC Name
AC Name for the Session, based on which, the
AC is selected.
References
• PPPoE global ACprofile related commands.
450
8.19.2
PPPoE Global Config Commands
8.19.2.1
Get pppoe global config
Description Use this command to get.
Command Syntax: get pppoe global config
8.19.2.2
Modify pppoe global config
Description Use this command to modify.
Command Syntax: modify pppoe global config
[ padimaxnumretries <padimaxnumretries-val> ]
[padrmaxnumretries <padrmaxnumretries-val> ] [ paditxintrvl
<paditxintrvl-val> ] [ padrtxintrvl<padrtxintrvl-val> ] [ wandntmrintrvl
<wandntmrintrvl-val> ] [ inactivitytmrintrvl <inactivitytmrintrvl-val> ]
[ discmaxnumretries <discmaxnumretries-val> ]
Parameters
Name
Description
padimaxnumretries
<padimaxnumretriesval>
Maximum number of times the PPPoE Client
sends a PADI for establishing a PPPoE Session.
Type: Modify -Optional
Valid values: 1 -10
Maximum number of times the PPPoE Client
sends a PADR for establishing a PPPoE Session.
Type: Modify - Optional
Valid values: 1 -10
The time, n seconds, between PADI retries from
the PPPoE Client.
Type: Modify - Optional
Valid values: 1 -60
The time, n seconds, between PADR retries from
the PPPoE Client.
Type: Modify - Optional
Valid values: 1 -60
The time, n seconds, for timeout of the WAN
Down Timer. The timer is started when the WAN
goes down, and if the timer times out, the session
is teared down. A value of zero for this timer
means it is not running.
Type: Modify - Optional
Valid values: 0 - 0xffffffff
The time, n seconds, for timeout of the Inactivity
Timer. The session can remain inactive for atmost
these n seconds after which it is teared down. A
value of zero means the timer is not running.
Type: Modify - Optional
Valid values: 0 - 0xffffffff
The maximum number of times the PPPoE client
does a discovery stage for establishing a PPPoE
session. A trap is given to GAG on reaching this
number.
Type: Modify - Optional
Valid values: 1 -5
padrmaxnumretries
<padrmaxnumretries
val>
paditxintrvl
<paditxintrvl -val>
padrtxintrvl
<padrtxintrvl-val>
wandntmrintrvl
<wandntmrintrvl-val>
inactivitytmrintrvl
<inactivitytmrintrvl-val>
discmaxnumretries
<discmaxnumretriesval>
Example
$ get pppoe global config
Output
451
Max Total Sessions
10
: 10
PADI Max Num Retries :
PADR Max Num Retries
5
: 10
PADI Tx Interval
:
PADR Tx Interval
10
: 5
WAN Dn Tmr Interval
:
InActivity Tmr Interval : 20
3
DISC Max Num Retries :
Output Fields
FIELD
Description
Max Total Sessions
Maximum number of PPPoE sessions supported.
PADI Max Num
Retries
PADR Max Num
Retries
PADI Tx Interval
Maximum number of times the PPPoE Client
sends a PADI for establishing a PPPoE Session.
Maximum number of times the PPPoE Client
sends a PADR for establishing a PPPoE Session.
The time, n seconds, between PADI retries from
the PPPoE Client.
The time, n seconds, between PADR retries from
the PPPoE Client.
The time, n seconds, for timeout of the WAN
Down Timer. The timer is started when the WAN
goes down, and if the timer times out, the session
is teared down. A value of zero for this timer
means it is not running.
The time, n seconds, for timeout of the Inactivity
Timer. The session can remain inactive for atmost
these n seconds after which it is teared down. A
value of zero means the timer is not running.
The maximum number of times the PPPoE client
does a discovery stage for establishing a PPPoE
session. A trap is given to GAG on reaching this
number.
PADR Tx Interval
WAN Dn Tmr Interval
InActivity Tmr Interval
DISC Max Num
Retries
References
• PPPoE global config related commands.
8.19.3
PPPoE Global Serviceprofile Commands
8.19.3.1
Get pppoe global serviceprofile
Description: Use this command to get.
Command Syntax: get pppoe global serviceprofile [profileid
<profileid-val>]
8.19.3.2
Create pppoe global serviceprofile
Description: Use this command to create.
Command Syntax: create pppoe global serviceprofile profileid
<profileid-val> servicename <servicename-val>
8.19.3.3
Delete pppoe global serviceprofile
Description Use this command to delete.
Command Syntax: delete pppoe global serviceprofile profileid
<profileid-val>
Parameters
Name
Description
profileid <profileid-val>
Profile Id of the Service Name configured.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
Valid values: 1 -4
Service Name for the Session, based on which,
the AC is selected.
Type: Create - Mandatory
servicename
<servicename-val>
Example
$ create pppoe global serviceprofile profileid 1 servicename any
452
Output
Verbose Mode On
Entry Created
Profile Id Service Name
-----------------------------------------------------------1
any
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Profile Id
Profile Id of the Service Name configured.
Service Name
Service Name for the Session, based on which,
the AC is selected.
References
• PPPoE global serviceprofile related commands.
8.19.4
PPPoE Global Stats Commands
8.19.4.1
Get pppoe global stats
Description: Use this command to get.
Command Syntax: get pppoe global stats
Parameters none
Example
$ get pppoe global stats
Output
Active Sessions
12
: 10
Total Sessions
:
Peak Active Sessions
20
: 12
Num of PADI Tx
:
Num of PADI Timeouts
15
: 3
Num of PADR Tx
:
Num of PADR Timeouts
2
: 2
Num of PADT Tx
:
Num of PADT Rx
1
: 3
Num of PADT Rejected :
Num of PADO Rx
1
: 2
Num of PADO Rejected :
Num of PADS Rx
0
: 12
Num of PADS Rejected :
Num of Malformed Pkts Rx : 2
Output Fields
453
FIELD
Description
Active Sessions
Total Sessions
The number of active pppoe sessions in the
system.
The total number of PPPoE sessions.
Peak Active Sessions
Peak number of active PPPoE sessions.
Num of PADI Tx
The number of PPPoE PADI transmitted.
Num of PADI Timeouts
Num of PADR Tx
The number of PPPoE timeouts waiting for a
response to a PADI.
The number of PPPoE PADR transmitted.
Num of PADR Timeouts
The number of PPPoE timeouts waiting for a
response to a PADR.
Num of PADT Tx
The number of PPPoE PADT transmitted.
Num of PADT Rx
The number of PPPoE PADT received.
Num of PADT Rejected
The number of PPPoE PADT discarded.
Num of PADO Rx
The number of PPPoE PADO received.
Num of PADO Rejected
The number of PPPoE PADO discarded.
Num of PADS Rx
The number of PPPoE PADS received.
Num of PADS Rejected
The number of PPPoE PADS discarded.
Num of Malformed Pkts
Rx
The number of PPPoE malformed packets
received.
References
• PPPoE global stats related commands.
8.19.5
Pppoe intf Commands
8.19.5.1
Get pppoe intf
Description: Use this command to get.
Command Syntax: get pppoe intf [ifname <interface-name>]
8.19.5.2
Create pppoe intf
Description: Use this command to create.
Command Syntax: create pppoe intf ifname <interface-name> lowif
<lowif –val>[ wanbridgeport <wanbridgepor-val>t ] [sessionid
<sessionid-val> ] [ acmacaddr <acmacaddr-val> ] macaddrprof
<macaddrprof-val> [ servicenameprof <servicenameprof-val> | any |
anyconfigured ] [ acnameprof <acnameprof-val> | any | anyconfigured ]
[ ethpkttype Type2 | 802_3 ] [ nature dynamic | static ] [ enable |
disable ]
8.19.5.3
Delete pppoe intf
Description: Use this command to delete.
Command Syntax: delete pppoe intf ifname <interface-name>
8.19.5.4
Modify pppoe intf
Description: Use this command to modify.
Command Syntax: modify pppoe intf ifname <interface-name> lowif
<lowif –val>[ wanbridgeport <wanbridgepor-val>t ] [sessionid
<sessionid-val> ] [ acmacaddr <acmacaddr-val> ] macaddrprof
<macaddrprof-val> [ servicenameprof <servicenameprof-val> | any |
anyconfigured ] [ acnameprof <acnameprof-val> | any | anyconfigured ]
[ ethpkttype Type2 | 802_3 ] [ nature dynamic | static ] [ enable |
disable ]
Parameters
Name
Description
lowif <lowif-val>
This specifies the lower interface index. It
contains the ifindex of the PPP relay interface.
Type: Create - Mandatory
Valid values: 0 - 254
WAN side bridge port. A value of zero means any
WAN side port is acceptable. Currently, only
value zero is supported.
Type: Create - Optional
Modify - Optional
Default value: 0x0
wanbridgeport
<wanbridgeport-val>
454
sessionid <sessionidval>
acmacaddr
<acmacaddr-val>
macaddrprof
<macaddrprof-val>
servicenameprof
<servicenameprof-val> |
any |anyconfigured
acnameprof
<acnameprof-val> |any
| anyconfigured
ethpkttype Type2 |
802_3
nature dynamic | static
enable | disable
Session Id for the session given only in case a
static session is being created.
Type: Create - Optional
Modify - Optional
Valid values: 1 - 0xffff
Default value: 0x0
MAC address of the remote AC given only in
case a static session is being created.
Type: Create - Optional
Modify - Optional
Default value: 00:00:00:00:00:00
Profile Id for self MAC addresses. The profile for
the same is created using the
PPPoEMacAddrProfileTable.
Type: Create - Mandatory
Modify - Optional
Profile Id related to Service Name for the Session
based on which the AC is selected.The Profile for
the same is created using the
PPPoESessionProfileTable. A value of "any"
means no specific service is needed to select an
AC. A value of "anyconfigured"means any
configured service name profile can be used for
selecting an AC.
Type: Create - Optional
Modify - Optional
Valid values: , 0-0xffffffff
Default value: 0
Profile Id related to AC Name for the Session
based on which the AC is selected. The Profile
for the same is created using the
PPPoEAcProfileTable. A value of "any" means no
specific AC is needed for establishing a session
on the WAN side. A value of
"anyconfigured"means any configured AC name
profile can be used for selecting an AC.
Type: Create - Optional
Modify - Optional
Valid values: 0-0xffffffff
Default value: 0
This specifies the type of the packet.
Type: Create - Optional
Modify - Optional
Default value: Type2
Specifies if the interface is dynamic or static in
nature. The session is assumed to be in
established state when the interface is static in
nature.
Type: Create - Optional
Modify - Optional
Default value: dynamic
Administrative status of the interface.
Type: Create - Optional
Modify - Optional
Valid values: enable, disable
Default value: enable
Example
$ create pppoe intf ifname pppoe-0 lowif ppp-0 wanbridgeport 1
sessionid 10 acmacaddr 00:0E:7F:61:C1:BE macaddrprof 1
servicenameprof 2 acnameprof 4 ethpkttype Type2 nature dynamic
0x1 enable
Output
Verbose Mode On
Entry Created
455
Ifname
ppp-0
: pppoe-0
Low If Name
:
WAN Bridge Port
: 1
Session Id
: 10
AC Mac Addr
: 00:0E:7F:61:C1:BE Mac Addr Prof : 1
Service Name Profile : 2
AC Name Prof
: 4
Eth Pkt Type
dynamic
: Type2
Nature
:
Oper Status
Enable
: Up
Admin Status
:
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Ifname
Low If Name
The PPPoE Interface.
This specifies the lower interface index. It
contains the ifindex of the PPP relay interface.
WAN side bridge port. A value of zero means
any WAN side port is acceptable. Currently, only
value zero is supported.
Session Id for the session given only in case a
static session is being created.
MAC address of the remote AC given only in
case a static session is being created.
Profile Id for self MAC addresses. The profile for
the same is created using the
PPPoEMacAddrProfileTable.
Profile Id related to Service Name for the
Session based on which the AC is selected.The
Profile for the same is created using the
PPPoESessionProfileTable. A value of "any"
means no specific service is needed to select an
AC. A value of "anyconfigured"means any
configured service name profile can be used for
selecting an AC.
Profile Id related to AC Name for the Session
based on which the AC is selected. The Profile
for the same is created using the
PPPoEAcProfileTable. A value of "any" means
no specific AC is needed for establishing a
session on the WAN side. A value of
"anyconfigured"means any configured AC name
profile can be used for selecting an AC.
This specifies the type of the packet.
WAN Bridge Port
Session Id
AC Mac Addr
Mac Addr Prof
Service Name Profile
AC Name Prof
Eth Pkt Type
Nature
Oper Status
Admin Status
Specifies if the interface is dynamic or static in
nature. The session is assumed to be in
established state when the interface is static in
nature.
The actual/current state of the interface. It can
be either up or down.
The desired state of the interface. It may be
either Up or Down.
References
• PPPoE session config related commands.
8.19.6
PPPoE Session Stats Commands
8.19.6.1
Get pppoe session stats
Description: Use this command to get.
Command Syntax: get pppoe session stats [ifname <interfacename>]
456
Parameters
Name
Description
ifname <interface-name>
The PPPoE interface.
Type: Get -- Optional
Valid values: 0 - 254
Example
$ get pppoe session stats ifname pppoe-0
Output
Ifname
: pppoe-0
Session Id
: 10
Peer Mac Addr
: 00:0E:7F:61:C1:BE
Num of PADI Tx
: 4
Num of PADI Timeouts
:
2
Num of PADR Tx
: 1
Num of PADR Timeouts
:
0
Num of PADT Tx
: 1
Num of PADT Rx
:
1
Num of PADT Rejected
2
: 1
Num of PADO Rx
:
Num of PADO Rejected
1
: 0
Num of Multi PADO Rx
:
Num of PADS Rx
Num of PADS Rejected
: 1
Num of Malformed Pkts Rx
1
Version
: 1
Connect Time
: 5
:
0
Num of Generic Err Rx :
Type
:
1
: Mon Apr 18 14:00:59 2004
Duration (s)
: 100
AC Cookie :
A1659E40766EDBD7214E18095A5E500C
Host Unique
Service Name
: 0000003E
: dvt
State
AC Name
: sessionStage
: REDBACK
Output Fields
FIELD
Description
Ifname
The PPPoE interface.
Session Id
Session Id.
Peer Mac Addr
MAC address of the remote AC.
Num of PADI Tx
The number of PPPoE PADI transmitted.
Num of PADI Timeouts
The number of PPPoE timeouts waiting for a
response to a PADI.
The number of PPPoE PADR transmitted.
Num of PADR Tx
Num of PADR Timeouts
457
Num of PADT Tx
The number of PPPoE timeouts waiting for a
response to a PADR.
The number of PPPoE PADT transmitted.
Num of PADT Rx
The number of PPPoE PADT received.
Num of PADT Rejected
The number of PPPoE PADT discarded.
Num of PADO Rx
The number of PPPoE PADO received.
Num of PADO Rejected
The number of PPPoE PADO discarded.
Num of Multi PADO Rx
Num of PADS Rx
Number of times more than 1 PPPoE PADO was
received.
The number of PPPoE PADS received.
Num of PADS Rejected
The number of PPPoE PADS discarded.
Num of Generic Err Rx
Number of generic errors received.
Version
Version as given in the PPPoE rfc-2516.
Type
Type as given in the PPPoE rfc-2516.
Connect Time
Time when the session was established.
Duration (s)
State
Number of seconds since the session was
established.
Binary sequence representing the AC cookie
given in negotiations.
Binary sequence representing the host unique
tag value.
State that session is in.
Service Name
Service name with which the session came up.
AC Name
AC name with which the session came up.
Num of Malformed Pkts
Rx
The number of PPPoE malformed packets
received.
AC Cookie
Host Unique
References
• PPPoE session stats related commands.
8.19.7
PPPR Interface Commands
8.19.7.1
Get pppr intf
Description: Use this command to get.
Command Syntax: get pppr intf [ifname <interface-name>]
8.19.7.2
Create pppr intf
Description: Use this command to create.
Command Syntax:create pppr intf ifname <interface-name>lowif
<lowif-val> [ maxpdu <maxpdu-val> ] [ ppprackto <ppprackto-val>]
[ lowiftoggletimerto <lowiftoggletimerto-val> ] [ nature dynamic |
static ] [configstatus Normal | Config ] [ pktpriority <pktpriority-val> ]
[enable | disable]
8.19.7.3
Delete pppr intf
Description Use this command to delete.
Command Syntax: delete pppr intf ifname <interface-name>
8.19.7.4
Modify pppr intf
Description Use this command to modify.
Command Syntax: modify pppr intf ifname <interface-name>
[ppprackto <ppprackto-val>] lowiftoggletimerto <lowiftoggletimertoval>] [nature dynamic | static] [pktpriority <pktpriority-val>] [enable |
disable]
Parameters
Name
Description
ifname <interfacename>
The PPPR interface.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: 0 - 254
This specifies the name of the lower AAL5
interface.
Type: Create -Mandatory
Valid values: 0 - 574
This specifies the maximum PDU size on a PPPR
interface.
Type: Create - Optional
Valid values: 0 - 1492
Default value: 1492
Time in seconds to wait for LCP terminate Ack,
after sending a terminate request.
lowif <lowif-val>
maxpdu <maxpdu-val>
ppprackto <pppracktoval>
458
lowiftoggletimerto
<lowiftoggletimerto-val>
nature dynamic |
static
configstatus Normal
|Config
enable | disable
pktpriority <pktpriorityval>
Type: Create - Optional
Modify - Optional
Valid values: 0 -10
Default value: 5
Time in seconds to wait for lowif to come up
without tearing down the pppr session.
Type: Create - Optional
Modify - Optional
Valid values: 0 – 10
Default value: 5
Specifies if the interface is dynamic or static in
nature.
Type: Create - Optional
Modify - Optional
Default value: Dynamic
This mode describes the configuration status for
the interface. If the "config" bit is set, this interface
shall be created, but will have a dormant status.
Only after the receipt of an pppoa packet from the
CPE side, this interface shall become active.
Type: Create - Optional
Modify - Optional
Default value: Normal
Administrative status of the interface
Type: Optional
Valid values: enable or disable
Default Value: enable
Priority to be set in tagged PPPOE frames or PPP
packets sent over this port from Control
Plane .This priority shall also be used for choice of
traffic class/ Queue on outgoing interface whether
the frame is tagged or not.In case the bridge port
is over an Aggregated ATM VC, this will also be
used to identify the VC, on which the packet is to
be sent.
Type: Create - Optional
Modify - Optional
Valid values: 0 – 7
Default value: 0
Example
$ create pppr intf ifname pppr-0 lowif aal5-0 maxPdu 1484 ppprAckTO
10 lowifToggleTimerTO 10 nature dynamic configstatus Normal
Output
Verbose Mode On
Entry Created
Ifname
: pppr-0
Low IfName
: aal5-0
Max PDU Size
: 1484
Ter Ack TimeOut : 10
Lowif Toggle TimeOut : 10
Nature
: dynamic
Config Status
: Normal
Operational Status
: up
Admin Status
: up
PPPOA PacketsPrio:2
Verbose Mode Off:
Entry Created
Output Fields
FIELD
Description
Ifname
The PPPR interface.
Low IfName
This specifies the name of the lower AAL5
interface.
This specifies the maximum PDU size on a PPPR
interface.
Max PDU Size
459
Ter Ack TimeOut
Lowif Toggle TimeOut
Nature
Config Status
Operational Status
Admin Status
PPPOA PacketsPrio
460
Time in seconds to wait for LCP terminate Ack,
after sending a terminate request.
Time in seconds to wait for lowif to come up
without tearing down the pppr session.
Specifies if the interface is dynamic or static in
nature.
This mode describes the configuration status for
the interface. If the "config" bit is set, this interface
shall be created, but will have a dormant status.
Only after the receipt of an pppoa packet from the
CPE side, this interface shall become active. The
"In-Use" and "Not-In-Use" bits are read-only bits.
The "Not-In-Use" bit indicates that the entry is
dormant and "In-Use" bit indicates that the entry is
activated.
The actual/current state of the interface. It may be
either Up or Down.
The desired state of the interface. It may be either
Up or Down.
Priority to be set in tagged PPPOE frames or PPP
packets sent over this port from Control
Plane .This priority shall also be used for choice of
traffic class/ Queue on outgoing interface whether
the frame is tagged or not.In case the bridge port
is over an Aggregated ATM VC, this will also be
used to identify the VC, on which the packet is to
be sent.
8.20
IA (Intermeida Agent) Commands
8.20.1
Dra global stats Commands
8.20.1.1
Get dra global stats
Description: Use this command to get t.
Command Syntax: get dra global stats
8.20.1.2
Reset dra global stats
Description: Use this command to reset.
Command Syntax: reset dra global stats
Parameter
None
Example
$ get dra global stats
Output
DRA Disc Count
: 40
DRA Req Count
: 40
DRA Decline Count : 30
DRA Inform Count : 20
DRA Offer Count
: 10
DRA Ack Count
DRA Nack Count
: 50
: 10
Output field
Field
Description
DRA Disc Count
Number of DHCP discovery packets received
DRA Req Count
Number of DHCP request packets received
DRA Decline Count
Number of DHCP decline packets received
DRA Inform Count
Number of DHCP inform packets received
DRA Offer Count
Number of DHCP offer packets received
DRA Ack Count
Number of DHCP Ack packets received
DRA Nack Count
Number of DHCP Nack packets received
References
• DHCP Relay Agent commands
8.20.2
Dra instance entry Commands
8.20.2.1
Get dra instance entry
Description: Use this command to get.
Command Syntax: get dra instance entry [portid <portid-val>] [vlan
<vlan-val>]
8.20.2.2
Create dra instance entry
Description: Use this command to create.
Command Syntax: create dra instance entry portid <portid-val>
vlan <vlan-val> profileid <profileid-val> [ status disable | client |
server ] [ op82 disable | AddAlways | AddIfNotExists ]
[ configsuboption aci | Portid | None ] [ acival <acival-val> ] [ raival
<raival-val> ] [ syncratefields ActualDataRateupstrm |
ActualDataRatednstrm | MinDataRateupstrm | MinDataRatednstrm |
461
AttainableDataRateupstrm | AttainableDataRatednstrm |
MaxDataRateupstrm | MaxDataRatednstrm | MinLpDataRateupstrm |
MinLpDataRatednstrm | MaxDelayupstrm | ActualDelayupstrm |
MaxDelaydnstrm | ActualDelaydnstrm | None ] [ op82fromclientact
drop | forward ] [ learning disable | enable ] [ portno <portno-val> ]
[ draaddop82tounicast disable | enable ]
8.20.2.3
Delete dra instance entry
Command Syntax: delete dra instance entry portid <portid-val>
vlan <vlan-val>
8.20.2.4
Modify dra instance entry
Description: Use this command to modify.
Command Syntax: modify dra instance entry portid <portid-val>
vlan <vlan-val> [ profileid <profileid-val> ] [ status disable | client |
server ] [ op82 disable | AddAlways | AddIfNotExists ]
[ configsuboption aci | Portid | None | None ] [ acival <acival-val> ]
[ raival <raival-val> ] [ syncratefields ActualDataRateupstrm |
ActualDataRatednstrm | MinDataRateupstrm | MinDataRatednstrm |
AttainableDataRateupstrm | AttainableDataRatednstrm |
MaxDataRateupstrm | MaxDataRatednstrm | MinLpDataRateupstrm |
MinLpDataRatednstrm | MaxDelayupstrm | ActualDelayupstrm |
MaxDelaydnstrm | ActualDelaydnstrm | None | None ]
[ op82fromclientact drop | forward ] [ learning disable | enable ]
[ portno <portno-val> ] [ draaddop82tounicast disable | enable ]
Parameters
Name
Description
portid <portid-val>
Bridge Port Identifier
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 194
vlan <vlan-val>
VLAN identifier. In case of stacked mode this is
virtual VLAN
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4095
profileid <profileidval>
DRA profile identifier. This shall be used for this
DRA instance
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 4
462
status disable | client |
server
This field is used to configure the status of DHCP
relay agent per instance. It can be disabled or
configured as client port or server port. If it is
configured as client port then it adds option 82 and
/or do learning as per configuration. If it is
configured as server port then it removes option
82 and does learning if we dont get portid from
agent circuit id.
Type: Create -- Optional
Modify -- Optional
Default value: disable
op82 disable |
AddAlways |
AddIfNotExists
This specifies the action to be performed on
Option 82 on receiving DHCP discovery packets
for this instance. If disabled DRA will not add
Option82 tag to the DHCP packets. If AddAlways
is set then Option 82 is always added. If
AddIfNotExists is set then Option 82 is added only
if the received DHCP packet does not contain
Option 82.
Type: Create -- Optional
Modify -- Optional
Default value: AddAlways
configsuboption aci |
Portid | None | None
This bitmask is used to indicate which all
parameters are configured for this instance.
Parameter bit set in this bitmask will overwrite the
automatically derived values of agent circuit Id
and/or port id by the values configured in this MO.
Type: Create -- Optional
Modify -- Optional
Default value: None
acival <acival-val>
This is use to configure agent circuit id for this
instance. If ACI bit is set in
gsvDRAConfigSubOptionthen this parameter will
overwrite the generated Agent Circuit Id
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
raival <raival-val>
This is use to configure remote agent id for this
instance. This parameter uniquely identifies the
subscriber on the associated access loop logical
port on the Columbia.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
463
syncratefields
ActualDataRateupstrm
|
ActualDataRatednstrm
| MinDataRateupstrm |
MinDataRatednstrm |
AttainableDataRateups
trm |
AttainableDataRatedns
trm |
MaxDataRateupstrm |
MaxDataRatednstrm |
MinLpDataRateupstrm
|
MinLpDataRatednstrm
| MaxDelayupstrm |
ActualDelayupstrm |
MaxDelaydnstrm |
ActualDelaydnstrm |
None | None
op82fromclientact
drop | forward
This bitmask is used to indicate what all access
loop characteristic parameters are to be added to
access loop characteristic suboption.
Type: Create -- Optional
Modify -- Optional
This specifies the action to be taken on receiving
DHCP message from the client with option 82. If
DHCP message contains option82 and we want
the packet to be dropped then drop should be set
and if we want the packet to be forwarded then
forward should be set.
Type: Create -- Optional
Modify -- Optional
Default value: drop
learning disable |
enable
This field specifies whether DHCP learning is to
be done on this port or not. If enabled DRA will
learn the IP Addresses assigned towards this port
using upstream/downstream packets received on
this port.
Type: Create -- Optional
Modify -- Optional
Default value: enable
portno <portno-val>
This field specifies Atm Port number.Its value is
considered only when the bitmask for portid is set
in ConfigSubOptionBitmask
Type: Create -- Optional
Modify -- Optional
Default value: \0
draaddop82tounicast
disable | enable
This field specifies whether Option 82 is to be
added to DHCP Unicast packets or not. If enabled
Option 82 will be added to DHCP Unicast Packets
and when disabled, it will not be added.
Type: Create -- Optional
Modify -- Optional
Default value: enable
Example
$ create dra instance entry portid 1 vlan 5 profileid 1 status client op82
AddAlways configsuboption aci acival "[ANI] atm 3/10:100.33" (slot = 3,
port = 10, vpi = 100, vci = 33)" raival "conexant noida" syncratefields
ActualDelaydnstrm op82fromclientact drop learning enable portno 10
draaddop82tounicast enable Auto
Output
Verbose Mode On
464
Entry Created
Port Id
5
: 1
VLAN
:
Profile Id
client
: 1
DRA status :
Option82
: AddAlways
Config Sub-Option
: aci
Agent Circuit Id
: "[ANI] atm 3/10:100.33" (slot
= 3, port = 10, vpi = 100, vci = 33)"
Remote Agent Id
: "conexant noida"
SyncRateInfoField
: ActualDelaydnstrm
DRA Act For Op82 From Client : drop
DRA learning
10
: enable
Port No
:
VCI
100
: 33
VPI
:
L2 type
Llcmux
: Eth
Encap Type :
DRA Add Op82 To Unicast
: enable
Verbose Mode Off:
Entry Created
Output field
465
Field
Description
Port Id
Bridge Port Identifier
VLAN
VLAN identifier. In case of stacked mode this is
virtual VLAN
Profile Id
DRA profile identifier. This shall be used for this
DRA instance
DRA status
This field is used to configure the status of DHCP
relay agent per instance. It can be disabled or
configured as client port or server port. If it is
configured as client port then it adds option 82 and
/or do learning as per configuration. If it is
configured as server port then it removes option
82 and does learning if we dont get portid from
agent circuit id.
Option82
This specifies the action to be performed on
Option 82 on receiving DHCP discovery packets
for this instance. If disabled DRA will not add
Option82 tag to the DHCP packets. If AddAlways
is set then Option 82 is always added. If
AddIfNotExists is set then Option 82 is added only
if the received DHCP packet does not contain
Option 82.
Config Sub-Option
This bitmask is used to indicate which all
parameters are configured for this instance.
Parameter bit set in this bitmask will overwrite the
automatically derived values of agent circuit Id
and/or port id by the values configured in this MO.
Agent Circuit Id
This is use to configure agent circuit id for this
instance. If ACI bit is set in
gsvDRAConfigSubOptionthen this parameter will
overwrite the generated Agent Circuit Id
Remote Agent Id
This is use to configure remote agent id for this
instance. This parameter uniquely identifies the
subscriber on the associated access loop logical
port on the Columbia.
SyncRateInfoField
This bitmask is used to indicate what all access
loop characteristic parameters are to be added to
access loop characteristic suboption.
DRA Act For Op82
From Client
This specifies the action to be taken on receiving
DHCP message from the client with option 82. If
DHCP message contains option82 and we want
the packet to be dropped then drop should be set
and if we want the packet to be forwarded then
forward should be set.
DRA learning
This field specifies whether DHCP learning is to
be done on this port or not. If enabled DRA will
learn the IP Addresses assigned towards this port
using upstream/downstream packets received on
this port.
Port No
This field specifies Atm Port number.Its value is
considered only when the bitmask for portid is set
in ConfigSubOptionBitmask
VCI
VCI Identifier of the AAL5 VC corresponding the
bridge port for this instance is created
VPI
VPI Identifier of the AAL5 VC corresponding the
bridge port for this instance is created
L2 type
This Parameter represents the L2 type used
Encap Type
This Parameter specifies the encapsulation type of
the aal5 VC corresponding the bridge port for
which this instance is created
DRA Add Op82 To
Unicast
This field specifies whether Option 82 is to be
added to DHCP Unicast packets or not. If enabled
Option 82 will be added to DHCP Unicast Packets
and when disabled, it will not be added.
References
• DHCP Relay Agent commands
8.20.3
Dra stats entry Commands
8.20.3.1
Get dra stats entry
Description: Use this command to get.
Command Syntax: get dra stats entry [portid <portid-val>] [vlan
<vlan-val>]
8.20.3.2
Reset dra stats entry
Description: Use this command to reset.
Command Syntax: get dra stats entry [portid <portid-val>] [vlan
<vlan-val>]
Parameters
Name
Description
portid <portid-val>
Bridge port identifier
Type: Reset -- Mandatory
Get -- Optional
Valid values: 1 - 194
466
vlan <vlan-val>
VLAN identifier. In case of stacked mode this is
virtual VLAN
Type: Reset -- Mandatory
Get -- Optional
Valid values: 1 - 4095
Example
$ get dra stats entry portid 1 vlan 1
Output
Port Id
: 1
VLAN
: 1
Dhcp Pkt Received
: 40
Dhcp Pkt Sent : 90
Dhcp Pkt Discarded : 40
Output field
Field
Description
Port Id
Bridge port identifier
VLAN
VLAN identifier. In case of stacked mode this is
virtual VLAN
Dhcp Pkt Received
Number of DHCP packets received for this
instance
Dhcp Pkt Sent
Number of DHCP packets sent for this instance
Dhcp Pkt Discarded
Number of DHCP packets discarded for this
instance
References
• DHCP Relay Agent commands
8.20.4
Dra global config Commands
8.20.4.1
Get dra global config
Description: Use this command to get.
Command Syntax: get dra global config
8.20.4.2
Modify dra global config
Description: Use this command to modify.
Command Syntax: modify dra global config [status Enable | Disable]
Parameters
Name
Description
status Enable |
Disable
Global status of DRA
Type: Modify -- Optional
Example
$ get dra global config
Output
DRA global Status
-----------------------------------------------------------Enable
Output field
467
Field
Description
DRA global Status
Global status of DRA
References
• DHCP Relay Agent commands
8.20.5
Ia profile entry Commands
8.20.5.1
Get ia profile entry
Description: Use this command to get.
Command Syntax: get ia profile entry [profileid <profileid-val>]
8.20.5.2
Create ia profile entry
Description: Use this command to create.
Command Syntax: create ia profile entry profileid <profileid-val>
[ anitype auto | config ] [ anival <anival-val> ] [ aciprefixstr
<aciprefixstr-val> ] [ acifieldlist AniVal | Chassis | Rack | Frame | Slot |
SubSlot | L2Type | Port | Vpi | Vci | VlanTag | None ] [ suboption Aci |
Rai | EncapType | AccessLoopChar | None ] [ chassisval chassisval ]
[ rackval <rackval-val> ] [ frameval <frameval-val> ] [ slotval <slotvalval> ] [ subslotval <subslotval-val> ]
8.20.5.3
Delete ia profile entry
Description: Use this command to delete.
Command Syntax: delete ia profile entry [profileid <profileid-val>]
8.20.5.4
Modify ia profile entry
Description: Use this command to modify.
Command Syntax: modify ia profile entry profileid <profileid-val>
[ anitype auto | config ] [ anival <anival-val> ] [ aciprefixstr
<aciprefixstr-val> ] [ acifieldlist AniVal | Chassis | Rack | Frame | Slot |
SubSlot | L2Type | Port | Vpi | Vci | VlanTag | None | None ]
[ suboption Aci | Rai | EncapType | AccessLoopChar | None | None ]
[ chassisval <chassisval-val> ] [ rackval <rackval-val> ] [ frameval
<frameval-val> ] [ slotval <slotval-val> ] [ subslotval <subslotval-val> ]
Parameters
468
Name
Description
profileid <profileidval>
Intermediate Agent Profile Identifier. This can be
applied on multiple PIA or DRA instances.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4
anitype auto | config
This field specifies whether the Access node
Identifier should be automatically derived or is
configured by the user. If its value is auto, the ANI
is derived from MAC address of access node.
Type: Create -- Optional
Modify -- Optional
Default value: auto
anival <anival-val>
This is used to configure access node identifier.
This field will be used only when value of
gsvIaAniType is config.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
aciprefixstr
<aciprefixstr-val>
This is used to configure user defined string to be
concatenated as a part of flexible syntax in Agent
Circuit Id. It is a string of characters with spaces
and special characters.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
acifieldlist AniVal |
Chassis | Rack | Frame
| Slot | SubSlot |
L2Type | Port | Vpi |
Vci | VlanTag | None |
None
This field represents list of parameters which will
take part in auto generation of Agent Circuit Id.
Type: Create -- Optional
Modify -- Optional
suboption Aci | Rai |
EncapType |
AccessLoopChar |
None | None
This field represents bitmask for suboptions to be
added to VSA tag in case of PIA and Option82 tag
in case of DRA. The options which can be added
include Agent Circuit Id, Agent Remote Id,
EncapType and AccessLoopCharacterstics. Agent
Circuit id identifies the circuit, Agent Remote id
specifies the subscriber information, EncapType
and AccessLoopChar identify with the
encapsulation type and access loop characterstics
respectively.
Type: Create -- Optional
Modify -- Optional
chassisval
<chassisval-val>
Chasis number of access node
Type: Create -- Optional
Modify -- Optional
Default value: \0
rackval <rackval-val>
Rack no of access node
Type: Create -- Optional
Modify -- Optional
Default value: \0
frameval <framevalval>
Frame number of access node.
Type: Create -- Optional
Modify -- Optional
Default value: \0
slotval <slotval-val>
Slot number of access node
Type: Create -- Optional
Modify -- Optional
Default value: \0
subslotval
<subslotval-val>
Sub-slot number of access node.
Type: Create -- Optional
Modify -- Optional
Default value: \0
Example
$ create ia profile entry profileid 1 anitype auto anival 00aabbccddff
aciprefixstr "Conexant Noida" acifieldlist port vpi vci suboption Aci
chassisval 1 rackval 1 frameval 1 slotval 3 subslotval 1Output
Output
Verbose Mode On
Entry Created
469
Profile Id
: 1
ANI Type : auto
ANI value
: 00aabbccddff
Aci Prefix Str : "Conexant Noida"
ACI Field List : port vpi vci
Sub Option
: Aci
Chassis
: 1
Rack
: 1
Frame
: 1
Slot
: 3
Sub Slot
: 1
Verbose Mode Off:
Entry Created
Output field
Field
Description
Profile Id
Intermediate Agent Profile Identifier. This can be
applied on multiple PIA or DRA instances.
ANI Type
This field specifies whether the Access node
Identifier should be automatically derived or is
configured by the user. If its value is auto, the
ANI is derived from MAC address of access
node.
ANI value
This is used to configure access node identifier.
This field will be used only when value of
gsvIaAniType is config.
Aci Prefix Str
This is used to configure user defined string to
be concatenated as a part of flexible syntax in
Agent Circuit Id. It is a string of characters with
spaces and special characters.
ACI Field List
This field represents list of parameters which will
take part in auto generation of Agent Circuit Id.
Sub Option
This field represents bitmask for suboptions to
be added to VSA tag in case of PIA and
Option82 tag in case of DRA. The options which
can be added include Agent Circuit Id, Agent
Remote Id, EncapType and
AccessLoopCharacterstics. Agent Circuit id
identifies the circuit, Agent Remote id specifies
the subscriber information, EncapType and
AccessLoopChar identify with the encapsulation
type and access loop characterstics
respectively.
Chassis
Chasis number of access node
Rack
Rack no of access node
Frame
Frame number of access node.
Slot
Slot number of access node
Sub Slot
Sub-slot number of access node.
References
• Intermediate Agent commands
8.20.6
Pia instance entry Commands
8.20.6.1
Get pia instance entry
Description: Use this command to get.
470
Command Syntax: get pia instance entry [portid <portid-val>] [vlan
<vlan-val>]
8.20.6.2
Create pia instance entry
Description: Use this command to create.
Command Syntax: create pia instance entry portid <portid-val>
vlan <vlan-val> profileid <profileid-val> [ status enable | disable ]
[ vsatag disable | AddAlways | AddIfNotExists ]
[ configsuboptionbitmask aci | PortId | None ] [ acival <acival-val> ]
[ raival <raival-val> ] [ syncratefields ActualDataRateupstrm |
ActualDataRatednstrm | MinDataRateupstrm | MinDataRatednstrm |
AttainableDataRateupstrm | AttainableDataRatednstrm |
MaxDataRateupstrm | MaxDataRatednstrm | MinLpDataRateupstrm |
MinLpDataRatednstrm | MaxDelayupstrm | ActualDelayupstrm |
MaxDelaydnstrm | ActualDelaydnstrm | None ] [ iwftagfromclientact
drop | forward ] [ insertiwfsubop enable | disable ] [ portno <portnoval> ]
8.20.6.3
Delete pia instance entry
Description: Use this command to delete.
Command Syntax: delete pia instance entry portid <portid-val> vlan
<vlan-val>
8.20.6.4
Modify pia instance entry
Description: Use this command to modify.
Command Syntax: modify pia instance entry portid <portid-val>
vlan <vlan-val> [ profileid <profileid-val> ] [ status enable | disable ]
[ vsatag disable | AddAlways | AddIfNotExists ]
[ configsuboptionbitmask aci | PortId | None | None ] [ acival <acivalval> ] [ raival <raival-val> ] [ syncratefields ActualDataRateupstrm |
ActualDataRatednstrm | MinDataRateupstrm | MinDataRatednstrm |
AttainableDataRateupstrm | AttainableDataRatednstrm |
MaxDataRateupstrm | MaxDataRatednstrm | MinLpDataRateupstrm |
MinLpDataRatednstrm | MaxDelayupstrm | ActualDelayupstrm |
MaxDelaydnstrm | ActualDelaydnstrm | None | None ]
[ iwftagfromclientact drop | forward ] [ insertiwfsubop enable |
disable ] [ portno <portno-val> ]
Parameters
Name
Description
portid <portid-val>
Bridge Port Identifier
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 194
vlan <vlan-val>
VLAN identifier. In case of stacked mode this is
virtual VLAN
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 4095
471
profileid <profileidval>
PIA profile identifier. This shall be used for this
PIA Instance
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 4
status enable | disable
Used to enable or disable PPPOE intermmediate
agent for this instance
Type: Create -- Optional
Modify -- Optional
Default value: disable
vsatag disable |
AddAlways |
AddIfNotExists
This specifies the action to be performed on VSA
Tag on receiving PPPoE discovery packets for this
instance. If disabled PIA will not add VSA tag to
the PPPoE packets. If AddAlways is set then VSA
tag is always added. If AddIfNotExists is set then
VSA tag is added only if the received packet does
not contain the VSA tag.
Type: Create -- Optional
Modify -- Optional
Default value: AddAlways
configsuboptionbitm
ask aci | PortId | None
| None
This bitmask is used to indicate which all
parameters are configured for this instance.
Parameter bit set in this bitmask will overwrite the
automatically derived values of agent circuit Id
and/or port id by the values configured in this MO.
Type: Create -- Optional
Modify -- Optional
Default value: None
acival <acival-val>
This is use to configure Agent Circuit Id for this
instance. If ACI bit is set in
gsvPiaConfigSubOptionBitmask then this
parameter will overwrite the generated Agent
Circuit Id
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
raival <raival-val>
This is used to configure Remote Agent Id for this
instance. This parameter uniquely identifies the
subscriber on the associated access loop logical
port on Columbia.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
472
syncratefields
ActualDataRateupstrm
|
ActualDataRatednstrm
| MinDataRateupstrm |
MinDataRatednstrm |
AttainableDataRateups
trm |
AttainableDataRatedns
trm |
MaxDataRateupstrm |
MaxDataRatednstrm |
MinLpDataRateupstrm
|
MinLpDataRatednstrm
| MaxDelayupstrm |
ActualDelayupstrm |
MaxDelaydnstrm |
ActualDelaydnstrm |
None | None
iwftagfromclientact
drop | forward
This bitmask is used to indicate what all access
loop characteristic parameters are to be added to
access loop characteristic suboption.
Type: Create -- Optional
Modify -- Optional
This field specifies the Action to be taken on
receiving PPPoE discovery msg with IWF
suboption from client. It can be configured as
either drop or forward. Default action is to drop the
packet silently.
Type: Create -- Optional
Modify -- Optional
Default value: drop
insertiwfsubop enable
| disable
This is used to indicate whether to add IWF
suboption to Columbia originated PPPoE
discovery packets received for this instance. This
field is valid only for PPPOAE interface.
Type: Create -- Optional
Modify -- Optional
Default value: enable
portno <portno-val>
This field specifies Atm Port number.Its value is
considered only when the bitmask for portid is set
in ConfigSubOptionBitmask
Type: Create -- Optional
Modify -- Optional
Default value: \0
Example
$ create pia instance entry portid 1 vlan 1 profileid 1 status enable
vsatag AddAlways configsuboptionbitmask aci acival "[ANI] atm
3/10:100.33î (slot = 3, port = 10, vpi = 100, vci = 33)" raival "conexant
noida" syncratefields ActualDelaydnstrm iwftagfromclientact drop
insertiwfsubop enable portno 10 Auto Output
Output
Verbose Mode On
Entry Created
Port Id
1
: 1
VLAN
Profile Id
enable
: 1
PIA status :
PIAVsaOption
: AddAlways
Config Sub Options Bitmask : aci
473
:
Agent Circuit Id
: "[ANI] atm 3/10:100.33î (slot =
3, port = 10, vpi = 100, vci = 33)"
Remote Agent Id
: "conexant noida"
SyncRateInfoField Bitmask
: ActualDelaydnstrm
Act for IWFTag From Client : drop
Insert Iwf Subop
: enable
Port No
: 10
VCI
100
: 33
L2 type
: Eth
Encap Type
: Llcmux
VPI
:
Verbose Mode Off:
Entry Created
Output field
474
Field
Description
Port Id
Bridge Port Identifier
VLAN
VLAN identifier. In case of stacked mode this is
virtual VLAN
Profile Id
PIA profile identifier. This shall be used for this
PIA Instance
PIA status
Used to enable or disable PPPOE
intermmediate agent for this instance
PIAVsaOption
This specifies the action to be performed on
VSA Tag on receiving PPPoE discovery packets
for this instance. If disabled PIA will not add VSA
tag to the PPPoE packets. If AddAlways is set
then VSA tag is always added. If AddIfNotExists
is set then VSA tag is added only if the received
packet does not contain the VSA tag.
Config Sub Options
Bitmask
This bitmask is used to indicate which all
parameters are configured for this instance.
Parameter bit set in this bitmask will overwrite
the automatically derived values of agent circuit
Id and/or port id by the values configured in this
MO.
Agent Circuit Id
This is use to configure Agent Circuit Id for this
instance. If ACI bit is set in
gsvPiaConfigSubOptionBitmask then this
parameter will overwrite the generated Agent
Circuit Id
Remote Agent Id
This is used to configure Remote Agent Id for
this instance. This parameter uniquely identifies
the subscriber on the associated access loop
logical port on Columbia.
SyncRateInfoField
Bitmask
This bitmask is used to indicate what all access
loop characteristic parameters are to be added
to access loop characteristic suboption.
Act for IWFTag From
Client
This field specifies the Action to be taken on
receiving PPPoE discovery msg with IWF
suboption from client. It can be configured as
either drop or forward. Default action is to drop
the packet silently.
Insert Iwf Subop
This is used to indicate whether to add IWF
suboption to Columbia originated PPPoE
discovery packets received for this instance.
This field is valid only for PPPOAE interface.
Port No
This field specifies Atm Port number.Its value is
considered only when the bitmask for portid is
set in ConfigSubOptionBitmask
VCI
VCI Identifier of the AAL5 VC corresponding the
bridge port for this instance is created
VPI
VPI Identifier of the AAL5 VC corresponding the
bridge port for this instance is created
L2 type
This Parameter specifies the L2 type used
Encap Type
This Parameter specifies the encapsulation type
of the aal5 VC corresponding the bridge port for
which this instance is created
References
• PPPoE Intermediate Agent commands
8.20.7
Pia stats entry Commands
8.20.7.1
Get pia stats entry
Description: Use this command to get.
Command Syntax: get pia stats entry [portid <portid-val>] [vlan
<vlan-val>]
8.20.7.2
Reset pia stats entry
Description: Use this command to reset.
Command Syntax: reset pia stats entry portid <portid-val> vlan
<vlan-val>
Parameters
Name
Description
portid <portid-val>
Bridge port Identifier
Type: Reset -- Mandatory
Get -- Optional
Valid values: 1 - 194
vlan <vlan-val>
VLAN identifier. In case of stacked mode this is
virtual VLAN
Type: Reset -- Mandatory
Get -- Optional
Valid values: 1 - 4095
Additional Values: 4097
Example
$ get pia stats entry portid 1 vlan 1
Output
Port Id
: 1
VLAN
Padi Received : 10
Padi Discarded : 4354
Padr Received : 4354
Padr Discarded : 4354
Output field
475
: 1
Field
Description
Port Id
Bridge port Identifier
VLAN
VLAN identifier. In case of stacked mode this is
virtual VLAN
Padi Received
Number of PADI received for this instance
Padi Discarded
Number of PADI discarded for this instance
Padr Received
Number of PADR received for this instance
Padr Discarded
Number of PADR packets discarded for this
instance
References
• PPPoE Intermediate Agent commands
8.20.8
Pia global config Commands
8.20.8.1
Get pia global config
Description: Use this command to get.
Command Syntax: get pia global config
8.20.8.2
Modify pia global config
Description: Use this command to modify.
Command Syntax: modify pia global config [status Enable | Disable]
Parameters
Name
Description
status Enable |
Disable
Global status of PIA
Type: Modify -- Optional
Example
$ get pia global config
Output
PIA global Status : Enable
Output field
Field
Description
PIA global Status
Global status of PIA
References
• PPPoE Intermediate Agent commands
476
8.21
QoS Commands
8.21.1
IRL Map Commands
8.21.1.1
Get irl map
Description: Use this command to get.
Command Syntax: get irl map [ifname <interface-name>]
8.21.1.2
Create irl map
Description: Use this command to create.
Command Syntax: create irl map ifname < interface-name >
profilename <profile-name>
8.21.1.3
Delete irl map
Description: Use this command to delete.
Command Syntax: delete irl map ifname < interface-name >
Parameters
Name
Description
ifname < interface-name
>
Interface Name whose IRL mapping information
is to be configured.
Valid Values: aal5-0 - aal5-*
Type : Create Mandatory
Delete Mandatory
Get --Optional
Valid values: ND - ND
Specifies the name of the IRL profile to be
associated with the interface. String of up to 64
characters ( 'A'- 'Z', 'a'-'z', '0'-'9','-','_') and any
combination of printable characters excluding ';'
Type: Create Mandatory
profilename <profilename>
Example $ create irl map ifname aal5-0 profilename gold
Output
Verbose Mode On
Entry Created
Interface
Profile Name
-----------------------------------------------------------aal5-0
gold
Verbose Mode Off:
Entry Created
Output field
Field
Description
Interface
Interface Name whose IRL mapping information
is to be configured. Valid Values: aal5-0 - aal5-*
Specifies the name of the IRL profile to be
associated with the interface. String of up to 64
characters ( 'A'- 'Z', 'a'-'z', '0'-'9','-','_') and any
combination of printable characters excluding ';'
Profile Name
8.21.2
IRL Profile Commands
8.21.2.1
Get irl profile
Description: Use this command to get.
477
Command Syntax: get irl profile [profilename <profile-name>]
8.21.2.2
Create irl profile
Description: Use this command to create.
Command Syntax: create irl profile profilename <profile-name>
[ irltype sr2cm | trtcm] [ cir <cir-val> ] [ cbs <cbs-val > ] [ pir <pir-val > ]
[ pbs <pbs-val > ] [ conformaction <colorgreen-val> ] [ exceedaction
drop |coloryellow ] [violateaction drop | coloryellow ]
8.21.2.3
Delete irl profile
Description: Use this command to delete.
Command Syntax: delete irl profile profilename <profile-name>
8.21.2.4
Modify irl profile
Description: Use this command to modify.
Command Syntax: modify irl profile profilename <profile-name>
[ irltype sr2cm | trtcm] [ cir <cir-val > ] [ cbs <cbs-val > ] [ pir <pir-val > ]
[ pbs <pbs-val > ] [ conformaction <colorgreen-val>] [ exceedaction
drop |coloryellow ] [violateaction drop | coloryellow ]
Parameters
Name
Description
profilename <profilename>
Profile name uniquely identify an IRL profile in the
system. String of up to 64 characters ( 'A'- 'Z', 'a''z', '0'-'9','-','_') and any combination of printable
characters excluding ';'.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
Valid values: ND - ND
This field specifies the type of IRL. Two types of
IRLs are supported. Single Rate Two Color
Marker (sr2cm) and Two Rate Three Color Marker
(trtcm).
Type: Create - Optional
Modify - Optional
Valid values: trtcm
Committed Information Rate of the IRL in kbps.
This field is valid for both sr2cm and trtcm type of
profiles. The value of this field cannot be more
than PIR.
Type: Create -- Optional
Modify -- Optional
Default value:0-16000
Committed Burst Size of the IRL in bytes. This
field is valid in both sr2cm and trtcm type of
profiles. The value of this field cannot be more
than PBS in case of trTcm.
Type: Create -- Optional
Modify -- Optional
Default value: 96-10000
Default value: 7500
Peak Information Rate of the IRL in kbps. This
field is valid only for trtcm type of profile. The
value of this field cannot be less than CIR.
Type: Create -- Optional
Modify -- Optional
Default value: 96-16000
Default value: 1000
Peak burst size of the IRL in bytes. This field is
valid only for trtcm type of profile. The value of
irltype sr2cm | trtcm
cir <cir-val >
cbs <cbs-val >
pir <pir-val >
pbs <pbs-val >
478
conformaction
colorgreen
exceedaction drop |
coloryellow
violateaction drop |
coloryellow
this field cannot be less than CBS.
Type: Create -- Optional
Modify -- Optional
Default value: 96-15000
Default value: 10000
Color type to be applied for conforming packets.
This field is valid in both sr2cm and trtcm type of
profiles Type: Create -- Optional
Modify -- Optional
Default value: colorgreen
Color for exceeding packets. This field is valid only
for trtcm type of profiles
Type: Create -- Optional
Modify -- Optional
efault value: coloryellow
Color type to be applied for violating packets. This
field is valid in both sr2cm and trtcm type of
profiles Type: Create -- Optional
Modify -- Optional
Default value: drop
Example $ create irl profile profilename gold irltype trtcm cir 1000 cbs
400 pir 2000 pbs 12000 conformaction colorgreen exceedaction
coloryellow violateaction drop
Output
Output field
Field
Description
Profile name
Profile name uniquely identifies an IRL profile in
the system. String of up to 64 characters ( 'A'- 'Z',
'a'-'z', '0'-'9','-','_') and any combination of printable
characters excluding ';'.
This field specifies the type of IRL. Two type of
IRLs are supported. Single Rate Two Color
Marker (sr2cm) and Two Rate Three Color Marker
(trtcm).
Committed Information Rate of the IRL in kbps.
This field is valid for both sr2cm and trtcm type of
profiles. The value of this field cannot be more
than PIR.
Committed Burst Size of the IRL in bytes. This
field is valid in both sr2cm and trtcm type of
profiles. The value of this field cannot be more
than PBS in case of trTcm.
Peak Information Rate of the IRL in kbps. This
field is valid only for trtcm type of profile. The
value of this field cannot be less than CIR.
Peak burst size of the IRL in bytes. This field is
valid only for trtcm type of profile. The value of
this field cannot be less than CBS.
Color type to be applied for conforming packets.
This field is valid in both sr2cm and trtcm type of
profiles.
Color for exceeding packets. This field is valid only
for trtcm type of profiles.
Color type to be applied for violating packets. This
field is valid in both sr2cm and trtcm type of
profiles
Profile Type
CIR(kbps)
CBS(bytes)
PIR(kbps)
PBS(bytes)
Conform action
Exceed action
Violate action
References
•
479
IRL Commands
8.21.3
IRL Stats Commands
8.21.3.1
Get irl stats
Description: Use this command to get.
Command Syntax: get irl stats [ifname <interface-name>]
Parameters
Name
Description
ifname
name>
Interface Name whose IRL statistics are
requested.
Valid Values: aal5-0 - aal5-*.
Type : Get -- Optional
Valid values : ND - ND
<interface-
Example $ get irl stats ifname aal5-0
Output
Interface
100
: aal5-0
Num packets exceeded : 300
1000
Num packets violated
:
Num packets conformed :
Output field
Field
Interface
Num packets violated
Num packets
exceeded
Num packets
conformed
Description
Interface Name whose IRL statistics are
requested.
Number of packets that violated PIR in case of
trTcm. In case of crTcm it is the number of
packets violating CIR.
Number of packets that exceeded CIR. This field
is valid only for trtcm type of profiles.
Number of packets that conformed to CIR.
References
• IRL Commands
8.21.4
Bridge rlinstance map Commands
8.21.4.1
Get bridge rlinstance map
Description: Use this command to get.
Command Syntax: get bridge rlinstance map [portid <portid-val>]
[flowtype <flowtype-val> | bcast | unregmcast | unknownucast]
8.21.4.2
Create bridge rlinstance map
Description: Use this command to create.
Command Syntax: create bridge rlinstance map portid <portidval>flowtype <flowtype-val>| bcast | unregmcast | unknownucast |
instanceid <instanceid-val>
8.21.4.3
Delete bridge rlinstance map
Description: Use this command to get.
Command Syntax: delete bridge rlinstance map portid <portid-val>
flowtype <flowtype-val> | bcast | unregmcast | unknownucast
8.21.4.4
Modify bridge rlinstance map
Description: Use this command to modify.
480
Command Syntax: modify bridge rlinstance map portid <portidval>flowtype <flowtype-val>| bcast | unregmcast | unknownucast
[instanceid <instanceid-val>]
Parameters
Name
Description
portid <portid-val>
Bridge Port Identifier with which an instance is
associated. If the value of this field is 'All', it
indicates all bridge ports. For a particular flow,
instance map cannot be created both for a specific
port as well as for 'all' the bridge ports.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 194
flowtype <flowtypeval>| bcast |
unregmcast |
unknownucast
This field identifies the flow for which this instance
is applied. Three flow types are reserved for
broadcast, unregistered multicast and unknown
unicast traffic. The other user defined flows are
identified by filtering rules by associating flow type
with a rule action of type 'ratelimiter'.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 16 - 32
instanceid
<instanceid-val>
This field identifies the Rate limiting instance.
Type: Create -- Mandatory
Modify -- Optional
Valid values: 1 - 250
Example
$ create bridge rlinstance map portid 6 flowtype bcast instanceid 1
configstatus Auto
Output
Verbose Mode On
Entry Created
Port Id
: 6
Flow Type
: bcast
Instance Id : 1
Verbose Mode Off:
Entry Created
Output field
481
Field
Description
Port Id
Bridge Port Identifier with which an instance is
associated. If the value of this field is 'All', it
indicates all bridge ports. For a particular flow,
instance map cannot be created both for a specific
port as well as for 'all' the bridge ports.
Flow Type
This field identifies the flow for which this instance
is applied. Three flow types are reserved for
broadcast, unregistered multicast and unknown
unicast traffic. The other user defined flows are
identified by filtering rules by associating flow type
with a rule action of type 'ratelimiter'.
Instance Id
This field identifies the Rate limiting instance.
Cautions
• An entry in this table shall not be applicable for a bridge port created
over PPPOE and IPOE interface.
8.21.5
Rl actionprofile info Commands
8.21.5.1
Get rl actionprofile info
Description: Use this command to get.
Command Syntax: get rl actionprofile info [profileid <profileid-val>]
[result conform | exceed | violate] [action drop | allow | sendtocontrol |
copytocontrol | modifytos | setbaclevel]
8.21.5.2
Create rl actionprofile info
Description: Use this command to create.
Command Syntax: create rl actionprofile info profileid <profileidval> result conform | exceed | violate action drop | allow | sendtocontrol
| copytocontrol | modifytos | setbaclevel [actionval <actionval-val>]
[actionmask <actionmask-val>] [description <description-val>]
8.21.5.3
Delete rl actionprofile info
Description: Use this command to delete.
Command Syntax: get rl actionprofile info profileid <profileidval>result conform | exceed | violate action drop | allow | sendtocontrol
| copytocontrol | modifytos | setbaclevel
8.21.5.4
Modify rl actionprofile info
Description Use this command to modify.
Command Syntax: modify rl actionprofile info profileid <profileidval> result conform | exceed | violate action drop | allow | sendtocontrol
| copytocontrol | modifytos | setbaclevel [actionval <actionval-val>]
[actionmask <actionmask-val>] [description <description-val>]
Parameters
Name
Description
profileid <profileidval>
Rate limiter's action profile identifier, which
uniquely identifies the action profile.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 32
482
result conform |
exceed | violate
The result type for which action is configured to be
taken. Multiple actions can be configured for a
result type.There shall be multiple entries with
same profile identifier and a result type if multiple
actions are configured for the result type. If there
is no entry configured for a result type, the action
is assumed to be 'allow' for that result.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
action drop | allow |
sendtocontrol |
copytocontrol |
modifytos | setbaclevel
Action to be taken on the packet.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
actionval <actionvalval>
The parameter should contain valid value for
some actions that require an additional input.For
sendtocontrol and copytocontrol actions this
parameter should contain control flow id (0 - 3).
Other values are invalid for this action. For
modifytos action this parameter should contain
value to be set in tos field in the packet in the
range 0 to 255. Other values are invalid for this
action. The application of this value is dependent
on the mask field. For setbaclevel action this
parameter should contain Buffer Admission
Control level 0 or 1. Other values are invalid for
this action. This parameter is ignored for other
actions.
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 0xffffffff
Default value: 0
actionmask
<actionmask-val>
This field is valid for sendtocontrol, copytocontrol
and modifytos actions only.For sendtocontrol and
copytocontrol actions this parameter should
contain trap disabled (0xffffffff) or trap enabled
(0x00000000). Other values are invalid for this
action.Only lower 8-bits are taken into
consideration for modifytos action and other bits
are ignored. In the mask if a bit location contains
1, then the corresponding bit in the TOS field is
overwritten with the corresponding bit in action
value. In the mask if a bit location contains 0, then
the corresponding bit in the TOS field remains
unchanged.
Type: Create -- Optional
Modify -- Optional
Valid values: 0 - 0xffffffff
Default value: 0xffffffff
483
description
<description-val>
Description of the application that receives
packets matching this RL. This field is mandatory
if Action is 'sendtocontrol' or 'copytocontrol'.The
description string should not begin with
underscore '_' as it is reserved for special usage
e.g. _PPPOE_CONTROL.
Type: Create -- Optional
Modify -- Optional
Default value: "\0"
Example
$ create rl actionprofile info profileid 1 result conform action
copytocontrol actionval 0x00000000 actionmask 0xffffffff description
lacp
Output
Verbose Mode On
Entry Created
Action Profile Id : 1
conform
Action Result
Profile Action
0x00000000
: copytocontrolActionVal
Action Mask
lacp
: 0xffffffff
:
:
Application Description :
Verbose Mode Off:
Entry Created
Output field
484
Field
Description
Action Profile Id
Rate limiter's action profile identifier, which
uniquely identifies the action profile.
Action Result
The result type for which action is configured to be
taken. Multiple actions can be configured for a
result type.There shall be multiple entries with
same profile identifier and a result type if multiple
actions are configured for the result type. If there
is no entry configured for a result type, the action
is assumed to be 'allow' for that result.
Profile Action
Action to be taken on the packet.
ActionVal
The parameter should contain valid value for
some actions that require an additional input.For
sendtocontrol and copytocontrol actions this
parameter should contain control flow id (0 - 3).
Other values are invalid for this action. For
modifytos action this parameter should contain
value to be set in tos field in the packet in the
range 0 to 255. Other values are invalid for this
action. The application of this value is dependent
on the mask field. For setbaclevel action this
parameter should contain Buffer Admission
Control level 0 or 1. Other values are invalid for
this action. This parameter is ignored for other
actions.
Action Mask
This field is valid for sendtocontrol, copytocontrol
and modifytos actions only.For sendtocontrol and
copytocontrol actions this parameter should
contain trap disabled (0xffffffff) or trap enabled
(0x00000000). Other values are invalid for this
action.Only lower 8-bits are taken into
consideration for modifytos action and other bits
are ignored. In the mask if a bit location contains
1, then the corresponding bit in the TOS field is
overwritten with the corresponding bit in action
value. In the mask if a bit location contains 0, then
the corresponding bit in the TOS field remains
unchanged.
Application
Description
8.21.6
Rl instance info Commands
8.21.6.1
Get rl instance info
Description of the application that receives
packets matching this RL. This field is mandatory
if Action is 'sendtocontrol' or 'copytocontrol'.The
description string should not begin with
underscore '_' as it is reserved for special usage
e.g. _PPPOE_CONTROL.
Description: Use this command to get.
Command Syntax: get rl instance info [instanceid <instanceid-val>]
8.21.6.2
Create rl instance info
Description: Use this command to create.
Command Syntax: create rl instance info instanceid <instanceidval> profileid <profileid-val> actionprofileid <actionprofileid-val>
8.21.6.3
Delete rl instance info
Description: Use this command to delete.
Command Syntax: delete rl instance info instanceid <instanceidval>
Parameters
Name
Description
instanceid
<instanceid-val>
Rate limiter instance identifier, which uniquely
identifies a rate limiter instance.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 250
profileid <profileidval>
This field identifies the rate limiter instance's
configuration profile. The rate limiter's algorithm
and associated parameters are based on the
configuration profile.
Type: Create -- Mandatory
Valid values: 1 - 16
actionprofileid
<actionprofileid-val>
This field identifies the rate limiter instance's
action profile. The rate limiter's actions on a
packet depending on the result are based on the
action profile.
Type: Create -- Mandatory
Valid values: 1 - 32
Example
$ create rl instance info instanceid 3 profileid 2 actionprofileid 1
Output
Verbose Mode On
485
Entry Created
Instance Id : 3
Profile Id
: 2
Action Profile Id : 1
Verbose Mode Off:
Entry Created
Output field
Field
Description
Instance Id
Rate limiter instance identifier, which uniquely
identifies a rate limiter instance.
Profile Id
This field identifies the rate limiter instance's
configuration profile. The rate limiter's algorithm
and associated parameters are based on the
configuration profile.
Action Profile Id
This field identifies the rate limiter instance's
action profile. The rate limiter's actions on a
packet depending on the result are based on the
action profile.
8.21.7
Rl profile info Commands
8.21.7.1
Get rl profile info
Description: Use this command to get.
Command Syntax: get rl profile info [profileid <profileid-val>]
8.21.7.2
Create rl profile info
Description: Use this command to create
Command Syntax: create rl profile info profileid <profileid-val>
[ rate <rate-val> ] [ mbs <mbs-val> ] [ level packet | byte ] [ type sr2cm
| trtcm ] [ peakrate <peakrate-val> ] [ pbs <pbs-val> ]
8.21.7.3
Delete rl profile info
Description: Use this command to delete.
Command Syntax: get rl profile info profileid <profileid-val>
8.21.7.4
Modify rl profile info
Description: Use this command to modify
Command Syntax: modify rl profile info profileid <profileid-val>
[ rate <rate-val> ] [ mbs <mbs-val> ] [ level packet | byte ] [ type sr2cm
| trtcm ] [ peakrate <peakrate-val> ] [ pbs <pbs-val> ]
Parameters
Name
Description
profileid <profileidval>
Rate limiter's configuration profile identifier,
whichuniquely identifies the configuration profile.
The configuration profile contains all parameters
required for rate limiting algorithm to operate.
Type: Create -- Mandatory
Delete -- Mandatory
Modify -- Mandatory
Get -- Optional
Valid values: 1 - 16
486
rate <rate-val>
This field defines the committed information rate. If
'level' is 'packet'(1), the unit is packets per second.
If 'level' is 'byte'(2), the unit is bits per second.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 100000000
Default value: 100000000
mbs <mbs-val>
This field defines the committed burst size. If
'level' is 'packet'(1), the unit is number of packets.
If 'level' is 'byte'(2), the unit is number of bytes.
Type: Create -- Optional
Modify -- Optional
Valid values: 4 - 65535
Default value: 65535
level packet | byte
Level of the rate limiter identifies whether the
algorithm executes in terms of number of packets
or number of bytes.If the 'level' is 'packet'(1), rate
is configured in terms of packets per second and
burst size is configured in terms of number of
packets.If the 'level' is 'byte'(2), rate is configured
in terms of bits per second and burst size is
configured in terms of number of bytes.
Type: Create -- Optional
Modify -- Optional
Default value: packet
type sr2cm | trtcm
Type identifies the algorithm for rate limiting.The
sr2cm (single rate two color marker) is a singlerate algorithm. It takes rate and burst size as input
parameters.The trtcm (two rate three color
marker) is a dual-rate algorithm. It takes two sets
of rate and burstsize as inputs, one each for peak
and committed information.
Type: Create -- Optional
Modify -- Optional
Default value: sr2cm
peakrate peakrateval>
This field is relevant only if 'type' is 'trtcm'(2). This
field defines the peak information rate. If 'level' is
'packet'(1), the unit is packets per second. If level
is byte, the unit is bits per second.
Type: Create -- Optional
Modify -- Optional
Valid values: 1 - 100000000
Default value: 100000000
pbs <pbs-val>
This field is relevant only if 'type' is 'trtcm'(2). This
field defines the peak burst size. If 'level' is
'packet'(1), the unit is number of packets. If 'level'
is 'byte'(2), the unit is number of bytes.
Type: Create -- Optional
Modify -- Optional
Valid values: 4 - 65535
Default value: 65535
Example
487
$ create rl profile info profileid 1 rate 24 mbs 24 level packet type trtcm
peakrate 30 pbs 30
Output
Verbose Mode On
Entry Created
Profile Id : 1
Level
: packet
Type
: trtcm
Rate
: 24
Max Burst Size
: 24
Peak Rate
: 30
Peak Max Burst Size : 30
Verbose Mode Off:
Entry Created
Output field
Field
Description
Profile Id
Rate limiter's configuration profile identifier,
whichuniquely identifies the configuration profile.
The configuration profile contains all parameters
required for rate limiting algorithm to operate.
Level
Level of the rate limiter identifies whether the
algorithm executes in terms of number of packets
or number of bytes.If the 'level' is 'packet'(1), rate
is configured in terms of packets per second and
burst size is configured in terms of number of
packets.If the 'level' is 'byte'(2), rate is configured
in terms of bits per second and burst size is
configured in terms of number of bytes.
Type
Type identifies the algorithm for rate limiting.The
sr2cm (single rate two color marker) is a singlerate algorithm. It takes rate and burst size as input
parameters.The trtcm (two rate three color
marker) is a dual-rate algorithm. It takes two sets
of rate and burstsize as inputs, one each for peak
and committed information.
Rate
This field defines the committed information rate. If
'level' is 'packet'(1), the unit is packets per second.
If 'level' is 'byte'(2), the unit is bits per second.
Max Burst Size
This field defines the committed burst size. If
'level' is 'packet'(1), the unit is number of packets.
If 'level' is 'byte'(2), the unit is number of bytes.
Peak Rate
This field is relevant only if 'type' is 'trtcm'(2). This
field defines the peak information rate. If 'level' is
'packet'(1), the unit is packets per second. If level
is byte, the unit is bits per second.
Peak Max Burst Size
This field is relevant only if 'type' is 'trtcm'(2). This
field defines the peak burst size. If 'level' is
'packet'(1), the unit is number of packets. If 'level'
is 'byte'(2), the unit is number of bytes.
8.21.8
Scheduling profile class Commands
8.21.8.1
Get sched profile class
Description: Use this command to get.
Command Syntax: get sched profile class [name <name-val>]
[classid <classid-val>]
8.21.8.2
Modify sched profile class
Description Use this command to modify.
488
Command Syntax: modify sched profile class name <name-val>
classid <classid-val> [param1 <param1-val>] [param2 <param2-val>]
[param3 <param3-val>] [param4 <param4-val>] [param5 <param5val>]
Parameters
Name
Description
name <name-val>
Name of the scheduling profile.
Type: Modify - Mandatory
Get - Optional
classid <classid-val>
param1 <param1-val>
Scheduling profile class identifier
Type: Modify -- Mandatory
Get -- Optional
Valid values: 1- 8
This specifies the first parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP scheduling algorithm, this
parameter specifies the weight of the class
queue on the scale of 1-100. Value 100 means
Strict Priority in PP scheduling profile.This
weight will be normalized with the sum of all
classId weights. For Custom scheduling
algorithm, this parameter specifies the excess
bandwidth sharing weight of the class on the
scale of 1-100. If for a class, both Minimum
bandwidth and the Excess sharing weight are
configured as zero, then the queue shall never
be scheduled. Default value of this parameter is
calculated as (classid * 10). The default value
listed is only an indicative value.
Type: Modify - Optional
param2 <param2-val>
param3 <param3-val>
param4 <param4-val>
param5 <param5-val>
This specifies the second parameter for the
class queue that is used in the scheduling
algorithm of the profile. For PP scheduling
algorithm, it is ignored. For Custom scheduling
algorithm, this parameter specifies the Minimum
bandwidth in Kbps. Value zero means no
minimum bandwidth guarantee for the class.
Type: Modify - Optional
This specifies the third parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP scheduling algorithm, it is
ignored. For Custom scheduling algorithm, this
parameter specifies the Maximum bandwidth
limit in Kbps for the class. Value zero means no
maximum bandwidth limit for the class.
Type: Modify - Optional
This specifies the fourth parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP and Custom scheduling
algorithms, it is ignored. The default value listed
is only an indicative value.
Type: Modify -- Optional
This specifies the fifth parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP and Custom scheduling
algorithms, it is ignored. The default value listed
is only an indicative value.
Type: Modify - Optional
Example
$ get sched profile class name gold classid 1
Output
489
Profile Name
: gold
Class Id
: 1
Profile Class Param1 : 20
Profile Class Param2 : 25
Profile Class Param3 : 25
Profile Class Param4 : 0
Profile Class Param5 : 25
Output field description
Field
Description
Profile Name
Class Id
Name of the scheduling profile
Scheduling profile class identifier
This specifies the first parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP scheduling algorithm, this
parameter specifies the weight of the class
queue on the scale of 1-100. Value 100 means
Strict Priority in PP scheduling profile.This
weight will be normalized with the sum of all
classId weights. For Custom scheduling
algorithm, this parameter specifies the excess
bandwidth sharing weight of the class on the
scale of 1-100. If for a class, both Minimum
bandwidth and the Excess sharing weight are
configured as zero, then the queue shall never
be scheduled. Default value of this parameter is
calculated as (classid * 10). The default value
listed is only an indicative value.
This specifies the second parameter for the
class queue that is used in the scheduling
algorithm of the profile. For PP scheduling
algorithm, it is ignored.
For Custom scheduling algorithm, this parameter
specifies the Minimum bandwidth in Kbps. Value
zero means no minimum bandwidth guarantee
for the class.
This specifies the third parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP scheduling algorithm, it is
ignored.
For Custom scheduling algorithm, this parameter
specifies the Maximum bandwidth limit in Kbps
for the class. Value zero means no maximum
bandwidth limit for the class.
This specifies the fourth parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP and Custom scheduling
algorithms, it is ignored. The default value listed
is only an indicative value.
This specifies the fifth parameter for the class
queue that is used in the scheduling algorithm of
the profile. For PP and Custom scheduling
algorithms, it is ignored. The default value listed
is only an indicative value.
Profile Class Param1
Profile Class Param2
Profile Class Param3
Profile Class Param4
Profile Class Param5
References
• Scheduling profile related commands
8.21.9
Scheduling profile info Commands
8.21.9.1
Get sched profile info
Description: Use this command to get.
Command Syntax: get sched profile info [name <name-val>]
8.21.9.2
Create sched profile info
Description: Use this command to create.
Command Syntax: create sched profile info name <name-val> [algo
pp | custom] iftype eth| atm
490
8.21.9.3
Delete sched profile info
Description: Use this command to delete.
Command Syntax: delete sched profile info name <name-val>
Parameters
Name
name <name-val>
Description
Name of the scheduling profile
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
algo pp | custom
Scheduling algorithm of the profile. Currently only
Proabalistic Priority is supported over ethernet and
custom is supported over ATM. In Proabalistic
Priority algorithm, the traffic class parameter
determines the probablity with which its
corresponding queue is served when it is polled by
the server. In Custom algorithm, user shall have
flexibility to assign minimum rate, maximum rate,
and excess bandwidth sharing weight for classes
and the scheduling shall be done based on these
parameters among classes.
Type: Create -- Optional
Default value: pp
iftype eth | atm
The type of the interface Ethernet/ATM port for
which the scheduling profile is applicable.
Type: Create - Mandatory
Example $ create sched profile info name gold algo pp iftype atm
Output Verbose Mode On
Verbose Mode On
Entry Created
Profile Name
: gold
Scheduling Algorithm
eth
: pp
Interface Type :
Verbose Mode Off:
Entry Created
Output field
Field
Description
Profile Name
Name of the scheduling profile
Scheduling algorithm of the profile. Currently only
Proabalistic Priority is supported over ethernet and
custom is supported over ATM. In Proabalistic
Priority algorithm, the traffic class parameter
determines the probablity with which its
corresponding queue is served when it is polled by
the server. In Custom algorithm, user shall have
flexibility to assign minimum rate, maximum rate,
and excess bandwidth sharing weight for classes
and the scheduling shall be done based on these
parameters among classes.
The type of the interface Ethernet/ATM port for
which the scheduling profile is applicable.
Scheduling
Algorithm
Interface Type
Caution
• For a scheduling profile that has iftype as atm, upto 8 classes can
be configured, while for a scheduling profile that has iftype as eth, 8
classes can be configured.
References
491
• Scheduling profile related commands.
8.21.10
Trfclass profile class Commands
8.21.10.1
Get trfclass profile class
Description: Use this command to get.
Command Syntax: get trfclass profile class [profileid <profileid-val>]
[classid <classid-val>]
8.21.10.2
Modify trfclass profile class
Description: Use this command to get.
Command Syntax: modify trfclass profile class profileid <profileidval>classid <classid-val> [size <size-val>] [thrshld1 <thrshld1-val>]
Parameters
Name
Description
profileid <profileidval>
Traffic class profile identifier.
Type: Modify -- Mandatory
Get -- Optional
Valid values: 1 - 10
classid <classid-val>
Traffic class profile class identifier.
Type: Modify -- Mandatory
Get -- Optional
size <size-val>
This parameter specifies the size of the Traffic
class.
Type: Modify -- Optional
thrshld1 <thrshld1val>
This parameter specifies the low threshold of the
queue, as a percentage of the queue size. When
the queue is full beyond this threshold, only
conforming frames are passed and nonconforming frames are dropped. Conformance of
frames is determined as per IRL configured on
input the ATM port.
Type: Modify -- Optional
Valid values: 0 - 100
Example
$ get trfclass profile class profileid 1 classid 1
Output
Profile Identifier
Id
: 1
Class
: 1
Traffic Class Param Size : 32
Thresh : 50
Traffic Class Param
Output field
492
Field
Description
Profile Identifier
Traffic class profile identifier.
Class Id
Traffic class profile class identifier.
Traffic Class Param
Size
This parameter specifies the size of the Traffic
class.
Traffic Class Param
Thresh
This parameter specifies the low threshold of the
queue, as a percentage of the queue size. When
the queue is full beyond this threshold, only
conforming frames are passed and nonconforming frames are dropped. Conformance of
frames is determined as per IRL configured on
input the ATM port.
References
• See traffic class profile related commands.
8.21.11
Trfclass profile info Commands
8.21.11.1
Get trfclass profile info
Description: Use this command to get.
Command Syntax: get trfclass profile info [profileid <profileid-val>]
8.21.11.2
Create trfclass profile info
Description: Use this command to get.
Command Syntax: create trfclass profile info profileid <profileidval> iftype eth | atm
8.21.11.3
Delete trfclass profile info
Description: Use this command to delete.
Command Syntax: get trfclass profile info profileid <profileid-val>
Parameters
Name
Description
profileid <profileidval>
Traffic class profile identifier.
Type: Create -- Mandatory
Delete -- Mandatory
Get -- Optional
Valid values: 1 - 10
iftype eth | atm
Interface type.
Type: Create -- Mandatory
Example
$ create trfclass profile info profileid 3 iftype eth
Output
Verbose Mode On
Entry Created
Profile identifier : 3
Interface Type : eth
Verbose Mode Off:
Entry Created
Output field
493
Field
Description
Profile identifier
Traffic class profile identifier.
Interface Type
Interface type.
8.21.12
Trfclass stats Commands
8.21.12.1
Get trfclass stats
Description: Use this command to get.
Command Syntax: get trfclass stats [ifname <ifname-val>] [classid
<classid-val>]
8.21.12.2
Reset trfclass stats
Description: Use this command to get.
Command Syntax: reset trfclass stats [ifname <ifname-val>]
[classid <classid-val>]
Parameters
Name
Description
ifname <ifname-val>
Interface name
Type: Reset -- Mandatory
Get -- Optional
classid <classid-val>
Traffic class identifier
Type: Reset -- Mandatory
Get -- Optional
Example
$ get trfclass stats ifname 149 classid 1
Output
Interface Name : 149
Class Id : 1
NumDiscardPkts : 10
Output field
494
Field
Description
Interface Name
Interface name
Class Id
Traffic class identifier
NumDiscardPkts
Number of packets discarded
8.22
RMON Commands
8.22.1
RMON Statistics Group Commands
8.22.1.1
Create srmon probe
Description: Use this command to create RMON probe.
Command Syntax: create srmon probe rindex <rindex-val> ifname
<interface-name> owner <owner-string>
8.22.1.2
Delete srmon probe
Description: Use this command to delete the RMON probe.
Command Syntax: delete srmon probe rindex <rindex-val>
8.22.1.3
Get srmon probe
Description Use this command to get RMON probe information and
statistics.
Command Syntax: get srmon probe [rindex <rindex-val>]
Parameters
Name
Description
rindex <rindex-val>
Unique identifier of the probe.
Type: Create – Mandatory
Delete – Mandatory
Get - Optional
Valid values : 0 -20
This specifies the Interface name.
Type: Create – Mandatory
Valid values : eoa-0 - *, eth-0-*
The entity that configured this probe, and is
therefore using the resources assigned to it.
Type : Create – Mandatory
Valid values: Strings of up to 64 ASCII
characters.
Ifname <interfacename>
owner <owner-string>
Example
$ get srmon probe rindex 1
Output
Verbose Mode On
RMON Probe Index
If-Name
Owner
Total Octets
Packets
: 1
: eth-0
: Conexant
: 800
Stats
Total
: 200
Total Broadcast Packets : 138
Packets : 200
Total Multicast
Total 64 Octets
Octets
: 200
: 100
Total 65-127
Total 128-255 Octets
Octets
: 300
: 200
Total 256-511
Total 512-1023 Octets
Octets : 100
: 50
Total 1024-1518
Output field
495
Field
Description
RMON Probe Index
If-Name
Unique identifier of RMON probe.
This specifies the Interface name. It can be :
Stats Owner
Total Octets
Total Packets
Total Broadcast
Packets
Total Multicast Packets
Total 64 Octets
Total 65-127 Octets
Total 128-255 Octets
Total 256-511 Octets
Total 512-1023 Octets
Total 1024-1518 Octets
eoa-0 - *, eth-*
The entity that configured this entry and is
therefore using the resources assigned to it.
The total number of octets of data (including
those in bad packets) received on the network
(excluding framing bits but including FCS
octets).
The total number of packets (including bad
packets, broadcast packets, and multicast
packets) received.
The total number of good packets received, that
were directed to the broadcast address.
The total number of good packets received, that
were directed to a multicast address.
The total number of packets (including bad
packets) received, that were 64 octets in length
(excluding framing bits but including FCS
octets).
The total number of packets (including bad
packets) received, that were between 65 and
127 octets in length inclusive (excluding framing
bits but including FCS octets).
The total number of packets (including bad
packets) received that were between 128 and
255 octets in length inclusive (excluding framing
bits but including FCS octets).
The total number of packets (including bad
packets) received that were between 256 and
511 octets in length inclusive (excluding framing
bits but including FCS octets).
The total number of packets (including bad
packets) received that were between 512 and
1023 octets in length inclusive (excluding
framing bits but including FCS octets).
The total number of packets (including bad
packets) received that were between 1024 and
1518 octets in length inclusive (excluding
framing bits but including FCS octets).
Caution
• This command is not supported on an EoA interface for which
ConfigStatus is set to Config.
8.22.2
RMON Task Info Commands
8.22.2.1
Get rmon task
Description: Use this command to get.
Command Syntax: get rmon task [rname <task-name>]
Parameters
Name
Description
Rname< taskname>
This parameter specifies the name of a
particular task.
Valid values: Any task name present in the
system.
Example
$ get rmon task taskname tsk1
Output
496
Name
SUSPEND
: TSK1
Status
: EVENT
Sched Count
: 1
Priority
: 10
Preempt
: Yes
Time Slice
: 0
Stack Base
: 0x520cc18
Stack Size
: 2048
CleanStackSize : 14080
LastSchedTime
: Thu Jan 01 00:00:08 1970-
Output field
Field
Description
Name
This parameter specifies the name of the task.
Status
This parameters specifies the status of the task.
The task can in ready state, terminated state,
suspended state or finished state.
Sched Count
This parameter specifies the Schedule count of
the task i.e. number of times the task has been
scheduled.
Priority
This parameter tells the priority of the task.
Preempt
This parameter tells whether the task
preemption is allowed or not. If the value is yes
then task can be preempted .If the value is No ,
then task can not be preempted.
Time Slice
This parameters tell the time slice of the task. If
this value is zero, it means that time slicing is
disabled for this task.
Stack Base
This parameter specifies the base address
(starting address) of the stack associated with
this task. The stack of the task would span from
the address as given by Stack Base till the
address as given by (Stack Base + Stack Size).
Note that the stack grows from the address as
given by (Stack Base + Stack Size) towards
Stack Base.
Stack Size
This parameters tells the total number of bytes in
the task's stack.
CleanStackSize
This Parameter tells the free stack size i.e. the
number of bytes that have never been accessed
in the stack of task. Basically this gives an idea
of the stack watermark.
LastSchedTime
This parameter tells the system time at which
the task was lastly scheduled.
8.22.3
RMON Memory Pool info Commands
8.22.3.1
Get rmon mpool
Description: Use this command to get.
Command Syntax: get rmon mpool [rname <mpool-name>]
Parameters
Name
Description
rname mpool
This parameter specifies the name of a
particular memory pool.
Valid values : Any memory pool name present
in the system. A user can also give first few
characeters of a memory pool name. In that
case all the memory pools whose name start
with those characters shall be displayed.
Example 1
For variable size memory pool
$ get rmon mpool DCLFR113
497
Output
Name
5392
: DCLFR113
Size
:
Min
5360
: 16
Free
:
Tasks Waiting
FIFO
: 0
Suspend Type
:
StartAddr
: 0x147b7d28
FirstTaskName
: -
FirstAllocator
CLFR
: CLFR
LastAllocator
:
LastDellocater
: CLFR
LastFailUser
: -
LastFailDellocater : -
WaterMark
: 84
TotalMemAlloc
: 52
TotalMemFree
: 52
MemAllocFailCount
: 0
MemFreeFailCount
: 0
MPoolType
5392
: DYNAMIC
Threshold
:
Threhold Count
: 0
LastMemAllocTime
: Thu Jan 01 00:01:08 1970
LastMemFreeTime
: Thu Jan 01 00:02:18 1970
LastMemAllocFailTime: LastMemFreeFailTime : ThresholdHitTime
: -
Output field
498
Field
Description
Name
Name of the memory pool. For fixed size pool,
the name starts with 'D'.
Size
Size of memory pool i.e.number of bytes in the
pool.
Min
Minimum number of bytes for each allocation
from this pool.
Free
Number of free bytes in the pool i.e. Number of
bytes that are available in the pool for allocation
and has not been yet allocated.
Task Waiting
Number of tasks waiting on this pool.
Suspend Type
The task suspended type. Task suspend type on
a memory pool can be either FIFO (First In First
Out) or Priority.
Start Addr
The Starting Address of the memory pool.
FirstTaskName
Name of the first suspended task on this
memory pool.
FirstAllocator
Name of the module which has firstly allocated
memory from the pool.
LastAllocator
Name of the module which has lastly (i.e. most
recently) allocted memory from the pool.
LastDellocater
Name of the module which has lastly (ie. most
recently)deallocated memory to the pool.
LastFailAllocator
Name of the module which has lastly failed to
allocate the memory from the pool.
LastFailDeallocator
Name of the module which has lastly failed to
deallocate the memory to the pool.
WaterMark
WaterMark of the memorypool i.e. the maximum
amount of memory that has been allocated from
the memory pool at some point in time.
TotalMemAlloc
Total amount of memory allocated from the
memory pool (since its creation ). This field is a
running counter and it only increments. When
the memory is freed this field is not decremented
rather the TotalMemFree field is incremented.
TotalMemFree
Total amount of memory that has been
deallocted from the memory pool (since its
creation). This is also a running counter.
MemAllocFailCount
The number of times memory allocation from
this pool has been failed.
MemFreeFailCount
The number of times the memory deallocation to
the pool has been failed.
MPoolType
Type of the pool. If the value is DYNAMIC , the
memory pool is of variable size . If it is
PARTITION, it is fixed type memory pool.
Threshold
Threshold Value set for the memory pool, in
number of bytes.
ThresholdCOunt
Number of times the threshold value has been
hit for this memory pool.
LastMemAllocTime
The system time when memory was lastly
allocated from the pool.
LastMemFreeTime
The system time when memory was lastly freed
into the pool.
LastMemAllocFailTime
The system time when the last memory
allocation from the pool has failed.
LastMemFreeFailTime
The system time when the last memory
deallocation has failed.
ThresholdHitTime
The system time when threshold of the pool has
hit most recently.
Example 2
For fixed size memory pool
$ get rmon mpool FTSK142
Output
Name
: FTSK142
Size
: 280
Partion Size
: 20
Allocated
: 1
Free
: 9
Tasks Waiting
FIFO
: 0
Suspend Type
:
StartAddr
: 0x5307e40
FirstTaskName
: -
FirstAllocator
TSK1
: TSK1
LastAllocator
:
LastDellocater
: TSK1
LastFailUser
: -
LastFailDellocater : -
WaterMark
: 84
TotalMemAlloc
: 3
TotalMemFree
: 2
MemAllocFailCount
: 0
MemFreeFailCount
: 0
MPoolType
: PARTTION
Threshold
: 280
Threhold Count
: 0
LastMemAllocTime
: Thu Jan 01 00:02:34 1970
LastMemFreeTime
: Thu Jan 01 00:02:49 1970
LastMemAllocFailTime: LastMemFreeFailTime : ThresholdHitTime
: -
Output field
Field
499
Description
500
Name
Name of the memory pool. For fixed size pool,
the name starts with 'F'.
Size
Size of memory pool i.e.number of bytes in the
pool.
Partition Size
Partition size specifies the size of each partition
in bytes.
Allocated
Number of partitions allocated.
Free
Number of free partitions in the pool i.e. Number
of partitions that are available in the pool for
allocation and has not been yet allocated.
Task Waiting
Number of tasks waiting on this pool.
Suspend Type
The task suspended type. Task suspend type on
a memory pool can be either FIFO (First In First
Out) or Priority.
StartAddr
The Starting Address of the memory pool.
FirstTaskName
Name of the first suspended task on this
memory pool.
FirstAllocator
Name of the module which has firstly allocated
partition from the pool.
LastAllocator
Name of the module which has lastly (i.e. most
recently) allocted partition from the pool.
LastDellocater
Name of the module which has lastly (ie. most
recently) freed the partition to the pool.
LastFailUser
Name of the module which has lastly failed to
allocate the partition from the pool.
LastFailDellocater
Name of the module which has lastly failed to
free the partition in to the pool.
WaterMark
WaterMark of the memorypool i.e. the maximum
amount of memory that has been allocated from
the memory pool at some point in time. This
figure (displayed in bytes) includes the memory
allocated as well as the overhead that nucleus
keeps while allocating partitions.
TotalmemAlloc
Total number of partitions allocated from the
memory pool (since its creation ). This is a
running counter, it always increments never
decrements.
TotalMemFree
Total number of partitions that has been freed
into the memory pool (since its creation). This is
a running counter, it always increments never
decrements.
MemAllocFailCount
The number of times partition allocation from this
pool has failed.
MemFreeFailCount
The number of times the partition deallocation to
the pool has failed.
MPoolType
Type of the pool. If the value is DYNAMIC , the
memory pool is of variable size . If it is
PARTITION, it is fixed type memory pool.
Threshold
Threshold Value set for the memory pool, in
number of bytes.
Threshold Count
Number of times the threshold value has been
hit for this memory pool.
LastMemAllocTime
The last system time when a partition has been
allocated from the pool.
LastMemFreeTime
The last system time when a partition has been
freed into the pool.
8.22.3.2
LastMemAllocFailTime
The last system time when the partition
allocation from the pool has failed.
LastMemFreeFailTime
The last system time when the partition
deallocation has failed.
ThresholdHitTime
The last system time when threshold of the pool
has hit.
Get rmon mpool threshold
Description: Use this command to get the critical events logged for the
memory pool. This command will display 20 entries (maximum) .Events
are logged for the memory pool for the following 3 cases:
• Mem Pool Allocation Fail.
• Mem Pool Deallocation Fail.
• Threshold Hit.
Command Syntax: get rmon mpool threshold
Parameters
None
Example
$ get rmon mpool threshold
Output
Task Name : TSK1
Mpool Name : FTSK143
Pool Type : PARTITION
ThresholdHitTimeStamp :Thu Jan 01 00:20:53 1970
Event Type :
Allocation Fail
Output field
Field
Description
Task Name
Name of the module which tries to allocate or
deallocate from memory pool during a critical
event.
MPool Name
The name of memory pool.
Pool Type
Type of memory pool. DYNAMIC for variable
size of memory pool and PARTITION for fixed
size memory pool.
ThresholdHitTimeStamp
The system time at which event logging is
done.
Event Type
Cause of event logging.
Its value can be:
Allocation Fail - If allocation from pool has
failed.
Deallocation Fail - If deallocation from pool has
failed.
Threshold Hit - If threshold value of pool has
been hit while allocation.
8.22.3.3
Reset rmon mpool
Description: Use this command to reset some parameters of memory
pool. This command will reset the following parameters of memory
pool.
• Set MemAllocFailCount value to zero.
501
• Set MemFreeFailCount value to zero.
• Set watermark value to the value of the currently allocated memory
from that pool.
• Set ThresholdCount value to the zero.
Command Syntax: reset rmon mpool
Parameters
None
Example
$ reset rmon mpool
Output Field(s)
None
8.22.4
RMON Queue info Commands
8.22.4.1
get rmon queue
Description: Use this command to get the information about a
particular queue or about all the queues present in the system.
Command Syntax: get rmon queue [rname <queue-name>]
Parameters
Name
Description
rname <queue-name>
This parameter specifies the name of a
particular queue.
Valid values: Any queue name present in the
system.
Example
$ get rmon queue rname tsk173
Output
Name
: TSK173
Start Addr
: 0x520c700
Size
: 10
Available Size
: 9
Pending Msgs
: 1
Msg Type
: FIXED
Msg Size
: 1
Suspend Type
: PRIORITY
Tasks Waiting
: 0
FirstTaskName
: -
TotalMsgIn
: 3
TotalMsgOut
: 2
DropCount
: 0
WaterMark
: 3
LastMsgInFailPtr: 0x0
LastSender
: TSK2
LastRecvr
: TSK1
LastSenderFail
: -
LastRecvFail
: -
ThreshHold
: 10
ThresholdHitCount: 0
LastMsgOutTime
: Thu Jan 01 00:04:17 1970
LastMsgInTime
: Thu Jan 01 00:03:50 1970
LastMsgOutFailTime : LastMsgInFailTime
: -
ThresholdHitTime
: -
Output field
502
Field
Description
Name
Name of the Queue.
Start Addr
The Starting Address of the queue.
503
Size
Size of the queue i.e the total number of
unsigned words (4 bytes) in the queue.
Available Size
Available size of the queue i.e. number of
unsigned words (4 bytes) free in the queue.
Pending Msgs
Number of messages present in the queue.
Msg Type
Type of the messages in the queue. If it is
FIXED, then all the messages in the queue are
of a fixed size. If it is VARIABLE , then the
messages present in the queue can be of
varying size.
Msg Size
Size of the message in number of unsigned
words (4 bytes). If the msg type is fixed, then it
tells the exact size of each message , else if the
msg type is variable then it tells the maximum
message size.
Suspend Type
The task suspended type. Task suspend type
on the queue can be either FIFO (First In First
Out) or Priority.
Tasks Waiting
Number of tasks waiting on this queue.
FirstTaskName
Name of the first suspended task on this queue.
TotalMsgIn
Total number of messages enqueued i.e. the
number of messages send to this queue (since
its creation ). This is a running counter and
never decrements.
TotalMsgOut
Total number of messages dequed i.e. the
number of messages received from this
queue(since creation). This is a running counter
and never decrements.
DropCount
Number of messages dropped i.e. total number
of times message send to this queue failed.
This is a running counter and never
decrements.
WaterMark
WaterMark of the queue i.e the maximum
number of unsigned words (4 bytes) that has
been present in this queue at some point in
time.
LastMsgInFailPtr
Address of the message buffer that failed to
enqueue in the queue lastly.
LastSender
Name of the module which has lastly (i.e. most
recently) send the message to the queue.
LastRecvr
Name of the module which has lastly (ie. most
recently)recieved the message from the queue.
LastSenderFail
Name of the module which has lastly failed to
send the message to the queue.
LastRecvFail
Name of the module which has lastly failed to
receive the message from the queue.
Threshold
Threshold Value set for the queue, in number
of unsigned words (4 bytes).
ThresholdHitCount
Number of times threshold has been hit for the
queue.
LastMsgOutTime
The system time when the message was lastly
received from the queue.
LastMsgInTime
The system time when the message was lastly
send to the queue.
LastMsgOutFailTime
The system time when the message receiving
from the queue has lastly failed.
8.22.4.2
LastMsgInFailTime
The system time when the message send to
the queue has lastly failed.
ThresholdHitTime
The system time when threshold of the queue
has lastly hit.
Get rmon queue threshold
Description: Use this command to get the critical events logged for the
queue. This command will display 20 entries (maximum) . Events are
logged for the queue for the following 3 cases:
• Message Receiving From Queue Fail.
• Message Send To Queue Fail.
• Threshold Hit.
Command Syntax: get rmon queue threshold
Parameters
None
Example
$ get rmon queue threshold
Output
Queue Name
: TSK173
Task
Name: TSK1
ThreshHitTime : Thu Jan 01 00:00:14 1970
Event Type
: Msg Recv From Q Fail
Output field
Field
Description
Queue Name
Name of the queue.
Task Name
Name of the module which has tried to send or
receive the message from the queue when the
event has happened.
ThresholdHitTime
The system time at which event logging is
done.
Event Type
Cause of event logging.
Its value can be:
Msg Send To Q Fail - If failure occurred while
sending message to queue.
Msg Recv From Q Fail - If failure occurred while
receiving a message from the queue.
Threshold Hit - If threshold value of queue has
been hit while sending the message to queue.
8.22.4.3
Reset rmon queue
Description: Use this command to reset some parameters of queue.
This command will reset the following parameters of queue.
• Set DropCount value to zero.
• Set watermark value to the value of the currently used size of
queue .
• Set ThresholdCount value to the zero.
Command Syntax: Reset rmon queue
Parameters
None
Example
504
$ reset rmon queue
Output Field(s)
None
8.22.5
RMON Net buffers info Commands
8.22.5.1
Get rmon netbuf
Description: Use this command to get the information about all the net
buffers present in the system.
Command Syntax: get rmon netbuf
Parameters
None
Example
$ get rmon netbuf
Output
TotalNetBuf
: 116
TotalUsed
: 8
TotalFree
: 7
WaterMark
: 3
Threshold
: 116
ThresholdHitCount: 0
AllocFailCount
: 0
FreeFailCount
: 0
LastUserTask
: PKEV
LastFreeTask
: PKEV
LastUserFailTask :
LastFreeFailTask :
ThresholdHitTask :
LastUsedTime
: Thu Jan 01 00:04:45 1970
LastFreeTime
: Thu Jan 01 00:05:01 1970
LastUseFailTime
: -
ThresholdHitTime : -
Output field
505
Field
Description
TotalNetBuf
Total number of net buffers present in the
system.
TotalUsed
Total number of net buffers allocated by the
system since the system has come up. This is a
running counter and never decrements.
TotalFree
Total number of net buffers freed by the system
since the system has come up. This is a
running counter and never decrements.
WaterMark
WaterMark of the net buffer i.e. maximum
number of net buffers used by the system at
some point in time.
Threshold
Threshold value set for net buffer in the system
in terms of number of net buffers.
ThresholdHitCount
Number of times threshold has been hit for the
net buffer.
AllocFailCount
Number of times net buffer allocation has failed.
FreeFailCount
Number of times net buffer freeing has failed.
LastUserTask
Name of the task which has lastly allocated
(used)the net buffer.
LastFreeTask
Name of the task which has lastly deallocated
(freed) the net buffer.
LastUserFailTask
Name of the task which has lastly failed to
allocate (used) the net buffer.
8.22.5.2
LastFreeFailTask
Name of the task which has lastly failed to
deallocate (freed) the net buffer.
ThresholdHitTask
Name of the task which has lastly allocated
(used) the net buffer, causing threshold hit.
LastUsedTime
The last system time when net buffer was lastly
used.
LastFreeTime
The last system time when net buffer was lastly
freed.
LastUseFailTime
The last system time when the net buffer
allocation has lastly failed.
ThresholdHitTime
The last system time when the threshold has hit
while allocating the net buffer.
Get rmon netbuf threshold
Description: Use this command to get the critical events logged for the
netbuffer. This command will display 20 entries(maximum). Events are
logged for netbuffer in the following 3 cases:
• Allcation of net buffer failed.
• Threshold Hit.
Command Syntax: get rmon netbuf threshold
Parameters
None
Example
$ get rmon netbuf threshold
Output
Task Name : TSK1
ThresholdHitTimeStamp : Thu Jan 01 00:00:39 1970
Event Type :
Allocation Fail
Output field
Field
Description
Task Name
The name of Task which tries to allocate the
netbuffer during a critical event.
ThresholdHitTimeStamp
The system time when event logging is done.
Event Type
Cause of event logging.
Its value can be:
Allocation Fail - If allocation of net buffer has
failed.
Threshold Hit - If threshold value of net buffer
has been hit while allocation.
8.22.5.3
Reset rmon netbuf
Description: Use this command to reset some parameters of netbuf.
This command will reset the following parameters of netbuf.
• Set ThresholdCount value to zero.
• Set AllocFailCount value to zero
• Set WaterMark to the number of net buffers currently used by
system.
• Set FreeFailCount value to the zero.
Command Syntax: reset rmon netbuf
506
Parameters
None
Example
$ reset rmon netbuf
Output Field(s)
None
8.22.6
RMON Semaphore info Commands
8.22.6.1
Get rmon semaphore
Description: Use this command to get the information about all the
semaphores present in the system.
Command Syntax: get rmon semaphore
Parameters
None
Example
$ get rmon semaphore
Output
Name
First Task
Count
Suspend Type
Tasks Waiting
-------------------------------------------------------------SACL4
-
1
FIFO
0
Output field
Field
Description
Name
This specifies the name of the semaphore.
Count
This specifies the current instance count of the
semaphore.
Suspend Type
This specifies the task suspended type on this
semaphore. It can be either FIFO type or
priority type.
Task Waiting
This specifies the number of tasks waiting on
this semaphore.
First Task
This specifies the name of the first task
suspended on the semaphore.
8.22.7
RMON Event Group info Commands
8.22.7.1
Get rmon eventgrp
Description
Use this command to get the information about all the event groups
present in the system.
Command Syntax: get rmon eventgrp
Parameters
None
Example
$ get rmon eventgrp
507
Output
Name
First Task
Event Flags
Tasks Waiting
------------------------------------------------------------EDSLM11
DSLM
0
1
Output field
508
Field
Description
Name
This specifies the name of the event flag group.
Count
This specifies the current event flags.
Suspend Type
This specifies the task suspended type on this
semaphore. It can be either FIFO type or
priority type.
Task Waiting
This specifies the number of tasks waiting on
the event flag group.
First Task
This specifies the name of the first task
suspended on the event flag group.
8.23
SNMP Commands
8.23.1
SNMP Comm Commands
8.23.1.1
Get snmp comm
Description: Use this command to get.
Command Syntax: get snmp comm [community <community-val >]
8.23.1.2
Create snmp comm
Description: Use this command to create.
Command Syntax: create snmp comm community <community-val
> [access ro | rw]
8.23.1.3
Delete snmp comm
Description: Use this command to delete.
Command Syntax: delete snmp comm community <community-val>
Parameter
Name
Description
community
<community-val >
access ro | rw
This specifies the Community name.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
This specifies the access permissions given to
man-agers with this community name. ro implies
Read Only permissions and rw implies Read-Write
per-missions.
Type: Create - Optional
Default value: ro
Example $ create snmp comm community public
Output
Verbose Mode On
Verbose Mode On
Entry Created
Access community
-----------------------------------------------------------ro
public
Verbose Mode Off:
Entry Created
Output field description
Field
Description
community
This specifies the Community name.
This specifies the access permissions given to
man-agers with this community name.ro implies
Read Only permissions and rw implies Read-Write
per-missions.
Access
References
• SNMP commands
509
8.23.2
SNMP Host Commands
8.23.2.1
Get snmp host
Description: Use this command to get.
Command Syntax: get snmp host
8.23.2.2
Create snmp host
Description: Use this command to create.
Command Syntax: create snmp host ip <ip-address > community
<community-val >
8.23.2.3
Delete snmp host
Description: Use this command to delete.
Command Syntax: delete snmp host ip <ip-address > community
<community-val >
Parameter
Name
Description
This specifies the IP address of the manager
that has access permissions.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
This specifies the Community name. This must
be a valid community in the snmp community
table.
Type: Create - Mandatory
Delete - Mandatory
Get - Optional
ip <ip-address >
community
<community-val >
Example
$ create snmp host ip 172.25.34.34 community public
Output
Verbose Mode On
Entry Created
Host Address
Community
-------------------------------------------------------------172.25.34.34
public
Verbose Mode Off:
Entry Created
Output field description
Field
Ip Address
Community
References
• SNMP commands
510
Description
This specifies the IP address of the manager
that has access permissions.
This specifies the Community name. This must
be a valid community in the snmp community
table.
8.23.3
SNMP Stats Commands
8.23.3.1
Snmp stats
Description: Use this command to get.
Command Syntax: get snmp stats
8.23.3.2
Modify snmp stats
Description: Use this command to modify.
Command Syntax: modify snmp stats [authentraps enable | disable]
Parameter
Name
Description
Indicates whether the SNMP agent process is
permitted to generate authentication-failure
traps. The value of this object overrides any
configuration information; as such, it provides a
means whereby all authentication-failure traps
may be disabled.
authentraps enable
|disable
Type: Modify - Optional
Default value: disable
Example $ get snmp stats
Output
InPkts
: 100
OutPkts
InBadVersions
: 0
InBadCommunityNames : 0
InBadCommunityUses : 0
InASNParseErrs
InNoSuchNames
: 100
: 0
InTooBigs
: 0
InBadValues
: 0
InReadOnlys
: 0
: 0
InGenErrs
: 0
InTotalReqVars
: 200
InTotalSetVars
: 0
InGetRequests
: 100
InGetNexts
: 0
InSetRequests
: 0
InGetResponses
: 0
InTraps
: 0
OutTooBigs
: 0
OutNoSuchNames
: 0
OutBadValues
: 0
OutGenErrs
: 0
OutGetRequests
: 0
OutGetNexts
: 0
OutSetRequests
: 0
OutGetResponses
: 100
OutTraps
: 0
AuthenTraps
: disable
SilentDrops
: 0
ProxyDrops
: 0
Output field description
Field
InPkts
OutPkts
InBadVersions
InBadCommunityNames
InBadCommunityUses
InASNParseErrs
511
Description
The total number of Messages delivered to the
SNMP entity from the transport service.
The total number of SNMP Messages which
were passed from the SNMP protocol entity to
the transport service.
The total number of SNMP Messages which
were delivered to the SNMP protocol entity and
were for an unsupported SNMP version.
The total number of SNMP Messages delivered
to the SNMP protocol entity which used a
SNMP com-munity name not known to say
entity.
The total number of SNMP Messages delivered
to the SNMP protocol entity which represented
an SNMP operation which was not allowed by
the SNMP community named in the Message.
The total number of ASN.1 or BER errors
InTooBigs
InNoSuchNames
InBadValues
InReadOnlys
InGenErrs
InTotalReqVars
InTotalSetVars
InGetRequests
InGetNexts
InSetRequests
InGetResponses
InTraps
OutTooBigs
OutNoSuchNames
OutBadValues
OutGenErrs
OutGetRequests
512
encountered by the SNMP protocol entity when
decoding received SNMP Messages.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity and for
which the value of the error-status field is
'tooBig'.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity and for
which the value of the error-status field is
'noSuchName'.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity and for
which the value of the error-status field is
'badValue'.
The total number valid SNMP PDUs which were
de-livered to the SNMP protocol entity and for
which the value of the error-status field is
`readOnly'. It should be noted that it is a
protocol error to generate an SNMP PDU which
contains the value 'readOnly' in the error-status
field, as this object is provided as a means of
detecting incorrect implementations of the
SNMP.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity and for
which the value of the error-status field is
'genErr'.
The total number of MIB objects which have
been retrieved successfully by the SNMP
protocol entity as the result of receiving valid
SNMP Get-Request and Get-Next PDUs.
The total number of MIB objects which have
been altered successfully by the SNMP protocol
entity as the result of receiving valid SNMP SetRequest PDUs.
The total number of SNMP Get-Request PDUs
which have been accepted and processed by
the SNMP protocol entity.
The total number of SNMP Get-Next PDUs
which have been accepted and processed by
the SNMP protocol entity.
The total number of SNMP Set-Request PDUs
which have been accepted and processed by
the SNMP protocol entity.
The total number of SNMP Get-Response
PDUs which have been accepted and
processed by the SNMP protocol entity.
The total number of SNMP Trap PDUs which
have been accepted and processed by the
SNMP protocol entity.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity and for
which the value of the error-status field is
'tooBig'.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity and for
which the value of the error-status is
'noSuchName'.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity and for
which the value of the error-status field is
'badValue'.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity and for
which the value of the error-status field is
'genErr'.
The total number of SNMP Get-Request PDUs
which have been generated by the SNMP
protocol entity.
OutGetNexts
OutSetRequests
OutGetResponses
OutTraps
AuthenTraps
SilentDrops
ProxyDrops
The total number of SNMP Get-Next PDUs
which have been generated by the SNMP
protocol entity.
The total number of SNMP Set-Request PDUs
which have been generated by the SNMP
protocol entity.
The total number of SNMP Get-Response
PDUs which have been generated by the
SNMP protocol entity.
The total number of SNMP Trap PDUs which
have been generated by the SNMP protocol
entity.
Indicates whether the SNMP agent process is
permitted to generate authentication-failure
traps. The value of this object overrides any
configuration infor-mation; as such, it provides a
means whereby all au-thentication-failure traps
may be disabled.
The total number of GetRequest-PDUs,
GetNextRequest-PDUs, GetBulkRequestPDUs, SetRe-quest-PDUs, and InformRequestPDUs delivered to the SNMP entity which were
silently dropped be-cause the size of a reply
containing an alternate Re-sponse-PDU with an
empty variable-bindings field, was greater than,
either a local constraint, or the maximum
message size associated with the origi-nator of
the request.
The total number of GetRequest-PDUs,
GetNex-tRequest-PDUs, GetBulkRequestPDUs, SetRequest-PDUs, and InformRequestPDUs delivered to the SNMP entity, which were
silently dropped, be-cause the transmission of
the (possibly translated) message to a proxy
target failed in a manner (other than a time-out)
such that no Response-PDU could be returned.
References
• SNMP commands.
8.23.4
SNMP Traphost Commands
8.23.4.1
Get snmp traphost
Description: Use this command to get.
Command Syntax: get snmp traphost [ip <ip-address>] [port <portval >]
8.23.4.2
Create snmp traphost
Description: Use this command to create.
Command Syntax: create snmp traphost ip <ip-address >
community <community-val > [port <port-val >] [version v1 | v2c]
8.23.4.3
Delete snmp traphost
Description: Use this command to delete.
Command Syntax: delete snmp traphost ip < ip-address > [port
<port-val >]
8.23.4.4
Modify snmp traphost
Description: Use this command to modify
Command Syntax: modify snmp traphost ip <ip> [port <port>]
[version v1 | v2c] [severity critical | major | minor | info]
Parameter
513
Name
Description
ip<ip-address >
This specifies the IP address of the manager
where trap is to be sent.
Type: Create - Mandatory
Delete - Mandatory
Modify - Mandatory
Get - Optional
This specifies the Port at which the trap is to be
sent.
Type: Create -Optional
Get - Optional
Modify - Optional
Delete - Optional
This specifies the Trap version to be sent to the
Manager.
Type: Create-Optional
Get - Optional
Modify - Optional
Default value: v2c
This specifies the Trap severity which is used for
trap classification.The given trap severity will be
used for filtering of traps on per manager basis
i.e. manager will receive traps on the basis of
configured severity
Type: Create - Optional
Modify - Optional
port <port-val >
version v1 | v2c
severity critical | major
| minor | info
Example
$ create snmp traphost ip 172.25.34.34 port 162 community public version v2c
severity minor
Output
Verbose Mode On
Entry Created
Ip Address : 172.25.34.34
Community
: public
Port
: 162
Severity
: minor
Version : v2c
Verbose Mode Off:
Entry Created
Output field description
Field
Description
Ip Address
This specifies the IP address of the manager
where trap is to be sent.
This specifies the Port at which the trap is to be
sent.
This specifies the Community name used in the
trap.
This specifies the Trap version to be sent to the
Manager
This specifies the Trap severity which is used for
trap classification.The given trap severity will be
used for filtering of traps on per manager basis
i.e. manager will receive traps on the basis of
configured severity
Port
Community
Version
Severity
514
8.24
SNTP Commands
8.24.1
SNTP Cfg Commands
8.24.1.1
Get sntp cfg
Description: Use this command to get.
Command Syntax: get sntp cfg
8.24.1.2
Modify sntp cfg
Description: Use this command to modify.
Command Syntax: modify sntp cfg [enable | disable]
Parameter
Name
Description
enable|disable
This specifies whether the SNTP service is
enabled or disabled. True means that SNTP is
enabled and False means that SNTP is disabled.
Type: Modify - Optional
Valid values: enable, disable
Example
$ modify sntp cfg enable
Output
Verbose Mode On/Off
Status : Enable
Output field description
Name
Description
Status
This specifies whether the SNTP service is
enabled or disabled. True means that SNTP is
enabled and False means that SNTP is disab
8.24.2
SNTP servaddr Commands
8.24.2.1
Get sntp servaddr
Description: Use this command to get.
Command Syntax: get sntp servaddr
8.24.2.2
Create sntp servaddr
Description: Use this command to create.
Command Syntax: create sntp servaddr <ip-address>
Example
$ create sntp servaddr 172.23.3.45
Output
Verbose Mode On
Verbose Mode On
Entry Created
Server Addr : 172.23.3.45
Verbose Mode Off
Entry Created
515
Status : Standby
Output field description
Field
Server Addr
Status
8.24.3
SNTP Stats Commands
8.24.3.1
Get sntp stats
Description
This specifies the IP Address of the SNTP
Server.
Server is in Use. OR Server is in standby mode
i.e. not in use.
Description: Use this command to get.
Command Syntax: get sntp stats
8.24.3.2
Reset sntp stats
Description: Use this command to reset.
Command Syntax: reset sntp stats
Example
$ get sntp stats
Output
Verbose Mode On/Off
Requests count
: 0
Invalid Response count : 0
Response count
: 0
Lost Response count : 0
Last Time Stamp [MM/DD/YYYY::HH:MM:SS] : Thu Jan 01 00:00:00
1970
Output field
Field
Requests count
Responses count
Invalid Responses
count
Lost Responses count
Last Time Stamp
[MM/DD/
YYYY::HH:MM:SS]
516
Description
This specifies the number of requests sent to
SNTP
Server.
This specifies the Number of responses received
from SNTP Server.
This specifies the Number of invalid responses
received from SNTP Server.
This specifies the number of responses which do
not come within time limit.
This specifies time at which the local clock was
last set or corrected. The display format shall be
mm/dd/ yyyy:hr:min:sec.
8.25
System Commands
8.25.1
Cbuftrace cfg Commands
8.25.1.1
Get cbuftrace cfg
Description: Use this command to get.
Command Syntax: get cbuftrace cfg [module <module-val>]
8.25.1.2
Reset cbuftrace cfg
Description: Use this command to reset.
Command Syntax: reset cbuftrace cfg module <module-val>
Parameters
Name
module <module-val>
Description
This specifies the module, for which c-buftrace
configuration is to be modified
Type: Reset -- Mandatory
Get -- Optional
Example
$ get cbuftrace cfg module GAG
Output
module : GAG
flow
: 3
level : 0xff
Output field
Field
Description
module
This specifies the module, for which c-buftrace
configuration is to be modified
flow
This indicates a Hexadecimal bitmask, which
sets the filter for c-buftrace flow.
level
This indicates a Hexadecimal bitmask, which
sets the filter for c-buftrace level.
8.25.2
System Configuration Save and Restore Commands
8.25.2.1
Commit
Description: Use this command to commit the active configuration to
the flash. This command is not supported
Command Syntax: commit [nbsize]
Parameters:
None
Example
$ commit
Output
Set Done
Caution
This command will take some time to execute.
517
References
• reboot command
• Download command.
8.25.2.2
Reboot
Description: Use this command to reboot the system and to set the
boot configuration.
Command Syntax: reboot [control <nvram|network>] [dataplane
<nvram|network>] [config <network | default | last | backup | clean |
minimum | safe >]
Parameters
Name
Description
control
<nvram|network>
This specifies whether the control plane binaries are
to be fetched from the network or the binaries already
present in NVRAM are to be used.
Type : Optional
Default value: Binary present in NVRAM.
dataplane
<nvram|network>
This specifies whether the data plane binaries are to
be fetched from the network or the binaries already
present in NVRAM are to be used.
Type: Optional
Default value: Binaries present in NVRAM.
This specifies the boot configuration – the
<last|backup|clean|minimum> source, from which to
boot up. The boot configuration is set to last
automatically, whenever a commit command is given.
The boot configuration being an optional parameter, if
it is not specified, it retains the previous value. So
giving reboot after a commit will result in a reboot from
the committed configuration.
Default: Use Default factory configuration while
booting up.
Backup: Use the Backup configuration to boot the
system.
Last: Use last committed configuration to boot the
system.
config
<network|default|
Minimum: Use a configuration in which:
last|backup|clean|minim • the size command is executed.
um>
• the user (login name and password as root) is
created.
• an Ethernet interface with IP address 192.168.1.1
mask 255.255.0.0 is created.
Clean: The system comes up with nothing configured.
Network: The system fetches the default configuration
file from the remote host and system comes up with
this default configuration, fd.cfg.
Type : Optional
Default value: If a reboot is being given for the first
time, then the default value is default. Otherwise, the
default value is the same as what was given the last
time.
Mode: Super-User.
Example
$ reboot
Output None
Output Fields None
518
References
• Commit command.
8.25.3
System Control Table Commands
8.25.3.1
Create user
Description: Use this command to create a user account. A maximum
two accounts can exist.
Command Syntax: create user name <user-name> passwd
<password> [root|user]
8.25.3.2
Delete user
Description: Use this command to delete a user login.
Command Syntax: delete user name <user-name>
8.25.3.3
Get user
Description: Use this command to display information of all the users.
Password information isnot displayed.
Command Syntax: get user
Parameters
Name
Description
Name <user-name>
passwd <password>
Root|user
Example
This specifies the User Name to be created.
Type: Mandatory
Valid values: String of up to 64 characters ( ‘A’‘Z’, ‘a’-‘z’, ‘0’-‘9’,’-‘,’_’) and any combination of
printable
characters excluding “;”
This specifies the password required by this user
to
login to the unit.
Type : Mandatory
Valid values: String of up to 64 characters ( ‘A’‘Z’, ‘a’-‘z’, ‘0’-‘9’,’-‘,’_’) and any combination of
printable characters excluding “;”.
This indicates the privilege level of the user.
Type : Optional
Default value: user
$ create user name user1 passwd temp1 user
Output
Verbose Mode On
Entry Created
Privilege
UserName
---------------------user
user1
Verbose Mode Off
Entry Created
Output Fields
FIELD
UserName
Privilege
References
519
Description
This shows the new user login, which has been
cre-ated.
This represents the privilege level associated with
the user name shown. It may be: user, root
• Delete user command.
• get user command
• passwd related commands.
8.25.3.4
Passwd
Description: Use this command to change the password associated
with a user login. An ordinary user may change the password for
another user if he knows the old password. However, the root does not
need to know a user’s existing password before changing it. The
passwords are not echoed on to the screen.
Command Syntax: passwd [name]
Parameters
Name
Description
name
The id of the user whose password is to be
changed. If not specified then the current user is
as-sumed.
Type: Mandatory, if user is logged in through
serial port and user authentication is disabled
through se-rial port. Otherwise, Optional.
Valid values: String of up to 64 characters (All
print-able characters except ‘;‘)
Mode: Super-User, User.
Example Normal Usage
Normal Usage
$passwd
Old Password:
New Password:
Confirm New Password:
Set Done.
Super User (for ordinary user)
$passwd User1
Enter New Password:
Confirm New Password:
Set Done.
Output
None
Caution
None.
References
• user command
8.25.4
System crash info commands
8.25.4.1
Get system crash info
Description: T This command is used to display a list of crashes that
were encountered by the system. This command is not supported on
the Flashless system.
Command Syntax: get system crash info [numentries <numentriesval>] [showview [general | ctrlandstatusregs | stackregs | stackinfo |
altwinregs | stdwinregs | stdwinregsdetailed | coprocessorregs] +]
Parameters
Name
520
Description
Numentries
<numentries-val>
This specifies the last <numentries> number of
crashes encountered in the system.
Type: Optional
Valid values: 1 to 128
Default : 1
showview general |
ctrlandstatusregs |
stackregs | stackinfo |
altwinregs | stdwinregs |
stdwinregsdetailed |
coprocessorregs]+
The optional showview parameter shall help the
user to view selective details of the crash dump.
The information on any one or combination of
crash dump sections can be retrieved by ORing
the following parameters:
•general
•ctrlandstatusregs
•stackregs
•stackinfo
•altwinregs
•stdwinregs
•stdwinregsdetailed
•coprocessorregs
Note: You cannot use the stdwinregs and
stdwinregsdetailed parameters simultaneously.
Mode: Super-User, User
Example
$ get system crash info numentries 1 showview general
ctrlandstatusregs stackregs stackinfo altwinregs stdwinregs
coprocessorregs
Output
General crash info
Crash Id
: 1
Crash IU
: 0
Time of Crash
: Thu Jan 01 00:00:43 1970
DP Version
: DP_B02_10_15_09_ip1000a
CP Version
: COL2.10.3.0.060317
Crash Cause
: CP crashed after DP Init
SystemUpTime
Days
Hours
Mins
Secs
-------------------------------------------------------0
0
0
43
User Crash Info :
Control And Status Registers
PSR Reg
: 0x940060c7
0x1
Single Fault PC
: 0x4d3cdb8
0x4d3cdbc
Double Fault PC
: 0x0
0x0
Y Reg MSW
: 0x0
0x12345678
Single Fault Trap Num : 0x7
0xffffffff
Fault Status Reg
: 0x14
0xcf70
IER
: 0x2000
0x4f7a070
Alternate Window # 0x1f
Reg#:Local
:
In
0 : 0x0
: 0x0
2 : 0x0
: 0x0
521
Wim Reg
:
Single Fault nPC
:
Double Fault nPC
:
Y Reg LSW
:
Double Fault Trap Num :
Double Fault Reg
:
Trap Base Reg
:
|Reg#:Local
| 1 : 0x0
| 3 : 0x0
:
In
: 0x0
: 0x0
|
4
6
: 0x0
: 0x0
: 0x0
: 0x0
| 5
| 7
: 0x0
: 0x0
: 0x0
: 0x0
Alternate Window # 0x1e
Reg#:Local
:
In
0 : 0x0
: 0x0
2 : 0x0
: 0x0
4 : 0x0
: 0x0
6 : 0x0
: 0x0
|Reg#:Local
| 1 : 0x0
| 3 : 0x0
| 5 : 0x0
| 7 : 0x0
:
:
:
:
:
In
0x0
0x0
0x0
0x0
|
Alternate Window # 0x1d
Reg#:Local
:
In
0 : 0x0
: 0x0
2 : 0x0
: 0x0
4 : 0x0
: 0x0
6 : 0x0
: 0x0
|Reg#:Local
| 1 : 0x0
| 3 : 0x0
| 5 : 0x0
| 7 : 0x0
:
:
:
:
:
In
0x0
0x0
0x0
0x0
|
|Reg#:Local
| 1 : 0x0
| 3 : 0x0
| 5 : 0x0
| 7 : 0x0
:
:
:
:
:
In
0x0
0x0
0x0
0x0
|
....
....
....
Alternate Window # 0x18
Reg#:Local
:
In
0 : 0x0
: 0x0
2 : 0x0
: 0x0
4 : 0x0
: 0x0
6 : 0x0
: 0x0
Current Standard Window Dump # 0x8
Registers :
Global
New Func Called
0
: 0x0
0x30800005
1
: 0x0
2
: 0x7
0x2800005
3
: 0x18
4
: 0x4f6cca8
0x52bdce0
5
: 0x144805cc
6
: 0x5c67400
0x52bdc18
7
: 0x0
0x4ce765c
:
Out
:
Local
:
In
: 0x0
: 0x1
:
: 0x0
: 0x0
: 0x52a7164
: 0x5c67400
: 0x0
:
: 0x5
: 0x4f6cca8
: 0x5c67400
: 0x0
: 0x2
:
: 0x1
: 0x52bdbb0
: 0xffff
: 0x59ec
: 0x0
:
: 0x4f6e040
: 0x0
:
Standard Window Dump # 0x9
Registers :
0
:
1
:
2
:
0x4fcbf38
3
:
4
:
5
:
0x51eb851f
6
:
0x52bdc98
522
Global
0x0
0x0
0x7
:
Out
: 0x30800005
: 0x0
: 0x2800005
:
Local
: 0x1
: 0x52bde30
: 0x2
:
In
: 0x0
: 0xf
:
0x18
0x4f6cca8
0x144805cc
: 0x2
: 0x52bdce0
: 0x0
: 0x5c67400
: 0x0
: 0x5c67000
: 0xf
: 0x567
:
0x5c67400
: 0x52bdc18
: 0x0
:
7
: 0x0
0x4ce591c
: 0x4ce765c
: 0x0
:
Standard Window Dump # 0xa
Registers
0
0x542a810
1
2
0x5abc6f8
3
0x542a810
4
0x5c36448
5
0x5b69300
6
0x52bdd18
7
0x4ce52f0
:
Global
: 0x0
:
Out
: 0x0
:
Local
: 0x5b70ed0
:
:
In
: 0x0
: 0x7
: 0xf
: 0x4fcbf38
: 0x52bde18
: 0x20000000
: 0x0
:
: 0x18
: 0xf
: 0x0
:
: 0x4f6cca8
: 0x567
: 0x4f6cbb8
:
: 0x144805cc
: 0x51eb851f
: 0xffffffff
:
: 0x5c67400
: 0x52bdc98
: 0x0
:
: 0x0
: 0x4ce591c
: 0x52bdcd9
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
....
....
....
Wim Window # 0x0
Registers
0
1
2
3
4
5
6
0x5c67410
7
0x4f62f7c
:
:
:
:
:
:
:
:
Global
0x0
0x0
0x7
0x18
0x4f6cca8
0x144805cc
0x5c67400
: 0x0
Out
0x0
0xb
0x0
0x5c67400
0xffffffff
0x0
0x52bdff8
: 0x0
Local
0x0
0x0
0x0
0x0
0x0
0x0
0x0
: 0x0
:
In
0x0
0x0
0x0
0x0
0x0
0x0
Standard Window Dump # 0x1
Registers
0
0x57e2688
1
2
3
4
0x54758a4
5
6
0x5c67410
7
0x4d501fc
:
Global
: 0x0
:
Out
: 0x0
:
Local
: 0x0
:
:
:
:
:
:
:
:
:
:
:
:
:
:
: 0x0
: 0xf7
: 0xe7
:
0x0
0x7
0x18
0x4f6cca8
0x0
0x0
0x0
0x0
0x52bd8e5
0x1
0x0
0x0
In
: 0x144805cc
: 0x5c67400
: 0x0
: 0x5c67410
: 0x0
: 0x8000
: 0x40
:
: 0x0
: 0x4f62f7c
: 0x52a69a8
:
:
Local
: 0x944060c2
: 0x4d4bbec
: 0x4d4bbf0
:
In
: 0xedd
: 0x0
: 0x0
Standard Window Dump # 0x2
Registers
0
1
2
523
:
Global
: 0x0
: 0x0
: 0x7
:
Out
: 0x57e2688
: 0x0
: 0xf7
3
4
5
6
0x5c67410
7
0x4a58968
:
:
:
:
0x18
0x4f6cca8
0x144805cc
0x5c67400
: 0x0
:
:
:
:
0xe7
0x54758a4
0x40
0x5c67410
: 0x4d501fc
Coprocessor Register Dump
CCSR Register
: 0x2f7f72a7
0x7fffffff
CCPR Register
: 0xfe5bf8b7
CCIR Register
: 0xffffffff
0xffffffff
CCOBR Register
: 0xfffffffe
0xdfffffff
Call Stack
StackDepth
StackPtr
8
0x52bdbb0
7
0x52bdc18
6
0x52bdc98
5
0x52bdd18
4
0x52bdd90
3
0x52bde30
2
0x52bdec8
:
:
:
:
: 0x0
: 0x0
: 0x0
:
: 0x1
:
CCCRC Register
:
CCIBR Register
:
CCOR Register
:
at the time of Crash :
:
CallAddress :
Return Address:
Frame Ptr
:
: 0x4f6e040
: 0x4ce765c
:0x52bdc18
:
: 0x4ce765c
: 0x4ce591c
:0x52bdc98
:
: 0x4ce591c
: 0x4ce52f0
:0x52bdd18
:
: 0x4ce52f0
: 0x4ce3140
:0x52bdd90
:
: 0x4ce3140
: 0x4ce333c
:0x52bde30
:
: 0x4ce333c
: 0x4ce44dc
:0x52bdec8
:
: 0x4ce44dc
: 0x4f62830
:0x52bdf90
:
Stack dump at the
0x052bb528: 00 00
0x052bb538: 00 00
0x052bb548: 00 00
0x052bb558: 00 00
0x052bb568: 00 00
0x052bb578: 00 00
0x052bb588: 00 00
0x052bb598: 00 00
0x052bb5a8: 01 23
0x052bb5b8: 05 2b
0x052bb5c8: 05 2b
0x052bb5d8: 05 2b
0x052bb5e8: 00 00
0x052bb5f8: 00 00
0x052bb608: 00 00
0x052bb618: 00 00
0x052bb628: 00 00
0x052bb638: 05 a5
0x052bb648: cc cc
0x052bb658: 00 01
0x052bb668: 00 00
0x052bb678: 00 00
0x052bb688: 05 2b
0x052bb698: 00 00
0x052bb6a8: 00 00
time of Crash:
00 00 00 00 00
00 00 00 00 00
00 00 00 00 00
00 00 00 00 00
00 00 00 00 00
00 00 00 00 04
00 00 00 00 00
00 00 00 00 00
45 67 00 00 21
b5 f0 05 bf c4
bb d8 04 a4 0a
b5 f0 00 00 00
3a d4 00 00 00
00 00 05 a5 14
00 00 00 00 00
00 21 00 00 21
00 00 00 00 00
f2 3c 05 2b b0
cc cd 00 00 3a
38 00 05 a4 d9
00 01 00 00 00
00 00 05 2b b7
bd 88 05 2b b7
00 00 00 00 00
00 77 00 00 3a
00
00
00
00
00
04
04
00
44
00
40
24
00
50
00
47
00
08
d4
50
01
28
28
00
d4
00
00
00
00
00
00
05
00
00
00
00
00
0d
00
00
00
05
00
00
ff
00
05
05
00
00
00
00
00
00
00
00
a4
00
00
00
00
00
0a
00
00
00
a5
00
00
ff
00
2b
a5
00
00
Task for which stack over flow occur
_______________________________________
524
0x2000708
0x0
0x5c67000
0x0
00
00
00
00
00
00
d9
12
00
00
00
00
00
00
00
00
14
00
00
ff
00
bd
14
00
00
00
00
00
00
27
23
50
34
00
00
17
15
40
00
00
00
68
1d
01
bc
02
88
68
00
00
00
00
00
00
00
00
00
05
05
80
ff
05
04
00
00
00
00
00
00
00
05
05
04
05
00
00
00
00
00
00
00
00
a5
a4
00
ff
a4
b8
00
00
00
00
00
00
00
26
a5
a4
a6
00
00
00
00
00
00
00
00
14
d9
00
ff
d9
24
00
00
00
00
00
00
3a
47
14
43
13
00
00
00
00
00
00
00
00
68
50
02
ff
7c
78
00
00
00
00
17
01
d4
f0
50
8c
2c
00
NO Stack Overflow
Output Fields
Field
Description
Crash Id
The crash number.
Crash IU
The internal processor number.
Time of Crash
This specifies the time of the crash.
DP Version
Version of Crashed DP
CP Version
Version of Crashed CP
Crash Cause
This specifies the crash cause. Following are the
possible causes:
- Ctrl Transfer To CP Failed
- Crash in CP self processing
- DP Init Failure
- CP crashed after DP Init
- DP crashed after DP Init
- DP internal Failure
- System in Loop
- Crash in DP Processing
SystemUpTime
This specifies the system up time in:
Days : Hours : Minutes : Seconds
525
PSR Reg
This specifies the value of the processor state
register at the time of the crash.
Wim Reg
The window invalid mask register.
PC
This specifies the value of the program counter
at the time of the crash.
nPC
This specifies the value of the next program
counter at the time of the crash.
Y Reg MSW
This specifies the value of MSW of the Y
Register at the time of the crash.
Y Reg LSW
This specifies the value of LSW of the Y
Register at the time of the crash.
Trap Num
This specifies the number of traps that caused
the crash.
Trap Base Reg
This specifies the value of the Trap Base
register at the time of the crash.
Fault Status Reg
This specifies the value of the Fault Status
Register at the time of the crash.
Double Fault Reg
This specifies the value of the Double Fault
Register at the time of the crash.
IER
This specifies the value of the Implementation
Extension Register at the time of the crash.
Alternate Window Reg# Local
For crashes involving Alternate Windows, this
capture specifies all local register for Alternate
Windows # 24 to 31 (0x1f to 0x18).
Alternate Window Reg# In
For crashes involving Alternate Windows, this
capture specifies all input register for Alternate
Windows # 24 to 31(0x1f to 0x18).
Standard Window
Dump - Registers -
The Sparclet Global register.
Global
Standard Window
Dump - Registers - Out
The output registers of the specified Sparclet
Window.
Standard Window
Dump - Registers Local
Standard Window
Dump - Registers - In
The input registers of the specified Sparclet
Window.
CCSR Register
The CCP Status register.
CCCRC Register
The CCP CRC register.
CCPR Register
The CCP Polynomial register.
CCIR Register
The CCP InReg register.
CCIBR Register
The CCP InBuf register.
CCOBR Register
The CCP OutBuf register.
CCOR Register
The CCP OutReg register.
Stack at the time of the
Crash - StackDepth CallAddress
Stack at the time of the
Crash - StackDepth Return Address
Stack at the time of the
Crash - StackDepth Frame Ptr
Stack at the time of the
Crash - StackDepth StackPtr
Stack dump at the time
of Crash
The callee function address.
Tasks for which Stack
Overflow Occurred
In case the crash is due to stack overflow, the
task for which stack overflow has occurred will
be displayed here. Otherwise, it would specify
that stack overflow hasn't occurred - meaning
that the crash is due to some other reason.
The local registers of the specified Sparclet
Window.
The return address back to the caller function.
The frame pointer at the time of the call.
The stack pointer at the time of the call.
The stack dump at the time of crash. The total
size of the dump would be the minimum
between the hash define 400 and the total
number of bytes actually in the stack.
Note: The Current Standard Window dump displays the current dump
corresponding to Global, Out, Local, and In.
8.25.4.2
Get system crash configinfo
Description: This command gets system crash configuration
parameters..
Command Syntax: get system crash configinfo
8.25.4.3
Modify system crash configinfo
Description: This command modifies system crash configuration
parameters
Command Syntax: modify system crash configinfo [action reboot |
debug]
Parameters
526
Name
Description:
Action reboot|debug
This parameter defines the state of the system
after a DP IU crashes. If the action is set to
reboot, the system shall reboot after DP IU
crash. If it is set to debug, the system shall not
reboot and a CLI prompt shall be given to the
user for further debugging.
Type
:Modify - Optional
Valid values : reboot - debug
Example
$ modify system crash configinfo action reboot
Output
Crash Config Info
: reboot
Output Fields
Field
Description
Crash Config Info
This parameter defines the state of the system
after a DP IU crashes. If the action is set to
reboot, the system shall reboot after DP IU
crash. If it is set to debug, the system shall not
reboot and a CLI prompt shall be given to the
user for further debugging.
8.25.5
System Info Commands
8.25.5.1
Get system info
Description: This command to get system parameters.
Command Syntax: get system info
8.25.5.2
Modify system info
Description: Use this command to modify the system parameters.
Command Syntax: modify system info [contact <sys-contact>]
[name <sys-name>] [location <sys-location>] [vendor <sys-vendorinfo>] [logthresh <sys-log-threshold>] [systime <systime>] [dst