You are on page 1of 923

Status

Change Note
Short Title

Released

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

3HH-01016-AAAA-TCZZA

Edition 03

Contents

Contents
1- ISAM CLI

1.1 Preface . . . . . . . . .
1.2 CLI Commands . . . . .
1.3 Nodes . . . . . . . . . .
1.4 Parameters . . . . . . .
1.5 Filters . . . . . . . . . .
1.6 Printers . . . . . . . . .
1.7 Getting help . . . . . . .
1.8 The CLI Prompt . . . .
1.9 Entering CLI Commands

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

. 2
. 3
. 4
. 5
. 8
. 9
. 10
. 11
. 12

2- CLI Information
2.1 Help Command . . . .
2.2 Logout Command . .
2.3 History Command . .
2.4 Echo Command . . .
2.5 Telnet Command . . .
2.6 Exec Command . . .
2.7 Sleep Command . . .
2.8 Tree Command . . . .
2.9 Poll Command . . . .
2.10 Write Command . . .
2.11 Help Command . . .
2.12 Info Command . . .
2.13 Exit Command . . .
2.14 Back Command . . .
2.15 Delete Command . .
2.16 In Command . . . .
2.17 Configure Command
2.18 Action Command . .
2.19 Sample Command .
2.20 Show Command . .
2.21 Discard . . . . . . .

13
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3- Environment Configuration Commands

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

35

3.1 Environment Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4- Alarm Configuration Commands


4.1 Alarm Log Configuration Command . . . .
4.2 Alarm Entries Configuration Command . .
4.3 Alarm Delta Log Configuration Command
4.4 SHub Alarm Configuration Command . . .

37
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

5- Trap Configuration Commands

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

38
39
43
44

46

5.1 Trap Definition Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47


5.2 Trap Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
5.3 SHub Trap Manager Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . 52

6- Equipment Configuration Commands

3HH-01016-AAAA-TCZZA Edition 03

54

Released

Contents

6.1 Slot Configuration Command . . . . . . . .


6.2 Applique Configuration Command . . . . . .
6.3 Protection Group Configuration Command .
6.4 Protection Element Configuration Command
6.5 ISAM Configuration Command . . . . . . .
6.6 Rack Configuration Command . . . . . . . .
6.7 Shelf Configuration Command . . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

7- xDSL Configuration Commands

55
56
57
58
59
60
61

62

7.1 xDSL Common Service Profile Configuration Command . . . . .


7.2 xDSL Common Spectrum Profile Configuration Command . . . .
7.3 xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command
7.4 xDSL Spectrum Profile for RE-ADSL2 Configuration Command .
7.5 xDSL Spectrum Profile for ADSL2 Plus Configuration Command .
7.6 xDSL Spectrum Profile for VDSL Configuration Command . . . .
7.7 xDSL Line Configuration Command . . . . . . . . . . . . . . . . .
7.8 xDSL Line TCA Threshold Configuration Command . . . . . . . .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

8- ATM Configuration Commands

63
65
68
70
72
74
77
80

82

8.1 ATM PVC Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

9- Interface Management Configuration Commands

85

9.1 Network Interface Configuration Command . . . . . . . . . . .


9.2 Extend Interface Configuration Command . . . . . . . . . . .
9.3 Interface Alarm Configuration Command . . . . . . . . . . . .
9.4 SHub Management Interface Configuration Command . . . .
9.5 SHub IP Configuration Command . . . . . . . . . . . . . . . .
9.6 SHub Multi-Network Configuration Command . . . . . . . . .
9.7 SHub ICMP Configuration Command . . . . . . . . . . . . . .
9.8 SHub Port Control Configuration Command . . . . . . . . . .
9.9 SHub Interface Uplink Group Configuration Command . . . .
9.10 SHub Interface Uplink Group Portlist Configuration Command

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

10- Error Configuration Commands


10.1 Error Log Configuration Command

98

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

11- System Configuration Commands

100

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


11.2 System Management Host IP-Address Configuration Command . . . . .
11.3 System Management Default Route Configuration Command . . . . . . .
11.4 System SNTP Configuration Command . . . . . . . . . . . . . . . . . . .
11.5 SHub System SNTP Configuration Command . . . . . . . . . . . . . . .
11.6 SHub System ICMP Filter Configuration Command . . . . . . . . . . . .
11.7 SHub System ICMP Filter In Port List Configuration Command . . . . . .
11.8 SHub System ICMP Filter Out Port List Configuration Command . . . . .
11.9 SHub System TCP Filter Configuration Command . . . . . . . . . . . . .
11.10 SHub System TCP Filter In Port List Configuration Command . . . . . .
11.11 SHub System TCP Filter Out Port List Configuration Command . . . . .
11.12 SHub System UDP Filter Configuration Command . . . . . . . . . . . .
11.13 SHub System UDP Filter In Port List Configuration Command . . . . . .
11.14 SHub System UDP Filter Out Port List Configuration Command . . . . .
11.15 SHub System other Protocol Filter Configuration Command . . . . . . .
11.16 SHub System other Protocol Filter In Port List Configuration Command .
11.17 SHub System other Protocol Filter Out Port List Configuration Command
11.18 SHub System Vlan Filter Configuration Command . . . . . . . . . . . .
11.19 SHub System IP Group Configuration Command . . . . . . . . . . . . .

ii

Released

86
88
89
90
91
92
93
94
96
97

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

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

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

3HH-01016-AAAA-TCZZA

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

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

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

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

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

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

101
103
104
105
106
107
109
110
111
113
114
115
117
118
119
121
122
123
124

Edition 03

Contents

11.20 SHub System ID Configuration Command . . . . . . . .


11.21 SHub System Software Group Configuration Command
11.22 SHub System VLAN Group Configuration Command . .
11.23 SHub System HTTP Configuration Command . . . . . .

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

12- Security Configuration Commands

.
.
.
.

125
126
127
128

129

12.1 Security Banner Configuration Commmand . . . . . . . . . . . . . . . . .


12.2 Operator Configuration Command . . . . . . . . . . . . . . . . . . . . . .
12.3 Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . .
12.4 Security SNMP Community Configuration Command . . . . . . . . . . . .
12.5 SHub Security SNMP Community Configuration Command . . . . . . . .
12.6 Security Domain Configuration Command . . . . . . . . . . . . . . . . . .
12.7 Security Domain IP Pool Configuration Command . . . . . . . . . . . . .
12.8 Security Domain User Configuration Command . . . . . . . . . . . . . . .
12.9 Security Connection Profile Configuration Command . . . . . . . . . . . .
12.10 Security Connection Policy Configuration Command . . . . . . . . . . .
12.11 Security IP Address Pool Configuration Command . . . . . . . . . . . .
12.12 Security IP Address Pool Reserve Configuration Command . . . . . . .
12.13 Security Radius Client Configuration Command . . . . . . . . . . . . . .
12.14 Security Radius AUTH Server Configuration Command . . . . . . . . .
12.15 Security Radius Accounting Server Configuration Command . . . . . . .
12.16 Security Radius Dynamic AUTH Client Configuration Command . . . . .
12.17 Security Radius Policy Configuration Command . . . . . . . . . . . . . .
12.18 Security Radius Server Configuration Command . . . . . . . . . . . . .
12.19 Security 802.1x PAE System Configuration Command . . . . . . . . . .
12.20 Security 802.1x Port Authentication Configuration Command . . . . . .
12.21 Security 802.1x Extension, Port Authentication Configuration Command
12.22 Security 802.1x Port Configuration Command . . . . . . . . . . . . . . .
12.23 Security Password Policy Configuration Commmand . . . . . . . . . . .

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

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

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

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

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

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

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

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

13- Transaction Configuration Commands

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

130
131
133
136
137
139
141
142
143
144
145
146
147
148
150
152
153
155
156
157
159
160
161

162

13.1 Transaction Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

14- Software Management Configuration Commands

164

14.1 Software Management Overall Software Package Configuration Command . . . . . . . . 165

15- Ethernet Configuration Commands

168

15.1 Ethernet IP Configuration Command . . . . . . . . . . . . .


15.2 SHub Ethernet MAC-Filter Configuration Command . . . . .
15.3 SHub Ethernet MAC-Filter Port List Configuration Command
15.4 SHub Ethernet Rate Configuration Command . . . . . . . .

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

16- IGMP Configuration Commands


16.1 IGMP Channel Sources Configuration Command . . . .
16.2 IGMP Package Bitmaps Configuration Command . . .
16.3 IGMP System Configuration Command . . . . . . . . .
16.4 SHub IGMP IGS System Configuration Command . . .
16.5 SHub IGMP Response Timer Configuration Command
16.6 SHub IGMP Router Port Configuration Command . . .
16.7 SHub IGMP Vlan Filter Configuration Command . . . .

169
170
171
172

173
.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

17- Multicast Configuration Commands

174
175
176
178
179
180
181

182

17.1 Multicast General Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 183


17.2 Multicast Capacity Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 184
17.3 Multicast Sources Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 185

3HH-01016-AAAA-TCZZA Edition 03

Released

iii

Contents

18- IP Configuration Commands

186

18.1 VRF Configuration Command . . . . . . . . . . . . . . . .


18.2 VRF Route Configuration Command . . . . . . . . . . . .
18.3 VLAN Bundle Configuration Command . . . . . . . . . . .
18.4 IP SHub VRF Configuration Command . . . . . . . . . . .
18.5 IP SHub VRF Route Map . . . . . . . . . . . . . . . . . . .
18.6 IP SHub VRF route preference command . . . . . . . . . .
18.7 IP SHub VRF Route Configuration Command . . . . . . .
18.8 IP Shub Arp Configuration Command . . . . . . . . . . . .
18.9 IP Shub Arp Configuration Command Per Vlan . . . . . . .
18.10 IP Interface Network Configuration Command . . . . . . .
18.11 IP Interface Network VRF Configuration Command . . . .
18.12 IP Interface Network Numbered Configuration Command
18.13 IP Interface User Port Configuration Command . . . . . .
18.14 IP Interface User Port VRF Configuration Command . . .
18.15 IP Interface User Bridge Port Configuration Command . .
18.16 IP Interface User Port VRF Configuration Command . . .
18.17 IP User Gateway Interface VRF Configuration Command

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

19- VLAN Configuration Commands

187
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

205

19.1 VLAN General Configuration Command . . . . . . . . . . . . . . . . .


19.2 VLAN Configuration Command . . . . . . . . . . . . . . . . . . . . .
19.3 VLAN Filtering Database Configuration Command . . . . . . . . . . .
19.4 VLAN Protocol based Configuration Command . . . . . . . . . . . . .
19.5 SHub VLAN Configuration Command . . . . . . . . . . . . . . . . . .
19.6 SHub Static Egress Port for VLAN Configuration Command . . . . . .
19.7 SHub Static Untagged Egress Port for VLAN Configuration Command
19.8 SHub Multicast MAC Filtering Database Configuration Command . . .
19.9 SHub Multicast Filtering Configuration Command . . . . . . . . . . .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

20- Bridge Configuration Commands


20.1 Bridge General Configuration Command . . . . . . . . .
20.2 Bridge Port Configuration Command . . . . . . . . . . .
20.3 Bridge Port to VLAN Association Configuration Command
20.4 SHub Bridge Configuration Command . . . . . . . . . . .
20.5 SHub Bridge Port Configuration Command . . . . . . . .

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

.
.
.
.
.
.
.
.
.

206
207
209
210
212
214
215
216
217

218
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

21- Link Aggregation Configuration Commands

.
.
.
.
.

219
220
222
224
225

226

21.1 Link Aggregation Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 227


21.2 Link Aggregation Group Configuration Command . . . . . . . . . . . . . . . . . . . . . . 228

22- Rapid Spanning Tree Configuration Commands

230

22.1 RSTP Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231


22.2 RSTP Port Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

23- QoS Configuration Commands

233

23.1 QoS Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


23.2 QoS Single Dot1P Marker Configuration Command . . . . . . . . . . . . . . . . .
23.3 QoS Single DSCP Marker Configuration Command . . . . . . . . . . . . . . . . .
23.4 QoS DSCP Contract Table Marker Configuration Command . . . . . . . . . . . . .
23.5 QoS DSCP Contract Table Codepoint Configuration Command For Dscp-contract
23.6 QoS Dot1P And DSCP Contract Table Marker Configuration Command . . . . . .
23.7 DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract .
23.8 QoS Dot1P And Single DSCP Marker Configuration Command . . . . . . . . . . .
23.9 QoS Dot1P Alignment Marker Configuration Command . . . . . . . . . . . . . . .

iv

Released

3HH-01016-AAAA-TCZZA

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

234
235
236
237
238
239
240
241
242

Edition 03

Contents

23.10 QoS Policer profile Configuration Command . . . . . . . . . . .


23.11 QoS Queue Profile Configuration Command . . . . . . . . . .
23.12 QoS Scheduler Profile Configuration Command . . . . . . . . .
23.13 QoS CAC Profile Configuration Command . . . . . . . . . . . .
23.14 QoS Session Profile Configuration Command . . . . . . . . . .
23.15 QoS 802.1P Class to Queue Mapping Configuration Command
23.16 QoS DSL Link Configuration Command . . . . . . . . . . . . .
23.17 QoS LIM Queue Configuration Command . . . . . . . . . . . .
23.18 QoS DSCP to Dot1P L3 Traffic Configuration Command . . . .
23.19 SHub QoS Queue Configuration Command . . . . . . . . . . .
23.20 SHub QoS Traffic Class Configuration Command . . . . . . . .
23.21 SHub QoS Ingress Policing on Port . . . . . . . . . . . . . . .
23.22 SHub QoS Flows to be Policed . . . . . . . . . . . . . . . . . .
23.23 SHub QoS Policer Configuration Command . . . . . . . . . . .

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

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

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

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

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

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

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

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

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

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

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

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

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

24- PPPoX-Relay Configuration Commands

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

243
244
245
246
247
249
250
251
252
253
254
255
256
257

258

24.1 PPPoX CC Global Configuration Command . . . . . . . . .


24.2 PPPoX CC Engine Configuration Command . . . . . . . .
24.3 PPPoX CC Engine Monitoring Configuration Command . .
24.4 PPPoX CC Client Port Configuration Command . . . . . .
24.5 PPPoX CC Client Port Monitoring Configuration Command

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

25- PPPoE Configuration Commands

.
.
.
.
.

259
260
261
262
263

264

25.1 PPPoE Server Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265


25.2 PPPoE Profile Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
25.3 PPPoX Interface Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . 267

26- DHCP Relay Configuration Commands

268

26.1 DHCP Relay Agent Configuration Command . . . . . . . . .


26.2 DHCP Relay SHub Configuration Command . . . . . . . . .
26.3 DHCP Relay SHub Server Configuration Command per VRF
26.4 DHCP Relay SHub Agent Configuration Command per VRF .

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

27- OSPF Configuration Commands


27.1 OSPF Parameters Configuration Command . . . . .
27.2 OSPF Area Configuration Command . . . . . . . . .
27.3 OSPF Interface Configuration Command . . . . . . .
27.4 OSPF Interface Timers Configuration Command . . .
27.5 OSPF Interface MD5 Key Configuration Command . .
27.6 OSPF Interface Metric Configuration Command . . .
27.7 OSPF Aggregate Configuration Command . . . . . .
27.8 OSPF Stub Area Configuration Command . . . . . .
27.9 OSPF Interface Configuration Command . . . . . . .
27.10 OSPF Interface Timers Configuration Command . .
27.11 OSPF Interface MD5 Key Configuration Command .
27.12 OSPF Interface Metric Configuration Command . . .
27.13 OSPF Nssa Area Configuration Command . . . . .
27.14 OSPF Interface Configuration Command . . . . . .
27.15 OSPF Interface Timers Configuration Command . .
27.16 OSPF Interface MD5 Key Configuration Command .
27.17 OSPF Interface Metric Configuration Command . . .
27.18 OSPF NSSA Aggregate Configuration Command . .
27.19 OSPF Redistribution Configuration Command . . . .
27.20 OSPF Redistribution Route Configuration Command

269
271
272
273

274
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

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

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

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

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

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

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

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

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

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

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

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

28- RIP Configuration Commands

3HH-01016-AAAA-TCZZA Edition 03

.
.
.
.

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

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

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

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

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

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

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

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

275
276
277
278
279
281
282
283
284
285
286
288
289
290
291
292
294
295
296
297

298

Released

Contents

28.1 RIP Common Configuration Command . . . . .


28.2 RIP Redistribution Configuration Command . . .
28.3 RIP Interface Configuration Command . . . . .
28.4 RIP Interface Timers Configuration Command .
28.5 RIP Interface MD5 Key Configuration Command
28.6 RIP Route Aggregation Command . . . . . . . .
28.7 RIP Route Map Command . . . . . . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

29- XDSL Bonding Configuration Commands

.
.
.
.
.
.
.

299
300
301
302
303
304
305

306

29.1 xDSL Bonding Group Profile Configuration Command . . . . . . . . . . . . . . . . . . . . 307


29.2 xDSL Bonding Configuration Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

30- CPE Remote Configuration Commands

310

30.1 CPE Remote Management System Configuration Commands . . . . . . . . . . . . . . . . 311

31- Equipment Status Commands


31.1 Slot Status Command . . . . . . . .
31.2 Applique Status Command . . . . . .
31.3 Shelf Summary Status Command . .
31.4 Protection Element Status Command
31.5 Protection Group Status Command .
31.6 ISAM Status Command . . . . . . . .
31.7 Rack Status Command . . . . . . . .
31.8 Shelf Status Command . . . . . . . .

312
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

32- Trap Status Commands

.
.
.
.
.
.
.
.

313
316
319
321
322
324
325
327

329

32.1 Trap Manager Queue Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

33- Alarm Log Status Commands

331

33.1 Alarm Log Status Command . . . . . . . . . . . . . . . . . .


33.2 Alarm Equipment Status Command . . . . . . . . . . . . . .
33.3 Alarm Equipment Holder Status Command . . . . . . . . . .
33.4 Alarm Plug in Unit Status Command . . . . . . . . . . . . . .
33.5 Alarm ATM Status Command . . . . . . . . . . . . . . . . .
33.6 Alarm Ethernet Interface Log Status Command . . . . . . . .
33.7 Alarm Software Management Status Command . . . . . . .
33.8 Alarm xDSL Common Status Command . . . . . . . . . . .
33.9 Alarm xDSL Near End Status Command . . . . . . . . . . .
33.10 Alarm xDSL Far End Status Command . . . . . . . . . . .
33.11 Alarm TCA-xDSL Log Status Command . . . . . . . . . . .
33.12 Alarm log Electrical to Optical Conversion Status Command
33.13 Alarm Authentication Status Command . . . . . . . . . . .
33.14 Alarm xDSL Bonding Status Command . . . . . . . . . . .
33.15 Alarm Redundancy Status Command . . . . . . . . . . . .
33.16 Alarm Custom Status Command . . . . . . . . . . . . . . .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

34- Current Alarm Status Commands


34.1 Alarm Current Status Command . . . . . . . . . . . . .
34.2 Alarm Current Equipment Status Command . . . . . .
34.3 Alarm Equipment Holder Status Command . . . . . . .
34.4 Alarm Plug In Unit Status Command . . . . . . . . . .
34.5 Alarm Current ATM Status Command . . . . . . . . . .
34.6 Alarm Current Ethernet Interface Status Command . . .
34.7 Alarm Current Software Management Status Command
34.8 Alarm Current xDSL Status Command . . . . . . . . .
34.9 Alarm TCA-xDSL Log Status Command . . . . . . . . .

vi

Released

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

332
334
336
339
342
344
345
347
349
352
355
359
361
363
365
366

368
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

3HH-01016-AAAA-TCZZA

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

369
371
372
374
376
378
379
380
383

Edition 03

Contents

34.10 Alarm Electrical to Optical Conversion Status Command


34.11 Alarm Current Authentication Status Command . . . . .
34.12 Alarm Current xDSL Bonding Status Command . . . . .
34.13 Alarm Redundancy Status Command . . . . . . . . . .
34.14 Alarm Custom Status Command . . . . . . . . . . . . .

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

35.1 Alarm Snap-shot Status Command . . . . . . . . . . . . . . .


35.2 Alarm Snap-shot Equipment Status Command . . . . . . . . .
35.3 Alarm Equipment Holder Status Command . . . . . . . . . . .
35.4 Alarm Plug In Unit Status Command . . . . . . . . . . . . . .
35.5 Alarm ATM Status Command . . . . . . . . . . . . . . . . . .
35.6 Alarm Snap-shot Ethernet Interface Status Command . . . . .
35.7 Alarm Snap-shot Software Management Status Command . .
35.8 Alarm xDSL Snap-shot Status Command . . . . . . . . . . . .
35.9 Alarm TCA-xDSL Log Status Command . . . . . . . . . . . . .
35.10 Alarm Electrical to Optical Conversion for Snap-shot . . . . .
35.11 Alarm Authentication Alarms for Snap-shot Status Command
35.12 Alarm xDSL Bonding Snap Shot Status Command . . . . . .
35.13 Alarm IPoX Snap-shot Status Command . . . . . . . . . . . .
35.14 Alarm Redundancy Snap Shot Status Command . . . . . . .
35.15 Alarm Custom Snap Shot Status Command . . . . . . . . . .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

35- Alarm Snap-shot Status Commands

394

36- Alarm Delta Log Status Commands


36.1 Alarm Generic Delta Alarm Log Status Command . . .
36.2 Alarm Indeterminate Delta Alarm Log Status Command
36.3 Alarm Warning Delta Alarm Log Status Command . . .
36.4 Alarm Minor Delta Alarm Log Status Command . . . . .
36.5 Alarm Major Delta Alarm Log Status Command . . . . .
36.6 Alarm Critical Delta Alarm Log Status Command . . . .

386
387
389
391
392

395
398
399
401
403
405
406
407
410
413
414
416
418
419
420

422
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

37- SHub Alarm Status Command


37.1 SHub Alarm Current Status Command . . . . . . . . . . . .
37.2 SHub Alarm Current Equipment Status Command . . . . . .
37.3 SHub Alarm Current Ethernet Interface Status Command . .
37.4 SHub Alarm Snap-shot Status Command . . . . . . . . . . .
37.5 SHub Alarm Equipment Snap-shot Status Command . . . .
37.6 SHub Alarm Snap-shot Ethernet Interface Status Command .
37.7 SHub Alarm RIP Snap-shot Status Command . . . . . . . .
37.8 SHub Alarm OSPF Snap-shot Status Command . . . . . . .
37.9 SHub Alarm Uplink group Snap-shot Status Command . . .
37.10 SHub Alarm Delta-Log Changes Status Command . . . . .
37.11 SHub Alarm Entries Status Command . . . . . . . . . . . .

423
424
428
432
436
440

444
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

38- Alarm Status Commands

.
.
.
.
.
.
.
.
.
.
.

445
447
449
450
452
454
455
456
458
459
460

462

38.1 Alarm Entries Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

39- ATM Status Commands

467

39.1 ATM Interface Status Command . . . . . . . . . . . . . . . . . . . . .


39.2 PVC Status Command . . . . . . . . . . . . . . . . . . . . . . . . . .
39.3 TC Adaptor Protocol Interval Status . . . . . . . . . . . . . . . . . . .
39.4 TC Adaptor Protocol Current Quarter Performance Data . . . . . . . .
39.5 TC Adaptor Protocol Current Day Performance Data . . . . . . . . . .
39.6 TC Adaptor Protocol Performance Data for Previous Quarter Intervals
39.7 TC Adaptor Protocol Performance Data for Previous Day Intervals . .

3HH-01016-AAAA-TCZZA Edition 03

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

Released

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

468
469
470
471
473
475
477

vii

Contents

40- Bridge Status Commands


40.1 Bridge Port Status Command . . . . . . . . . . . .
40.2 Bridge Port to ATM PVC mapping Status Command
40.3 SHub Bridge Status Command . . . . . . . . . . .
40.4 SHub Bridge Port Status Command . . . . . . . . .

479
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

41.1 Global VLAN Status Command . . . . . . . . . . . . . . . . . . . . .


41.2 Residential Bridge VLAN Status Command . . . . . . . . . . . . . . .
41.3 Cross-connect VLAN Status Command . . . . . . . . . . . . . . . . .
41.4 Stacked VLAN Status Command . . . . . . . . . . . . . . . . . . . .
41.5 Stacked QoS VLAN Status Command . . . . . . . . . . . . . . . . . .
41.6 Layer-2 terminated VLAN Status Command . . . . . . . . . . . . . .
41.7 VLAN Name mapping Status Command . . . . . . . . . . . . . . . .
41.8 VLAN Filtering Database Status Command . . . . . . . . . . . . . . .
41.9 Bridge Port Filtering Database Status Command . . . . . . . . . . . .
41.10 Port VLAN association Status Command . . . . . . . . . . . . . . .
41.11 VLAN Priority Regeneration Profile Status Command . . . . . . . . .
41.12 Duplicate Mac Alarm Status Command . . . . . . . . . . . . . . . .
41.13 Port Event Status Command . . . . . . . . . . . . . . . . . . . . . .
41.14 Port Statistics for Current Quarter Status Command . . . . . . . . .
41.15 Port Statistics for Current Day Status Command . . . . . . . . . . .
41.16 Port Statistics for Previous Quarter Intervals Status Command . . . .
41.17 Port Statistics for Previous Day Intervals Status Command . . . . . .
41.18 VLAN Port Statistics for Current Quarter Status Command . . . . . .
41.19 VLAN Port Statistics for Current Day Status Command . . . . . . . .
41.20 VLAN Port Statistics for Previous Quarter Intervals Status Command
41.21 VLAN Port Statistics for Previous Day Intervals Status Command . .
41.22 SHub Port VLAN association Status Command . . . . . . . . . . . .
41.23 SHub VLAN Name mapping Status Command . . . . . . . . . . . .
41.24 SHub VLAN Filtering Database Status Command . . . . . . . . . . .
41.25 SHub Filtering Database Entry Status Command . . . . . . . . . . .
41.26 SHub Duplicate Mac Alarm Status Command . . . . . . . . . . . . .

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

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

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

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

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

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

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

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

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

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

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

41- VLAN Status Commands

480
482
483
484

487

42- Link Aggregation Status Commands

488
489
490
491
492
493
494
495
497
499
500
502
503
505
507
509
511
513
515
517
519
521
522
523
525
527

528

42.1 Link Aggregation Group Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . 529


42.2 Link Aggregation Member List Status Command . . . . . . . . . . . . . . . . . . . . . . . 532
42.3 Link Aggregate Member Link Status Command . . . . . . . . . . . . . . . . . . . . . . . . 533

43- RSTP Status Commands

537

43.1 RSTP Bridge and Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

44- QOS Status Commands


44.1 QoS Session Profile Status Command . . . . . . . . .
44.2 QoS Marker Profile Status Command . . . . . . . . . .
44.3 QoS Policer Profile Status Command . . . . . . . . . .
44.4 QoS Queue Profile Status Command . . . . . . . . . .
44.5 QoS Scheduler Profile Status Command . . . . . . . .
44.6 QoS CAC Profile Status Command . . . . . . . . . . .
44.7 QoS DSL Bandwidth Status Command . . . . . . . . .
44.8 QoS Buffer Overflow Statistics for Previous Quarter . .
44.9 QoS Buffer Overflow Statistics for Current Quarter . . .
44.10 QoS Buffer Overflow Statistics for Previous Day . . .
44.11 QoS Buffer Overflow Statistics for Current Day . . . .
44.12 QoS Buffer Overflow Statistics Total Status Command

viii

Released

542
.
.
.
.
.
.
.
.
.
.
.
.

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

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

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

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

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

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

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

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

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

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

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

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

3HH-01016-AAAA-TCZZA

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

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

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

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

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

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

543
544
545
546
547
548
549
551
553
555
557
559

Edition 03

Contents

44.13 QoS SHub Meter Statistics Status Command . . . . . . . . . . . . . . . . . . . . . . . . 562


44.14 QoS SHub Flow Statistics Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 563

45- IP Status Commands


45.1 IP VRF Statistics . . . . . . . . . . . . . . . . .
45.2 IP Interface Status Command . . . . . . . . . .
45.3 IP VRF Interface User Port Status Command . .
45.4 IP VRF Interface User Port Status Command . .
45.5 IP VRF Routes Status Command . . . . . . . .
45.6 IP VRF Net To Media Statistics . . . . . . . . .
45.7 IP VRF Mapping . . . . . . . . . . . . . . . . .
45.8 IP VRF Next Index . . . . . . . . . . . . . . . .
45.9 IP SHub VRF Status Command . . . . . . . . .
45.10 IP SHub VRF Route Status Command . . . . .
45.11 IP SHub ARP VRF Based Statistics Command
45.12 IP Traceroute Status Command . . . . . . . .

564
.
.
.
.
.
.
.
.
.
.
.
.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

46.1 xDSL Profiles Status Command . . . . . . . . . . . . . . . .


46.2 xDSL PM Interval Per Interface Status Command . . . . . .
46.3 xDSL Operational Data Near End Line Status Command . .
46.4 xDSL Operational Data Near End Channel Status Command
46.5 xDSL Operational Data Far End Line Status Command . . .
46.6 xDSL Operational Data Far End Channel Status Command .
46.7 xDSL Operational Data Statistics . . . . . . . . . . . . . . .
46.8 xDSL Carrier Data Near End Status Command . . . . . . . .
46.9 xDSL Carrier Data Far End Status Command . . . . . . . . .
46.10 xDSL Failure Status Near End Status Command . . . . . .
46.11 xDSL Failure Status Far End Status Command . . . . . . .
46.12 xDSL Counters Near End Line Current 15 Min . . . . . . .
46.13 xDSL Counters Near End Line Current Day . . . . . . . . .
46.14 xDSL Counters Near End Line Previous 15 Min . . . . . . .
46.15 xDSL Counters Near End Of Line Previous Day . . . . . . .
46.16 xDSL Counters Near End Channel Current 15 Min . . . . .
46.17 xDSL Counters Near End Channel Current Day . . . . . . .
46.18 xDSL Counters Near End Channel Previous 15 Min . . . .
46.19 xDSL Counters Near End Channel Previous Day . . . . . .
46.20 xDSL Counters Far End Line Current 15 Min . . . . . . . .
46.21 xDSL Counters Far End Line Current Day . . . . . . . . . .
46.22 xDSL Counters Far End Line Previous 15 Min . . . . . . . .
46.23 xDSL Counters Far End Line Previous Day . . . . . . . . .
46.24 xDSL Counters Far End Channel Current 15 Min . . . . . .
46.25 xDSL Counters Far End Channel Current Day . . . . . . . .
46.26 xDSL Counters Far End Channel Previous 15 Min . . . . .
46.27 xDSL Counters Far End Channel Previous Day . . . . . . .
46.28 xDSL Inventory XT/RT Status Command . . . . . . . . . .
46.29 xDSL Board Capability Status Command . . . . . . . . . .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

46- xDSL Status Commands

582

47- xDSL Bonding Status Commands


47.1 xDSL Bonding Profiles Status Command . . . . . . . . . . .
47.2 xDSL Bonding Near End Operational Data Status Command
47.3 xDSL Bonding Far End Operational Data Status Command .
47.4 xDSL Bonding Near End Failure Status Command . . . . . .
47.5 xDSL Bonding Far End Failure Status Command . . . . . . .

565
566
569
571
573
574
575
576
577
578
579
581

583
584
586
590
591
595
596
598
600
602
603
604
606
608
610
612
613
614
615
616
618
620
622
624
625
626
627
628
629

632
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

48- PPPoE Status Commands

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

633
634
635
636
638

640

48.1 PPPoE Sessions Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

3HH-01016-AAAA-TCZZA Edition 03

Released

ix

Contents

48.2 PPPoE Sessions/Connection Status Command


48.3 PPPoE Interface Status Command . . . . . . .
48.4 PPPoX Interface Statistics . . . . . . . . . . . .
48.5 PPPoE Interface Statistics . . . . . . . . . . . .
48.6 PPPoE Interface Received Statistics . . . . . .
48.7 PPPoE Interface Transmitted Statistics . . . . .
48.8 PPPoE Profile Status Command . . . . . . . . .
48.9 Ip-address Related PPP Status Command . . .
48.10 Mac-address Related PPP Status Command .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

49- Interface Status Commands

.
.
.
.
.
.
.
.
.

642
643
645
647
648
650
651
653
654

655

49.1 Interface Alarm Status Command . . . . . . .


49.2 Physical Interface Status Command . . . . . .
49.3 Interface Status Command . . . . . . . . . . .
49.4 Interface Test Status Command . . . . . . . .
49.5 Interface Stack Status Command . . . . . . .
49.6 SHub Interface Status Command . . . . . . .
49.7 SHub Interface Port Control Status Command
49.8 SHub Interface Uplink Group Status Command
49.9 Interface Extensive Status Command . . . . .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

50- SNTP Status Commands

.
.
.
.
.
.
.
.
.

656
657
658
661
663
665
666
668
669

670

50.1 SNTP Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671

51- System Status Commands


51.1 SHub System IP Status Command . . . .
51.2 SHub System Version Status Command .
51.3 SHub System HTTP Status Command . .
51.4 SHub System Common Status Command .
51.5 SHub System Control Status Command . .
51.6 SHub IP Filter Status Command . . . . . .
51.7 SHub System Manager Status Command .
51.8 System Statistics . . . . . . . . . . . . . .
51.9 System Licenses Status Command . . . .

672
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

52- Transaction Status Commands

.
.
.
.
.
.
.
.
.

673
674
675
676
677
678
681
682
683

685

52.1 Transaction Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686


52.2 Transaction Log Entry Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 687

53- Error Status Command

688

53.1 Error Log Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689

54- Software Status Commands


54.1 Database Status Command . . . . . . . . . . .
54.2 Disk Status Command . . . . . . . . . . . . . .
54.3 Overall Software Package Status Command . .
54.4 Software Package Status Command . . . . . .
54.5 File Status Command . . . . . . . . . . . . . . .
54.6 Upload/Download Status Command . . . . . . .
54.7 SHub Software Management Status Command .
54.8 SHub Configuration File Status Command . . .
54.9 Status of the SHub Boot ROM update . . . . . .

691
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

55- IGMP Status Commands

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

692
693
694
696
697
699
701
702
703

704

55.1 IGMP System Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705

Released

3HH-01016-AAAA-TCZZA

Edition 03

Contents

55.2 IGMP Channel Sources Status Command . . .


55.3 IGMP Channel Miscellaneous Status Command
55.4 IGMP Multicast Sources Statistics . . . . . . . .
55.5 IGMP Module Counter Status Commands . . . .
55.6 IGMP Module Time Status Command . . . . . .
55.7 IGMP Module Misc Status Command . . . . . .
55.8 SHub IGMP Vlan Router Port Status Command

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

56- Transport Status Commands


56.1 ICMP Status Command . . . . . . . .
56.2 IP Address Status Command . . . . .
56.3 IP Statistics . . . . . . . . . . . . . . .
56.4 IP Route Status Command . . . . . . .
56.5 IP Net-To-Media Status Command . .
56.6 SNMP Status Command . . . . . . . .
56.7 System Status Command . . . . . . .
56.8 UDP Status Command . . . . . . . . .
56.9 UDP Listener Status Command . . . .
56.10 Ethernet Dot3 Status Command . . .
56.11 Interface MAU Status Command . . .
56.12 SHub Ethernet Dot3 Status Command
56.13 SHub Dot3 Control Status Command
56.14 SHub Dot3 Pause Status Command .
56.15 SHub Ethernet Dot3 Status Command
56.16 SHub L2 Filter Status Command . . .
56.17 SHub Rate Status Command . . . . .

.
.
.
.
.
.
.

706
708
709
711
713
714
715

716
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

57- DHCP Relay Status Commands

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

717
719
720
722
724
725
728
729
730
731
734
736
737
738
740
743
745

746

57.1 DHCP Relay Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747


57.2 DHCP Relay SHub Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748

58- Multicast Status Commands

749

58.1 Multicast VLAN FWD Port Status Command . . . . . . . . . . . . . . . . . . . . . . . . . 750

59- CPE Remote Status Commands

751

59.1 CPE Remote Management System Status Command . . . . . . . . . . . . . . . . . . . . 752

60- Session Status Commands

753

60.1 Session Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754

61- PPPoX-Relay Status Commands

756

61.1 PPPoX CC Engine Statistics . . . . . . . . . . . .


61.2 PPPoX CC Client Port Statistics . . . . . . . . . .
61.3 PPPoX CC Engine Monitor Statistics . . . . . . .
61.4 PPPoX CC Client Port Monitor Statistics . . . . .
61.5 PPPoX CC Session Engine Status Command . .
61.6 PPPoX CC Session Client Port Status Command

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

62- OSPF Status Commands


62.1 OSPF Area Status Command . . . . . . . .
62.2 OSPF LSA Status Command . . . . . . . .
62.3 OSPF External Link State Status Command
62.4 OSPF Interface Status Command . . . . . .
62.5 OSPF Neighbour Status Command . . . . .
62.6 OSPF Routing Status Command . . . . . . .

3HH-01016-AAAA-TCZZA Edition 03

757
758
759
760
761
762

763
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

Released

764
766
767
768
770
772

xi

Contents

62.7 OSPF Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773


62.8 OSPF Parameter Status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774

63- RIP Status Commands


63.1 RIP Statistics . . . . . . . . .
63.2 RIP Peer Status Command .
63.3 RIP Routing Status Command
63.4 RIP Global Status Command .

775
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

64- Security Status Commands

776
777
778
779

780

64.1 Operator Information Status Command . . . . . . . . . . .


64.2 Domain Status Command . . . . . . . . . . . . . . . . . .
64.3 User Sessions Status Command . . . . . . . . . . . . . . .
64.4 Connection Profile Status Command . . . . . . . . . . . .
64.5 Local IP Pool Status Command . . . . . . . . . . . . . . .
64.6 IP Address Status Command . . . . . . . . . . . . . . . .
64.7 RADIUS Authentication Server Statistics . . . . . . . . . .
64.8 RADIUS Authenticating Server Status Command . . . . . .
64.9 RADIUS Accounting Server Statistics . . . . . . . . . . . .
64.10 RADIUS Accounting Server Status Command . . . . . . .
64.11 RADIUS Dynamic Authentication Client Status Command
64.12 RADIUS Next Available Index . . . . . . . . . . . . . . .
64.13 RADIUS Client Status Command . . . . . . . . . . . . . .
64.14 PAE Authenticator Status Command . . . . . . . . . . . .
64.15 EAPOL Statistics . . . . . . . . . . . . . . . . . . . . . .
64.16 Diagnostic Information Status Command . . . . . . . . .
64.17 Session Statistics . . . . . . . . . . . . . . . . . . . . . .
64.18 PAE Port System Status Command . . . . . . . . . . . .
64.19 Mac-address Related Eapol Status Command . . . . . .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

65- Alarm Management Commands


65.1 Alarm Management Command . . . . . . .
65.2 Snap Shot Management Command . . . .
65.3 SHub Snap Shot Management Command .
65.4 Alarm Delta Log Management Command .
65.5 Log Management Command . . . . . . . .

.
.
.
.

781
782
783
785
786
787
788
790
791
793
794
796
797
798
800
802
805
807
808

809
.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

66- ATM Management Commands

810
811
812
813
814

815

66.1 ATM Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816

67- IGMP Management Commands


67.1 IGMP Management Command . . . . . . . . . . .
67.2 IGMP Multicast Sources Management Command
67.3 IGMP Slot Management Command . . . . . . . .
67.4 IGMP Channel Management Command . . . . . .

817
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

68- PPPoX Management Commands

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

818
819
820
821

822

68.1 PPPoX Engine Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . 823

69- xDSL Management Commands

824

69.1 xDSL Line Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825

70- Software Management Commands

826

70.1 Software Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827

xii

Released

3HH-01016-AAAA-TCZZA

Edition 03

Contents

70.2 OSWP Software Management Command . .


70.3 Database Management Command . . . . .
70.4 File Management Command . . . . . . . . .
70.5 SHub Software Management Command . .
70.6 SHub Database Management Command . .
70.7 SHub SWPackage Administration Command
70.8 Update the SHub Boot ROM . . . . . . . . .

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

71- OSPF Management Commands

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

.
.
.
.
.
.
.

828
829
830
831
832
833
834

835

71.1 OSPF Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . . . 836

72- RIP Management Commands

837

72.1 RIP Interface MD5 Key Management Command . . . . . . . . . . . . . . . . . . . . . . . 838

73- Equipment Management Commands

839

73.1 Equipment Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840


73.2 Slot Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
73.3 SHub Port Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842

74- Bridge Management Commands

843

74.1 Learned Unicast Mac Address Management Command . . . . . . . . . . . . . . . . . . . 844


74.2 VLAN Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
74.3 Port Related RSTP Management Command . . . . . . . . . . . . . . . . . . . . . . . . . 846

75- Trap Management Commands

847

75.1 Trap Manager Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848

76- IP Management Commands

849

76.1 Slot Related VRF Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . 850


76.2 IP VRF Interface Reset Management Command . . . . . . . . . . . . . . . . . . . . . . . 851
76.3 Traceroute Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852

77- DHCP Management Command

853

77.1 DHCP Relay User Port Management Command . . . . . . . . . . . . . . . . . . . . . . . 854

78- Transport Management Commands

855

78.1 IP Net to Media Management Command . . . . . . . . . . . . . . . . . . . . . . . . . . . 856

79- SNTP Management Commands


79.1 SNTP Management Command

857

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858

80- Transactions Management Commands

859

80.1 Transaction Configuration Managemant Command . . . . . . . . . . . . . . . . . . . . . . 860

81- Security Management Commands

861

81.1 Security 802.1x Port Authentication Management Command . . . . . . . . . . . . . . . . 862

82- Support Commands

863

82.1 Ping Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864

3HH-01016-AAAA-TCZZA Edition 03

Released

xiii

Contents

Commands
Error List

874

Abbreviations

893

Index

895

xiv

Released

3HH-01016-AAAA-TCZZA

Edition 03

1- ISAM CLI

1.1 Preface
1.2 CLI Commands
1.3 Nodes
1.4 Parameters
1.5 Filters
1.6 Printers
1.7 Getting help
1.8 The CLI Prompt
1.9 Entering CLI Commands

3HH-01016-AAAA-TCZZA Edition 03

1-2
1-3
1-4
1-5
1-8
1-9
1-10
1-11
1-12

Released

1 ISAM CLI

1.1 Preface
Scope
This user guide describes the Command Line Interface (CLI) commands supported by the Alcatel 7302 ISAM.
These commands are used for installation, configuration, management and troubleshooting.

User Profile
The guide is intended for operating personnel (sometimes called craft persons).

The CLI Structure


The ISAM CLI is a command-driven interface accessible via telnet or via the craft terminal.
The CLI can be used to configure and manage ISAM equipment.

Released

3HH-01016-AAAA-TCZZA

Edition 03

1 ISAM CLI

1.2 CLI Commands


Command Types
The commands of the CLI language can be divided into two groups: global and environmental commands.
Global commands (such as the logout command) can be entered in any context and have the same effect in each
context.
Environmental commands (such as the info command) can only be entered in some contexts (for example, the info
command cannot be used in the show node) and have a different effect in each context. The purpose of the
command (for example, showing the configuration) is the same but the implementation or the generated output is
different.
Some commands are also implicit. For example, when you enter only the node name configure system security
snmp community fden, you run an implicit command that changes your context to the specified node and that
creates this node if it did not previously exist.
The available commands are discussed in a separate chapter.

Access Rights
Not every operator can execute every command.
Access to commands is granted via the operator profile.
It is possible that an operator can execute a given command in one context and not in another.

Options and Parameters


Commands can have options and parameters.
Options are special parameters that are context insensitive. For example, you can enter the option detail after info
in any context.
Options must be given at the end of the command preceeding the filter and printer specifications.

3HH-01016-AAAA-TCZZA Edition 03

Released

1 ISAM CLI

1.3 Nodes
Node Definition
A command definition tree, further abbreviated to "command tree" is a structure of nested command nodes from
which CLI commands can be derived. A command node consists of a node name and zero or more resource
identifiers. The resource identifiers behave like parameters, but identify a particular resource. For example, public
in configure system security snmp community public is an unnamed resource identifier of the node community.
One such command node identifies a context. A CLI command can be derived from a command tree starting from
the root node, but a command with the same meaning and impact can also be derived from a lower level node or
subnode. The following are examples of equivalent commands:
info configure system security snmp community public in any node.
info system security snmp community public in node configure
info security snmp community public in node configure system
info snmp community public in node configure system security
info community public in node configure system security snmp
info in node configure system security snmp community public
The root node is the highest level. Directly below the root node are important command nodes such as configure
and show.

Node Creation
A dynamic node is a sub-node of the configure node that corresponds to a configurable resource that an operator
can create.
An operator can create a dynamic node by navigating to it. The system will automatically create the node. The
operator can configure its prompt in such a way that it shows if the operator navigated to an existing or a new node.
The ability to create nodes is limited by the access rights of the user.
It is also possible that the system creates additional subnodes in other nodes, for example, in the show node due to
the creation of a new dynamic node in the configure node.

Node Deletion
A dynamic node can be deleted by placing no in front of the node name. For example, configure system security
snmp no community public deletes the specified node and all its subnodes. The ability to delete nodes is limited
by the access rights of the operator.

Resource Attributes
The value of resource attributes can be changed by entering the name of the resource attribute followed by the new
value. For example, password plain:secret sets the value of the resource attribute named password to the plain
text string secret.
Resource attributes can be set to their default value by entering no followed by the name of the resource attribute.
For example, no password sets the value of the resource attribute named password to the default value (no
password required).

Released

3HH-01016-AAAA-TCZZA

Edition 03

1 ISAM CLI

1.4 Parameters
Named and Unnamed Parameters
Parameters are characterised by a name and a type.
Parameters can be named or unnamed.
Named parameters are entered as two tokens: a keyword and a value (for example, password plain:secret). Some
commands (such as info) require only the keyword.
Only the value token is entered for unnamed parameters (for example, public in the node name community
public).
Most options and first resource identifiers are unnamed.
Parameters can be entered in any order. Only unnamed keys must be entered directly after the node name.

Parameter Types
Parameter values belong to a parameter type. Parameter types limit the parameter values to strings that the system
can understand.
Parameter types consists of 1 to N fields with separators in between. Each field belongs to a basic type. The
separator is in most cases a colon : or a slash /.
The name of parameter types always starts with an uppercase character and can contain an optional domain name.
The domain name is separated from the parameter name by ::.
The sequence in which the fields appear can differ in case one of the fields belongs to an enumeration type. For
example, if provided some possible values for the parameter type ExtendedFileName (the first field is an
enumeration field with possible values file and ftp, host-name, user-name, password and local-file are also fields):
file: local-file
ftp: host-name @ user-name : password / local-file
Parameter types are built by combining 1 to N basic types.

Basic Types
Basic types can be divided in two groups: fixed length basic types and variable length basic types.
Examples of variable length basic types are:
integers
printable strings (representing operator chosen names or descriptions)
SNMP object identifiers
binary strings
The length of a variable length basic type is in most cases limited. The definition of logical length depends on the
basic type: number of characters for printable strings, number of bytes for binary strings, and number of numbers in
the object identfier for SNMP object identifiers.
Examples of fixed length basic types are:
ip-address
fixed-length printable strings
enumeration types (limited list of allowed strings)

3HH-01016-AAAA-TCZZA Edition 03

Released

1 ISAM CLI

Basic Type Formatting Rules


Integers can be entered in a decimal format. Large integers can be abbreviated as follows:
decimal-number k which is equal to decimal-number *1000 (For example: 3k is equal to 3000)
decimal-number M which is equal to decimal-number *1000000
decimal-number G which is equal to decimal-number *1000000000
Binary strings must be entered as: hex-byte : hex-byte :...: hex-byte. hex-byte is a number between 0 and 255 in
hexadecimal format (all lowercase).For example, 3f:23:ff:b2 is a valid binary string.
Object identifiers and ipv4-addresses must be entered as: decimal-number . decimal-number .....
decimal-number.For example, 128.17.32.45 is a valid object identifier.
The values of all fields may be placed within double quotes. A field separator can never be placed within double
quotes. For example, "1"/"1" is a valid shelf identifier, but "1/1" is not a valid shelf identifier.
A field value can contain multiple double quotes. For example, "hallo world" is equivalent to hallo" "world or to
"hallo"" ""world".
Printable strings must be placed within double quotes if they contain special characters: double quote ", a backslash
\, a cross #, a space, a tab, a carriage return, or a new line. The \ is the escape character. The \ char is equivalent to
char with the following exceptions:
\r : carriage-return
\t : tab
\n : new-line
In some cases it is possible that a command is ambiguous. For example, info operator detail can be interpreted in
two ways: list the configuration of the operator with the name detail or list the configuration of all operators in
detail.
The ambiguity is solved by the parser in the following way: if the string contains quotes, it is interpreted as a
printable string, otherwise it is interpreted as a keyword. For example, info operator "detail" lists the
configuration of the operator with the name detail and info operator detail lists the configuration of all operators
in detail.

Syntax Check
The system verifies if each typed character is syntactically correct.
In case the system detects a syntax error, it will position the cursor at the offending character and beep.
This can give strange effects if you are entering characters in the 'insert mode': the invalid characters will shift to
the right and any newly entered character will be inserted in front of the faulty characters.
To avoid this strange effect, it is recommended to work in the (default) overwrite mode.

Loops
The values of some resource identifiers may contain numerical ranges for some commands. Numerical ranges are
entered as [ start...end ] in which start and end are integers for which 0 <= end - start <= 1000.
The system will execute a command with a numerical range end - start times in which the numerical range is each
time replaced by a number out of the range.
Numerical ranges have following restrictions:
One command can only contain 1 numerical range.
Ranges between quotes are not interpreted as a numerical range.
Command completion may refuse to work once a numerical range is entered.
Commands that normally change the context, don't do this once they contain a numerical range.

Released

3HH-01016-AAAA-TCZZA

Edition 03

1 ISAM CLI

3HH-01016-AAAA-TCZZA Edition 03

Released

1 ISAM CLI

1.5 Filters
The language provides filters to manipulate the output of commands.
The available filters are discussed in detail in a separate chapter.
Filters can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify a sequence of filters as in following example: info | match exact:1/1 | count lines.

Released

3HH-01016-AAAA-TCZZA

Edition 03

1 ISAM CLI

1.6 Printers
The language provides printers to allow the user to decide how the output must be printed on his terminal.
The available printers are discussed in detail in a separate chapter.
Printers can be specified in case the command generates output. They are separated from the basic command with a
pipe character |.
The user can specify maximum one printer as in following example: info | match exact:1/1 | more
The default printer can be specified for the CLI session or the operator.

3HH-01016-AAAA-TCZZA Edition 03

Released

1 ISAM CLI

1.7 Getting help


The user can get help in two ways.
The first is using the help command. This gives an extensive explanation on the command.
The user can also enter a question-mark ? at each position in the command. He will then get a short explanation on
what he can enter at this position in the command.
For example: configure system security operator ? gives following output:
<Sec::OperatorName>

: the name of the operator [a-z0-9] (1<=x<=11)

This has the following meaning:


Sec::OperatorName is the name of the parameter type. This indicates that the user must enter a parameter value.
: indicates that the concerned object is a parameter. Nodes are indicated with a +, commands with a -.
the name of the operator explains how the parameter will be interpreted by the system.
[a-z0-9] indicates that the value may consist of the lower-case alfanumeric characters, the ASCII characters a till
z and 0 till 9.
(1<=x<=11) indicates that the name must consist of at least 1 character and maximum 11 characters.

10

Released

3HH-01016-AAAA-TCZZA

Edition 03

1 ISAM CLI

1.8 The CLI Prompt


The prompt can be configured by the user. The prompt can be specified for the session, for an operator or for an
operator profile. If no specific prompt is specified for the session, the prompt specified for the operator is taken and
the prompt specified for the operator profile is taken if no prompt is specified for the operator.
The prompt can be composed with following components :
%n : the name of the current operator.
%! : the current history number.
% num d : the current context.
- num is the maximum number of components (starting from the last) that are shown (default is all).
- each component will be separated from the next one with a >.
- a > is also added in front of the first component.

%% : a %
%c : # if the current node was an existing node or $ if it is newly created.
any other character is just added to the prompt as is.

The default prompt is "%n%d%c "


The system will add a > at the end of each empty prompt or each prompt that consists purely out of white-space

3HH-01016-AAAA-TCZZA Edition 03

Released

11

1 ISAM CLI

1.9 Entering CLI Commands


Following key strokes are treated in a special way while entering commands:
arrow-left : move the cursor one position to the left.
arrow-right : move the cursor one position to the right.
arrow-up : get the previous stored command (round-robin, starts with the last stored command).
arrow-down : get the next stored command (round-robin, starts with the oldest stored command).
insert : toggle between insert and overwrite mode.
backspace : delete the character before the cursor and move the cursor one position to the left.
delete : delete the character under the cursor.
control-c : interrupt the current command or clear the current entered string.
control-a : move the cursor to the beginning of the line.
control-p : get the previous stored command (round-robin, starts with the last stored command).
control-n : get the next stored command (round-robin, starts with the oldest stored command).
control-k : delete all characters starting from the position of the cursor.
control-u : delete all entered characters.
control-w : delete one word before the cursor.
control-l : clear screen.
tab : trigger command completion.
space : terminate a token and trigger command completion, unless it is placed between double quotes.
# : treat all following commands as comment, unless they are placed between double quotes.
? : trigger online-help, unless it is placed between double quotes.
Entering a tab triggers command completion.
The system will try to expand the existing entered string until an ambiguity is found. If there is no ambiguity, a space
will be added behind the token.
Entering a space behind an entered string has - for keywords - the same effect as the tab.
For example: entering c followed by a tab in the root node will expand to configure.
For example: entering c followed by a space in the root node will expand to configure.
For example: entering configure system security operator admin pr followed by a tab will expand to configure
system security operator admin pro because there is still an ambiguity here between prompt and profile.

12

Released

3HH-01016-AAAA-TCZZA

Edition 03

2- CLI Information

2.1 Help Command


2.2 Logout Command
2.3 History Command
2.4 Echo Command
2.5 Telnet Command
2.6 Exec Command
2.7 Sleep Command
2.8 Tree Command
2.9 Poll Command
2.10 Write Command
2.11 Help Command
2.12 Info Command
2.13 Exit Command
2.14 Back Command
2.15 Delete Command
2.16 In Command
2.17 Configure Command
2.18 Action Command
2.19 Sample Command
2.20 Show Command
2.21 Discard

3HH-01016-AAAA-TCZZA Edition 03

2-14
2-15
2-16
2-17
2-18
2-19
2-20
2-21
2-22
2-23
2-24
2-25
2-26
2-27
2-28
2-29
2-30
2-31
2-32
2-33
2-34

Released

13

2 CLI Information

2.1 Help Command


Command Description
This command displays detailed information on a particular topic.
By default, this command gives information on the current node.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by each user. A user will only be able to get help for nodes for which the user has
read or write access.

Command Syntax
The command has the following syntax:
> help cli commands

14

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.2 Logout Command


Command Description
This command logs out the user.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by any user.

Command Syntax
The command has the following syntax:
> help cli commands logout

3HH-01016-AAAA-TCZZA Edition 03

Released

15

2 CLI Information

2.3 History Command


Command Description
This command displays the last commands entered at the terminal.
A maximum of 20 commands can be stored. A command that is identical to the previous command is not stored.
Commands containing syntax and semantic errors are also stored in the history buffer. This way a user can correct
a command without retyping the command completely.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by all users.

Command Syntax
The command has the following syntax:
> help cli commands history

16

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.4 Echo Command


Command Description
This command echoes a string to the standard output.

User Level
The command can be accessed by operators with help privileges.
This command can be accessed by any user.

Command Syntax
The command has the following syntax:
> help cli commands echo

3HH-01016-AAAA-TCZZA Edition 03

Released

17

2 CLI Information

2.5 Telnet Command


Command Description
This command establishes a telnet session to another server.
The telnet session will last until the connection is closed by the telnet server or when the operator enters the
character Control-^.
The session inactivity-time protection will not display any messages on the screen when the user executes the telnet
command. The user's connection will be broken without warning if the inactivity timeout expires.

User Level
The command can be accessed by operators with help privileges.
This command can only be executed by users wtih read or write access to functions located in the SHub.
The command can only be executed from a telnet terminal and not from a craft terminal.

Command Syntax
The command has the following syntax:
> help cli commands telnet

18

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.6 Exec Command


Command Description
This command executes CLI commands found in a text file. A file containing CLI commands is called a script file.
A script file must follow the same syntax rules as commands entered interactively. Only the tab and the question
mark lose their special meaning in a script, so command expansion and single-line help are not available.
The script will be aborted if one of the commands in the script fails. A command may be preceded by a minus '-' to
prevent the script from being aborted in case of a semantic error; for example, when you try to delete a node
instance that does not exist.
By default, a command script does not interact with the user. The execution of the script will be aborted if a
command or filter requires interaction with the user. Interactivity can be enabled by specifying the interactive
option with the exec command.
The exec command may not be used in a command script, so command scripts may not be nested.
Script files are typically stored in the /var/cmd directory.
A script file can be used to restore a configuration. The complete configuration of the system can be stored in a
script with the name /var/cmd/config and with the command info configure | tee config. The configuration can be
restored on an empty system with the command exec /var/cmd/config.
Warning: the /var/cmd is cleaned when the system resets, so the configuration file must be transferred to another
system with tftp before resetting the system.
Note: saving and restoring the configuration will not work for areas in which resource identifiers are assigned
dynamically by the system.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by all users. However, the execution of the script will be aborted when the CLI
parser tries to execute the first command in the script for which the user does not have authorization.

Command Syntax
The command has the following syntax:
> help cli commands exec

3HH-01016-AAAA-TCZZA Edition 03

Released

19

2 CLI Information

2.7 Sleep Command


Command Description
This command pauses the execution for the specified number of seconds.
This command is typically used in scripts (see the exec command).

User Level
The command can be accessed by operators with help privileges.
This command can be executed by any user.

Command Syntax
The command has the following syntax:
> help cli commands sleep

20

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.8 Tree Command


Command Description
This command displays the structure of a node and its subnodes.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by any user on a node to which the user has read or write access.
The output does not contain any information related to subnodes to which the user does not have access.

Command Syntax
The command has the following syntax:
> help cli commands tree

3HH-01016-AAAA-TCZZA Edition 03

Released

21

2 CLI Information

2.9 Poll Command


Command Description
This command cannot be directly executed by the user. It is the default command for some nodes related to testing.
This command starts a test and displays the test results during the specified time period at regular intervals.

User Level
The command can be accessed by operators with help privileges.

Command Syntax
The command has the following syntax:
> help cli commands poll

22

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.10 Write Command


Command Description
This command writes a message to the terminal of the adressee.
The message can be directed to a user, to all users with the same user profile, or to all users.
Messages are only delivered to users that are logged in. Users that are not logged in will not receive the message.
The sender will also receive the message if it is one of the addressees.

User Level
The command can be accessed by operators with help privileges.
This command can be used by any user.

Command Syntax
The command has the following syntax:
> help cli commands write

3HH-01016-AAAA-TCZZA Edition 03

Released

23

2 CLI Information

2.11 Help Command


Command Description
This command displays detailed information on a particular topic.
By default, this command gives information on the current node.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by each user. A user will only be able to get help for nodes for which the user has
read or write access.

Command Syntax
The command has the following syntax:
> help cli commands help

24

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.12 Info Command


Command Description
This command shows the configuration of the current node and all of its subnodes.

User Level
The command can be accessed by operators with help privileges.
This command can be accessed in all nodes to which the user has read access. It is not available in admin and
show nodes or their subnodes.
The output will only contain information for the nodes for which the user has read access.

Command Syntax
The command has the following syntax:
> help cli commands info

3HH-01016-AAAA-TCZZA Edition 03

Released

25

2 CLI Information

2.13 Exit Command


Command Description
This command changes the current position to the parent node of the current position. This command always
succeeds, even if the current position is the top node. If the current position is the top node, the command does not
have an effect.
The all option changes the current position to the top node.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by all users

Command Syntax
The command has the following syntax:
> help cli commands exit

26

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.14 Back Command


Command Description
This command changes the current position to the previous position.
This command will always succeed, even if the previous position no longer exists. If the previous position no longer
exists, the command changes the current position to the top node.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by all users.

Command Syntax
The command has the following syntax:
> help cli commands back

3HH-01016-AAAA-TCZZA Edition 03

Released

27

2 CLI Information

2.15 Delete Command


Command Description
This command deletes a file from the directory /var/cmd. This file is typically created with the tee filter.
The command will always succeed, even if the specified file does not exist.

User Level
The command can be accessed by operators with help privileges.
The command can be executed by all users.

Command Syntax
The command has the following syntax:
> help cli commands delete

28

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.16 In Command
Command Description
This command cannot be directly executed by the operator. It is the default command for all nodes when node
attributes are not specified, with the exception of all subnodes of configure and the leaf nodes of show.

User Level
The command can be accessed by operators with help privileges.
This command can be executed by any user for the nodes to which the user has read or write access.

Command Syntax
The command has the following syntax:
> help cli commands in

3HH-01016-AAAA-TCZZA Edition 03

Released

29

2 CLI Information

2.17 Configure Command


Command Description
This command cannot be directly executed by the user. It is the default command for the configuration node and
most of its subnodes.
This command serves four purposes:
changes the current position to a node
creates a node. The current position will be changed to the newly created node.
modifies one or more attributes of a node. The current position will be changed to the modified node.
deletes a node
The command changes the current position to a node if the user specifies an existing node and no parameters, for
example, configure equipment shelf 1/1. The last character in the default prompt will be #.
The command creates a node if the node is dynamic and the specified node instance does not exist, for example,
configure system security operator new_user password plain:"hallo#". Parameter values must be supplied for all
mandatory parameters. Parameter values may be supplied for optional parameters. The command changes the
current position to the newly created node. The last character in the default prompt will be $.
The command modifies the attributes of a node if the node instance exists and if the user supplies parameters, for
example, configure system security operator existing description "a new description".
The command will delete a node when it is a dynamic node and the node name is preceeded by no, for example,
configure system security no operator existing.

User Level
The command can be accessed by operators with help privileges.
A user can change the current position to each node to which the user has read access.
A user can create, modify, and delete nodes to which the user has write access.

Command Syntax
The command has the following syntax:
> help cli commands configure

30

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.18 Action Command


Command Description
This command cannot be directly executed by the user. It is the default command for the admin node and most of
its subnodes.
This command serves two purposes:
changes the current position to a node
executes an action
This command changes the current position to a node if the operator specifies an existing node and no parameters.
If the user specifies a parameter, it will try to execute the corresponding action.

User Level
The command can be accessed by operators with help privileges.
The user can change the current position to each node to which the user has read access.
The user can execute the action to each node to which the user has access.

Command Syntax
The command has the following syntax:
> help cli commands action

3HH-01016-AAAA-TCZZA Edition 03

Released

31

2 CLI Information

2.19 Sample Command


Command Description
This command executes a test and shows the result.
This command cannot be executed directly by the user. It is the default command for some leaf nodes of show. It
shows the runtime data.

User Level
The command can be accessed by operators with help privileges.
The user can execute this command for all nodes to which the user has read access.

Command Syntax
The command has the following syntax:
> help cli commands sample

32

Released

3HH-01016-AAAA-TCZZA

Edition 03

2 CLI Information

2.20 Show Command


Command Description
This command shows the runtime data.
This command cannot be executed directly by the user. It is the default command for the leaf nodes of show. It
shows the runtime data.

User Level
The command can be accessed by operators with help privileges.
The user can execute this command for all nodes to which the user has read access.

Command Syntax
The command has the following syntax:
> help cli commands show

3HH-01016-AAAA-TCZZA Edition 03

Released

33

2 CLI Information

2.21 Discard
Command Description
This printer discards all output. This can be useful in some scripts.

User Level
The command can be accessed by operators with help privileges.
This command can be used by any operator.

Command Syntax
The command has the following syntax:
> help cli printers discard

34

Released

3HH-01016-AAAA-TCZZA

Edition 03

3- Environment Configuration Commands

3.1 Environment Configuration Command

3HH-01016-AAAA-TCZZA Edition 03

3-36

Released

35

3 Environment Configuration Commands

3.1 Environment Configuration Command


Command Description
This command allows the operator to manage the session-specific parameters. These parameters are only valid for
a specific session and are lost when the user logs out.
The default values for prompt and print can be found in configure system security operator operator-name.
The default value for terminal-timeout can be found in configure system security profile profile-name.
The procedure on how to specify a prompt is described in the ISAM CLI - The CLI Prompt chapter.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> environment [ no prompt | prompt <Sec::Prompt> ][ no terminal-timeout |
terminal-timeout default | timeout : <Sec::InactivityTimeout> ][ no print | print
<Sec::EnvMore> ]

Command Parameters
Table 3.1-2 "Environment Configuration Command" Command Parameters
Parameter

Type

[ no ] prompt
[ no
terminal-timeout
[ no ] print

36

<Sec::Prompt>
length: x<19
] default
|
timeout
:
<Sec::InactivityTimeout>
unit: minutes
<Sec::EnvMore>
Possible values are :
- more : the output is passed via the more
filter
- no-more : the output is put directly on
the terminal
- default : use the method as specified by
the profile

Released

Description
optional parameter with default value: ""
the specification of the prompt
optional parameter with default value: "timeout :
0"
the maximum time a terminal may be inactive
optional parameter with default value: "default"
specifies the way the output is printed on the
terminal

3HH-01016-AAAA-TCZZA

Edition 03

4- Alarm Configuration Commands

4.1 Alarm Log Configuration Command


4.2 Alarm Entries Configuration Command
4.3 Alarm Delta Log Configuration Command
4.4 SHub Alarm Configuration Command

3HH-01016-AAAA-TCZZA Edition 03

4-38
4-39
4-43
4-44

Released

37

4 Alarm Configuration Commands

4.1 Alarm Log Configuration Command


Command Description
This command allows the operator to maintain a log containing all state changes of alarms by enabling the logging
mode and setting the severity level equal to or higher than the severity level for which the operator is interested.
The alarm log allows the operator to keep track of XDSL lines and to maintain a log of them.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm log-sev-level <Alarm::alarmSeverity> log-full-action
<Alarm::alarmLogFullAction> non-itf-rep-sev-level <Alarm::alarmSeverity>

Command Parameters
Table 4.1-2 "Alarm Log Configuration Command" Command Parameters
Parameter
log-sev-level

log-full-action

non-itf-rep-sev-level

38

Type

Description

<Alarm::alarmSeverity>
Possible values are :
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
<Alarm::alarmLogFullAction>
Possible values are :
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset
<Alarm::alarmSeverity>
Possible values are :
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

optional parameter
set the lowest severity level to log alarms

Released

optional parameter
set the action if log buffer is full

optional parameter
set minimum severity level to report non itf alarms

3HH-01016-AAAA-TCZZA

Edition 03

4 Alarm Configuration Commands

4.2 Alarm Entries Configuration Command


Command Description
This command allows the operator to manage local alarm entries.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm entry (index) severity <Alarm::alarmSeverity> [ no service-affecting
| service-affecting ][ no reporting | reporting ][ no logging | logging ]

Command Parameters
Table 4.2-1 "Alarm Entries Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::alarmIndex>
alarm type
Possible values are :
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day
- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min
- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day

3HH-01016-AAAA-TCZZA Edition 03

Released

39

4 Alarm Configuration Commands

Resource Identifier

Type

Description

- xtca-fe-day-uas : xdsl far end TCA alarm


- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction
- cell-discard-down : cell discarded in the
downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing

40

Released

3HH-01016-AAAA-TCZZA

Edition 03

4 Alarm Configuration Commands

Resource Identifier

Type

Description

- rack-fan-unit2 : fan unit rack 2 failing


- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config

3HH-01016-AAAA-TCZZA Edition 03

Released

41

4 Alarm Configuration Commands

Resource Identifier

Type

Description

group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system

Table 4.2-2 "Alarm Entries Configuration Command" Command Parameters


Parameter

Type

severity

[ no
service-affecting
[ no ] reporting
[ no ] logging

42

Description

<Alarm::alarmSeverity>
optional parameter
Possible values are :
assign a severity level to this alarm
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
] <Alarm::alarmServAffect>
optional
parameter
with
default
value:
"noservice-affecting"
defines whether an alarm is service affecting or not
<Alarm::alarmRepMode>
optional
parameter
with
default
value:
"noreporting"
enable or disable reporting of the alarm
<Alarm::alarmLogMode>
optional parameter with default value: "nologging"
enable or disable logging of the alarm

Released

3HH-01016-AAAA-TCZZA

Edition 03

4 Alarm Configuration Commands

4.3 Alarm Delta Log Configuration Command


Command Description
This command configures the buffer size in the alarm table.
The operator defines the action to be taken when the alarm log buffer is completely full. If the log is set to wrap,
older log records are overwritten by recent records. If the log is set to halt, then logging is stopped until the log
buffer is reset.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm delta-log indet-log-full-action <Alarm::alarmDeltaLogFullAction>
warn-log-full-action <Alarm::alarmDeltaLogFullAction> minor-log-full-action
<Alarm::alarmDeltaLogFullAction> major-log-full-action
<Alarm::alarmDeltaLogFullAction> crit-log-full-act <Alarm::alarmDeltaLogFullAction>

Command Parameters
Table 4.3-2 "Alarm Delta Log Configuration Command" Command Parameters
Parameter
indet-log-full-action

warn-log-full-action

minor-log-full-action

major-log-full-action

crit-log-full-act

Type

Description

<Alarm::alarmDeltaLogFullAction>
Possible values are :
- wrap : wrap around when log is full
- halt : halt logging when log is full
<Alarm::alarmDeltaLogFullAction>
Possible values are :
- wrap : wrap around when log is full
- halt : halt logging when log is full
<Alarm::alarmDeltaLogFullAction>
Possible values are :
- wrap : wrap around when log is full
- halt : halt logging when log is full
<Alarm::alarmDeltaLogFullAction>
Possible values are :
- wrap : wrap around when log is full
- halt : halt logging when log is full
<Alarm::alarmDeltaLogFullAction>
Possible values are :
- wrap : wrap around when log is full
- halt : halt logging when log is full

optional parameter
set the action when indeterminate log buffer is full

3HH-01016-AAAA-TCZZA Edition 03

optional parameter
set the action when indeterminate delta log buffer is
full
optional parameter
set the action when minor delta log buffer is full
optional parameter
set action when major delta log buffer is full
optional parameter
set action when critical delta log buffer is full

Released

43

4 Alarm Configuration Commands

4.4 SHub Alarm Configuration Command


Command Description
This command configures alarm SHub parameters.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure alarm shub entry (index) severity <Alarm::alarmSeverity> [ no
service-affecting | service-affecting ][ no reporting | reporting ]

Command Parameters
Table 4.4-1 "SHub Alarm Configuration Command" Resource Parameters
Resource Identifier
(index)

44

Type

Description

<Alarm::ShubAlarmIndex>
alarm type
Possible values are :
- fan : shub fan failure
- power-fan : shub power fan failure
- db-restore : shub DB restore
- reboot : shub reboot from emergency
boot package
- sntp-comm : shub SNTP communication
- eth-link-down : shub ethernet link down
status
- mac-conflict : MAC conflict
- no-arp-reply : no ARP reply
ospf-itf-err
:
OSPF
interface
configuration error
- ospf-auth-err : OSPF interface
authetication error
- ospf-rx-bad-err : bad packets received on
OSPF interface
- ospf-lsdb-oflow-90 : external LSA
database reached 90% of the limit
- ospf-lsdb-oflow : external LSA database
reached 90% of the limit
- ospf-nhbr-statchg : OSPF neighbor state
change
- ospf-itf-statchg : OSPF interface state
change
rip-config-err
:
RIP
interface
configuration error

Released

3HH-01016-AAAA-TCZZA

Edition 03

4 Alarm Configuration Commands

Resource Identifier

Type

Description

rip-auth-fail
:
RIP
interface
authentication failure
- rip-rcv-bad-pkt : bad packet received on
RIP interface
- uplink-down : uplink group down

Table 4.4-2 "SHub Alarm Configuration Command" Command Parameters


Parameter
severity

[ no
service-affecting
[ no ] reporting

Type

Description

<Alarm::alarmSeverity>
optional parameter
Possible values are :
assign a severity level to this alarm
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
] <Alarm::alarmServAffect>
optional
parameter
with
default
value:
"noservice-affecting"
defines whether an alarm is service affecting or not
<Alarm::alarmRepMode>
optional
parameter
with
default
value:
"noreporting"
enable or disable reporting of the alarm

3HH-01016-AAAA-TCZZA Edition 03

Released

45

5- Trap Configuration Commands

5.1 Trap Definition Configuration Command


5.2 Trap Manager Configuration Command
5.3 SHub Trap Manager Configuration Command

46

Released

5-47
5-49
5-52

3HH-01016-AAAA-TCZZA

Edition 03

5 Trap Configuration Commands

5.1 Trap Definition Configuration Command


Command Description
This command allows the operator to define the priority of a given trap.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure trap definition (name) priority <Trap::Priority>

Command Parameters
Table 5.1-1 "Trap Definition Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Trap::Name>
the name of the trap
Possible values are :
- cold-start : entry for cold start trap
- unused-1 : entry for cold start trap
- link-down : entry for link down trap
- link-up : entry for link up trap
- auth-failure : entry for authentication
failure trap
- unused-2 : entry for cold start trap
- unused-3 : entry for cold start trap
- change-occured : entry for change
occured trap
- unused-4 : entry for cold start trap
- unused-5 : entry for cold start trap
- unused-6 : entry for cold start trap
- init-started : entry for initialization
started trap
- lic-key-chg-occr : entry for license key
change occured trap

Table 5.1-2 "Trap Definition Configuration Command" Command Parameters


Parameter
priority

Type

Description

<Trap::Priority>
optional parameter
Possible values are :
the trap priority
- urgent : urgent - needs to be informed
immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap

3HH-01016-AAAA-TCZZA Edition 03

Released

47

5 Trap Configuration Commands

48

Released

3HH-01016-AAAA-TCZZA

Edition 03

5 Trap Configuration Commands

5.2 Trap Manager Configuration Command


Command Description
This command configures an SNMP manager. This SNMP manager will receive traps when an event occurs in the
system.
The SNMP manager can be easily flooded by events if something happens with the system. This command allows
the operator to specify in which traps the manager is interested (trap filtering) and how the traps must be spread in
time (trap shaping).
Traps that cannot be delivered will be dropped.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure trap [[no] manager (address) [ no priority | priority <Trap::Priority> ][
no cold-start-trap | cold-start-trap ][ no link-down-trap | link-down-trap ][ no
link-up-trap | link-up-trap ][ no auth-fail-trap | auth-fail-trap ][ no change-trap |
change-trap ][ no init-started-trap | init-started-trap ][ no lic-key-chg-occr |
lic-key-chg-occr ][ no phys-line-trap | phys-line-trap ][ no eqpt-change-trap |
eqpt-change-trap ][ no success-set-trap | success-set-trap ][ no other-alarm-trap |
other-alarm-trap ][ no warning-trap | warning-trap ][ no minor-trap | minor-trap ][ no
major-trap | major-trap ][ no critical-trap | critical-trap ][ no redundancy-trap |
redundancy-trap ][ no eqpt-prot-trap | eqpt-prot-trap ][ no max-per-window |
max-per-window <Trap::WindowCount> ][ no window-size | window-size <Trap::WindowSize>
][ no max-queue-size | max-queue-size <Trap::QueueSize> ][ no min-interval |
min-interval <Trap::Interval> ][ no min-severity | min-severity <Alarm::alarmSeverity>
]]

Command Parameters
Table 5.2-1 "Trap Manager Configuration Command" Resource Parameters
Resource Identifier
(address)

Type

Description

<Ip::V4Address> : <Trap::Port>
the address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]

Table 5.2-2 "Trap Manager Configuration Command" Command Parameters


Parameter
[ no ] priority

[ no ] cold-start-trap

Type

Description

<Trap::Priority>
optional parameter with default value: "medium"
Possible values are :
lowest priority a trap should have to be reported
- urgent : urgent - needs to be informed
immediately
- high : high priority trap
- medium : medium priority trap
- low : low priority trap
<Trap::ColdStart>
optional
parameter
with
default
value:
"no-cold-start"

3HH-01016-AAAA-TCZZA Edition 03

Released

49

5 Trap Configuration Commands

Parameter

Type

[ no ] link-down-trap

<Trap::LinkDown>

[ no ] link-up-trap

<Trap::LinkUp>

[ no ] auth-fail-trap

<Trap::AuthenticationFailure>

[ no ] change-trap

<Trap::ChangeOccured>

[ no ] init-started-trap

<Trap::InitStarted>

[ no
lic-key-chg-occr

] <Trap::LicenceKeyChange>

[ no ] phys-line-trap
[ no
eqpt-change-trap

<Trap::PhysLine>
] <Trap::Equipment>

[ no ] success-set-trap

<Trap::SuccessfullSet>

[ no ] other-alarm-trap <Trap::IndeterminateAlarm>
[ no ] warning-trap

<Trap::Warning>

[ no ] minor-trap

<Trap::Minor>

[ no ] major-trap

<Trap::Major>

[ no ] critical-trap

<Trap::Critical>

[ no ] redundancy-trap <Trap::Redundancy>
[ no ] eqpt-prot-trap

<Trap::EqptProt>

[ no ] <Trap::WindowCount>
max-per-window
range: [1...20] unit: traps
[ no ] window-size
<Trap::WindowSize>
range: [0...3600] unit: s
[ no ] max-queue-size <Trap::QueueSize>
range: [1...20] unit: traps
[ no ] min-interval
<Trap::Interval>

50

Released

Description
enable sending cold start trap
optional
parameter
with
default
value:
"no-link-down"
enable sending link down trap
optional parameter with default value: "no-link-up"
enable sending of link up trap
optional
parameter
with
default
value:
"no-auth-failure"
enable sending authentication failure trap
optional
parameter
with
default
value:
"no-change-trap"
enable sending of change occured trap
optional
parameter
with
default
value:
"no-init-start"
enable sending init started trap
optional
parameter
with
default
value:
"no-lic-key-chg-occr"
enable sending licence key change occured trap
optional
parameter
with
default
value:
"no-phy-line-chg"
enable sending physical line state change trap
optional
parameter
with
default
value:
"no-eqpt-change"
enable sending equipment config or state change
trap
optional
parameter
with
default
value:
"no-success-set"
enable sending successful sets trap
optional
parameter
with
default
value:
"no-other-alarm"
enable sending indeterminate alarm changes trap
optional
parameter
with
default
value:
"no-warn-trap"
enable sending warning alarm changes trap
optional
parameter
with
default
value:
"no-minor-trap"
enable sending minor alarm changes trap
optional
parameter
with
default
value:
"no-major-trap"
enable sending major alarm changes trap
optional
parameter
with
default
value:
"no-critical-trap"
enable sending critical alarm changes trap
optional
parameter
with
default
value:
"no-redundancy-trap"
enable sending redundancy alarm changes trap
optional
parameter
with
default
value:
"no-eqpt-prot-trap"
enable sending eqpt protection switch alarm
changes trap
optional parameter with default value: 2
maximum allowed number of traps per window
optional parameter with default value: 60
the size of a time window for traps in seconds
optional parameter with default value: 10
maximum number of traps that can be queued
optional parameter with default value: 30

3HH-01016-AAAA-TCZZA

Edition 03

5 Trap Configuration Commands

Parameter
[ no ] min-severity

Type

Description

range: [0...3600] unit: s


the minimum time between two traps
<Alarm::alarmSeverity>
optional parameter with default value: "major"
Possible values are :
lowest severity an alarm must have, to be reported
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

3HH-01016-AAAA-TCZZA Edition 03

Released

51

5 Trap Configuration Commands

5.3 SHub Trap Manager Configuration Command


Command Description
This node allows to configure a SNMP manager of the SHub.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure trap shub [[no] manager (address) [ no cold-start-trap | cold-start-trap
][ no auth-fail-trap | auth-fail-trap ][ no change-trap | change-trap ][ no
community-string | community-string <PrintableString-0-255> ][ no snmp-version |
snmp-version <Snmp::SHubVersion> ][ no min-severity | min-severity
<Snmp::SHubAlarmSeverity> ]]

Command Parameters
Table 5.3-1 "SHub Trap Manager Configuration Command" Resource Parameters
Resource Identifier
(address)

Type

Description

<Ip::V4Address> : <Trap::Port>
address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]

Table 5.3-2 "SHub Trap Manager Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] cold-start-trap

<Trap::SHubColdStart>

[ no ] auth-fail-trap

<Trap::SHubAuthenticationFailure>

[ no ] change-trap

<Trap::SHubChangeOccured>

optional
parameter
with
default
value:
"no-cold-start"
enable sending cold start trap
optional
parameter
with
default
value:
"no-auth-failure"
enable sending authentication failure trap
optional
parameter
with
default
value:
"no-change-trap"
enable sending of change occured trap
optional parameter with default value: "public"
the community string to be used
optional parameter with default value: "v2"
manager type

[ no ] <PrintableString-0-255>
community-string
length: x<255
[ no ] snmp-version
<Snmp::SHubVersion>
Possible values are :
- v1 : snmp V1 manager type
- v2 : snmp V2 manager type
[ no ] min-severity
<Snmp::SHubAlarmSeverity>
Possible values are :
- indeterminate : indeterminate
- warning : warning
- minor : minor

52

Released

optional
parameter
with
default
value:
"indeterminate"
lowest severity an alarm must have, to be reported

3HH-01016-AAAA-TCZZA

Edition 03

5 Trap Configuration Commands

Parameter

Type

Description

- major : major
- critical : critical

Command Output
Table 5.3-3 "SHub Trap Manager Configuration Command" Display parameters
Specific Information
name
row-status

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

3HH-01016-AAAA-TCZZA Edition 03

Released

53

6- Equipment Configuration Commands

6.1 Slot Configuration Command


6.2 Applique Configuration Command
6.3 Protection Group Configuration Command
6.4 Protection Element Configuration Command
6.5 ISAM Configuration Command
6.6 Rack Configuration Command
6.7 Shelf Configuration Command

54

Released

6-55
6-56
6-57
6-58
6-59
6-60
6-61

3HH-01016-AAAA-TCZZA

Edition 03

6 Equipment Configuration Commands

6.1 Slot Configuration Command


Command Description
This command allows the operator to configure a slot.
The slot is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameters can be configured for the slot:
planned-type: the unit type that will be inserted into the slot. The not-planned parameter indicates that a unit
will not be inserted into that slot.
power-down: the operator can power-up or power-down slots. This is only applicable to LSM.
unlock: the operator can lock or unlock a unit. A unit in thelocked state cannot be used. This attribute is only
supported for the NT (the system will refuse to lock the NT of a simplex system), EXT, and a managed LSM.
overrule-sw: the operator can overrule the default software version for this unit. This is only supported for
managed LSMs.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment slot (index) [ no planned-type | planned-type ][ no power-down |
power-down ][ no unlock | unlock ]

Command Parameters
Table 6.1-1 "Slot Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the physical number of the slot
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Table 6.1-2 "Slot Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] power-down

Possible values are depending on the


actual configuration and software,values
can be shown at online-help.
<Equipm::SlotPowerStatus>

[ no ] unlock

<Equipm::BoardAdminStatus>

optional
parameter
with
default
value:
"not-planned"
type of board intended to be in this position
optional
parameter
with
default
value:
"nopower-down"
used to power-up or power-down an LSM slot (not
supported for other type of slots)
optional parameter with default value: "lock"
changes the administration-status to unlock

[ no ] planned-type

3HH-01016-AAAA-TCZZA Edition 03

Released

55

6 Equipment Configuration Commands

6.2 Applique Configuration Command


Command Description
This command allows the operator to configure an applique.
The applique is identified by the physical slot number. The left-most slot in the shelf is number 1. The following
parameter can be configured for the slot:
planned-type: the applique type to be inserted into the slot. The not-planned parameter indicates that an
applique will not be inserted into that slot.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment applique (index) [ no planned-type | planned-type ]

Command Parameters
Table 6.2-1 "Applique Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the physical number of the applique
<Eqpt::Applique>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Applique>= range: [1...21]

Table 6.2-2 "Applique Configuration Command" Command Parameters


Parameter

Type

[ no ] planned-type

56

Description

Possible values are depending on the optional


parameter
with
default
value:
actual configuration and software,values "not-planned"
can be shown at online-help.
type of applique intended to be in this position

Released

3HH-01016-AAAA-TCZZA

Edition 03

6 Equipment Configuration Commands

6.3 Protection Group Configuration Command


Command Description
This command allows the operator to configure a protection group.
The protection group is identified by the eqptProtGroupId attribute. The value 1 is reserved for the extension chain
protection group which is always present and cannot be deleted.
The protection group is identified by an index, the value 1 is reserved for the extension chain protection
group,which is always present and cannot be deleted.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment protection-group (index) [ no admin-status | admin-status
<Equipm::PortGroupAdminStatus> ][ no eps-quenchfactor | eps-quenchfactor <TimeTicks> ]

Command Parameters
Table 6.3-1 "Protection Group Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<SignedInteger>

Index in eqpt Prot Group Table

Table 6.3-2 "Protection Group Configuration Command" Command Parameters


Parameter
[ no ] admin-status

[ no
eps-quenchfactor

Type
<Equipm::PortGroupAdminStatus>
Possible values are :
- unlock : unlock
- lock : lock
] <TimeTicks>
unit: msec

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: "unlock"
changes the administration-status to lock or unlock
optional parameter with default value: "1440000"
timervalue of quenching mechanism

Released

57

6 Equipment Configuration Commands

6.4 Protection Element Configuration Command


Command Description
This command allows the operator to configure a protection element.
The protection group is identified by the eqptProtGroupId attribute. The value 1 is reserved for the extension chain
protection group which is always present and cannot be deleted.
The redcy-ctrl-status parameter is used to force a switchover between elements of a protection group or to keep one
of the elements active. The forced-active parameter indicates that the NTA or NTB slot is configured as active.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment protection-element (index) [ no redcy-ctrl-status |
redcy-ctrl-status <Equipm::ProtElementRedcyCtrlStatus> ]

Command Parameters
Table 6.4-1 "Protection Element Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ Index in eqpt Prot Element Table
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Table 6.4-2 "Protection Element Configuration Command" Command Parameters


Parameter

Type

[ no
redcy-ctrl-status

58

] <Equipm::ProtElementRedcyCtrlStatus>
Possible values are :
- normal : normal
- forced_active : forced active

Released

Description
optional parameter with default value: "normal"
changes the redcy-ctrl-status

3HH-01016-AAAA-TCZZA

Edition 03

6 Equipment Configuration Commands

6.5 ISAM Configuration Command


Command Description
This command allows the operator to configure the ISAM. The operator can configure the following parameter:
description: text that describes the location of the ISAM.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment isam [ no description | description <Description-127> ]

Command Parameters
Table 6.5-2 "ISAM Configuration Command" Command Parameters
Parameter
[ no ] description

Type

Description

<Description-127>
length: x<127

optional parameter with default value: ""


any description to be used by the operator

3HH-01016-AAAA-TCZZA Edition 03

Released

59

6 Equipment Configuration Commands

6.6 Rack Configuration Command


Command Description
This command allows the operator to configure the rack. The operator can configure the following parameter:
description: text that describes the location of the rack.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment rack (index) [ no description | description <Description-127> ]

Command Parameters
Table 6.6-1 "Rack Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Eqpt::Rack>
range: [1...1]

the physcial position of the rack

Table 6.6-2 "Rack Configuration Command" Command Parameters


Parameter
[ no ] description

60

Type

Description

<Description-127>
length: x<127

optional parameter with default value: ""


any description to be used by the operator

Released

3HH-01016-AAAA-TCZZA

Edition 03

6 Equipment Configuration Commands

6.7 Shelf Configuration Command


Command Description
This command allows the operator to configure the shelf. The operator can configure the following parameters:
class: the classification of the shelf. The following shelf classes are supported:
- main-ethernet: supports Ethernet-based traffic. Shelves in this class can contain NT and LT units. There
must be at least one shelf of this class in the system.
- ext-ethernet: supports Ethernet-based traffic. Shelves in this class can only contain LT units.

planned-type: the type planned for this shelf. The not-planned parameter indicates that a shelf will not be
inserted at this position.
unlock: locks or unlocks the shelf.
description: text that describes the location of the shelf.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure equipment shelf (index) class <Equipm::ShelfClass> [ no planned-type |
planned-type ][ no unlock | unlock ][ no description | description <Description-127> ]

Command Parameters
Table 6.7-1 "Shelf Configuration Command" Resource Parameters
Resource Identifier
(index)

Type
<Eqpt::Rack> / <Eqpt::Shelf>
<Eqpt::Rack>=
range:
<Eqpt::Shelf>= range: [1...1]

Description
the physical identification of the shelf
[1...1]/

Table 6.7-2 "Shelf Configuration Command" Command Parameters


Parameter
class
[ no ] planned-type
[ no ] unlock
[ no ] description

Type

Description

<Equipm::ShelfClass>

optional parameter
the class to which the shelf belongs
Possible values are depending on the optional
parameter
with
default
value:
actual configuration and software,values "not-planned"
can be shown at online-help.
the planned type of the shelf
<Equipm::HolderAdminStatus>
optional parameter with default value: "lock"
changes the administration-status to unlock
<Description-127>
optional parameter with default value: ""
length: x<127
any description to be used by the operator

3HH-01016-AAAA-TCZZA Edition 03

Released

61

7- xDSL Configuration Commands

7.1 xDSL Common Service Profile Configuration


Command
7.2 xDSL Common Spectrum Profile Configuration
Command
7.3 xDSL Spectrum Profile for ADSL/ADSL2 Configuration
Command
7.4 xDSL Spectrum Profile for RE-ADSL2 Configuration
Command
7.5 xDSL Spectrum Profile for ADSL2 Plus Configuration
Command
7.6 xDSL Spectrum Profile for VDSL Configuration
Command
7.7 xDSL Line Configuration Command
7.8 xDSL Line TCA Threshold Configuration Command

62

Released

7-63
7-65
7-68
7-70
7-72
7-74
7-77
7-80

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

7.1 xDSL Common Service Profile Configuration


Command
Command Description
This command allows the operator to manage the DSL service profile. The service profile groups all parameters on
DSL service level (data rates, Rate Adaption mode, delay, ...). The service parameters are common for all DSL
flavors.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl [[no] service-profile (index) name <AsamProfileName> [(scope)
][version <SignedInteger> ][ no ra-mode-down | ra-mode-down <Xdsl::RAModeDownType> ][
no ra-mode-up | ra-mode-up <Xdsl::RAModeUpType> ][ no min-bitrate-down |
min-bitrate-down <Xdsl::BitRate> ][ no min-bitrate-up | min-bitrate-up <Xdsl::BitRate>
][ no plan-bitrate-down | plan-bitrate-down <Xdsl::BitRate> ][ no plan-bitrate-up |
plan-bitrate-up <Xdsl::BitRate> ][ no max-bitrate-down | max-bitrate-down
<Xdsl::BitRate> ][ no max-bitrate-up | max-bitrate-up <Xdsl::BitRate> ][ no
max-delay-down | max-delay-down <Xdsl::InterleavingDelay> ][ no max-delay-up |
max-delay-up <Xdsl::InterleavingDelay> ][ no imp-noise-prot-dn | imp-noise-prot-dn
<Xdsl::ImpNoiseProtection> ][ no imp-noise-prot-up | imp-noise-prot-up
<Xdsl::ImpNoiseProtection> ][ no activate | activate ]]

Command Parameters
Table 7.1-1 "xDSL Common Service Profile Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile

Table 7.1-2 "xDSL Common Service Profile Configuration Command" Command Parameters
Parameter
name
(scope)

version
[ no ] ra-mode-down

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<AsamProfileScope>
Possible values are :
- local-profile : the local profile
- network-profile : the network profile
<SignedInteger>

mandatory parameter
profile name
optional parameter
scope of the profile

<Xdsl::RAModeDownType>
Possible values are :
- operator-ctrld : operator controlled rate
adaptive mode in downstream

3HH-01016-AAAA-TCZZA Edition 03

optional parameter
version maintained by manager, usually 1 for new
profile
optional parameter with default value: "automatic"
rate adaptation mode for down stream

Released

63

7 xDSL Configuration Commands

Parameter

Type

[ no ] ra-mode-up

[ no ]
min-bitrate-down
[ no ] min-bitrate-up
[ no ]
plan-bitrate-down
[ no ] plan-bitrate-up
[ no ]
max-bitrate-down
[ no ] max-bitrate-up
[ no
max-delay-down
[ no ] max-delay-up
[ no
imp-noise-prot-dn
[ no
imp-noise-prot-up
[ no ] activate

64

- automatic : automatic rate adaptive mode


at startup in downstream
<Xdsl::RAModeUpType>
Possible values are :
- operator-ctrld : operator controlled rate
adaptive mode in upstream
- automatic : automatic rate adaptive mode
at startup in upstream
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::BitRate>
range: [0...65535] unit: kbps
<Xdsl::InterleavingDelay>
range: [1...63] unit: msec
<Xdsl::InterleavingDelay>
range: [1...63] unit: msec

] <Xdsl::ImpNoiseProtection>
range: [0...80] unit: 1/10 symbols
] <Xdsl::ImpNoiseProtection>
range: [0...80] unit: 1/10 symbols
<Xdsl::ActivateRowStatus>

Released

Description
optional parameter with default value: "automatic"
rate adaptation mode for up stream

optional parameter with default value: 1024


minimum downstream bit rate to be maintained
optional parameter with default value: 64
minimum upstream bit rate to be maintained
optional parameter with default value: 1536
planned bitrate in downstream
optional parameter with default value: 128
planned bitrate in upstream
optional parameter with default value: 6144
maximum bitrate in downstream
optional parameter with default value: 640
maximum bitrate in upstream
optional parameter with default value: 16
maximum delay for interleaving function in
downstream
optional parameter with default value: 16
maximum delay for interleaving function in
upstream
optional parameter with default value: 0
minimum impulse noise protection in downstream
optional parameter with default value: 0
minimum impulse noise protection in upstream
optional parameter with default value: "not-active"
The parameter is not visible during creation.
to activate the profile

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

7.2 xDSL Common Spectrum Profile Configuration


Command
Command Description
This command allows the operator to manage the DSL spectrum profile. The spectrum profiles groups all
parameters on DSL on physical level. These parameters are mainly related to the environmental conditions of the
line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
The specific values depending on the DSL flavor can be configured via:
configure xdsl spectrum-profile adsl-adsl2
configure xdsl spectrum-profile re-adsl
configure xdsl spectrum-profile adsl2-plus
configure xdsl spectrum-profile vdsl
The actual selected operating mode determines which set of DSL specific parameters is used. In case a common
parameter is not supported for a specific DSL flavor, this parameter will be ignored for that flavor.
When all the DSL specific flavors are configure the complete profile has to be activated.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl [[no] spectrum-profile (index) name <AsamProfileName> [(scope)
][version <SignedInteger> ][ no dis-ansi-t1413 | dis-ansi-t1413 ][ no dis-etsi-dts |
dis-etsi-dts ][ no dis-g992-1-a | dis-g992-1-a ][ no dis-g992-1-b | dis-g992-1-b ][ no
dis-g992-2-a | dis-g992-2-a ][ no dis-g992-3-a | dis-g992-3-a ][ no dis-g992-3-b |
dis-g992-3-b ][ no g992-3-l1 | g992-3-l1 ][ no g992-3-l2 | g992-3-l2 ][ no g992-3-am |
g992-3-am ][ no g992-5-a | g992-5-a ][ no g992-5-b | g992-5-b ][ no ansi-t1.424 |
ansi-t1.424 ][ no dis-etsi-ts | dis-etsi-ts ][ no itu-g993-1 | itu-g993-1 ][ no
ieee-802.3ah | ieee-802.3ah ][ no g992-5-am | g992-5-am ][ no min-noise-down |
min-noise-down <Xdsl::NoiseMargin> ][ no min-noise-up | min-noise-up
<Xdsl::NoiseMargin> ][ no trgt-noise-down | trgt-noise-down <Xdsl::NoiseMargin> ][ no
trgt-noise-up | trgt-noise-up <Xdsl::NoiseMargin> ][ no max-noise-down |
max-noise-down <Xdsl::NoiseMarginPlus> ][ no max-noise-up | max-noise-up
<Xdsl::NoiseMarginPlus> ][ no carrier-mask-down | carrier-mask-down
<Xdsl::CarrierMaskDown> ][ no carrier-mask-up | carrier-mask-up <Xdsl::CarrierMaskUp>
][ no rf-band-list | rf-band-list <Xdsl::RFBand> ][ no modification | modification
<Xdsl::ModifyStatus> ][ no activate | activate ]]

Command Parameters
Table 7.2-1 "xDSL Common Spectrum Profile Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile.

3HH-01016-AAAA-TCZZA Edition 03

Released

65

7 xDSL Configuration Commands

Table 7.2-2 "xDSL Common Spectrum Profile Configuration Command" Command Parameters
Parameter

Type

Description
mandatory parameter
profile name
optional parameter
scope of the profile

version

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<AsamProfileScope>
Possible values are :
- local-profile : the local profile
- network-profile : the network profile
<SignedInteger>

[ no ] dis-ansi-t1413

<Xdsl::T1413>

[ no ] dis-etsi-dts

<Xdsl::Etsidts>

[ no ] dis-g992-1-a

<Xdsl::G21potsnos>

[ no ] dis-g992-1-b

<Xdsl::G21isdnnos>

[ no ] dis-g992-2-a

<Xdsl::G22potsnos>

[ no ] dis-g992-3-a

<Xdsl::G23potsnos>

[ no ] dis-g992-3-b

<Xdsl::G23isdnnos>

[ no ] g992-3-l1

<Xdsl::G23PotsnosUs1>

[ no ] g992-3-l2

<Xdsl::G23PotsNosUs2>

[ no ] g992-3-am

<Xdsl::G23ExtPotsNos>

[ no ] g992-5-a

<Xdsl::G25PotsNos>

[ no ] g992-5-b

<Xdsl::G25IsdnNos>

[ no ] ansi-t1.424

<Xdsl::AnsiT1424>

[ no ] dis-etsi-ts

<Xdsl::EtsiTs>

[ no ] itu-g993-1

<Xdsl::ItuG9931>

[ no ] ieee-802.3ah

<Xdsl::Ieee802.3Ah>

[ no ] g992-5-am

<Xdsl::G25ExtPotsNos>

name
(scope)

66

Released

optional parameter
version maintained by manager, usually 1 for new
profile
optional
parameter
with
default
value:
"ansi-t1413-1998"
ANSI T1.413-1998
optional
parameter
with
default
value:
"etsi-dts-tm06006"
ETSI DTS/TM06006
optional parameter with default value: "g992-1-a"
G.992.1 POTS non-overlapped spectrum
optional parameter with default value: "g992-1-b"
G.992.1 ISDN non-overlapped spectrum
optional parameter with default value: "g992-2-a"
G.992.2 POTS non-overlapped spectrum
optional parameter with default value: "g992-3-a"
G.992.3 POTS non-overlapped spectrum
optional parameter with default value: "g992-3-b"
G.992.3 ISDN non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-3-l1"
G.992.3 POTS non-overlapped spectrum US mask
1
optional
parameter
with
default
value:
"dis-g992-3-l2"
G.992.3 POTS non-overlapped spectrum US mask
2
optional
parameter
with
default
value:
"dis-g992-3-am"
G.992.3 extended POTS with non-overlapped
spectrum
optional
parameter
with
default
value:
"dis-g992-5-a"
G.992.5 POTS non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-5-b"
G.992.5 ISDN non-overlapped spectrum
optional
parameter
with
default
value:
"dis-ansi-t1.424"
ansi T1.424
optional parameter with default value: "etsi-ts"
ETSI TS 101 270
optional
parameter
with
default
value:
"dis-itu-g993-1"
ITU G993-1
optional
parameter
with
default
value:
"dis-ieee-802.3ah"
IEEE 802.3ah
optional
parameter
with
default
value:

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

Parameter

Type

[ no ] <Xdsl::NoiseMargin>
min-noise-down
range: [0...310] unit: 1/10 db
[ no ] min-noise-up
<Xdsl::NoiseMargin>
range: [0...310] unit: 1/10 db
[ no ] <Xdsl::NoiseMargin>
trgt-noise-down
range: [0...310] unit: 1/10 db
[ no ] trgt-noise-up
<Xdsl::NoiseMargin>
range: [0...310] unit: 1/10 db
[ no ] <Xdsl::NoiseMarginPlus>
max-noise-down
range: [0...310,511] unit: 1/10 db
[ no ] max-noise-up
<Xdsl::NoiseMarginPlus>
range: [0...310,511] unit: 1/10 db
[ no ] <Xdsl::CarrierMaskDown>
carrier-mask-down
length: 64

[
carrier-mask-up

no

] <Xdsl::CarrierMaskUp>
length: 8

[ no ] rf-band-list

<Xdsl::RFBand>
length: x<40

[ no ] modification

<Xdsl::ModifyStatus>
Possible values are :
- start : to start modifying the profile
- cancel : to cancel the modifications done
- complete : to complete the modifications
<Xdsl::ActivateRowStatus>

[ no ] activate

3HH-01016-AAAA-TCZZA Edition 03

Description
"dis-g992-5-am"
G.992.5 extended POTS non-overlapped spectrum
optional parameter with default value: 0
minimum noise margin in downstream
optional parameter with default value: 0
minimum noise margin in upstream
optional parameter with default value: 60
target noise margin in downstream
optional parameter with default value: 60
maximum noise margin in upstream
optional parameter with default value: 511
target noise margin in downstream
optional parameter with default value: 511
maximum noise margin in upstream
optional parameter with default value: "00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 : 00 :
00 : 00 : 00 : 00 : 00 : 00 : 00"
the downstream carrier mask pattern
optional parameter with default value: "00 : 00 :
00 : 00 : 00 : 00 : 00 : 00"
the upstream carrier mask pattern
optional parameter with default value: "07 : 12 :
07 : d0 : 19 : 0d : ac : 0e : d8 : 19 : 1b : 58 : 1b :
bc : 19 : 27 : 74 : 27 : a6 : 19"
list of RF bands
optional parameter with default value: "complete"
to modify the profile

optional parameter with default value: "not-active"


The parameter is not visible during creation.
to activate the profile

Released

67

7 xDSL Configuration Commands

7.3 xDSL Spectrum Profile for ADSL/ADSL2


Configuration Command
Command Description
This command allows the operator to manage the ADSL and ADSL2 specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration Profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL-ADSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl-adsl2 [ no proprietary-feat |
proprietary-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::Adsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::Adsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no max-recv-power-up
| max-recv-power-up <Xdsl::RxPowerLevel> ]

Command Parameters
Table 7.3-1 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Resource
Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile.

Table 7.3-2 "xDSL Spectrum Profile for ADSL/ADSL2 Configuration Command" Command
Parameters
Parameter

Type

[ no ] proprietary-feat

Description

optional
parameter
with
default
value:
"no-proprietary"
enable proprietary features of the modem
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-down
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in downstream
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-up
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in upstream
[ no ] max-psd-down <Xdsl::Adsl2PowerSpectralDensityDown> optional parameter with default value: -400

68

<Xdsl::FeatureDisable>

Released

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

Parameter

Type

Description

range: [-600...-400] unit: 1/10 * dBm/Hz

maximum power spectral density allowed in


downstream
optional parameter with default value: -380
maximum power spectral density allowed in
upstream
optional
parameter
with
default
value:
"pbo-mode-down"
upstream power backoff mode
optional parameter with default value: 255
the maximum receive power allowed in upstream

[ no ] max-psd-up

<Xdsl::Adsl2PowerSpectralDensityUp>
range: [-600...-380] unit: 1/10 * dBm/Hz

[ no ] pbo-mode

<Xdsl::PboMode>

[ no
max-recv-power-up

] <Xdsl::RxPowerLevel>
range: [-255...255]

3HH-01016-AAAA-TCZZA Edition 03

Released

69

7 xDSL Configuration Commands

7.4 xDSL Spectrum Profile for RE-ADSL2


Configuration Command
Command Description
This command allows the operator to manage the Reach Extented ADSL2 specific part of the DSL spectrum profile.
The spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the Reach Extended DSL2 flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) re-adsl [ no proprietary-feat |
proprietary-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::ReAdsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::ReAdsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no
max-recv-power-up | max-recv-power-up <Xdsl::RxPowerLevel> ]

Command Parameters
Table 7.4-1 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Resource
Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile.

Table 7.4-2 "xDSL Spectrum Profile for RE-ADSL2 Configuration Command" Command
Parameters
Parameter

Type

[ no ] proprietary-feat

Description

optional
parameter
with
default
value:
"no-proprietary"
enable proprietary features of the modem
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-down
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in downstream
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-up
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in upstream
[ no ] max-psd-down <Xdsl::ReAdsl2PowerSpectralDensityDown>optional parameter with default value: -370

70

<Xdsl::FeatureDisable>

Released

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

Parameter

Type

Description

range: [-600...-370] unit: 1/10 * dBm/Hz

[ no ] max-psd-up
[ no ] pbo-mode
[ no
max-recv-power-up

maximum power spectral density allowed in


downstream
<Xdsl::ReAdsl2PowerSpectralDensityUp> optional parameter with default value: -329
range: [-600...-329] unit: 1/10 * dBm/Hz
maximum power spectral density allowed in
upstream
<Xdsl::PboMode>
optional
parameter
with
default
value:
"pbo-mode-down"
upstream power backoff mode
] <Xdsl::RxPowerLevel>
optional parameter with default value: 255
range: [-255...255]
the maximum receive power allowed in upstream

3HH-01016-AAAA-TCZZA Edition 03

Released

71

7 xDSL Configuration Commands

7.5 xDSL Spectrum Profile for ADSL2 Plus


Configuration Command
Command Description
This command allows the operator to manage the ADSL2-plus specific part of the DSL spectrum profile. The
spectrum profiles groups all parameters on DSL on physical level. These parameters are mainly related to the
environmental conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the ADSL2-plus flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) adsl2-plus [ no proprietaty-feat |
proprietaty-feat ][ no max-agpowlev-down | max-agpowlev-down <Xdsl::PowerLevel> ][ no
max-agpowlev-up | max-agpowlev-up <Xdsl::PowerLevel> ][ no max-psd-down | max-psd-down
<Xdsl::Adsl2PowerSpectralDensityDown> ][ no max-psd-up | max-psd-up
<Xdsl::Adsl2PowerSpectralDensityUp> ][ no pbo-mode | pbo-mode ][ no max-recv-power-up
| max-recv-power-up <Xdsl::RxPowerLevel> ]

Command Parameters
Table 7.5-1 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Resource
Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile.

Table 7.5-2 "xDSL Spectrum Profile for ADSL2 Plus Configuration Command" Command
Parameters
Parameter

Type

[ no ] proprietaty-feat

Description

optional
parameter
with
default
value:
"no-proprietary"
enable proprietary features of the modem
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-down
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in downstream
[ no ] <Xdsl::PowerLevel>
optional parameter with default value: 255
max-agpowlev-up
range: [0...255] unit: 1/10 * dBm
maximum aggregate power allowed in upstream
[ no ] max-psd-down <Xdsl::Adsl2PowerSpectralDensityDown> optional parameter with default value: -400

72

<Xdsl::FeatureDisable>

Released

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

Parameter

Type

Description

range: [-600...-400] unit: 1/10 * dBm/Hz

maximum power spectral density allowed in


downstream
optional parameter with default value: -380
maximum power spectral density allowed in
upstream
optional
parameter
with
default
value:
"pbo-mode-down"
upstream power backoff mode
optional parameter with default value: 255
the maximum receive power allowed in upstream

[ no ] max-psd-up

<Xdsl::Adsl2PowerSpectralDensityUp>
range: [-600...-380] unit: 1/10 * dBm/Hz

[ no ] pbo-mode

<Xdsl::PboMode>

[ no
max-recv-power-up

] <Xdsl::RxPowerLevel>
range: [-255...255]

3HH-01016-AAAA-TCZZA Edition 03

Released

73

7 xDSL Configuration Commands

7.6 xDSL Spectrum Profile for VDSL Configuration


Command
Command Description
This command allows the operator to manage the VDSL specific part of the DSL spectrum profile. The spectrum
profiles groups all parameters on DSL on physical level. These parameters are mainly related to the environmental
conditions of the line (spectrum management).
The Spectrum Configuration profile contains parameters which have a common value for all DSL flavors
(Common) and parameters which have a specific value depending on the DSL flavor used (ADSL1/2, READSL2,
ADSL2Plus, VDSL).
This chapter contains the VDSL flavor specific parameters.
Note: the activation of the profile has to be done via configure xdsl spectrum-profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl spectrum-profile (index) vdsl [ no proprietary-feat |
proprietary-feat ][ no vdsl-band-plan | vdsl-band-plan <Xdsl::VdslBandPlan> ][ no
optional-band | optional-band <Xdsl::OptionalBandUsage> ][ no optional-endfreq |
optional-endfreq <Xdsl::OptionalBandEndFreq> ][ no adsl-band | adsl-band ][ no
max-agpowlev-down | max-agpowlev-down <Xdsl::VdslPowerLevel> ][ no max-agpowlev-up |
max-agpowlev-up <Xdsl::VdslPowerLevel> ][ no psd-shape-down | psd-shape-down
<Xdsl::VdslPsdShapeDown> ][ no psd-shape-up | psd-shape-up <Xdsl::VdslPsdShapeUp> ][
no pbo-mode | pbo-mode ][ no recv-psd-shape-up | recv-psd-shape-up
<Xdsl::RxVdslPsdShapeUp> ]

Command Parameters
Table 7.6-1 "xDSL Spectrum Profile for VDSL Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::ProfileIndex>
range: [1...100]

index of the profile.

Table 7.6-2 "xDSL Spectrum Profile for VDSL Configuration Command" Command Parameters
Parameter

Type

[ no ] proprietary-feat
[ no ] vdsl-band-plan

74

Description

<Xdsl::FeatureDisable>

optional
parameter
with
default
"no-proprietary"
proprietary features of the modem
<Xdsl::VdslBandPlan>
optional
parameter
with
default
Possible values are :
"band-plan-b3"
- band-plan-a4 : 4 bands of frequency 998 the VDSL band plan
(ITU-T)
- band-plan-a3 : 3 bands of frequency 998

Released

3HH-01016-AAAA-TCZZA

Edition 03

value:
value:

7 xDSL Configuration Commands

Parameter

Type

- band-plan-a2 : 2 bands of frequency 998


- band-plan-b4 : 4 bands of frequency 997
(ITU-T)
- band-plan-b3 : 3 bands of frequency 997
- band-plan-b2 : 2 bands of frequency 997
- a3-china : 3 bands of china band plan 1
- a2-china : 2 bands of china band plan 1
- b3-china : 3 bands of china band plan 2
- b2-china : 2 bands of china band plan 2
[ no ] optional-band
<Xdsl::OptionalBandUsage>
Possible values are :
- off : usage of optional band is not
allowed
- up : optional band can be used for
upstream
- down : optional band can be used for
downstream
[ no ] <Xdsl::OptionalBandEndFreq>
optional-endfreq
range: [138...276]
[ no ] adsl-band
<Xdsl::AdslBandUsage>
[ no
max-agpowlev-down
[ no
max-agpowlev-up
[ no
psd-shape-down

Description

optional parameter with default value: "off"


optional band Usage

optional parameter with default value: 138


optional band end frequency
optional
parameter
with
default
value:
"adsl-band-notallowed"
adsl band Usage
] <Xdsl::VdslPowerLevel>
optional parameter with default value: 255
range: [-310...255] unit: 1/10 * dBm
maximum power allowed on the line in
downstream
] <Xdsl::VdslPowerLevel>
optional parameter with default value: 255
range: [-310...255] unit: 1/10 * dBm
maximum power allowed on the line in upstream
] <Xdsl::VdslPsdShapeDown>
optional
parameter
with
default
value:
Possible values are :
"etsi-p-cab-m1"
- ansi-ftt-ex-m1 : ANSI standard spectral power spectral density shape in downstream
density in downstream
- ansi-ftt-ex-m2 : ANSI standard spectral
density in downstream
- ansi-ftt-cab-m1 : ANSI standard spectral
density in downstream
- ansi-ftt-cab-m2 : ANSI standard spectral
density in downstream
- etsi-p-ex-p1-m1 : ETSI standard spectral
density in downstream
- etsi-p-ex-p1-m2 : ETSI standard spectral
density in downstream
- etsi-p-ex-p2-m1 : ETSI standard spectral
density in downstream
- etsi-p-ex-p2-m2 : ETSI standard spectral
density in downstream
- etsi-p-cab-m1 : ETSI standard spectral
density in downstream
- etsi-p-cab-m2 : ETSI standard spectral
density in downstream
- etsi-p-ex-m2-s1 : ETSI proprietary
spectral density in downstream
- etsi-p-ex-m2-s2 : ETSI proprietary
spectral density in downstream
- etsi-p-ex-m2-s3 : ETSI proprietary
spectral density in downstream
- etsi-p-ex-m2-s4 : ETSI proprietary
spectral density in downstream

3HH-01016-AAAA-TCZZA Edition 03

Released

75

7 xDSL Configuration Commands

Parameter
[ no ] psd-shape-up

[ no ] pbo-mode
[ no
recv-psd-shape-up

76

Type

Description

<Xdsl::VdslPsdShapeUp>
Possible values are :
- ansi-ftt-ex-m1 : ANSI standard
density in upstream
- ansi-ftt-ex-m2 : ANSI standard
density in upstream
- ansi-ftt-cab-m1 : ANSI standard
density in upstream
- ansi-ftt-cab-m2 : ANSI standard
density in upstream
- etsi-p-m1 : ETSI standard
density in upstream
- etsi-p-m2 : ETSI standard
density in upstream
<Xdsl::PboMode>

optional parameter with default value: "etsi-p-m1"


power spectral density shape in upstream
spectral
spectral
spectral
spectral
spectral
spectral

] <Xdsl::RxVdslPsdShapeUp>
Possible values are :
- ansi-a : ansi standard spectral density
shape in upstream
- ansi-f : ansi standard spectral density
shape in upstream
- ansi-custom-ex : ansi custom spectral
density shape in upstream
- ansi-custom-cab : ansi custom spectral
density shape in upstream
- etsi-a : etsi standard spectral density
shape in upstream
- etsi-b : etsi standard spectral density
shape in upstream
- etsi-c : etsi standard spectral density
shape in upstream
- etsi-d : etsi standard spectral density
shape in upstream
- etsi-e : etsi standard spectral density
shape in upstream
- etsi-f : etsi standard spectral density
shape in upstream
- etsi-custom-ex : etsi custom spectral
density shape in upstream
- etsi-custom-cab : etsi custom standard
spectral density shape in upstream

Released

optional
parameter
with
default
value:
"pbo-mode-up"
upstream power backoff mode
optional parameter with default value: "etsi-a"
the reference RX PSD shape for upstream

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

7.7 xDSL Line Configuration Command


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

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) service-profile <AsamProfilePointer> spectrum-profile
<AsamProfilePointer> [ no ansi-t1413 | ansi-t1413 ][ no etsi-dts | etsi-dts ][ no
g992-1-a | g992-1-a ][ no g992-1-b | g992-1-b ][ no g992-2-a | g992-2-a ][ no g992-3-a
| g992-3-a ][ no g992-3-b | g992-3-b ][ no g992-3-l1 | g992-3-l1 ][ no g992-3-l2 |
g992-3-l2 ][ no g992-3-am | g992-3-am ][ no g992-5-a | g992-5-a ][ no g992-5-b |
g992-5-b ][ no ansi-t1.424 | ansi-t1.424 ][ no etsi-ts | etsi-ts ][ no itu-g993-1 |
itu-g993-1 ][ no ieee-802.3ah | ieee-802.3ah ][ no g992-5-am | g992-5-am ][ no
carrier-data-mode | carrier-data-mode <Xdsl::CarrierDataMode> ][ no admin-up |
admin-up ][ no bonding-mode | bonding-mode <Xdsl::BondingMode> ]

Command Parameters
Table 7.7-1 "xDSL Line Configuration Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Table 7.7-2 "xDSL Line Configuration Command" Command Parameters


Parameter
service-profile
spectrum-profile
[ no ] ansi-t1413

Type

Description

<AsamProfilePointer>
range: [0...65535]
<AsamProfilePointer>
range: [0...65535]
<Xdsl::T1413>

optional parameter
service profile to be configured on this port
optional parameter
spectrum profile to be configured on this port
optional
parameter
with
default
value:
"dis-ansi-t1413-1998"
ANSI T1.413-1998

3HH-01016-AAAA-TCZZA Edition 03

Released

77

7 xDSL Configuration Commands

Parameter

Type

Description

[ no ] etsi-dts

<Xdsl::Etsidts>

[ no ] g992-1-a

<Xdsl::G21potsnos>

[ no ] g992-1-b

<Xdsl::G21isdnnos>

[ no ] g992-2-a

<Xdsl::G22potsnos>

[ no ] g992-3-a

<Xdsl::G23potsnos>

[ no ] g992-3-b

<Xdsl::G23isdnnos>

[ no ] g992-3-l1

<Xdsl::G23PotsnosUs1>

[ no ] g992-3-l2

<Xdsl::G23PotsNosUs2>

[ no ] g992-3-am

<Xdsl::G23ExtPotsNos>

[ no ] g992-5-a

<Xdsl::G25PotsNos>

[ no ] g992-5-b

<Xdsl::G25IsdnNos>

[ no ] ansi-t1.424

<Xdsl::AnsiT1424>

[ no ] etsi-ts

<Xdsl::EtsiTs>

[ no ] itu-g993-1

<Xdsl::ItuG9931>

[ no ] ieee-802.3ah

<Xdsl::Ieee802.3Ah>

[ no ] g992-5-am

<Xdsl::G25ExtPotsNos>

optional
parameter
with
default
value:
"dis-etsi-dts-tm06006"
ETSI DTS/TM06006
optional
parameter
with
default
value:
"dis-g992-1-a"
G.992.1 POTS non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-1-b"
G.992.1 ISDN non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-2-a"
G.992.2 POTS non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-3-a"
G.992.3 POTS non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-3-b"
G.992.3 ISDN non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-3-l1"
G.992.3 POTS non-overlapped spectrum US mask
1
optional
parameter
with
default
value:
"dis-g992-3-l2"
G.992.3 POTS non-overlapped spectrum US mask
2
optional
parameter
with
default
value:
"dis-g992-3-am"
G.992.3 extended POTS with non-overlapped
spectrum
optional
parameter
with
default
value:
"dis-g992-5-a"
G.992.5 POTS non-overlapped spectrum
optional
parameter
with
default
value:
"dis-g992-5-b"
G.992.5 ISDN non-overlapped spectrum
optional
parameter
with
default
value:
"dis-ansi-t1.424"
ansi T1.424
optional parameter with default value: "dis-etsi-ts"
ETSI TS 101 270
optional
parameter
with
default
value:
"dis-itu-g993-1"
ITU G993-1
optional
parameter
with
default
value:
"dis-ieee-802.3ah"
IEEE 802.3ah
optional
parameter
with
default
value:
"dis-g992-5-am"
G.992.5 extended POTS non-overlapped spectrum
optional parameter with default value: "off"
carrier data measurement collection

[ no
carrier-data-mode

[ no ] admin-up

78

] <Xdsl::CarrierDataMode>
Possible values are :
- off : disable the collection
- on : enable the collection
- on-init : enable and re-initialize the line
<Xdsl::LineAdminStatus>

Released

optional
parameter
"admin-down"

3HH-01016-AAAA-TCZZA

with

default

Edition 03

value:

7 xDSL Configuration Commands

Parameter
[ no ] bonding-mode

Type

Description

adminstrative status of the xdsl line


<Xdsl::BondingMode>
optional
parameter
with
default
Possible values are :
"native-bonding"
- native-bonding : native bonding mode channel-1 bonding mode
for channel-1
- atm-bonding : atm bonding mode for
channel-1

3HH-01016-AAAA-TCZZA Edition 03

Released

79

value:

7 xDSL Configuration Commands

7.8 xDSL Line TCA Threshold Configuration


Command
Command Description
This command allows the operator to configure the Threshold Crossing Alert (TCA) thresholds. The configuration
is specific per xdsl line.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl line (if-index) tca-line-threshold [ no enable | enable ][ no
es-nearend | es-nearend <Xdsl::IntervalTcaThreshold> ][ no ses-nearend | ses-nearend
<Xdsl::IntervalTcaThreshold> ][ no uas-nearend | uas-nearend
<Xdsl::IntervalTcaThreshold> ][ no es-day-nearend | es-day-nearend
<Xdsl::DayTcaThreshold> ][ no ses-day-nearend | ses-day-nearend
<Xdsl::DayTcaThreshold> ][ no uas-day-nearend | uas-day-nearend
<Xdsl::DayTcaThreshold> ][ no es-farend | es-farend <Xdsl::IntervalTcaThreshold> ][ no
ses-farend | ses-farend <Xdsl::IntervalTcaThreshold> ][ no uas-farend | uas-farend
<Xdsl::IntervalTcaThreshold> ][ no es-day-farend | es-day-farend
<Xdsl::DayTcaThreshold> ][ no ses-day-farend | ses-day-farend <Xdsl::DayTcaThreshold>
][ no uas-day-farend | uas-day-farend <Xdsl::DayTcaThreshold> ]

Command Parameters
Table 7.8-1 "xDSL Line TCA Threshold Configuration Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Table 7.8-2 "xDSL Line TCA Threshold Configuration Command" Command Parameters
Parameter
[ no ] enable

Type

Description

<Xdsl::TcaEnable>

optional parameter with default value: "disable"


enable the reporting of TCA's for this XDSL line
optional parameter with default value: 0
errored seconds at the near end
optional parameter with default value: 0
severely errored seconds at the near end
optional parameter with default value: 0
unavailable seconds at the near end
optional parameter with default value: 0
errored seconds at the near end for a day
optional parameter with default value: 0
severely errored seconds at the near end for a day
optional parameter with default value: 0
unavailable seconds at the near end for a day

[ no ] es-nearend

<Xdsl::IntervalTcaThreshold>
range: [0...900]
[ no ] ses-nearend
<Xdsl::IntervalTcaThreshold>
range: [0...900]
[ no ] uas-nearend
<Xdsl::IntervalTcaThreshold>
range: [0...900]
[ no ] es-day-nearend <Xdsl::DayTcaThreshold>
range: [0...86400]
[ no ] <Xdsl::DayTcaThreshold>
ses-day-nearend
range: [0...86400]
[ no ] <Xdsl::DayTcaThreshold>
uas-day-nearend
range: [0...86400]

80

Released

3HH-01016-AAAA-TCZZA

Edition 03

7 xDSL Configuration Commands

Parameter
[ no ] es-farend
[ no ] ses-farend
[ no ] uas-farend
[ no ] es-day-farend
[ no ] ses-day-farend
[ no ] uas-day-farend

Type

Description

<Xdsl::IntervalTcaThreshold>
range: [0...900]
<Xdsl::IntervalTcaThreshold>
range: [0...900]
<Xdsl::IntervalTcaThreshold>
range: [0...900]
<Xdsl::DayTcaThreshold>
range: [0...86400]
<Xdsl::DayTcaThreshold>
range: [0...86400]
<Xdsl::DayTcaThreshold>
range: [0...86400]

optional parameter with default value: 0


errored seconds at the far end
optional parameter with default value: 0
severely errored seconds at the far end
optional parameter with default value: 0
unavailable seconds at the far end
optional parameter with default value: 0
errored seconds at the far end for a day
optional parameter with default value: 0
severely errored seconds at the far end for a day
optional parameter with default value: 0
unavailable seconds at the far end for a day

3HH-01016-AAAA-TCZZA Edition 03

Released

81

8- ATM Configuration Commands

8.1 ATM PVC Configuration Command

82

Released

8-83

3HH-01016-AAAA-TCZZA

Edition 03

8 ATM Configuration Commands

8.1 ATM PVC Configuration Command


Command Description
This command configures an ATM PVC.
The admin status will allow or disallow traffic flowing on the PVC
The encapsulation type configures the way higher layer traffic is encapsulated in the AAL5 container.
The "LLC Encapsulation" method allows multiplexing of multiple protocols over a single ATM virtual connection
(VC). The protocol type of each PDU is identified by a prefixed IEEE 802.2 Logical Link Control (LLC) header.
In the "VC Multiplexing" method, each ATM VC carries PDUs of exactly one protocol type. When multiple
protocols need to be transported, there is a separate VC for each.
Usage of the encapsulations :
llc-snap and vc-mux-bridged-8023 can be used for cross-connects, ibridge, PPPoE and IPoE
llc-snap-routed and vc-mux-routed can be used for IPoA
llc-nlpid and vc-mux-pppoa can be used for PPPoA
It is also possible to automatically detect the used encapsulation type on the link.
automatic:ip is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-snap-routed and
vc-mux-routed
automatic:ppp is used for auto-detection between llc-snap, vc-mux-bridged-8023, llc-nlpid and vc-mux-pppoa
automatic:pppoa is used for auto-detection between llc-nlpid and vc-mux-pppoa.
The only encapsulation type supported on L2 LT's is llc-snap.

User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> configure atm [[no] pvc (port-index) [ no admin-down | admin-down ][ no
aal5-encap-type | aal5-encap-type llc-snap | llc-snap-routed | llc-nlpid |
vc-mux-bridged-8023 | vc-mux-routed | vc-mux-pppoa | automatic : ip | ppp | pppoa ]]

Command Parameters
Table 8.1-1 "ATM PVC Configuration Command" Resource Parameters
Resource Identifier
(port-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the atm static Interface with vpi and vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 8.1-2 "ATM PVC Configuration Command" Command Parameters


Parameter
[ no ] admin-down

Type

Description

<Atm::adminStatus>

optional parameter with default value: "admin-up"


enables or disables the traffic flow

3HH-01016-AAAA-TCZZA Edition 03

Released

83

8 ATM Configuration Commands

Parameter
[
aal5-encap-type

84

Type
no

] llc-snap | llc-snap-routed | llc-nlpid |


vc-mux-bridged-8023 | vc-mux-routed |
vc-mux-pppoa | automatic : ip | ppp |
pppoa
Possible values are :
- llc-snap : logical link control
encapsulation bridged protocol
- llc-snap-routed : logical link control
encapsulation routed protocol
- llc-nlpid : logical link control
encapsulation pppoa protocol
- vc-mux-bridged-8023 : virtual channel
multiplex bridged protocol
- vc-mux-routed : virtual channel
multiplex routed protocol
- vc-mux-pppoa : virtual channel
multiplex pppoa protocol
- automatic : automatic detection of
encapsulation type
- ip : autodetection of the used ip
encapsulation
- ppp : autodetection of the used ppp
encapsulation
- pppoa : autodetection of the used pppoa
encapsulation

Released

Description
optional parameter with default value: "llc-snap"
describes the different encapsulations methods for
carrying network interconnect traffic over AAL
type 5 over ATM

3HH-01016-AAAA-TCZZA

Edition 03

9- Interface Management Configuration Commands

9.1 Network Interface Configuration Command


9.2 Extend Interface Configuration Command
9.3 Interface Alarm Configuration Command
9.4 SHub Management Interface Configuration Command
9.5 SHub IP Configuration Command
9.6 SHub Multi-Network Configuration Command
9.7 SHub ICMP Configuration Command
9.8 SHub Port Control Configuration Command
9.9 SHub Interface Uplink Group Configuration Command
9.10 SHub Interface Uplink Group Portlist Configuration
Command

3HH-01016-AAAA-TCZZA Edition 03

9-86
9-88
9-89
9-90
9-91
9-92
9-93
9-94
9-96
9-97

Released

85

9 Interface Management Configuration Commands

9.1 Network Interface Configuration Command


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

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface port (port) [ no (admin-up) ][ no (link-updown-trap) ][ no user
| user <Itf::asamIfExtCustomerId> ][ no severity | severity
<Itf::asamIfExtAlmReportingSeverity> ]

Command Parameters
Table 9.1-1 "Network Interface Configuration Command" Resource Parameters
Resource Identifier
(port)

86

Type

Description

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface index


<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVci>
:
<PPPoE::LogicalSesId> | <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot> / <Eqpt::Port> | atm-if :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot> / <Eqpt::Port> | atm-pvc :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
bridge-port
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci>
|
pppoe
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :

Released

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

Resource Identifier

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::NtSlot> : <Ip::LogicalId>
sw-loopback
:
<Eqpt::Rack>
<Eqpt::Shelf> / <Eqpt::NtSlot>

Description
/
|
/

Table 9.1-2 "Network Interface Configuration Command" Command Parameters


Parameter
[ no ] (admin-up)
[ no
(link-updown-trap)
[ no ] user
[ no ] severity

Type

Description

<Itf::ifAdminStatus>

optional
parameter
with
default
value:
"admin-down"
the desired state of the interface
optional
parameter
with
default
value:
"no-link-updown-trap"
indicate whether link-up/link-down traps should be
generated
optional parameter with default value: "available"
description of the user connected to this interface
optional parameter with default value: "default"
set minimum severity for alarm to be reported

] <Itf::ifLinkUpDownTrapEnable>

<Itf::asamIfExtCustomerId>
length: x<32
<Itf::asamIfExtAlmReportingSeverity>
Possible values are :
- indeterminate : not a definite known
severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
- no-alarms : do not report alarm
- default : take default as specified in
asamIfExtAlmReportingSeverityDefaultTable

3HH-01016-AAAA-TCZZA Edition 03

Released

87

9 Interface Management Configuration Commands

9.2 Extend Interface Configuration Command


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

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface atm-pvc (pvc-index) [ no customer-id | customer-id
<Itf::asamIfExtCustomerId> ]

Command Parameters
Table 9.2-1 "Extend Interface Configuration Command" Resource Parameters
Resource Identifier
(pvc-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the ATM PVC interface index
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 9.2-2 "Extend Interface Configuration Command" Command Parameters


Parameter
[ no ] customer-id

88

Type

Description

<Itf::asamIfExtCustomerId>
length: x<32

optional parameter with default value: "available"


Config the customerId per PVC

Released

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

9.3 Interface Alarm Configuration Command


Command Description
This command allows the operator to configure the default severity for an alarm on this type of interface.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface alarm (index) [ no default-severity | default-severity
<Itf::asamIfExtAlmReportingSeverityDefault> ]

Command Parameters
Table 9.3-1 "Interface Alarm Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Itf::AlarmItfType>

index of the IANA ifType

Table 9.3-2 "Interface Alarm Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] default-severity <Itf::asamIfExtAlmReportingSeverityDefault>
optional parameter with default value: "major"
Possible values are :
default severity to be reported
- indeterminate : not a definite known
severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

3HH-01016-AAAA-TCZZA Edition 03

Released

89

9 Interface Management Configuration Commands

9.4 SHub Management Interface Configuration


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

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub [[no] vlan-id (vlan-id) [ no mtu | mtu <Shub::ifMainMtu> ][
no admin-status | admin-status <Shub::AdminStatus> ]]

Command Parameters
Table 9.4-1 "SHub Management Interface Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]

vlan id

Table 9.4-2 "SHub Management Interface Configuration Command" Command Parameters


Parameter
[ no ] mtu
[ no ] admin-status

90

Type

Description

<Shub::ifMainMtu>
range: [90...9100]
<Shub::AdminStatus>
Possible values are :
- up : up
- down : down
- auto-up : autoup

optional parameter with default value: 1500


MTU for the vlan interface
optional parameter with default value: "down"
administrative state of the vlan interface

Released

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

9.5 SHub IP Configuration Command


Command Description
This node allows the operator to configure IP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) vrf-id <Vrf::ShubVrfID>

Command Parameters
Table 9.5-1 "SHub IP Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]

vlan id

Table 9.5-2 "SHub IP Configuration Command" Command Parameters


Parameter
vrf-id

Type

Description

<Vrf::ShubVrfID>
range: [0...127]

optional parameter
the VRF instance to which this interface is
associated

3HH-01016-AAAA-TCZZA Edition 03

Released

91

9 Interface Management Configuration Commands

9.6 SHub Multi-Network Configuration Command


Command Description
This node allows the operator to configure multinet IP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) [[no] ip-addr (ip-addr) ]

Command Parameters
Table 9.6-1 "SHub Multi-Network Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)
(ip-addr)

92

Type

Description

<Vlan::VlanOamIndex>
vlan id
range: [1...4093]
<Ip::V4Address> / <Ip::PrefixLengthFull> ip-address

Released

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

9.7 SHub ICMP Configuration Command


Command Description
This node allows the operator to configure ICMP parameters related to SHub.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> configure interface shub ip (vlan-id) icmp [ no err-msg-suppres | err-msg-suppres ][
no ping-msg-suppres | ping-msg-suppres ]

Command Parameters
Table 9.7-1 "SHub ICMP Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]

vlan id

Table 9.7-2 "SHub ICMP Configuration Command" Command Parameters


Parameter

Type

[ no ] err-msg-suppres <Shub::IcmpErrMsgSuppression>
[ no
ping-msg-suppres

] <Shub::PingMsgSuppression>

3HH-01016-AAAA-TCZZA Edition 03

Description
optional
parameter
with
default
value:
"no-err-msg-suppress"
suppress the sending of ICMP error messages
optional
parameter
with
default
value:
"no-ping-msg-suppress"
suppress PING packets

Released

93

9 Interface Management Configuration Commands

9.8 SHub Port Control Configuration Command


Command Description
This node allows the user to configure parameters related to port control configuration of an SHub interface.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure interface shub port (network-port) [ no mode | mode automatic | [10mbps |
100mbps | 1gbps] : full | half ][ no admin-status | admin-status <Shub::AdminStatus>
][ no port-type | port-type <Sys::Type> ][ no (mc-flooding) ]

Command Parameters
Table 9.8-1 "SHub Port Control Configuration Command" Resource Parameters
Resource Identifier
(network-port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

identifier of the port interface

Table 9.8-2 "SHub Port Control Configuration Command" Command Parameters


Parameter
[ no ] mode

[ no ] admin-status

[ no ] port-type

94

Type

Description

automatic | [10mbps | 100mbps | 1gbps] :


full | half
Possible values are :
- automatic : determine the parameters of
interface automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
- full : data transfer in full duplex
- half : data transfer in half duplex
<Shub::AdminStatus>
Possible values are :
- up : up
- down : down
- auto-up : autoup
<Sys::Type>
Possible values are :
- user : port to a directly connected user
- subtending : port to a subtended ISAM
- network : port to the service provider
(ISP)
- unused : port is not in use
- outband-mngt : port is used for
outband-management

optional parameter with default value: "automatic"


negotiation mode of the port interface parameters

Released

optional parameter with default value: "down"


administrative state of the port

optional parameter with default value: "unused"


the type of port interface

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

Parameter
[ no ] (mc-flooding)

Type

Description

<Sys::FloodMode>

optional
parameter
with
"no-mc-flooding"
enable multicast flooding

3HH-01016-AAAA-TCZZA Edition 03

Released

default

95

value:

9 Interface Management Configuration Commands

9.9 SHub Interface Uplink Group Configuration


Command
Command Description
This node allows the user to configure parameters related to uplink group configuration of an interface.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure interface shub [[no] group (group-id) [ no threshold | threshold
<Itf::Threshold> ]]

Command Parameters
Table 9.9-1 "SHub Interface Uplink Group Configuration Command" Resource Parameters
Resource Identifier
(group-id)

Type

Description

<Itf::GroupId>
range: [1...7]

A unique number for each logical uplink group

Table 9.9-2 "SHub Interface Uplink Group Configuration Command" Command Parameters
Parameter
[ no ] threshold

96

Type

Description

<Itf::Threshold>
range: [0...7]

optional parameter with default value: 0L


the min nbr of links to be operational UP in grp

Released

3HH-01016-AAAA-TCZZA

Edition 03

9 Interface Management Configuration Commands

9.10 SHub Interface Uplink Group Portlist


Configuration Command
Command Description
This node allows the user to configure parameters related to uplink group portlist configuration of an interface.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure interface shub group (group-id) [[no] port (port) ]

Command Parameters
Table 9.10-1 "SHub Interface Uplink Group Portlist Configuration Command" Resource
Parameters
Resource Identifier
(group-id)
(port)

Type

Description

<Itf::GroupId>
range: [1...7]
<Shub::NetworkPort>
range: [1...7]

A unique number for each logical uplink group

3HH-01016-AAAA-TCZZA Edition 03

the port

Released

97

10- Error Configuration Commands

10.1 Error Log Configuration Command

98

Released

10-99

3HH-01016-AAAA-TCZZA

Edition 03

10 Error Configuration Commands

10.1 Error Log Configuration Command


Command Description
This command configures parameters related to the error log.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure error [ no log-full-action | log-full-action <Error::errorLogFullAction> ]

Command Parameters
Table 10.1-2 "Error Log Configuration Command" Command Parameters
Parameter
[ no ] log-full-action

Type

Description

<Error::errorLogFullAction>
optional parameter with default value: "wrap"
Possible values are :
set the action when error log buffer is full
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset

3HH-01016-AAAA-TCZZA Edition 03

Released

99

11- System Configuration Commands

11.1 System Configuration Command


11.2 System Management Host IP-Address Configuration
Command
11.3 System Management Default Route Configuration
Command
11.4 System SNTP Configuration Command
11.5 SHub System SNTP Configuration Command
11.6 SHub System ICMP Filter Configuration Command
11.7 SHub System ICMP Filter In Port List Configuration
Command
11.8 SHub System ICMP Filter Out Port List Configuration
Command
11.9 SHub System TCP Filter Configuration Command
11.10 SHub System TCP Filter In Port List Configuration
Command
11.11 SHub System TCP Filter Out Port List Configuration
Command
11.12 SHub System UDP Filter Configuration Command
11.13 SHub System UDP Filter In Port List Configuration
Command
11.14 SHub System UDP Filter Out Port List Configuration
Command
11.15 SHub System other Protocol Filter Configuration
Command
11.16 SHub System other Protocol Filter In Port List
Configuration Command
11.17 SHub System other Protocol Filter Out Port List
Configuration Command
11.18 SHub System Vlan Filter Configuration Command
11.19 SHub System IP Group Configuration Command
11.20 SHub System ID Configuration Command
11.21 SHub System Software Group Configuration
Command
11.22 SHub System VLAN Group Configuration Command
11.23 SHub System HTTP Configuration Command

100

Released

11-101
11-103
11-104
11-105
11-106
11-107
11-109
11-110
11-111
11-113
11-114
11-115
11-117
11-118
11-119
11-121
11-122
11-123
11-124
11-125
11-126
11-127
11-128

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.1 System Configuration Command


Command Description
The id represents the SID (System ID) of the NE and is used to identify the NE in TL1 messages. The System ID may
only include letters, digits and hyphens, and must be unique for each NE in a managed network. The name is an
administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain
name. The location is the physical location of this node.The textual identification of the contact person for this
managed node, together with information on how to contact this person is given by contact-person.
The snmp-auth-traps indicates whether the SNMP agent process is permitted to generate authentication-failure
traps.The ether-shape-rate indicates ethernet frame shaping rate in kbit/s.
The system-mac is used to configure the system MAC address in ISAM. The systemMacAddr is the MAC address of
LANX interface on NT board. The lanxBaseMacAddr is the first MAC address of the consecutive MAC addresses
used by the LANX. The lanxRangeMac is the number of MAC addresses supported in LANX.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system [ no id | id <Sys::systemId> ]name <PrintableString-0-255> location
<PrintableString-0-255> contact-person <PrintableString-0-255> [ no en-snmp-auth-trap
| en-snmp-auth-trap ][ no ether-shape-rate | ether-shape-rate <Sys::etherShapeRate>
]mgnt-vlan-id <Vlan::VlanOamIndex> system-mac <Sys::MacAddr> / <Sys::MacAddr> /
<Sys::Range>

Command Parameters
Table 11.1-2 "System Configuration Command" Command Parameters
Parameter
[ no ] id
name
location
contact-person
[ no
en-snmp-auth-trap
[ no
ether-shape-rate
mgnt-vlan-id
system-mac

Type

Description

<Sys::systemId>
range: [a-zA-Z0-9-]length: x<20
<PrintableString-0-255>
length: x<255
<PrintableString-0-255>
length: x<255
<PrintableString-0-255>
length: x<255
] <Transport::SnmpAuthTraps>

optional parameter with default value: """"


the system ID of the NE
optional parameter
fully-qualified domain name of the system
optional parameter
location of this system
optional parameter
info about the contact person for this system
optional parameter with default value: "disable"
uniquely identifies a particular access server
] <Sys::etherShapeRate>
optional parameter with default value: 128
range: [128...2000] unit: kbps
outgoing ethernet frames shaping rate on
management itf
<Vlan::VlanOamIndex>
optional parameter
range: [1...4093]
configure management vlan id
<Sys::MacAddr> / <Sys::MacAddr> / optional parameter
<Sys::Range>
system mac address

3HH-01016-AAAA-TCZZA Edition 03

Released

101

11 System Configuration Commands

102

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.2 System Management Host IP-Address


Configuration Command
Command Description
This command allows the operator to configure the IP-address of the system.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system management host-ip-address bootp | manual : <Ip::V4Address> /
<Ip::PrefixLengthHost>

Command Parameters
Table 11.2-2 "System Management Host IP-Address Configuration Command" Command
Parameters
Parameter
host-ip-address

Type

Description

bootp | manual : <Ip::V4Address> / optional parameter


<Ip::PrefixLengthHost>
the host ip-address specification

3HH-01016-AAAA-TCZZA Edition 03

Released

103

11 System Configuration Commands

11.3 System Management Default Route


Configuration Command
Command Description
This command allows the operator to configure the default route of the system. Before the default route can be
configured the ip-address of the system must be set

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure system management [[no] default-route (default-route) ]

Command Parameters
Table 11.3-2 "System Management Default Route Configuration Command" Command Parameters
Parameter
(default-route)

104

Type

Description

<Ip::V4Address>

mandatory parameter
IP-address of the default-route

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.4 System SNTP Configuration Command


Command Description
This command allows the operator to configure the sntp and its related parameters

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system sntp server-ip-addr <Ip::V4Address> [ no server-port | server-port
<Sys::portNumber> ][ no polling-rate | polling-rate <Sys::pollingRate> ][ no enable |
enable ]

Command Parameters
Table 11.4-2 "System SNTP Configuration Command" Command Parameters
Parameter

Type

Description

server-ip-addr

<Ip::V4Address>

[ no ] server-port

<Sys::portNumber>
range: [0...65535]
<Sys::pollingRate>
unit: seconds
<Sys::sntpStatus>

optional parameter
configure the sntp ip address of the snmp agent
optional parameter with default value: 123
configure the sntp port number of the snmp agent
optional parameter with default value: 3600
polling rate for the snmp agent
optional parameter with default value: "disable"
enables or disables the sntp application

[ no ] polling-rate
[ no ] enable

3HH-01016-AAAA-TCZZA Edition 03

Released

105

11 System Configuration Commands

11.5 SHub System SNTP Configuration Command


Command Description
This command allows the operator to configure the of the SNTP SHub and its related parameters.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub sntp server-ip-addr <Ip::V4Address> [ no server-port |
server-port <Sys::portNumber> ][ no polling-rate | polling-rate <Sys::pollingRate> ][
no enable | enable ]

Command Parameters
Table 11.5-2 "SHub System SNTP Configuration Command" Command Parameters
Parameter

Type

Description

server-ip-addr

<Ip::V4Address>

[ no ] server-port

<Sys::portNumber>
range: [0...65535]
<Sys::pollingRate>
unit: seconds
<Sys::sntpStatus>

optional parameter
configure the sntp ip address of the snmp agent
optional parameter with default value: 123
configure the sntp port number of the snmp agent
optional parameter with default value: 3600
polling rate for the snmp agent
optional parameter with default value: "disable"
enables or disables the sntp application

[ no ] polling-rate
[ no ] enable

106

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.6 SHub System ICMP Filter Configuration


Command
Command Description
This command allows the operator to configure an ICMP filter on the SHub. The ICMP filter takes into account
source and/or destination IP addresses; either or both must be specified. Optionally the ICMP message type and/or
the ICMP message code can be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] icmp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no
msg-type | msg-type <Sys::MsgType> ][ no msg-code | msg-code <Sys::MsgCode> ][ no
direction | direction <Sys::Direction> ]]

Command Parameters
Table 11.6-1 "SHub System ICMP Filter Configuration Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L3 Filter rule number

Table 11.6-2 "SHub System ICMP Filter Configuration Command" Command Parameters
Parameter
[ no ] action-drop
[ no ] dst-ip-addr
[ no ] src-ip-addr
[ no ] msg-type

Type

Description

<Sys::L3Action>

optional
parameter
with
default
value:
"action-allow"
specifies the action to be taken on the packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
<Sys::MsgType>
optional
parameter
with
default
value:
Possible values are :
"no-icmp-type"
- echo-reply :
message type to be checked against the packet
- dest-unreach :

3HH-01016-AAAA-TCZZA Edition 03

Released

107

11 System Configuration Commands

Parameter

Type
- src-quench :
- redirect :
- echo-request :
- time-exceeded :
- param-prob :
- time-stamp-req :
- time-stamp-reply :
- infor-req :
- infor-reply :
- addr-mask-req :
- addr-mask-reply :
- no-icmp-type :
<Sys::MsgCode>
Possible values are :
- network-unreach :
- host-unreach :
- protocol-unreach :
- port-unreach :
- fragment-need :
- src-route-fail :
- dest-nwk-unknown :
- dest-host-unknown :
- src-host-isolated :
- dest-nwk-prohibit :
- dest-host-prohibit :
- nwk-unreach-tos :
- host-unreach-tos :
- no-icmp-code :
<Sys::Direction>
Possible values are :
- in : incoming packets
- out : outgoing packets

[ no ] msg-code

[ no ] direction

Description

optional
parameter
with
default
value:
"no-icmp-code"
message code to be checked against the packet

optional parameter with default value: "in"


specifies in which direction the filters are applied

Command Output
Table 11.6-3 "SHub System ICMP Filter Configuration Command" Display parameters
Specific Information
name
row-status

108

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.7 SHub System ICMP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) [[no] in-port (network-port)
]

Command Parameters
Table 11.7-1 "SHub System ICMP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(network-port)

Type

Description

<Sys::Number>
range: [1...65535]
<Shub::NetworkPort>
range: [1...7]

L3 Filter rule number

3HH-01016-AAAA-TCZZA Edition 03

the network port

Released

109

11 System Configuration Commands

11.8 SHub System ICMP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the ICMP filter is to be applied. It is used
for ICMP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter icmp (index-num) [[no] out-port (port) ]

Command Parameters
Table 11.8-1 "SHub System ICMP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(port)

110

Type

Description

<Sys::Number>
L3 Filter rule number
range: [1...65535]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.9 SHub System TCP Filter Configuration


Command
Command Description
This command allows the operator to configure a TCP filter on the SHub. The TCP filter takes into account source
and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
seperate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] tcp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no
min-dst-port | min-dst-port <Sys::Port> ][ no max-dst-port | max-dst-port <Sys::Port>
][ no min-src-port | min-src-port <Sys::Port> ][ no max-src-port | max-src-port
<Sys::Port> ][ no ack | ack <Sys::AckBit> ][ no rst | rst <Sys::RstBit> ][ no tos |
tos <Sys::Tos> ][ no direction | direction <Sys::Direction> ]]

Command Parameters
Table 11.9-1 "SHub System TCP Filter Configuration Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L3 Filter rule number

Table 11.9-2 "SHub System TCP Filter Configuration Command" Command Parameters
Parameter
[ no ] action-drop
[ no ] dst-ip-addr
[ no ] src-ip-addr
[ no ] min-dst-port

Type

Description

<Sys::L3Action>

optional
parameter
with
default
value:
"action-allow"
specifies the action to be taken on the packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
<Sys::Port>
optional parameter with default value: 0

3HH-01016-AAAA-TCZZA Edition 03

Released

111

11 System Configuration Commands

Parameter
[ no ] max-dst-port
[ no ] min-src-port
[ no ] max-src-port
[ no ] ack

[ no ] rst

[ no ] tos

[ no ] direction

Type

Description

range: [0...65535]

minimum port in the destination port


range(TCP/UDP ports)
optional parameter with default value: 65535
maximum port in the destination port range
optional parameter with default value: 0
minimum port in the source port range
optional parameter with default value: 65535
maximum port in the source port range
optional parameter with default value: "any"
tcp ACK bit to be checked against the packet

<Sys::Port>
range: [0...65535]
<Sys::Port>
range: [0...65535]
<Sys::Port>
range: [0...65535]
<Sys::AckBit>
Possible values are :
- establish : establish the bit
- not-establish : not establish the bit
- any : default value
<Sys::RstBit>
Possible values are :
- set : set the bit
- not-set : not set the bit
- any : default value
<Sys::Tos>
Possible values are :
- any : any
- high-reliable : high reliable
- high-throughput : high through put
- high-relia-thro : high reliable and
through put
- low-delay : low delay
- low-delay-high-relai : low delay and high
reliability
- low-delay-high-thro : low delay and high
through put
- best-tos : low delay, high reliability and
through put
<Sys::Direction>
Possible values are :
- in : incoming packets
- out : outgoing packets

optional parameter with default value: "any"


tcp RST bit to be checked against the packet

optional parameter with default value: "any"


IP TOS bit to be checked against the packet

optional parameter with default value: "in"


specifies the direction in which the filters are
applied

Command Output
Table 11.9-3 "SHub System TCP Filter Configuration Command" Display parameters
Specific Information
name
row-status

112

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.10 SHub System TCP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) [[no] in-port (network-port)
]

Command Parameters
Table 11.10-1 "SHub System TCP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(network-port)

Type

Description

<Sys::Number>
range: [1...65535]
<Shub::NetworkPort>
range: [1...7]

L3 Filter rule number

3HH-01016-AAAA-TCZZA Edition 03

the network port

Released

113

11 System Configuration Commands

11.11 SHub System TCP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the TCP filter is to be applied. It is used
for TCP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter tcp (index-num) [[no] out-port (port) ]

Command Parameters
Table 11.11-1 "SHub System TCP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(port)

114

Type

Description

<Sys::Number>
L3 Filter rule number
range: [1...65535]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.12 SHub System UDP Filter Configuration


Command
Command Description
This command allows the operator to configure a UDP filter on the SHub. The UDP filter takes into account
source and/or destination IP addresses; either or both must be specified.
When both source and destination protocol ports need to be configured, the latter must be performed through
seperate commands.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] udp (index-num) [ no action-drop |
action-drop ][ no dst-ip-addr | dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull>
][ no src-ip-addr | src-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no
min-dst-port | min-dst-port <Sys::Port> ][ no max-dst-port | max-dst-port <Sys::Port>
][ no min-src-port | min-src-port <Sys::Port> ][ no max-src-port | max-src-port
<Sys::Port> ][ no direction | direction <Sys::Direction> ]]

Command Parameters
Table 11.12-1 "SHub System UDP Filter Configuration Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L3 Filter rule number

Table 11.12-2 "SHub System UDP Filter Configuration Command" Command Parameters
Parameter
[ no ] action-drop
[ no ] dst-ip-addr
[ no ] src-ip-addr
[ no ] min-dst-port

Type

Description

<Sys::L3Action>

optional
parameter
with
default
value:
"action-allow"
specifies the action to be taken on the packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
<Sys::Port>
optional parameter with default value: 0
range: [0...65535]
minimum port in the destination port

3HH-01016-AAAA-TCZZA Edition 03

Released

115

11 System Configuration Commands

Parameter

Type

[ no ] max-dst-port
[ no ] min-src-port
[ no ] max-src-port
[ no ] direction

<Sys::Port>
range: [0...65535]
<Sys::Port>
range: [0...65535]
<Sys::Port>
range: [0...65535]
<Sys::Direction>
Possible values are :
- in : incoming packets
- out : outgoing packets

Description
range(TCP/UDP ports)
optional parameter with default value: 65535
maximum port in the destination port range
optional parameter with default value: 0
minimum port in the source port range
optional parameter with default value: 65535
maximum port in the source port range
optional parameter with default value: "in"
specifies in which direction the filters are applied

Command Output
Table 11.12-3 "SHub System UDP Filter Configuration Command" Display parameters
Specific Information
name
row-status

116

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.13 SHub System UDP Filter In Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) [[no] in-port (network-port)
]

Command Parameters
Table 11.13-1 "SHub System UDP Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(network-port)

Type

Description

<Sys::Number>
range: [1...65535]
<Shub::NetworkPort>
range: [1...7]

L3 Filter rule number

3HH-01016-AAAA-TCZZA Edition 03

the network port

Released

117

11 System Configuration Commands

11.14 SHub System UDP Filter Out Port List


Configuration Command
Command Description
This command allows the operator to configure the physical ports where the UDP filter is to be applied. It is used
for UDP filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter udp (index-num) [[no] out-port (port) ]

Command Parameters
Table 11.14-1 "SHub System UDP Filter Out Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(port)

118

Type

Description

<Sys::Number>
L3 Filter rule number
range: [1...65535]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.15 SHub System other Protocol Filter


Configuration Command
Command Description
This command allows the operator to configure an IP filter on the SHub, for protocols other than ICMP, TCP or
UDP. The IP filter takes into account source and/or destination IP addresses; either or both must be specified.
The physical ports where the filters have to be applied are configured subsequently, by means of dedicated
configuration commands.
When the filter is to be applied to incoming traffic, the command to configure the in-port is to be used. When the
filter is to be applied to outgoing traffic, the command to configure the out-port is to be used.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter [[no] port-filter (filter-rule) [ no protocol
| protocol <Sys::RestrictedProtocol> ][ no action-drop | action-drop ][ no dst-ip-addr
| dst-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> ][ no src-ip-addr | src-ip-addr
<Ip::V4Address> / <Ip::PrefixLengthFull> ][ no direction | direction <Sys::Direction>
]]

Command Parameters
Table 11.15-1 "SHub System other Protocol Filter Configuration Command" Resource Parameters
Resource Identifier
(filter-rule)

Type

Description

<Sys::Number>
range: [1...65535]

L3 filter rule number

Table 11.15-2 "SHub System other Protocol Filter Configuration Command" Command
Parameters
Parameter
[ no ] protocol

Type

Description

<Sys::RestrictedProtocol>
Possible values are :
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp

optional parameter with default value: "any"


type of protocol to be checked against the packet

3HH-01016-AAAA-TCZZA Edition 03

Released

119

11 System Configuration Commands

Parameter

Type

Description

- igrp : check the packet for igrp


- ospf : check the packet for ospf
- any : check the all packets
<Sys::L3Action>

[ no ] action-drop

optional
parameter
with
default
value:
"action-allow"
specifies the action to be taken on the packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
destination IP address to be matched with the
packet
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter with default value: "0.0.0.0/0"
source IP address to be matched with the packet
<Sys::Direction>
optional parameter with default value: "in"
Possible values are :
specifies in which direction the Filters are applied
- in : incoming packets
- out : outgoing packets

[ no ] dst-ip-addr
[ no ] src-ip-addr
[ no ] direction

Command Output
Table 11.15-3 "SHub System other Protocol Filter Configuration Command" Display parameters
Specific Information
name
row-status

120

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.16 SHub System other Protocol Filter In Port


List Configuration Command
Command Description
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to incoming traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) [[no] in-port
(network-port) ]

Command Parameters
Table 11.16-1 "SHub System other Protocol Filter In Port List Configuration Command" Resource
Parameters
Resource Identifier
(filter-rule)
(network-port)

Type

Description

<Sys::Number>
range: [1...65535]
<Shub::NetworkPort>
range: [1...7]

L3 filter rule number

3HH-01016-AAAA-TCZZA Edition 03

the network port

Released

121

11 System Configuration Commands

11.17 SHub System other Protocol Filter Out Port


List Configuration Command
Command Description
This command allows the operator to configure the physical ports where the "other Protocol" filter is to be applied.
It is used for "other Protocol" filters related to outgoing traffic.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter ip-filter port-filter (filter-rule) [[no] out-port
(port) ]

Command Parameters
Table 11.17-1 "SHub System other Protocol Filter Out Port List Configuration Command"
Resource Parameters
Resource Identifier
(filter-rule)
(port)

122

Type

Description

<Sys::Number>
L3 filter rule number
range: [1...65535]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.18 SHub System Vlan Filter Configuration


Command
Command Description
This command allows the operator to configure the management VLAN filter IP-address.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub filter [[no] shub-manager (index) src-ip-addr <Ip::V4Address>
]

Command Parameters
Table 11.18-1 "SHub System Vlan Filter Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Sys::SrcIpIndex>
range: [1...100]

index number of the SrcIp

Table 11.18-2 "SHub System Vlan Filter Configuration Command" Command Parameters
Parameter
src-ip-addr

Type

Description

<Ip::V4Address>

mandatory parameter
MgmtVlan filter IP address to be matched with the
packet

3HH-01016-AAAA-TCZZA Edition 03

Released

123

11 System Configuration Commands

11.19 SHub System IP Group Configuration


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

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry ip [ no ip-cfg-mode | ip-cfg-mode <Sys::DefIpAddr>
]def-ip-addr <Ip::V4Address> / <Ip::PrefixLengthFull> def-gateway <Ip::V4Address>

Command Parameters
Table 11.19-2 "SHub System IP Group Configuration Command" Command Parameters
Parameter

Type

[ no ] ip-cfg-mode

def-ip-addr
def-gateway

124

Description

<Sys::DefIpAddr>
optional parameter with default value: "manual"
Possible values are :
specifies how the system get the IP address
- manual : ip address got from the system
- dynamic : ip address got through
dynamic IP address
<Ip::V4Address> / <Ip::PrefixLengthFull> optional parameter
default IP address of the system
<Ip::V4Address>
optional parameter
default gateway IP Address

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.20 SHub System ID Configuration Command


Command Description
This command allows the operator to configure the PPP sessions.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry id contact <PrintableString> location <PrintableString>

Command Parameters
Table 11.20-2 "SHub System ID Configuration Command" Command Parameters
Parameter

Type

Description

contact

<PrintableString>

location

<PrintableString>

optional parameter
textual identification of the contact person
optional parameter
physical location of this node

3HH-01016-AAAA-TCZZA Edition 03

Released

125

11 System Configuration Commands

11.21 SHub System Software Group Configuration


Command
Command Description
This command allows the operator to configure the software for SHub system.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry software [ no sw-ver-name | sw-ver-name <Sys::FileName>
]sw-release-num <Sys::ReleaseNum>

Command Parameters
Table 11.21-2 "SHub System Software Group Configuration Command" Command Parameters
Parameter
[ no ] sw-ver-name
sw-release-num

126

Type

Description

<Sys::FileName>
length: 1<=x<256
<Sys::ReleaseNum>
length: 1<=x<7

optional parameter with default value: "shub"


identifies the Name of the shub Software release
optional parameter
identifies the software version number d.d.d.d

Released

3HH-01016-AAAA-TCZZA

Edition 03

11 System Configuration Commands

11.22 SHub System VLAN Group Configuration


Command
Command Description
This command allows the operator to configure the SHub system vlan group.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry vlan ext-vlan-id <Vlan::ExtVlanIndex>

Command Parameters
Table 11.22-2 "SHub System VLAN Group Configuration Command" Command Parameters
Parameter
ext-vlan-id

Type

Description

<Vlan::ExtVlanIndex>
range: [2...4093]

optional parameter
External Vlan id

3HH-01016-AAAA-TCZZA Edition 03

Released

127

11 System Configuration Commands

11.23 SHub System HTTP Configuration Command


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

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure system shub entry status [ no http-access | http-access ]

Command Parameters
Table 11.23-2 "SHub System HTTP Configuration Command" Command Parameters
Parameter
[ no ] http-access

128

Type

Description

<Sys::HttpStatus>

optional
parameter
with
"no-http-access"
enable http access for the users

Released

3HH-01016-AAAA-TCZZA

default

Edition 03

value:

12- Security Configuration Commands

12.1 Security Banner Configuration Commmand


12.2 Operator Configuration Command
12.3 Profile Configuration Command
12.4 Security SNMP Community Configuration Command
12.5 SHub Security SNMP Community Configuration
Command
12.6 Security Domain Configuration Command
12.7 Security Domain IP Pool Configuration Command
12.8 Security Domain User Configuration Command
12.9 Security Connection Profile Configuration Command
12.10 Security Connection Policy Configuration Command
12.11 Security IP Address Pool Configuration Command
12.12 Security IP Address Pool Reserve Configuration
Command
12.13 Security Radius Client Configuration Command
12.14 Security Radius AUTH Server Configuration
Command
12.15 Security Radius Accounting Server Configuration
Command
12.16 Security Radius Dynamic AUTH Client Configuration
Command
12.17 Security Radius Policy Configuration Command
12.18 Security Radius Server Configuration Command
12.19 Security 802.1x PAE System Configuration
Command
12.20 Security 802.1x Port Authentication Configuration
Command
12.21 Security 802.1x Extension, Port Authentication
Configuration Command
12.22 Security 802.1x Port Configuration Command
12.23 Security Password Policy Configuration Commmand

3HH-01016-AAAA-TCZZA Edition 03

12-130
12-131
12-133
12-136
12-137
12-139
12-141
12-142
12-143
12-144
12-145
12-146
12-147
12-148
12-150
12-152
12-153
12-155
12-156
12-157
12-159
12-160
12-161

Released

129

12 Security Configuration Commands

12.1 Security Banner Configuration Commmand


Command Description
This command allows the operator to configure the login or welcome banner.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security [ no login-banner | login-banner <Sec::Banner> ][ no
welcome-banner | welcome-banner <Sec::Banner> ]

Command Parameters
Table 12.1-2 "Security Banner Configuration Commmand" Command Parameters
Parameter

Type

Description

[ no ] login-banner

<Sec::Banner>

[ no
welcome-banner

] <Sec::Banner>

optional parameter with default value: ""


the banner to be shown before the operator enters
its name
optional parameter with default value: ""
the banner to be shown when the operator logged in

130

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.2 Operator Configuration Command


Command Description
This command allows the operator to specify an operator instance.
An operator can log into the system with the specified name and password once this instance is created.
Operators have a profile which determines most of the operator properties. The operator profile must be created
before the operator can be created.
The operator profile is assigned when the operator is created. The profile cannot be changed afterwards. If the
operator needs to change the profile, the operator must first delete the operator and then recreate it.
The default values for prompt can be found in configure system security profile profile-name. The procedure on
how to specify a prompt is described in the ISAM CLI - The CLI Prompt chapter.
The following rules apply to a plain text password:
The password must consist of a minimum of six and a maximum of 20 printable characters.
The password must contain at least one non-alphanumeric character.
A new password must be different from the last three passwords.
Never specify a new password using the encrypted option because you can mistakenly enter any hexadecimal string
which is not necessarily linked to a password and it is almost impossible to calculate a password from an encrypted
string. The encrypted method to specify passwords is only intented to restore an existing configuration.
An operator will be requested to enter a new password when the operator logs in for the first time after another
operator changed their password.
There is not a separate command to change a password. An operator must change the password in the operator's
operator node.

User Level
The command can be accessed by operators with all,forAdmin privileges, and executed by operators with all
privileges.
The last operator with security write permissions cannot be deleted.
An operator can be deleted when that operator is still logged in. The operator instance will only be effectively
removed once the operator logs out or is logged out by the system.
Operators without security read or write permissions can never see other operators.
Operators without security write permissions can never create, delete, or modify another operator but they can
enter the commands to perform these actions. However, these commands will always fail when executed.

Command Syntax
The command has the following syntax:
> configure system security [[no] operator (name) profile <Sec::ProfileName> password
prompt | plain : <Sec::PlainPassword> | encrypted : <Sec::EncryptedPassword> [ no
prompt | prompt <Sec::Prompt> ][ no description | description <Sec::OperatorDesc> ][
no more | more ]]

Command Parameters

3HH-01016-AAAA-TCZZA Edition 03

Released

131

12 Security Configuration Commands

Table 12.2-1 "Operator Configuration Command" Resource Parameters


Resource Identifier
(name)

Type

Description

<Sec::OperatorName>
range: [a-z0-9]length: 1<=x<11

the name of the operator

Table 12.2-2 "Operator Configuration Command" Command Parameters


Parameter
profile
password
[ no ] prompt
[ no ] description
[ no ] more

132

Type

Description

<Sec::ProfileName>
range: [a-z0-9]length: 1<=x<11

mandatory parameter
The parameter is not visible during modification.
the name of an operator profile
prompt | plain : <Sec::PlainPassword> | mandatory parameter
encrypted : <Sec::EncryptedPassword>
the password needed to log in
<Sec::Prompt>
optional parameter with default value: ""
length: x<19
the specification of the prompt
<Sec::OperatorDesc>
optional parameter with default value: ""
length: x<31
any description to be used by the operator
<Sec::More>
optional parameter with default value: "no-more"
all output is by default passed through the more
printer

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.3 Profile Configuration Command


Command Description
This command allows the operator to specify an operator profile.
This operator profile determines most of the operator properties.
An operator profile is typically used to limit the commands that a group of operators can execute to those for which
they have the necessary skills and for which they are responsible.
The procedure on how to specify a prompt is described in the ISAM CLI - The CLI Prompt chapter.

User Level
The command can be accessed by operators with all,forAdmin privileges.
The last operator with security write permissions cannot be deleted.
The permissions of a profile cannot be changed as long as one operator belongs to the profile.
Operators without security read or write permissions can never see other operator profiles.

Command Syntax
The command has the following syntax:
> configure system security [[no] profile (name) [ no prompt | prompt <Sec::Prompt> ][
no password-timeout | password-timeout <Sec::PasswordTimeout> ][ no terminal-timeout |
terminal-timeout <Sec::InactivityTimeout> ][ no description | description
<Sec::ProfileDesc> ][ no aaa | aaa <Sec::Aaa> ][ no atm | atm <Sec::Atm> ][ no alarm |
alarm <Sec::Alarm> ][ no cluster | cluster <Sec::Cluster> ][ no dhcp | dhcp
<Sec::Dhcp> ][ no equipment | equipment <Sec::Equipment> ][ no igmp | igmp <Sec::Igmp>
][ no ip | ip <Sec::Ip> ][ no ppoe | ppoe <Sec::Ppoe> ][ no qos | qos <Sec::Qos> ][ no
software-mngt | software-mngt <Sec::Sw> ][ no transport | transport <Sec::Transport>
][ no vlan | vlan <Sec::Vlan> ][ no xdsl | xdsl <Sec::Xdsl> ][ no security | security
<Sec::Security> ]]

Command Parameters
Table 12.3-1 "Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Sec::ProfileName>
range: [a-z0-9]length: 1<=x<11

the name of the profile

Table 12.3-2 "Profile Configuration Command" Command Parameters


Parameter
[ no ] prompt
[ no
password-timeout
[ no
terminal-timeout
[ no ] description

Type

Description

<Sec::Prompt>
length: x<19

optional parameter with default value: "\"%n%d%c


\""
the specification of the prompt
optional parameter with default value: 0
the maximum time a password may be unchanged
optional parameter with default value: 0
the maximum time a terminal may be inactive
optional parameter with default value: ""
any description to be used by the operator

] <Sec::PasswordTimeout>
range: [0...365] unit: days
] <Sec::InactivityTimeout>
range: [0...120] unit: minutes
<Sec::ProfileDesc>
length: x<31

3HH-01016-AAAA-TCZZA Edition 03

Released

133

12 Security Configuration Commands

Parameter
[ no ] aaa

[ no ] atm

[ no ] alarm

[ no ] cluster

[ no ] dhcp

[ no ] equipment

[ no ] igmp

[ no ] ip

[ no ] ppoe

[ no ] qos

[ no ] software-mngt

[ no ] transport

134

Type

Description

<Sec::Aaa>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Atm>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Alarm>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Cluster>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Dhcp>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Equipment>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Igmp>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Ip>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Ppoe>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Qos>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Sw>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Transport>
Possible values are :

optional parameter with default value: "none"


the access rights to AAA related commands

Released

optional parameter with default value: "none"


the access rights to ATM related commands

optional parameter with default value: "none"


the access rights to alarm related commands

optional parameter with default value: "none"


the access rights to cluster related commands

optional parameter with default value: "none"


the access rights to DHCP related commands

optional parameter with default value: "none"


the access rights to equipment related commands

optional parameter with default value: "none"


the access rights to IGMP related commands

optional parameter with default value: "none"


the access rights to IP related commands

optional parameter with default value: "none"


the access rights to PPOE related commands

optional parameter with default value: "none"


the access rights to qos related commands

optional parameter with default value: "none"


the access rights to software management related
commands
optional parameter with default value: "none"
the access rights to transport related commands

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

Parameter

[ no ] vlan

[ no ] xdsl

[ no ] security

Type
- write : write and read access
- read : read access
- none : no access
<Sec::Vlan>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Xdsl>
Possible values are :
- write : write and read access
- read : read access
- none : no access
<Sec::Security>
Possible values are :
- write : write and read access
- read : read access
- none : no access

3HH-01016-AAAA-TCZZA Edition 03

Description

optional parameter with default value: "none"


the access rights to VLAN related commands

optional parameter with default value: "none"


the access rights to xDSL related commands

optional parameter with default value: "none"


the access rights to security related commands

Released

135

12 Security Configuration Commands

12.4 Security SNMP Community Configuration


Command
Command Description
This command allows us to configure community names.
An existing community can not be modified
SNMP uses community names as a kind of password without user name to verify if a request may be executed or
not.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
There must be at least one community with read-write priviliges.

Command Syntax
The command has the following syntax:
> configure system security snmp [[no] community (name) [ no privilege | privilege
<Snmp::CommunityPrivilege> ]]

Command Parameters
Table 12.4-1 "Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Snmp::CommunityName>
length: x<32

the name of the community

Table 12.4-2 "Security SNMP Community Configuration Command" Command Parameters


Parameter
[ no ] privilege

136

Type

Description

<Snmp::CommunityPrivilege>
Possible values are :
- read-only : only read priviliges
- read-write : read and write priviliges
- write-only : only write privileges

optional parameter with default value: "read-only"


The parameter is not visible during modification.
the priviliges we have when we use this community

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.5 SHub Security SNMP Community


Configuration Command
Command Description
This command allows us to configure community names.
There can be many entries with the same community name or ip-address.
SNMP uses community names as a kind of password without user name to verify if a request may be executed or
not.
It is possible to allow only a limited number of ip-adresses to use a given community name.

User Level
The command can be accessed by operators with security privileges, and executed by operators with security
privileges.
The community used by the Command Language Interface (CLI) can not be deleted nor modified.

Command Syntax
The command has the following syntax:
> configure system security snmp shub [[no] community (index) name
<PrintableString-0-255> [ no privilege | privilege <Snmp::SHubCommunityPrivilege> ][
no ip-addr | ip-addr <Ip::V4Address> ]]

Command Parameters
Table 12.5-1 "SHub Security SNMP Community Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Snmp::SHubCommunityIndex>
range: [0...10]

number of the entry in the community table

Table 12.5-2 "SHub Security SNMP Community Configuration Command" Command Parameters
Parameter
name
[ no ] privilege

[ no ] ip-addr

Type

Description

<PrintableString-0-255>
length: x<255
<Snmp::SHubCommunityPrivilege>
Possible values are :
- read-only : only read
- read-write : read and write
<Ip::V4Address>

mandatory parameter
the name of the community
optional parameter with default value: "read-only"
the priviliges we have when we use this community
optional parameter with default value: "0.0.0.0"
the ip-address from where we may use this
community

Command Output

3HH-01016-AAAA-TCZZA Edition 03

Released

137

12 Security Configuration Commands

Table 12.5-3 "SHub Security SNMP Community Configuration Command" Display parameters
Specific Information
name
row-status

138

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.6 Security Domain Configuration Command


Command Description
This command configures the domain.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security [[no] domain (name) vrf-index <Aaa::DomainVrfIndex> [ no
vlan-id | vlan-id <Vlan::VlanIndexOrZero> ][ no primary-dns | primary-dns
<Ip::V4Address> ][ no second-dns | second-dns <Ip::V4Address> ][ no primary-nbns |
primary-nbns <Ip::V4Address> ][ no second-nbns | second-nbns <Ip::V4Address> ][ no
sess-timeout | sess-timeout <Aaa::DomainSessionTimeout> ][ no qos-policy | qos-policy
none | name : <Aaa::IgnoredQosProfileName> ]authenticator local | radius :
<Aaa::RadPolicyName> [ no admin-down | admin-down ]]

Command Parameters
Table 12.6-1 "Security Domain Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Aaa::DomainName>
length: 6<=x<64

name of the domain

Table 12.6-2 "Security Domain Configuration Command" Command Parameters


Parameter
vrf-index

Type

[ no ] primary-dns

<Aaa::DomainVrfIndex>
range: [-1,1...127]
<Vlan::VlanIndexOrZero>
range: [0...4092]
<Ip::V4Address>

[ no ] second-dns

<Ip::V4Address>

[ no ] primary-nbns

<Ip::V4Address>

[ no ] second-nbns

<Ip::V4Address>

[ no ] sess-timeout

<Aaa::DomainSessionTimeout>
range: [0...2147483647]
none
|
name
<Aaa::IgnoredQosProfileName>

[ no ] vlan-id

[ no ] qos-policy
authenticator

local | radius : <Aaa::RadPolicyName>

[ no ] admin-down

<Aaa::AdminState>

3HH-01016-AAAA-TCZZA Edition 03

Description
mandatory parameter
valid VRF index
optional parameter with default value: 0
a vlan id
optional parameter with default value: "0.0.0.0"
IP address of primary DNS server
optional parameter with default value: "0.0.0.0"
IP address of secondary DNS server
optional parameter with default value: "0.0.0.0"
IP address of primary NBNS server
optional parameter with default value: "0.0.0.0"
IP address of secondary NBNS server
optional parameter with default value: 0
maximum lifetime of a session
: optional parameter with default value: "none"
name of the QoS policy that must be applied to this
domain
mandatory parameter
type of authenticator
optional parameter with default value: "admin-up"
administrative state of the domain

Released

139

12 Security Configuration Commands

140

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.7 Security Domain IP Pool Configuration


Command
Command Description
This command allows the operator to define the domain IP pool.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security domain (name) [[no] ip-pool (name) vrf-index
<Aaa::VrfIndex> priority <SignedInteger> ]

Command Parameters
Table 12.7-1 "Security Domain IP Pool Configuration Command" Resource Parameters
Resource Identifier
(name)
(name)
vrf-index

Type

Description

<Aaa::DomainName>
length: 6<=x<64
<Aaa::IpAddrPoolName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the domain


name of the IP address pool
vrf associated with this pool

Table 12.7-2 "Security Domain IP Pool Configuration Command" Command Parameters


Parameter
priority

Type

Description

<SignedInteger>

mandatory parameter
priority associated with this IP pool

3HH-01016-AAAA-TCZZA Edition 03

Released

141

12 Security Configuration Commands

12.8 Security Domain User Configuration


Command
Command Description
This command configures the security domain for a user. A conceptual table lists the configurable parameters for a
user of a particular domain. This table will be used for authenticating users locally. If a domain is deleted, then all
the users of that domain will be deleted from this table.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security domain (name) [[no] user (name) password <Password> ]

Command Parameters
Table 12.8-1 "Security Domain User Configuration Command" Resource Parameters
Resource Identifier
(name)
(name)

Type

Description

<Aaa::DomainName>
length: 6<=x<64
<Aaa::DisplayString>
length: 6<=x<64

name of the domain


name of the user of a particular domain

Table 12.8-2 "Security Domain User Configuration Command" Command Parameters


Parameter
password

142

Type

Description

<Password>
length: 6<=x<64

mandatory parameter
user password, minimum 6 characters

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.9 Security Connection Profile Configuration


Command
Command Description
This command configures the connection profile parameters.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security [[no] conn-profile (name) version <SignedInteger> [ no
reject-no-domain | reject-no-domain ][ no reject-inv-domain | reject-inv-domain
]domain-name <Aaa::DomainName> ]

Command Parameters
Table 12.9-1 "Security Connection Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

name of connection profile

Table 12.9-2 "Security Connection Profile Configuration Command" Command Parameters


Parameter
version

Type

Description

<SignedInteger>

mandatory parameter
version number to be associated to the Profile
optional
parameter
with
default
value:
"accept-no-domain"
user session authentication if no domain name
optional
parameter
with
default
value:
"accept-inv-domain"
user session authentication if domain name invalid
mandatory parameter
name of the domain

[ no
reject-no-domain

] <Aaa::ActNoDomain>

[ no
reject-inv-domain

] <Aaa::ActInDomain>

domain-name

<Aaa::DomainName>
length: 6<=x<64

3HH-01016-AAAA-TCZZA Edition 03

Released

143

12 Security Configuration Commands

12.10 Security Connection Policy Configuration


Command
Command Description
This command configures a connection policy associated with the specified policy. The Operator should specify the
index indicating which connection policy has to be applied and the profile-index which provides the connection
profile associated with this policy.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security [[no] conn-policy conn-profile-name <AsamProfileName> ]

Command Parameters
Table 12.10-2 "Security Connection Policy Configuration Command" Command Parameters
Parameter
conn-profile-name

144

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

mandatory parameter
connection profile associated with this policy

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.11 Security IP Address Pool Configuration


Command
Command Description
This is the (conceptual) table for Local IP Address Allocation for PPP users ONLY. Two IP pools in the same VRF
should not contain overlapping IP address spaces. The IP address space is determined by start and size. A row in
this table (an Ip Pool) can be deleted only when, No domains are using this Pool and no Ipaddresses are already
allocated to user sessions from this Pool. When a row is deleted in this table, then the corresponding rows in the IP
address pool reserve and status are also removed.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security [[no] ip-addr-pool (name) vrf-index <Aaa::IpVrfIndex>
start-addr <Ip::V4Address> / <Ip::PrefixLength> [ no size | size
<Aaa::IpAddressPoolSize> ][ no admin-down | admin-down ]]

Command Parameters
Table 12.11-1 "Security IP Address Pool Configuration Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::IpAddrPoolName>
length: 1<=x<64
<Aaa::IpVrfIndex>
range: [1...255]

name of the IP address pool


vrf associated with this pool

Table 12.11-2 "Security IP Address Pool Configuration Command" Command Parameters


Parameter

Type

Description

start-addr

<Ip::V4Address> / <Ip::PrefixLength>

[ no ] size

<Aaa::IpAddressPoolSize>
range: [0...1000]

[ no ] admin-down

<Aaa::AdminState>

mandatory parameter
The parameter is not visible during modification.
first address from where allocation of IP addresses
starts
optional parameter with default value: 0
The parameter is not visible during modification.
number of IP addresses in the pool from the start
address
optional parameter with default value: "admin-up"
administrative state of this IP pool

3HH-01016-AAAA-TCZZA Edition 03

Released

145

12 Security Configuration Commands

12.12 Security IP Address Pool Reserve


Configuration Command
Command Description
This command configures the security IP address pool reserve address. A conceptual table is used for reserving
and unreserving an IP address from the specified pool. A entry can only be created when the corresponding entry
in the table (with the same IP address index) is created. An IP address can be reserved only when the IP address is
not allocated to any user session. Once the row is created in this table, the value for IP address pool status changes
to locally reserved. To unreserve an IP address, the corresponding entry should be deleted.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security ip-addr-pool (name) vrf-index <Aaa::IpVrfIndex> [[no]
reserve-address (ip-address) ]

Command Parameters
Table 12.12-1 "Security IP Address Pool Reserve Configuration Command" Resource Parameters
Resource Identifier
(name)
vrf-index
(ip-address)

146

Type

Description

<Aaa::IpAddrPoolName>
length: 1<=x<64
<Aaa::IpVrfIndex>
range: [1...255]
<Ip::V4Address>

name of the IP address pool

Released

vrf associated with this pool


IP addess to be reserved/unreserved.

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.13 Security Radius Client Configuration


Command
Command Description
This command enables or disables the relay functionality on the SHub.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [ no relay | relay ]

Command Parameters
Table 12.13-2 "Security Radius Client Configuration Command" Command Parameters
Parameter
[ no ] relay

Type

Description

<Aaa::RadiusRelay>

optional parameter with default value: "no-relay"


enable radius relay on shub

3HH-01016-AAAA-TCZZA Edition 03

Released

147

12 Security Configuration Commands

12.14 Security Radius AUTH Server Configuration


Command
Command Description
This command configures the RADIUS authentication servers. The conceptual table lists the RADIUS
authentication servers with its configurable parameters. If an entry (server) has to be deleted, then it must not be
associated with any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [[no] auth-server (name) vrf-index <Aaa::VrfIndex>
ip-address <Ip::V4Address> [ no port | port <Aaa::InetPortNumber> ]secret <Password> [
no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ][ no timeout-limit |
timeout-limit <Aaa::RadiusTimeout> ][ no admin-down | admin-down ][ no dead-interval |
dead-interval <Aaa::RadiusDeadInterval> ]]

Command Parameters
Table 12.14-1 "Security Radius AUTH Server Configuration Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAuthServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of RADIUS authentication server


vrf to which this auth server belongs

Table 12.14-2 "Security Radius AUTH Server Configuration Command" Command Parameters
Parameter

148

Type

Description

ip-address

<Ip::V4Address>

[ no ] port

<Aaa::InetPortNumber>
range: [0...65535]

secret

<Password>
length: 6<=x<64

[ no ] retry-limit

<Aaa::RadiusRetryLimit>
range: [0...100]

[ no ] timeout-limit

<Aaa::RadiusTimeout>
range: [1...60]

[ no ] admin-down

<Aaa::AdminState>

mandatory parameter
IP address of RADIUS authentication server
optional parameter with default value: 1812
UDP port to which RADIUS auth messages should
be sent
mandatory parameter
secret string used between RADIUS server and
client
optional parameter with default value: 3
no of times RADIUS server be tried before giving
up
optional parameter with default value: 3
time in sec between retransmission to RADIUS
server
optional parameter with default value: "admin-up"

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

Parameter
[ no ] dead-interval

Type

Description

<Aaa::RadiusDeadInterval>
range: [0...3600]

administrative state of the authentication server


optional parameter with default value: 600
no of sec before setting oper state to unknown from
down

3HH-01016-AAAA-TCZZA Edition 03

Released

149

12 Security Configuration Commands

12.15 Security Radius Accounting Server


Configuration Command
Command Description
This command configures the RADIUS accounting servers. The conceptual table lists the RADIUS accounting
servers with its configurable parameters. If an entry (server) has to be deleted, then it must not be associated with
any RADIUS policy. If an entry is associated with a policy, the deletion is not allowed.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [[no] acc-server (name) vrf-index <Aaa::VrfIndex>
ip-address <Ip::V4Address> [ no port | port <Aaa::InetPortNumber> ]secret <Password> [
no retry-limit | retry-limit <Aaa::RadiusRetryLimit> ][ no timeout-limit |
timeout-limit <Aaa::RadiusTimeout> ][ no admin-down | admin-down ][ no dead-interval |
dead-interval <Aaa::RadiusDeadInterval> ]]

Command Parameters
Table 12.15-1 "Security Radius Accounting Server Configuration Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAccServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the RADIUS accounting server


vrf to which the RADIUS Acc Server belongs

Table 12.15-2 "Security Radius Accounting Server Configuration Command" Command


Parameters
Parameter

150

Type

Description

ip-address

<Ip::V4Address>

[ no ] port

<Aaa::InetPortNumber>
range: [0...65535]

secret

<Password>
length: 6<=x<64

[ no ] retry-limit

<Aaa::RadiusRetryLimit>
range: [0...100]

[ no ] timeout-limit

<Aaa::RadiusTimeout>
range: [1...60]

mandatory parameter
IP address of RADIUS accounting server
optional parameter with default value: 1813
UDP port to which RADIUS accounting messages
be sent
mandatory parameter
secret string used between RADIUS server and
client
optional parameter with default value: 10
no of times RADIUS server be tried before giving
up
optional parameter with default value: 15
time in sec between retransmission to RADIUS
server

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

Parameter

Type

Description

[ no ] admin-down

<Aaa::AccAdminState>

[ no ] dead-interval

<Aaa::RadiusDeadInterval>
range: [0...3600]

optional parameter with default value: "admin-up"


administrative state of the accounting server
optional parameter with default value: 600
no of sec before setting oper state to unknown from
down

3HH-01016-AAAA-TCZZA Edition 03

Released

151

12 Security Configuration Commands

12.16 Security Radius Dynamic AUTH Client


Configuration Command
Command Description
This command configures the RADIUS Dynamic Authorization Clients. The conceptual table lists the RADIUS
Dynamic Authorization Clients with its configurable parameters.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [[no] dyn-auth-client (name) vrf-index
<Aaa::VrfIndex> ip-address <Ip::V4Address> secret <Password> [ no admin-down |
admin-down ]]

Command Parameters
Table 12.16-1 "Security Radius Dynamic AUTH Client Configuration Command" Resource
Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadDynAuthClientName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the RADIUS Dynamic Authorization


client
vrf to which the RADIUS Dyn Auth Client belongs

Table 12.16-2 "Security Radius Dynamic AUTH Client Configuration Command" Command
Parameters
Parameter

152

Type

Description

ip-address

<Ip::V4Address>

secret

<Password>
length: 6<=x<64

[ no ] admin-down

<Aaa::AdminState>

mandatory parameter
IP address of RADIUS authentication server
mandatory parameter
secret string used between RADIUS server and
client
optional parameter with default value: "admin-up"
administrative state of the authentication server

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.17 Security Radius Policy Configuration


Command
Command Description
This command configures RADIUS policies. The conceptual table lists the RADIUS policies with the parameters
that apply globally for the RADIUS policy. An entry in this table (policy) can be deleted only if it is not associated
with any of the domains. If this entry is deleted, then the corresponding entry in the RADIUS server will also be
deleted.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius [[no] policy (name) nas-id <Printable-0-64>
nas-ip-address <Ip::V4Address> [ no keep-domain-name | keep-domain-name ][ no
disable-accnt-msg | disable-accnt-msg ][ no acc-interval | acc-interval <Aaa::AccInt>
][ no eap | eap ]]

Command Parameters
Table 12.17-1 "Security Radius Policy Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Aaa::RadPolicyName>
length: 1<=x<64

name of the RADIUS policy

Table 12.17-2 "Security Radius Policy Configuration Command" Command Parameters


Parameter

Type

Description

nas-id

<Printable-0-64>
length: x<64

nas-ip-address

<Ip::V4Address>

[ no
keep-domain-name

] <Aaa::StripDomain>

[ no
disable-accnt-msg

] <Aaa::BootFlag>

mandatory parameter
NAS-Identifier used in messages towards the
Radius servers
mandatory parameter
NAS-IP-Address used in messages towards the
Radius servers
optional
parameter
with
default
value:
"strip-domain-name"
don't strip domain name when sending to RADIUS
server
optional
parameter
with
default
value:
"enable-accnt-msg"
whether to send accounting messages on reboot
optional parameter with default value: 0
Interim Accounting Interval in seconds
optional
parameter
with
default
value:
"enable-eap"

[ no ] acc-interval
[ no ] eap

<Aaa::AccInt>
range: [60...2147483647u,0...0u]
<Aaa::Eap>

3HH-01016-AAAA-TCZZA Edition 03

Released

153

12 Security Configuration Commands

Parameter

Type

Description
enable/diasable EAP

154

Released

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.18 Security Radius Server Configuration


Command
Command Description
This command configures RADIUS servers. The conceptual table lists the set of RADIUS servers with the
parameters of that set. The servers that are placed in a set using this table must first be defined in the RADIUS
Authenticaion and Accounting server. The value returned by the RADIUS server is used by the management station
as the value for the index when creating a new entry in this table.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security radius policy (name) [[no] servers (index) auth-server
none | name : <Aaa::RadAuthServerName> vrf-index-auth <Aaa::VrfIndex> [ no acc-server
| acc-server none | name : <Aaa::RadAccServerName> ][ no vrf-index-acc | vrf-index-acc
<Aaa::VrfIndex> ]priority <Aaa::Priority> ]

Command Parameters
Table 12.18-1 "Security Radius Server Configuration Command" Resource Parameters
Resource Identifier
(name)
(index)

Type

Description

<Aaa::RadPolicyName>
length: 1<=x<64
<Aaa::RadServerSetIndex>
range: [1...2]

name of the RADIUS policy


index of RADIUS profile

Table 12.18-2 "Security Radius Server Configuration Command" Command Parameters


Parameter
auth-server
vrf-index-auth
[ no ] acc-server

Type

Description

none
|
name
:
<Aaa::RadAuthServerName>
<Aaa::VrfIndex>
range: [0...127]
none | name : <Aaa::RadAccServerName>

mandatory parameter
the radius authentication server
mandatory parameter
vrf to which the RADIUS auth server belongs
optional parameter with default value: "none"
the radius accounting server
optional parameter with default value: 0L
vrf to which the RADIUS accounting server
belongs
mandatory parameter
priority of the set of RADIUS servers

[ no ] vrf-index-acc

<Aaa::VrfIndex>
range: [0...255]

priority

<Aaa::Priority>
range: [1...256]

3HH-01016-AAAA-TCZZA Edition 03

Released

155

12 Security Configuration Commands

12.19 Security 802.1x PAE System Configuration


Command
Command Description
This command configures the administrative enable and disable state for port access control in a system.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae [ no port-access | port-access ]

Command Parameters
Table 12.19-2 "Security 802.1x PAE System Configuration Command" Command Parameters
Parameter
[ no ] port-access

156

Type

Description

<Aaa::AuthenticationEnabled>

optional
parameter
with
default
"no-port-access"
enable/disable state for port access control

Released

3HH-01016-AAAA-TCZZA

Edition 03

value:

12 Security Configuration Commands

12.20 Security 802.1x Port Authentication


Configuration Command
Command Description
This command configures security 802.1x port authentication. A table contains the configuration objects for the
Authenticator PAE associated with each port. An entry appears in this table for each port that may authenticate
access to itself.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae authenticator (port) [ no controlled-port |
controlled-port <Aaa::PaeControlledPortControl> ][ no quiet-period | quiet-period
<Aaa::paeQuitTime> ][ no tx-period | tx-period <Aaa::paeTime> ][ no supp-timeout |
supp-timeout <Aaa::paeTime> ][ no server-timeout | server-timeout <Aaa::paeTime> ][ no
max-req | max-req <Aaa::paeMaxReq> ]

Command Parameters
Table 12.20-1 "Security 802.1x Port Authentication Configuration Command" Resource
Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 12.20-2 "Security 802.1x Port Authentication Configuration Command" Command


Parameters
Parameter
[ no ] controlled-port

[ no ] quiet-period
[ no ] tx-period
[ no ] supp-timeout

Type

Description

<Aaa::PaeControlledPortControl>
Possible values are :
- force-unauthorized : force unauthorized
control
- auto : automatic control
- force-authorized : force authorized
control
<Aaa::paeQuitTime>
range: [0...65535]

optional parameter with default value: "auto"


current value of the controlled Port

<Aaa::paeTime>
range: [1...65535]
<Aaa::paeTime>
range: [1...65535]

3HH-01016-AAAA-TCZZA Edition 03

optional parameter with default value: 60


quietPeriod constant currently used, value in
seconds
optional parameter with default value: 30
txPeriod constant currently used, value in seconds
optional parameter with default value: 30
suppTimeout constant currently used, value in

Released

157

12 Security Configuration Commands

Parameter

158

Type

[ no ] server-timeout

<Aaa::paeTime>
range: [1...65535]

[ no ] max-req

<Aaa::paeMaxReq>
range: [1...10]

Released

Description
seconds
optional parameter with default value: 30
serverTimeout constant currently used, value in
seconds
optional parameter with default value: 2
maxReq constant currently used

3HH-01016-AAAA-TCZZA

Edition 03

12 Security Configuration Commands

12.21 Security 802.1x Extension, Port


Authentication Configuration Command
Command Description
This command configures the security 802.1x extension port authentication. A table contains the configuration
objects for the Authenticator PAE associated with each port. An entry appears in this table for each port that may
authenticate access to itself.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae ext-authenticator (port) [ no authentication |
authentication ][ no init-authreq-off | init-authreq-off ][ no handshake | handshake
][ no handshake-period | handshake-period <Aaa::PortHandShakePeriod> ]

Command Parameters
Table 12.21-1 "Security 802.1x Extension, Port Authentication Configuration Command" Resource
Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 12.21-2 "Security 802.1x Extension, Port Authentication Configuration Command"


Command Parameters
Parameter

Type

Description

[ no ] authentication

<Aaa::PortAuthState>

[ no ] init-authreq-off

<Aaa::PortAuthReq>

[ no ] handshake

<Aaa::PortHandShakeMode>

optional parameter with default value: "no-authen"


enable 802.1x authentication
optional
parameter
with
default
value:
"initiate-authreq"
specify initiate authentication request to supplicant
optional
parameter
with
default
value:
"no-handshake"
enable handshake for this port
optional parameter with default value: 15
specify the handshake time interval

[ no
handshake-period

] <Aaa::PortHandShakePeriod>
range: [5...90]

3HH-01016-AAAA-TCZZA Edition 03

Released

159

12 Security Configuration Commands

12.22 Security 802.1x Port Configuration Command


Command Description
This command configures the security 802.1x port. A table contains the configuration objects for the Authenticator
PAE associated with each port. An entry appears in this table for each port that may authenticate access to itself.

User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> configure system security pae port (port) [ no initialize | initialize ]

Command Parameters
Table 12.22-1 "Security 802.1x Port Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 12.22-2 "Security 802.1x Port Configuration Command" Command Parameters


Parameter
[ no ] initialize

160

Type

Description

<Aaa::InitCont>

optional
parameter
with
default
"no-initialize"
initialization control for this port

Released

3HH-01016-AAAA-TCZZA

Edition 03

value:

12 Security Configuration Commands

12.23 Security Password Policy Configuration


Commmand
Command Description
This node allows the operator to configure the password policy.

User Level
The command can be accessed by operators with security,all privileges, and executed by operators with security
privileges.

Command Syntax
The command has the following syntax:
> configure system security password min-length <Sec::PwdLength> min-num-numeric-char
<Sec::PwdNumChars> min-num-special-char <Sec::PwdSpeChars> [ no mixed-case |
mixed-case <Sec::MixCase> ]

Command Parameters
Table 12.23-2 "Security Password Policy Configuration Commmand" Command Parameters
Parameter
min-length
min-num-numeric-char
min-num-special-char
[ no ] mixed-case

Type

Description

<Sec::PwdLength>
range: [4...20] unit: characters
<Sec::PwdNumChars>
range: [0...20] unit: characters
<Sec::PwdSpeChars>
range: [0...20] unit: characters
<Sec::MixCase>
Possible values are :
- mandatory : both upper and lower case
characters must be present
- not-mandatory : both upper and lower
case characters not mandatory

optional parameter
the minimum length of the password
optional parameter
minimum number of numerical characters
optional parameter
minimum number of special character
optional
parameter
with
default
value:
"not-mandatory"
both upper and lower case charactersre must be
present

3HH-01016-AAAA-TCZZA Edition 03

Released

161

13- Transaction Configuration Commands

13.1 Transaction Configuration Command

162

Released

13-163

3HH-01016-AAAA-TCZZA

Edition 03

13 Transaction Configuration Commands

13.1 Transaction Configuration Command


Command Description
This command allows the operator to configure transaction parameters.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> configure system transaction [ no time-out-value | time-out-value <TimeTicks>
]log-full-action <Trans::logFullaction>

Command Parameters
Table 13.1-2 "Transaction Configuration Command" Command Parameters
Parameter
[ no ] time-out-value
log-full-action

Type

Description

<TimeTicks>
unit: msec
<Trans::logFullaction>
Possible values are :
- wrap : older log records are overwritten
by recent ones
- halt : logging is stopped until the log
buffer is reset

optional parameter with default value: 6000


set the timeout for transaction
optional parameter
set action to be taken when the log is full

3HH-01016-AAAA-TCZZA Edition 03

Released

163

14- Software Management Configuration


Commands

14.1 Software Management Overall Software Package


Configuration Command

164

Released

14-165

3HH-01016-AAAA-TCZZA

Edition 03

14 Software Management Configuration Commands

14.1 Software Management Overall Software


Package Configuration Command
Introduction
The Overall SoftWare Package (OSWP) can be in any one of the following states: operational, aborting,
downloading, enabled, disabled, activated, and committed. The operator can perform such functions as download
the OSWP or set of files, abort its download, or enable or disable its autofetch property. The operator can also
specify primary and secondary tftp-server ids for downloading the database.
The operator can also configure the download set or the set of files that are needed before triggering activation.

Download a new OSWP


To download an OSWP, the system must have only one enabled/active/committed OSWP, the management channel
between the system and the manager has been established, and the system is not involved in another software
download process.
The manager requests the system to download a new OSWP. The manager specifies the path name of the overall
descriptor file, the TFTP-servers where the overall descriptor files are located, and the set of files the manager
wants to have available on the system before activating the new OSWP.
The system downloads the overall descriptor files and stores them persistently. The system downloads the software
files that are specified in the downloaded SWP descriptor files on condition that sufficient resources are available
for their persistent storage. The manager can monitor the progress of the download process with granularity.
The download process can be implicitly or explicitly interrupted. The implicit interruption can occur due to reasons
such as the unavailability of enough resources to store SWP files, the system is not able to download or interpret
the overall descriptor file, or the system is not able to download a selected SWP descriptor file. The explicit
interruption can occur when the manager requests the system to abort the ongoing download process.
If there are no exceptions, the system will have two OSWPs; the Enabled/Active/Committed OSWP and the new
downloaded OSWP. The status of the new OSWP is Enabled/NotActive/UnCommitted.

Abort an OSWP
The manager can abort an OSWP when the system has two OSWPs. The status of the first OSWP is
Enabled/Active/Committed while the second OSWP will be in one of the following three states:
Enabled/NotActive/UnCommitted, Downloading/NotActive/UnCommitted, or Disabled/NotActive/UnCommitted.
The management channel between the system and the manager is established and the system is not involved in any
other software download process.
The manager requests the system to remove the NotActive/UnCommitted OSWP. The system removes all the
persistent stored files and databases not related to the Enabled/Active/Committed OSWP. The status of the OSWP
to be removed will be Aborting/NotActive/UnCommitted during the complete removal operation.
After a successful abort, the system will have only one OSWP. The status of this OSWP will be
Enabled/Active/Committed. Only files and databases related to this OSWP are stored persistently in the system.

Activate a Not-Active OSWP


To activate a not-active OSWP, the system has two OSWPs. One OSWP is Enabled/Active and the second OSWP

3HH-01016-AAAA-TCZZA Edition 03

Released

165

14 Software Management Configuration Commands

is Enabled/NotActive. The management channel between the system and the manager is established and the system
is not involved in another software download process.
The manager requests the system to activate the Enabled/NotActive OSWP. Among the available databases, the
system first selects the database that is compatible with and linked to the Enabled/NotActive OSWP. The system
then starts the activation process of the NotActive OSWP.
Finally, after the successfull activation of the Not-active OSWP, the system has two OSWPs. The previous
Not-active OSWP is now active together with the selected compatible database. Also, the previous Active OSWP is
still available but NotActive.

Commit an OSWP
To commit an OSWP, the system has two OSWPs. The status of the first OSWP is Enabled/Active/UnCommited
and the status of the second OSWP is Enabled/NotActive/Committed.
The manager requests the system to commit the active OSWP. The system removes all the persistent stored files
and databases that do not belong to the Enabled/Active OSWP. The status of the OSWP to be committed will be
Enabled/Active/Committing during the complete commit operation.
Finally, after a successfull commit process, the system has only one OSWP. The status of this OSWP is
Enabled/Active/Committed. Only files related to this OSWP are stored persistently in the system.

Command Description
This command allows the operator to configure various OSWP attributes and parameters.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> configure software-mngt oswp (index) primary-file-server-id <Ip::V4Address>
second-file-server-id <Ip::V4Address> download-set <SwMngt::downloadSet> autofetch
<SwMngt::autoFetch>

Command Parameters
Table 14.1-1 "Software Management Overall Software Package Configuration Command"
Resource Parameters
Resource Identifier
(index)

Type

Description

<SwMngt::swmOswpIdx>
range: [1...2]

index to the swm oswp table

Table 14.1-2 "Software Management Overall Software Package Configuration Command"


Command Parameters
Parameter

Type

primary-file-server-id <Ip::V4Address>
second-file-server-id

166

<Ip::V4Address>

Released

Description
optional parameter
tftp server address for overall descriptor file
optional parameter
second tftp server address for overall descriptor file

3HH-01016-AAAA-TCZZA

Edition 03

14 Software Management Configuration Commands

Parameter
download-set

autofetch

Type

Description

<SwMngt::downloadSet>
Possible values are :
- min-set : minimum set of files needed to
activate
- actual-set : files applicable for the board
types
- complete-set : all the files
<SwMngt::autoFetch>
Possible values are :
- disabled : disable autofetch feature
- missing-files-only : only missing files
are fetched
- all-files : all the files are fetched

optional parameter
set of files needed before triggering activation

3HH-01016-AAAA-TCZZA Edition 03

optional parameter
enable or disable autofetch feature

Released

167

15- Ethernet Configuration Commands

15.1 Ethernet IP Configuration Command


15.2 SHub Ethernet MAC-Filter Configuration Command
15.3 SHub Ethernet MAC-Filter Port List Configuration
Command
15.4 SHub Ethernet Rate Configuration Command

168

Released

15-169
15-170
15-171
15-172

3HH-01016-AAAA-TCZZA

Edition 03

15 Ethernet Configuration Commands

15.1 Ethernet IP Configuration Command


Command Description
These parameters are configure to forwarding or not forwarding of the datagrams, along with whether the TTL
value has been provided by the transport layer or not.
The default value inserted into the Time-To-Live field of the IP header of datagrams originated at this entity,
whenever a TTL value is not supplied by the transport layer protocol. The indication of whether this entity is acting
as an IP router in respect to the forwarding of datagrams received by, but not addressed to, this entity. IP routers
forward datagrams, IP hosts do not.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> configure transport ip default-ttl <Ip::TTL>

Command Parameters
Table 15.1-2 "Ethernet IP Configuration Command" Command Parameters
Parameter
default-ttl

Type

Description

<Ip::TTL>
range: [1...255]

optional parameter
default value inserted into the time-to-live field of
the IP header

3HH-01016-AAAA-TCZZA Edition 03

Released

169

15 Ethernet Configuration Commands

15.2 SHub Ethernet MAC-Filter Configuration


Command
Command Description
This node allows the operator to configure MAC-filter.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub [[no] mac-filter (index-num) [ no protocol-type |
protocol-type <Sys::ProtocolType> ]filter any - <Sys::MacAddr> | <Sys::MacAddr> - any
| <Sys::MacAddr> - <Sys::MacAddr> [vlan-id <Sys::FilterVlanId> ][ no action-drop |
action-drop ]]

Command Parameters
Table 15.2-1 "SHub Ethernet MAC-Filter Configuration Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L2 Filter rule number

Table 15.2-2 "SHub Ethernet MAC-Filter Configuration Command" Command Parameters


Parameter
[ no ] protocol-type
filter

vlan-id
[ no ] action-drop

170

Type

Description

<Sys::ProtocolType>
range: [0,1536...65535]
any - <Sys::MacAddr> | <Sys::MacAddr>
any
|
<Sys::MacAddr>
<Sys::MacAddr>
Possible values are :
- any : all source MAC address
- <Sys::MacAddr> : source mac address
- any : all destination MAC address
- <Sys::MacAddr> : destination mac
address
<Sys::FilterVlanId>
range: [0...4094]
<Sys::L2Action>

optional parameter with default value: 0


specifies the non IP protocol type to be filtered
mandatory parameter
specifies to MAC addresses to be matched with the
packet

Released

optional parameter
Vlan Id to be filtered
optional
parameter
with
default
value:
"action-allow"
specifies the action to be taken on the packet

3HH-01016-AAAA-TCZZA

Edition 03

15 Ethernet Configuration Commands

15.3 SHub Ethernet MAC-Filter Port List


Configuration Command
Command Description
This node allows the operator to configure MAC-filter to a port.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub mac-filter (index-num) [[no] in-port (port) ]

Command Parameters
Table 15.3-1 "SHub Ethernet MAC-Filter Port List Configuration Command" Resource
Parameters
Resource Identifier
(index-num)
(port)

Type

Description

<Sys::Number>
L2 Filter rule number
range: [1...65535]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / the port number
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort>

3HH-01016-AAAA-TCZZA Edition 03

Released

171

15 Ethernet Configuration Commands

15.4 SHub Ethernet Rate Configuration Command


Command Description
This node allows the operator to configure the rate limit.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure transport shub rate-limit (ctrl-index) [ no lookup-enabled |
lookup-enabled ][ no bcast-pkt-enabled | bcast-pkt-enabled ][ no mcast-pkt-enabled |
mcast-pkt-enabled ]max-nbr-pkts <Sys::RateCtrlLimit>

Command Parameters
Table 15.4-1 "SHub Ethernet Rate Configuration Command" Resource Parameters
Resource Identifier
(ctrl-index)

Type

Description

<Shub::NetworkPort>
range: [1...7]

control index of the rate

Table 15.4-2 "SHub Ethernet Rate Configuration Command" Command Parameters


Parameter
[ no ] lookup-enabled

Type

Description

<Sys::DlfStatus>

optional
parameter
with
default
value:
"lookup-disabled"
destination lookup failure packet transmission
optional
parameter
with
default
value:
"bcast-pkt-disabled"
broadcast packet control transmission
optional
parameter
with
default
value:
"mcast-pkt-disabled"
multicast packet control transmission
optional parameter
limiting value for the maximum number of packets

[ no
bcast-pkt-enabled

] <Sys::BcastStatus>

[ no
mcast-pkt-enabled

] <Sys::McastStatus>

max-nbr-pkts

172

<Sys::RateCtrlLimit>
range: [1...65535]

Released

3HH-01016-AAAA-TCZZA

Edition 03

16- IGMP Configuration Commands

16.1 IGMP Channel Sources Configuration Command


16.2 IGMP Package Bitmaps Configuration Command
16.3 IGMP System Configuration Command
16.4 SHub IGMP IGS System Configuration Command
16.5 SHub IGMP Response Timer Configuration Command
16.6 SHub IGMP Router Port Configuration Command
16.7 SHub IGMP Vlan Filter Configuration Command

3HH-01016-AAAA-TCZZA Edition 03

16-174
16-175
16-176
16-178
16-179
16-180
16-181

Released

173

16 IGMP Configuration Commands

16.1 IGMP Channel Sources Configuration


Command
Command Description
This command allows the operator to configure pre-configured IGMP sources channel parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp channel (port) [ no perm-pkg-bitmap | perm-pkg-bitmap <Binary-08-08>
][ no max-num-group | max-num-group <Igmp::ChannelMaxNumGroup> ]

Command Parameters
Table 16.1-1 "IGMP Channel Sources Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 16.1-2 "IGMP Channel Sources Configuration Command" Command Parameters


Parameter

Type

[ no
perm-pkg-bitmap

] <Binary-08-08>
length: 8

[ no
max-num-group

] <Igmp::ChannelMaxNumGroup>
range: [0...10]

174

Released

Description
optional parameter with default value: "01 : 00 :
00 : 00 : 00 : 00 : 00 : 00"
packages, the user is allowed to join
optional parameter with default value: 0
max group number this port (ADSL, PVC) can
support

3HH-01016-AAAA-TCZZA

Edition 03

16 IGMP Configuration Commands

16.2 IGMP Package Bitmaps Configuration


Command
Command Description
This command allows the operator to configure IGMP package bitmaps. The package is intended primarily for use
by a network/element manager, such as an AWS, to support multiple sets of packages in different regions.
A package is a group of zero or more multicast sources that share a common access permission. By grouping the
source channels into one or more packages, it provides flexibility for the service provider to deliver different levels
of services to the end-users, for example, "Basic Package", "Middle-Tier Package", and "Premium Package".
NOTE:There is no requirement to configure the package. However, if it is modified, there is no effect on the
multicast source.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp package (index) [ no name | name <PrintableString-0-32> ][ no
template-name | template-name <PrintableString-0-32> ]template-version
<Igmp::igmpPackageTemplateVersion>

Command Parameters
Table 16.2-1 "IGMP Package Bitmaps Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Igmp::PackageIndex>
range: [1...64]

index of the package

Table 16.2-2 "IGMP Package Bitmaps Configuration Command" Command Parameters


Parameter
[ no ] name
[ no ] template-name
template-version

Type

Description

<PrintableString-0-32>
length: x<32
<PrintableString-0-32>
length: x<32
<Igmp::igmpPackageTemplateVersion>
range: [0...2147483647]

optional parameter with default value: ""


name of the package
optional parameter with default value: ""
name of the service template containing this pkg
optional parameter
version of the service template containing this pkg

3HH-01016-AAAA-TCZZA Edition 03

Released

175

16 IGMP Configuration Commands

16.3 IGMP System Configuration Command


Command Description
This command allows the operator to configure the IGMP system.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp system src-ip-address <Ip::V4Address> [ no verify-checksum |
verify-checksum ][ no query-interval | query-interval <Igmp::SystemQueryInterval> ][
no max-rsp-time | max-rsp-time <Igmp::SystemQueryMaxResponseTime> ][ no robustness |
robustness <Igmp::SystemRobustness> ][ no mem-query-int | mem-query-int
<Igmp::MembQueryIntvl> ][ no last-memb-cnt | last-memb-cnt <Igmp::MembQueryCount> ][
no last-max-resp-tim | last-max-resp-tim <Igmp::SystemLastMembMaxRespTime> ][ no
host-report-intv | host-report-intv <Igmp::SystemUnsolicitedReportIntvl> ][ no start |
start ]

Command Parameters
Table 16.3-2 "IGMP System Configuration Command" Command Parameters
Parameter
src-ip-address

Type

Description

optional parameter
the source ip address which is transmitted in every
multicast IP datagram
[ no ] <Igmp::igmpSystemVerifyChecksum>
optional
parameter
with
default
value:
verify-checksum
"verify-checksum-false"
whether IGMP checksum verification is performed
on received IGMP frame or not
[ no ] query-interval <Igmp::SystemQueryInterval>
optional parameter with default value: 125
range: [1...900] unit: sec
interval at which general membership queries
transmitted
[ no ] max-rsp-time
<Igmp::SystemQueryMaxResponseTime> optional parameter with default value: 100
range: [1...255] unit: 1/10 sec
maximum query response time advertised in
IGMPv2 queries
[ no ] robustness
<Igmp::SystemRobustness>
optional parameter with default value: 2
range: [1...10]
expected pkt loss on subnet
[ no ] mem-query-int <Igmp::MembQueryIntvl>
optional parameter with default value: 10
range: [2...255] unit: 1/10 sec
minimum interval between group-specific queries
[ no ] last-memb-cnt <Igmp::MembQueryCount>
optional parameter with default value: 2
range: [1...10]
number of GSQs ( group-specific queries) to be
sent
[ no ] <Igmp::SystemLastMembMaxRespTime> optional parameter with default value: 2
last-max-resp-tim
range: [1...255] unit: 1/10 sec
allows shorter max response times
[ no ] host-report-intv <Igmp::SystemUnsolicitedReportIntvl>
optional parameter with default value: 10
range: [1...255] unit: sec
interval of repetitions of host's report of group
membership

176

<Ip::V4Address>

Released

3HH-01016-AAAA-TCZZA

Edition 03

16 IGMP Configuration Commands

Parameter
[ no ] start

Type

Description

<Igmp::igmpSystemChangeOperStatus>

optional parameter with default value: "stop"


to start/stop the IGMP and mcast app module

3HH-01016-AAAA-TCZZA Edition 03

Released

177

16 IGMP Configuration Commands

16.4 SHub IGMP IGS System Configuration


Command
Command Description
This command allows the operator to configure the IGS system-related parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub igs-system [ no start-snooping | start-snooping ][ no
enable-status | enable-status ]self-ip-addr-mode <Igmp::SelfIpAddressMode>
self-ip-addr <Ip::V4Address> trace-selection <SignedInteger> [ no router-purge-intv |
router-purge-intv <Igmp::RouterInterval> ][ no host-purge-intv | host-purge-intv
<Igmp::HostInterval> ][ no report-fwd-intv | report-fwd-intv <Igmp::ForwardInterval> ]

Command Parameters
Table 16.4-2 "SHub IGMP IGS System Configuration Command" Command Parameters
Parameter

Type

Description

[ no ] start-snooping

<Igmp::SystemControl>

[ no ] enable-status

<Igmp::Status>

self-ip-addr-mode

self-ip-addr

<Igmp::SelfIpAddressMode>
Possible values are :
- configure : query by configure
- from-ip : query by ip
<Ip::V4Address>

optional
parameter
with
default
value:
"no-start-snooping"
start the snooping module
optional
parameter
with
default
value:
"no-enable-snooping"
enable snooping in the system
optional parameter
sets the mode through which IP address can be got

trace-selection

<SignedInteger>

[ no ] <Igmp::RouterInterval>
router-purge-intv
range: [60...600] unit: sec
[ no ] host-purge-intv <Igmp::HostInterval>
range: [130...1225] unit: sec
[ no ] report-fwd-intv <Igmp::ForwardInterval>
range: [1...255] unit: sec

178

Released

optional parameter
source address while sending IGMP query
optional parameter
specifies what will be traced
optional parameter with default value: 125
interval after which router port entry be purged
optional parameter with default value: 260
interval after which host port entry be purged
optional parameter with default value: 10
interval within which next report msg forwarded

3HH-01016-AAAA-TCZZA

Edition 03

16 IGMP Configuration Commands

16.5 SHub IGMP Response Timer Configuration


Command
Command Description
This command allows the operator to configure the SHub response timer for each VLAN.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub response-timer (vlan-id) [ no leave-rsp-timer | leave-rsp-timer
<Igmp::LeaveResponse> ]

Command Parameters
Table 16.5-1 "SHub IGMP Response Timer Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanIndex>
range: [1...4093]

VlanId for the leave response timer

Table 16.5-2 "SHub IGMP Response Timer Configuration Command" Command Parameters
Parameter
[ no ] leave-rsp-timer

Type

Description

<Igmp::LeaveResponse>
range: [0...10]

optional parameter with default value: 1


interval to wait for query response from host

3HH-01016-AAAA-TCZZA Edition 03

Released

179

16 IGMP Configuration Commands

16.6 SHub IGMP Router Port Configuration


Command
Command Description
This command allows the operator to configure the router port which is reachable.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub [[no] vlan-router-port (vlan-id) network-port
<Shub::NetworkPort> query-timer <Igmp::VlanRouterQueryTimer> ]

Command Parameters
Table 16.6-1 "SHub IGMP Router Port Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)
network-port

Type

Description

<Vlan::VlanId>
range: [1...4093]
<Shub::NetworkPort>
range: [1...7]

the id of a vlan for which a network port is


reachable
the network port that is reachable

Table 16.6-2 "SHub IGMP Router Port Configuration Command" Command Parameters
Parameter
query-timer

180

Type

Description

<Igmp::VlanRouterQueryTimer>
range: [60...600]

mandatory parameter
time interval to wait for query packet

Released

3HH-01016-AAAA-TCZZA

Edition 03

16 IGMP Configuration Commands

16.7 SHub IGMP Vlan Filter Configuration


Command
Command Description
This command allows the operator to configure the VLAN filter status to enable or diable the IGMP snooping on
that specific VLAN.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure igmp shub vlan-filter (filter-id) [ no snoop-filter | snoop-filter ]

Command Parameters
Table 16.7-1 "SHub IGMP Vlan Filter Configuration Command" Resource Parameters
Resource Identifier
(filter-id)

Type

Description

<Igmp::VlanFilterIndex>
range: [1...4093]

Vlan Id for which IGMP features is to be disabled

Table 16.7-2 "SHub IGMP Vlan Filter Configuration Command" Command Parameters
Parameter
[ no ] snoop-filter

Type

Description

<Igmp::VlanFilterStatus>

optional
parameter
"no-snoop-filter"
enable the snoop filter

3HH-01016-AAAA-TCZZA Edition 03

Released

with

default

181

value:

17- Multicast Configuration Commands

17.1 Multicast General Group Configuration Command


17.2 Multicast Capacity Configuration Command
17.3 Multicast Sources Configuration Command

182

Released

17-183
17-184
17-185

3HH-01016-AAAA-TCZZA

Edition 03

17 Multicast Configuration Commands

17.1 Multicast General Group Configuration


Command
Command Description
This command allows the operator to configure general multicast parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast general [ no fast-change | fast-change ][ no pkg-memb-bitmap |
pkg-memb-bitmap <Binary-08-08> ][ no max-bitrate | max-bitrate
<Igmp::GeneralMcastMaxBitRate> ][ no mean-bit-rate | mean-bit-rate
<Igmp::GeneralMcastMeanBitRate> ]

Command Parameters
Table 17.1-2 "Multicast General Group Configuration Command" Command Parameters
Parameter

Type

Description

[ no ] fast-change

<Igmp::generalMulticastFastChanChange> optional
parameter
with
default
value:
"dis-fast-change"
enable/disable fast channel changes
[ no ] <Binary-08-08>
optional parameter with default value: "ff : ff : ff :
pkg-memb-bitmap
length: 8
ff : ff : ff : ff : ff"
package(s) a class D address belongs
[ no ] max-bitrate
<Igmp::GeneralMcastMaxBitRate>
optional parameter with default value: 2500
range: [0...100000] unit: kbps
reasonable downstream max bitrate in ATM level
[ no ] mean-bit-rate
<Igmp::GeneralMcastMeanBitRate>
optional parameter with default value: 2500
range: [0...100000] unit: kbps
reasonable downstream mean bitrate in ATM level

3HH-01016-AAAA-TCZZA Edition 03

Released

183

17 Multicast Configuration Commands

17.2 Multicast Capacity Configuration Command


Command Description
This command allows the operator to configure the multicast capacity parameters.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast capacity [ no max-num-group | max-num-group
<Igmp::McastCapacityMaxNumGroup> ][ no max-num-uncfg | max-num-uncfg
<Igmp::McastCapacityMaxNumUnCfg> ][ no cfg-res-time | cfg-res-time <Igmp::reserveTime>
][ no uncfg-res-time | uncfg-res-time <Igmp::reserveTime> ]

Command Parameters
Table 17.2-2 "Multicast Capacity Configuration Command" Command Parameters
Parameter

Type

[ no
max-num-group

] <Igmp::McastCapacityMaxNumGroup>
range: [0...256]

[
max-num-uncfg

] <Igmp::McastCapacityMaxNumUnCfg>
range: [0...128]

no

[ no ] cfg-res-time
[ no ] uncfg-res-time

184

<Igmp::reserveTime>
unit: sec
<Igmp::reserveTime>
unit: sec

Released

Description
optional parameter with default value: 64
no of grps the system supports in enough
bandwidth
optional parameter with default value: 16
no of uncfg grps the system supports in enough
bandwidth
optional parameter with default value: 125
time to reserve the unused configured groups
optional parameter with default value: 0
time to reserve the unused unconfigured groups

3HH-01016-AAAA-TCZZA

Edition 03

17 Multicast Configuration Commands

17.3 Multicast Sources Configuration Command


Command Description
This command allows the operator to configure the multicast source.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> configure mcast [[no] src (class-d-addr) [ no dis-fast-change | dis-fast-change ][
no pkg-mem-bitmap | pkg-mem-bitmap <Binary-08-08> ][ no name | name
<PrintableString-0-32> ][ no atm-peak-bit-rate | atm-peak-bit-rate
<Igmp::McastSrcAtmPeakBitRate> ][ no atm-sus-bit-rate | atm-sus-bit-rate
<Igmp::McastSrcAtmSustainBitRate> ]vlan-id <Igmp::McastSrcVLANID> [ no service-name |
service-name <PrintableString-0-32> ]]

Command Parameters
Table 17.3-1 "Multicast Sources Configuration Command" Resource Parameters
Resource Identifier
(class-d-addr)

Type

Description

<MulticastAddress>

mcast
src
address
order(big-endian)

in

network-byte

Table 17.3-2 "Multicast Sources Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] dis-fast-change

<Igmp::generalMulticastFastChanChange> optional
parameter
with
default
value:
"fast-change"
enable fast channel change
[ no ] <Binary-08-08>
optional parameter with default value: "01 : 00 :
pkg-mem-bitmap
length: 8
00 : 00 : 00 : 00 : 00 : 00"
indicates to which package(s) a class D address
belongs
[ no ] name
<PrintableString-0-32>
optional parameter with default value: ""
length: x<32
name of the source
[ no ] <Igmp::McastSrcAtmPeakBitRate>
optional parameter with default value: 2500
atm-peak-bit-rate
range: [0...100000]
peak bit rate for transmit/downstream traffic
[ no ] atm-sus-bit-rate <Igmp::McastSrcAtmSustainBitRate>
optional parameter with default value: 2500
range: [0...100000]
sustainable bit rate for transmit/downstream traffic
vlan-id
<Igmp::McastSrcVLANID>
mandatory parameter
range: [1...4093]
The parameter is not visible during modification.
VLAN for this multicast source
[ no ] service-name
<PrintableString-0-32>
optional parameter with default value: ""
length: x<32
name of the service or service provider of this
mcast source

3HH-01016-AAAA-TCZZA Edition 03

Released

185

18- IP Configuration Commands

18.1 VRF Configuration Command


18.2 VRF Route Configuration Command
18.3 VLAN Bundle Configuration Command
18.4 IP SHub VRF Configuration Command
18.5 IP SHub VRF Route Map
18.6 IP SHub VRF route preference command
18.7 IP SHub VRF Route Configuration Command
18.8 IP Shub Arp Configuration Command
18.9 IP Shub Arp Configuration Command Per Vlan
18.10 IP Interface Network Configuration Command
18.11 IP Interface Network VRF Configuration Command
18.12 IP Interface Network Numbered Configuration
Command
18.13 IP Interface User Port Configuration Command
18.14 IP Interface User Port VRF Configuration Command
18.15 IP Interface User Bridge Port Configuration
Command
18.16 IP Interface User Port VRF Configuration Command
18.17 IP User Gateway Interface VRF Configuration
Command

186

Released

18-187
18-189
18-190
18-191
18-192
18-193
18-194
18-195
18-196
18-197
18-198
18-199
18-200
18-201
18-202
18-203
18-204

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.1 VRF Configuration Command


Command Description
This command allows an operator to create, delete, or modify a virtual routing and forwarding context for the data
plane. VRF index 0 is reserved and cannot be created, deleted, or modified.
The modification of my-ipaddress is not possible if there are still PPPoE connections established in the VRF.
The removal of VRF is not possible when there is an IP interface still attached or a PPPoE connection established
in the VRF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip [[no] vrf (index) name <Vrf::VrfName> [ no desc | desc
<Vrf::VrfDescription> ][ no contact | contact <Vrf::VrfContact> ][ no my-ipaddress |
my-ipaddress <Ip::V4Address> ][ no default-ttl | default-ttl <Vrf::DefaultTTL> ][ no
reassem-timeout | reassem-timeout <Gauge> ][ no mode | mode <Vrf::VrfMode> ]]

Command Parameters
Table 18.1-1 "VRF Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Vrf::VrfIndex>
range: [1...127]

the vrf index

Table 18.1-2 "VRF Configuration Command" Command Parameters


Parameter
name
[ no ] desc
[ no ] contact
[ no ] my-ipaddress
[ no ] default-ttl
[ no
reassem-timeout
[ no ] mode

Type

Description

<Vrf::VrfName>
length: 1<=x<22
<Vrf::VrfDescription>
length: x<32
<Vrf::VrfContact>
length: x<32
<Ip::V4Address>

mandatory parameter
the name
optional parameter with default value: ""
the description
optional parameter with default value: ""
contact information for administration of this VRF
optional parameter with default value: "0.0.0.0"
Ip Address of the system within this VRF
optional parameter with default value: 32
default value for time-to-live
optional parameter with default value: 30
maximum seconds the fragments to be held for
reassembly
optional parameter with default value: "forwarder"
the mode

<Vrf::DefaultTTL>
range: [1...255]
] <Gauge>
<Vrf::VrfMode>
Possible values are :
- forwarder : acting in forwarder mode
without user to user traffic
- router : acting in router mode

3HH-01016-AAAA-TCZZA Edition 03

Released

187

18 IP Configuration Commands

188

Released

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.2 VRF Route Configuration Command


Command Description
This command allows the operator to create or delete an indirect or direct route towards the network and a direct
route towards the user-side. The next hop address must match one of the IP interfaces towards the network.
Only one default route can be created for each VRF. Use an address of 0.0.0.0 to specify a default route.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip vrf (index) [[no] route-dest (dest-ip-address) next-hop direct :
user-port : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::DefaultVpi> : <Atm::DefaultVci> | <Ip::V4Address> : network : vlan : stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> | <Ip::V4Address> : network : vlan :
<Vlan::UVlanIndex> | <Ip::V4Address> : network : any | network : stacked :
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> | direct : network : <Vlan::UVlanIndex> |
direct : user-bridgeport : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> ]

Command Parameters
Table 18.2-1 "VRF Route Configuration Command" Resource Parameters
Resource Identifier
(index)
(dest-ip-address)
next-hop

Type

Description

<Vrf::VrfIndex>
the vrf index
range: [1...127]
<Ip::V4Address> / <Ip::PrefixLengthFull> inet-address with prefix
direct : user-port : <Eqpt::Rack> / the next hop IP-address
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | <Ip::V4Address> :
network
:
vlan
:
stacked
:
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex> | <Ip::V4Address> :
network : vlan : <Vlan::UVlanIndex> |
<Ip::V4Address> : network : any |
network : stacked : <Vlan::SVlanIndex> :
<Vlan::CVlanIndex> | direct : network :
<Vlan::UVlanIndex>
|
direct
:
user-bridgeport
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci>

3HH-01016-AAAA-TCZZA Edition 03

Released

189

18 IP Configuration Commands

18.3 VLAN Bundle Configuration Command


Command Description
This command allows an operator to create or delete a VLAN bundle.
If the operator deletes the last VLAN it will delete the VLAN bundle.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip [[no] vlan-bind (vlan-id) layer3-itf <Itf::IpoeInterface> ]

Command Parameters
Table 18.3-1 "VLAN Bundle Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

specifies the vlan ID.

Table 18.3-2 "VLAN Bundle Configuration Command" Command Parameters


Parameter
layer3-itf

190

Type

Description

<Itf::IpoeInterface>
Possible values are :
- new : new ip interface
- <Ip::Layer3ID> : the layer3-itf

mandatory parameter
The parameter is not visible during modification.
specifies the layer3 interface.

Released

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.4 IP SHub VRF Configuration Command


Command Description
This commands allows the operator to create, delete, or modify a virtual routing and forwarding context for the
control plane. VRF index 0 is reserved and cannot be created, deleted or modified.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub [[no] vrf (index) name <Vrf::ShubVrfName> (modeandcommstatus) ]

Command Parameters
Table 18.4-1 "IP SHub VRF Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Vrf::ShubVrfID>
range: [0...127]

the vrf id

Table 18.4-2 "IP SHub VRF Configuration Command" Command Parameters


Parameter

Type

name

<Vrf::ShubVrfName>
length: x<22
(modeandcommstatus) fast-path-mode : ena-user-user-com |
dis-user-user-com | slow-path-mode
Possible values are :
- fast-path-mode : set fast-path mode
- slow-path-mode : set slow-path mode
- ena-user-user-com : set user to user
comm via service-hub
- dis-user-user-com : unset user to user
comm

3HH-01016-AAAA-TCZZA Edition 03

Description
mandatory parameter
the name
mandatory parameter
some help

Released

191

18 IP Configuration Commands

18.5 IP SHub VRF Route Map


Command Description
This command allows the operator to configure the route map in IP SHub.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option [[no] route-map (dest-ip) source-proto
<Ip::SourceProto> (export) dest-proto <Ip::DestProto> ]

Command Parameters
Table 18.5-1 "IP SHub VRF Route Map" Resource Parameters
Resource Identifier
(index)
(dest-ip)
source-proto

Type

Description

<Vrf::ShubVrfID>
range: [0...127]
<Ip::V4Address>
<Ip::IpPrefixLengthInv>
<Ip::SourceProto>
Possible values are :
- any : any routing protocol
- static : static routing
- rip : berkeley rip or rip2
- ospf : open shortest path first

the vrf id
/ ip address and mask of the destination route
source routing protocol

Table 18.5-2 "IP SHub VRF Route Map" Command Parameters


Parameter
(export)

dest-proto

192

Type

Description

<Ip::ExportFlag>
Possible values are :
- permit : permit the route export
- deny : deny the route export
<Ip::DestProto>
Possible values are :
- any : any routing protocol
- ospf : ospf routing protocol
- rip : rip routing protocol
- ospf-rip : ospf and rip routing protocol

mandatory parameter
route allowed for export

Released

mandatory parameter
destination routing protocol

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.6 IP SHub VRF route preference command


Command Description
This commands allows an operator to specify the preference for the route learned by dynamic routing protocols.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) routing-option preference route-type (index) value
<Vrf::ShubProtPref>

Command Parameters
Table 18.6-1 "IP SHub VRF route preference command" Resource Parameters
Resource Identifier
(index)
(index)

Type

Description

<Vrf::ShubVrfID>
range: [0...127]
<Vrf::ShubProtId>
Possible values are :
- static : static route
- rip : RIPv2 protocol
- ospf : open shortest path first

the vrf id
the routing protocol id

Table 18.6-2 "IP SHub VRF route preference command" Command Parameters
Parameter
value

Type

Description

<Vrf::ShubProtPref>
range: [0...255]

optional parameter
the preference for the route

3HH-01016-AAAA-TCZZA Edition 03

Released

193

18 IP Configuration Commands

18.7 IP SHub VRF Route Configuration Command


Command Description
This command allows the operator to create, delete, or modify a virtual routing and forwarding context for the
control plane. VRF index 0 is reserved and cannot be created, deleted, or modified.
The Ip-address of the route destination must be of type x.x.x.0/24.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub vrf (index) [[no] route-dest (dest) next-hop
<Ip::NextHopV4Address> vlan-id <Vlan::VlanId> [ no metric | metric
<Vrf::ShubRouteMetric> ]]

Command Parameters
Table 18.7-1 "IP SHub VRF Route Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Vrf::ShubVrfID>
the vrf id
range: [0...127]
<Ip::V4Address> / <Ip::PrefixLengthFull> the destination ip address and mask of this route
<Ip::NextHopV4Address>
the next hop ip address of this route

(dest)
next-hop

Table 18.7-2 "IP SHub VRF Route Configuration Command" Command Parameters
Parameter

194

Type

Description

vlan-id

<Vlan::VlanId>
range: [1...4093]

[ no ] metric

<Vrf::ShubRouteMetric>

mandatory parameter
The parameter is not visible during modification.
vlan id
optional parameter with default value: 1
the primary routing metric for this route

Released

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.8 IP Shub Arp Configuration Command


Command Description
This command allows the operator to configure the IP SHub ARP parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub arp [ no cache-timeout | cache-timeout <Ip::ArpCacheTimeOut> ][ no
cache-pending | cache-pending <Ip::ArpCachePendingTime> ][ no cache-refresh |
cache-refresh <Ip::ArpCacheRefreshTime> ][ no cache-retry-time | cache-retry-time
<Ip::ArpCacheRetryTime> ][ no max-retry-itvl | max-retry-itvl
<Ip::ArpCacheMaxRetryTime> ][ no max-retries | max-retries <Ip::ArpMaxRetries> ]

Command Parameters
Table 18.8-2 "IP Shub Arp Configuration Command" Command Parameters
Parameter

Type

[ no ] cache-timeout

<Ip::ArpCacheTimeOut>
range: [30...86400]
[ no ] cache-pending <Ip::ArpCachePendingTime>
range: [30...3000]
[ no ] cache-refresh
<Ip::ArpCacheRefreshTime>
range: [30...3600]
[ no ] <Ip::ArpCacheRetryTime>
cache-retry-time
range: [1...60]
[ no ] max-retry-itvl
<Ip::ArpCacheMaxRetryTime>
range: [600...18000]
[ no ] max-retries
<Ip::ArpMaxRetries>
range: [2...10]

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: 7200
time after which the entry in cache is removed
optional parameter with default value: 30
time an unresolved entry will be held in cache
optional parameter with default value: 90
refresh interval for next hop ARP cache entries
optional parameter with default value: 1
retry time for next hop ARP cache entries
optional parameter with default value: 3600
max retry time for next hop ARP cache entries
optional parameter with default value: 3
maximum number of retry attempts for ARP
resolution

Released

195

18 IP Configuration Commands

18.9 IP Shub Arp Configuration Command Per Vlan


Command Description
This command allows the operator to configure the IP SHub ARP parameters for each VLAN.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip shub arp vlan (vlanid) [ no gratuitous-arp | gratuitous-arp ]

Command Parameters
Table 18.9-1 "IP Shub Arp Configuration Command Per Vlan" Resource Parameters
Resource Identifier
(vlanid)

Type

Description

<Vlan::VlanIndex>
range: [1...4093]

the vlan id

Table 18.9-2 "IP Shub Arp Configuration Command Per Vlan" Command Parameters
Parameter
[ no ] gratuitous-arp

196

Type

Description

<Shub::GratArp>

optional
parameter
with
default
value:
"no-gratuitous-arp"
process gratuitous broadcast ARP messages

Released

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.10 IP Interface Network Configuration Command


Command Description
This command creates an IP interface on a netwotk port.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface [[no] network (vlanid) ]

Command Parameters
Table 18.10-1 "IP Interface Network Configuration Command" Resource Parameters
Resource Identifier
(vlanid)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

3HH-01016-AAAA-TCZZA Edition 03

Description
| vlan id
:

Released

197

18 IP Configuration Commands

18.11 IP Interface Network VRF Configuration


Command
Command Description
This command allows the operator to configure VRF IP interface parameters. An interface can be of type
Numbered or Unumbered. The creation of the IP address will be for the Numbered interface only.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface network (vlanid) [[no] vrf (vrf-index) [ no arp-policy |
arp-policy <Vrf::ArpPolicy> ][ no unnumbered | unnumbered ]]

Command Parameters
Table 18.11-1 "IP Interface Network VRF Configuration Command" Resource Parameters
Resource Identifier
(vlanid)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Description
| vlan id
:

Table 18.11-2 "IP Interface Network VRF Configuration Command" Command Parameters
Parameter
(vrf-index)
[ no ] arp-policy

[ no ] unnumbered

198

Type

Description

<Vrf::VrfIndex>
range: [1...127]
<Vrf::ArpPolicy>
Possible values are :
- not-trusted : not trusted ARP packets
- trusted : trusted ARP packets
<Vrf::Unnumbered>

mandatory parameter
the vrf index
optional
parameter
with
default
"not-trusted"
system behaviour to received ARP packets

Released

value:

optional parameter with default value: "numbered"


unnumbered interface

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.12 IP Interface Network Numbered Configuration


Command
Command Description
This command associates an IP address to the numbered interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface network (vlanid) [[no] ip-address (ip-address) ]

Command Parameters
Table 18.12-1 "IP Interface Network Numbered Configuration Command" Resource Parameters
Resource Identifier
(vlanid)
(ip-address)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Ip::V4Address> / <Ip::PrefixLength>

3HH-01016-AAAA-TCZZA Edition 03

Description
| vlan id
:
inet-address

Released

199

18 IP Configuration Commands

18.13 IP Interface User Port Configuration


Command
Command Description
This command allows the operator to configure user port interface (rack/shelf/Lt-slot/port/vpi:vci).

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface user [[no] port (port-interface) ]

Command Parameters
Table 18.13-1 "IP Interface User Port Configuration Command" Resource Parameters
Resource Identifier
(port-interface)

200

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Released

3HH-01016-AAAA-TCZZA

Edition 03

18 IP Configuration Commands

18.14 IP Interface User Port VRF Configuration


Command
Command Description
This command allows an operator to configure VRF IP interface parameters. The operator enters the QoS Profile
Sessions parameter. For the network-side, the IP interfaces will always be 0.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface user port (port-interface) [[no] vrf (vrf-index) [ no
qos-profile | qos-profile none | name : <Vlan::IgnoredQosProfileName> ]]

Command Parameters
Table 18.14-1 "IP Interface User Port VRF Configuration Command" Resource Parameters
Resource Identifier
(port-interface)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 18.14-2 "IP Interface User Port VRF Configuration Command" Command Parameters
Parameter
(vrf-index)
[ no ] qos-profile

Type
<Vrf::VrfIndex>
range: [1...127]
none
|
name
<Vlan::IgnoredQosProfileName>

3HH-01016-AAAA-TCZZA Edition 03

Description
mandatory parameter
the vrf index
: optional parameter with default value: "none"
qos profile name

Released

201

18 IP Configuration Commands

18.15 IP Interface User Bridge Port Configuration


Command
Command Description
This is used to configure user bridgeport(IPoE) interface (rack/shelf/Lt-slot/port/vpi:vci).

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface user [[no] bridgeport (port-interface) ]

Command Parameters
Table 18.15-1 "IP Interface User Bridge Port Configuration Command" Resource Parameters
Resource Identifier
(port-interface)

202

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index
(1/1/4/1..)
of
<Eqpt::LtSlot>
/
<Eqpt::Port>
: user-bridgeport identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Released

3HH-01016-AAAA-TCZZA

rack/shelf/slot/port

Edition 03

18 IP Configuration Commands

18.16 IP Interface User Port VRF Configuration


Command
Command Description
This command allows an operator to configure VRF IP interface parameters. The operator enters the QoS Profile
Sessions parameter. For the network-side, the IP interfaces will always be 0.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface user bridgeport (port-interface) [[no] vrf (vrf-index) [ no
qos-profile | qos-profile none | name : <Vlan::IgnoredQosProfileName> ]]

Command Parameters
Table 18.16-1 "IP Interface User Port VRF Configuration Command" Resource Parameters
Resource Identifier
(port-interface)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index
(1/1/4/1..)
of
<Eqpt::LtSlot>
/
<Eqpt::Port>
: user-bridgeport identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

rack/shelf/slot/port

Table 18.16-2 "IP Interface User Port VRF Configuration Command" Command Parameters
Parameter
(vrf-index)
[ no ] qos-profile

Type
<Vrf::VrfIndex>
range: [1...127]
none
|
name
<Vlan::IgnoredQosProfileName>

3HH-01016-AAAA-TCZZA Edition 03

Description
mandatory parameter
the vrf index
: optional parameter with default value: "none"
qos profile name

Released

203

18 IP Configuration Commands

18.17 IP User Gateway Interface VRF Configuration


Command
Command Description
This command creates a user gateway interface. Whenever a VRF is created, there will be an auto-generated entry
in the VRF IP interface table. Only the operator can associate multiple IP addresses to this interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ip interface gateway [[no] vrf-id (user-gateway) ip-address
<Ip::V4Address> / <Ip::PrefixLength> ]

Command Parameters
Table 18.17-1 "IP User Gateway Interface VRF Configuration Command" Resource Parameters
Resource Identifier
(user-gateway)
ip-address

204

Type

Description

<Vrf::VrfIndex>
<Ip::V4Address> / <Ip::PrefixLength>

the vrf index


inet-address

Released

3HH-01016-AAAA-TCZZA

Edition 03

19- VLAN Configuration Commands

19.1 VLAN General Configuration Command


19.2 VLAN Configuration Command
19.3 VLAN Filtering Database Configuration Command
19.4 VLAN Protocol based Configuration Command
19.5 SHub VLAN Configuration Command
19.6 SHub Static Egress Port for VLAN Configuration
Command
19.7 SHub Static Untagged Egress Port for VLAN
Configuration Command
19.8 SHub Multicast MAC Filtering Database Configuration
Command
19.9 SHub Multicast Filtering Configuration Command

3HH-01016-AAAA-TCZZA Edition 03

19-206
19-207
19-209
19-210
19-212
19-214
19-215
19-216
19-217

Released

205

19 VLAN Configuration Commands

19.1 VLAN General Configuration Command


Command Description
This node allows to specify VLAN parameters which are globally applicable to all VLANs.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan [ no broadcast-frames | broadcast-frames ]priority-policy
<Vlan::PriorityMap>

Command Parameters
Table 19.1-2 "VLAN General Configuration Command" Command Parameters
Parameter

Type

[ no
broadcast-frames
priority-policy

206

] <Vlan::BrdcastControl>
<Vlan::PriorityMap>
Possible values are :
- vlan-specific : the priority of the vlan
- port-default : the default priority of the
port

Released

Description
optional
parameter
with
default
value:
"no-broadcast"
switch broadcast frames for each vlan
optional parameter
specifies how to deal with ethernet priority of the
upstream frames

3HH-01016-AAAA-TCZZA

Edition 03

19 VLAN Configuration Commands

19.2 VLAN Configuration Command


Command Description
This node allows to specify a VLAN and its attributes.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan [[no] id (vlanid) [ no name | name <Vlan::AdminString> ]mode
<Vlan::SystemMode> [ no priority | priority <Vlan::Priority> ][ no broadcast-frames |
broadcast-frames ][ no protocol-filter | protocol-filter <Vlan::ProtGroup> ][ no
pppoe-relay | pppoe-relay ](dhcp-opt-82) circuit-id <Vlan::CircuitId> remote-id
<Vlan::RemoteId> ]

Command Parameters
Table 19.2-1 "VLAN Configuration Command" Resource Parameters
Resource Identifier
(vlanid)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Description
| vlan id
:

Table 19.2-2 "VLAN Configuration Command" Command Parameters


Parameter
[ no ] name
mode

[ no ] priority
[ no
broadcast-frames
[ no ] protocol-filter

Type
<Vlan::AdminString>
length: x<32
<Vlan::SystemMode>
Possible values are :
- cross-connect : crossconnect vlan
- residential-bridge : residential bridge
vlan
- qos-aware : qos aware vlan
- layer2-terminated : layer2 terminated
vlan
<Vlan::Priority>
range: [0...7]
] <Vlan::StaticBrdcastControl>
<Vlan::ProtGroup>
Possible values are :
- pass-all : pass all traffic
- pass-ipoe : pass traffic of IPoE protocol
group
- pass-pppoe : pass traffic of PPPoE

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: ""
name
mandatory parameter
The parameter is not visible during modification.
mode

optional parameter with default value: 0


default frame priority
optional
parameter
with
default
value:
"no-broadcast"
switch downstream broadcast frames
optional parameter with default value: "pass-all"
filter protocol groups

Released

207

19 VLAN Configuration Commands

Parameter

[ no ] pppoe-relay
(dhcp-opt-82)

circuit-id

remote-id

208

Type

Description

protocol group
- pass-pppoe-ipoe : pass PPPoE and IPoE
protocol groups
<Vlan::PppoeRelayEnable>
optional
parameter
with
default
value:
"no-pppoe-relay"
enable pppoe relay
<Vlan::DhcpOption82>
mandatory parameter
Possible values are :
The parameter is not visible during creation.
- dhcp-opt-82 : enable dhcp option 82 enable dhcp option 82 (rb vlan)
(relay)
- dhcp-opt-82-off : disable dhcp option 82
(relay)
<Vlan::CircuitId>
mandatory parameter
Possible values are :
The parameter is not visible during creation.
- customer-id : add customerId as circuitId circuit id
- physical-id : add addPhysicalLineId as
circuitId
- notadd : not add circuitId
<Vlan::RemoteId>
mandatory parameter
Possible values are :
The parameter is not visible during creation.
- customer-id : add customerId as remote id
remoteId
- notadd : not add remoteId

Released

3HH-01016-AAAA-TCZZA

Edition 03

19 VLAN Configuration Commands

19.3 VLAN Filtering Database Configuration


Command
Command Description
This node allows to specify entries in the layer 2 Filtering Database for a specific VLAN and unicast MAC address.
This information is used by the bridge in determining how to propagate a received frame.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan [[no] unicast-mac (unicast-mac) vlan-id <Vlan::UVlanIndex> |
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> forward-port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> ]

Command Parameters
Table 19.3-1 "VLAN Filtering Database Configuration Command" Resource Parameters
Resource Identifier
(unicast-mac)
vlan-id

Type

Description

<Vlan::MacAddr>
length: 6
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

unicast mac address


| vlan id
:

Table 19.3-2 "VLAN Filtering Database Configuration Command" Command Parameters


Parameter
forward-port

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ mandatory parameter
<Eqpt::LtSlot>
/
<Eqpt::Port>
: forward bridge port
<Atm::DefaultVpi> : <Atm::DefaultVci>

3HH-01016-AAAA-TCZZA Edition 03

Released

209

19 VLAN Configuration Commands

19.4 VLAN Protocol based Configuration Command


Command Description
For protocol based VLANs, this node allows to specify how incoming traffic on a port is allocated to a particular
VLAN and priority.
For Ethernet frames the mapping to either PPPoE or IPoE protocol is:
protocol value 0x8863: PPPoE
protocol value 0x8864: PPPoE
protocol value 0x0800: IPoE
protocol value 0x0806: IPoE
protocol value 0x8035: IPoE
For RFC_1042 frames the mapping to either PPPoE or IPoE protocol is:
protocol value 0x8863: PPPoE
protocol value 0x8864: PPPoE
protocol value 0x0800: IPoE
protocol value 0x0806: IPoE
protocol value 0x8035: IPoE

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan [[no] port-protocol (port) protocol-group <Vlan::GroupId> vlan-id
<Vlan::UVlanIndex> | <Vlan::SVlanIndex> : <Vlan::CVlanIndex> priority <Vlan::Priority>
]

Command Parameters
Table 19.4-1 "VLAN Protocol based Configuration Command" Resource Parameters
Resource Identifier
(port)
protocol-group

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<Vlan::GroupId>
protocol group
Possible values are :
- pppoe : PPPoE
- ipoe : IPoE

Table 19.4-2 "VLAN Protocol based Configuration Command" Command Parameters


Parameter
vlan-id
priority

210

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Vlan::Priority>

Released

Description
| mandatory parameter
: protocol group vlan id
mandatory parameter

3HH-01016-AAAA-TCZZA

Edition 03

19 VLAN Configuration Commands

Parameter

Type

Description

range: [0...7]

priority of protocol based vlan

3HH-01016-AAAA-TCZZA Edition 03

Released

211

19 VLAN Configuration Commands

19.5 SHub VLAN Configuration Command


Command Description
This node allows to specify a VLAN and its attributes on the Service Hub.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub [[no] id (vlanid) [ no name | name <Vlan::AdminString> ]mode
<Shub::SystemMode> [ no mac-move-allow | mac-move-allow ]]

Command Parameters
Table 19.5-1 "SHub VLAN Configuration Command" Resource Parameters
Resource Identifier
(vlanid)

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]

vlan id

Table 19.5-2 "SHub VLAN Configuration Command" Command Parameters


Parameter

Type

[ no ] name
mode

[ no
mac-move-allow

<Vlan::AdminString>
length: x<32
<Shub::SystemMode>
Possible values are :
- cross-connect : crossconnect vlan
- residential-bridge : residential bridge
vlan
- layer2-terminated : layer2 terminated
vlan
- layer2-term-nwport : layer2 terminated
vlan on network port
- v-vlan : virtual vlan
- reserved : internal and external
communication via vlan
] <Shub::MacMoveStatus>

Description
optional parameter with default value: ""
name
mandatory parameter
The parameter is not visible during modification.
mode

optional
parameter
"mac-move-deny"
mac movement status

with

default

Command Output
Table 19.5-3 "SHub VLAN Configuration Command" Display parameters
Specific Information

212

Released

3HH-01016-AAAA-TCZZA

Edition 03

value:

19 VLAN Configuration Commands

name
row-status

Type

Description

<WaitRowStatus>
the status of the instance
Possible values are :
This element is only shown in detail mode.
- active : instance is in use
- not-in-service : instance exists but is not
used
- not-ready : instance exists but can not be
used

3HH-01016-AAAA-TCZZA Edition 03

Released

213

19 VLAN Configuration Commands

19.6 SHub Static Egress Port for VLAN


Configuration Command
Command Description
This node allows to specify the set of ports which are statically allocated as egress ports for the specified VLAN.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) [[no] egress-port (port) ]

Command Parameters
Table 19.6-1 "SHub Static Egress Port for VLAN Configuration Command" Resource Parameters
Resource Identifier
(vlanid)
(port)

214

Type

Description

<Vlan::VlanOamIndex>
vlan id
range: [1...4093]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / egress port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt

Released

3HH-01016-AAAA-TCZZA

Edition 03

19 VLAN Configuration Commands

19.7 SHub Static Untagged Egress Port for VLAN


Configuration Command
Command Description
This node allows to specify the egress ports which should transmit packets for this VLAN as untagged.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub id (vlanid) [[no] untag-port (network-port) ]

Command Parameters
Table 19.7-1 "SHub Static Untagged Egress Port for VLAN Configuration Command" Resource
Parameters
Resource Identifier
(vlanid)

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]

vlan id

(network-port)

3HH-01016-AAAA-TCZZA Edition 03

the untagged network port

Released

215

19 VLAN Configuration Commands

19.8 SHub Multicast MAC Filtering Database


Configuration Command
Command Description
This node allows to specify entries in the layer 2 Filtering Database for a specific VLAN and multicast MAC
address. This configuration applies to the Service Hub.
This information is used by the bridge in determining how to propagate a received frame.
The configuration is used to prohibit flooding of unknown multicast traffic on the specific VLAN and multicast
MAC address.
This Filtering Database can hold up to 256 entries.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub [[no] mcast-mac (mcast-mac) vlan-id <Vlan::VlanIndex> ]

Command Parameters
Table 19.8-1 "SHub Multicast MAC Filtering Database Configuration Command" Resource
Parameters
Resource Identifier
(mcast-mac)
vlan-id

216

Type

Description

<Vlan::MacAddr>
length: 6
<Vlan::VlanIndex>
range: [1...4093]

multicast mac address

Released

vlan id

3HH-01016-AAAA-TCZZA

Edition 03

19 VLAN Configuration Commands

19.9 SHub Multicast Filtering Configuration


Command
Command Description
This node allows to specify the egress ports for a entry in the layer 2 Filtering Database for multicast MAC address
on the SHub.
For a specific VLAN and multicast MAC address, the egress ports are configured. In case no ports are specified,
traffic destined to this particular multicast MAC will not be flooded.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure vlan shub mcast-mac (mcast-mac) vlan-id <Vlan::VlanIndex> [[no]
egress-port (port) ]

Command Parameters
Table 19.9-1 "SHub Multicast Filtering Configuration Command" Resource Parameters
Resource Identifier
(mcast-mac)
vlan-id
(port)

Type

Description

<Vlan::MacAddr>
multicast mac address
length: 6
<Vlan::VlanIndex>
vlan id
range: [1...4093]
lt : <Eqpt::Rack> / <Eqpt::Shelf> / outbound port
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort>

3HH-01016-AAAA-TCZZA Edition 03

Released

217

20- Bridge Configuration Commands

20.1 Bridge General Configuration Command


20.2 Bridge Port Configuration Command
20.3 Bridge Port to VLAN Association Configuration
Command
20.4 SHub Bridge Configuration Command
20.5 SHub Bridge Port Configuration Command

218

Released

20-219
20-220
20-222
20-224
20-225

3HH-01016-AAAA-TCZZA

Edition 03

20 Bridge Configuration Commands

20.1 Bridge General Configuration Command


Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire bridge.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge [ageing-time <Vlan::AgingTime> ]

Command Parameters
Table 20.1-2 "Bridge General Configuration Command" Command Parameters
Parameter
ageing-time

Type

Description

<Vlan::AgingTime>
range: [10...1096] unit: sec

optional parameter
ageing timeout for dynamic mac entries

3HH-01016-AAAA-TCZZA Edition 03

Released

219

20 Bridge Configuration Commands

20.2 Bridge Port Configuration Command


Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port. These
parameters determine the handling of frames on the bridge port.
Priority Regeneration Profile: these profiles are predetermined. Following profiles are available:
Profile 1: Trusted Port
Profile 2: Best Effort
Profile 3: Controlled Load, all priority 3 traffic
Profile 4: Controlled Load, all priority 4 traffic
Profile 5: Background
Profile 6: Best Effort, Controlled Load, Voice
Profile 7: Best Effort, Controlled Load, Voice according 802.1d Annex G
Profile 8: Best Effort, Voice
Profile 9: L2 VPN with 3 traffic classes
Profile 10: L2 VPN with 4 traffic classes
Details on these profiles can be obtained via a show command.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge [[no] port (port) [ no pvid | pvid <Vlan::UVlanIndex> |
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> ][ no default-priority | default-priority
<Vlan::Priority> ][ no mac-learn-off | mac-learn-off ][ no max-unicast-mac |
max-unicast-mac <Vlan::MaxMac> ][ no accept-frame-type | accept-frame-type
<Vlan::VlanFrameTypes> ][ no qos-profile | qos-profile none | name :
<Vlan::IgnoredQosProfileName> ][ no prio-regen-prof | prio-regen-prof
<Vlan::PrioRegenProfile> ]]

Command Parameters
Table 20.2-1 "Bridge Port Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 20.2-2 "Bridge Port Configuration Command" Command Parameters


Parameter

220

Type

[ no ] pvid

<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

[ no ] default-priority

<Vlan::Priority>
range: [0...7]

Released

Description
| optional parameter with default value: "stacked : 1
: : 1"
The parameter is not visible during creation.
default vlan id for untagged frames
optional parameter with default value: 0
priority to be set in upstream frames

3HH-01016-AAAA-TCZZA

Edition 03

20 Bridge Configuration Commands

Parameter
[ no ] mac-learn-off

Type

Description

<Vlan::learnStatus>

optional
parameter
with
default
value:
"mac-learning"
self learning of mac address
optional parameter with default value: "1"
max unicast mac addresses
optional parameter with default value: "untagged"
accept frame types

[ no
max-unicast-mac
[ no
accept-frame-type

] <Vlan::MaxMac>
range: [1...64]
] <Vlan::VlanFrameTypes>
Possible values are :
- single-tagged : admit only vlan tagged
- untagged : admit only vlan untagged
- mixed-tagged : admit vlan tagged and
vlan untagged
[ no ] qos-profile
none
|
name
:
<Vlan::IgnoredQosProfileName>
[ no ] prio-regen-prof <Vlan::PrioRegenProfile>
Possible values are :
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority
3 traffic
- cl-all-prio-4 : controlled load, all priority
4 traffic
- background : background
- be-cl-voice : best effort, controlled load,
voice
- be-cl-1d-voice : best effort, controlled
load, 802.Id Annex G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes

3HH-01016-AAAA-TCZZA Edition 03

optional parameter with default value: "none"


qos profile name
optional
parameter
with
default
value:
"trusted-port"
priority regeneration profile

Released

221

20 Bridge Configuration Commands

20.3 Bridge Port to VLAN Association


Configuration Command
Command Description
This command allows the operator to associate a VLAN to a bridge port and to define VLAN attributes on this port.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge port (port) [[no] vlan-id (index) [ no tag | tag ][ no qos-profile
| qos-profile none | name : <Vlan::IgnoredQosProfileName> ][ no prior-best-effort |
prior-best-effort ][ no prior-background | prior-background ][ no prior-spare |
prior-spare ][ no prior-exc-effort | prior-exc-effort ][ no prior-ctrl-load |
prior-ctrl-load ][ no prior-less-100ms | prior-less-100ms ][ no prior-less-10ms |
prior-less-10ms ][ no prior-nw-ctrl | prior-nw-ctrl ]]

Command Parameters
Table 20.3-1 "Bridge Port to VLAN Association Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>

(index)

Table 20.3-2 "Bridge Port to VLAN Association Configuration Command" Command Parameters
Parameter

Type

[ no ] tag

<Vlan::PortUntagStatus>

[ no ] qos-profile

none
|
name
<Vlan::IgnoredQosProfileName>
[ no ] prior-best-effort <Vlan::BestEffort>
[ no
prior-background

222

] <Vlan::Background>

[ no ] prior-spare

<Vlan::Spare>

[ no ] prior-exc-effort

<Vlan::ExcEffort>

Released

Description
optional parameter with default value: "untag"
tag control for egress port
: optional parameter with default value: "none"
qos profile name
optional
parameter
with
default
value:
"no-prior-best-effort"
enable best effort priority
optional
parameter
with
default
value:
"no-prior-background"
enable background priority
optional
parameter
with
default
value:
"no-prior-spare"
enable spare priority
optional
parameter
with
default
value:

3HH-01016-AAAA-TCZZA

Edition 03

20 Bridge Configuration Commands

Parameter

Type

[ no ] prior-ctrl-load
[ no
prior-less-100ms

<Vlan::CtrlLoad>
] <Vlan::Less100ms>

[ no ] prior-less-10ms

<Vlan::Less10ms>

[ no ] prior-nw-ctrl

<Vlan::NetworkCtrl>

3HH-01016-AAAA-TCZZA Edition 03

Description
"no-prior-exc-effort"
enable excellent effort priority
optional
parameter
with
default
value:
"no-prior-ctrl-load"
enable controlled load priority
optional
parameter
with
default
value:
"no-prior-less-100ms"
enable the video less than 100ms latency and jitter
priority
optional
parameter
with
default
value:
"no-prior-less-10ms"
enable the video less than 10ms latency and jitter
priority
optional
parameter
with
default
value:
"no-prior-nw-ctrl"
enable the network controlled priority

Released

223

20 Bridge Configuration Commands

20.4 SHub Bridge Configuration Command


Command Description
This command allows the operator to specify the aging time for dynamically learned MAC addresses in the filtering
database. The setting is applicable to the entire SHub bridge.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge shub ageing-time <Shub::AgingTime>

Command Parameters
Table 20.4-2 "SHub Bridge Configuration Command" Command Parameters
Parameter
ageing-time

224

Type

Description

<Shub::AgingTime>
range: [10...1000000] unit: sec

optional parameter
program ageing timeout for dynamic mac entries

Released

3HH-01016-AAAA-TCZZA

Edition 03

20 Bridge Configuration Commands

20.5 SHub Bridge Port Configuration Command


Command Description
This command allows the operator to specify various parameters applicable to a specific bridge port on the SHub.
These parameters determine the handling of frames on the bridge port.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure bridge shub port (network-port) [ no default-priority | default-priority
<Shub::PortPriority> ][ no pvid | pvid <Vlan::VlanOamIndex> ][ no accept-frame-type |
accept-frame-type <Shub::VlanFrameTypes> ][ no enable-dual-tag | enable-dual-tag ][ no
enable-pbit-mode | enable-pbit-mode ]

Command Parameters
Table 20.5-1 "SHub Bridge Port Configuration Command" Resource Parameters
Resource Identifier
(network-port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

the network port

Table 20.5-2 "SHub Bridge Port Configuration Command" Command Parameters


Parameter

Type

[ no ] default-priority

<Shub::PortPriority>
range: [0...7]
[ no ] pvid
<Vlan::VlanOamIndex>
range: [1...4093]
[ no ] <Shub::VlanFrameTypes>
accept-frame-type
Possible values are :
- all : admit all frame types
- tagged : admit only vlan tagged
[ no ] enable-dual-tag <Shub::IgnoreDT>
[ no
enable-pbit-mode

] <Shub::CopyPbitMode>

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: "0"
default ingress user priority
optional parameter with default value: 1
port vlan id
optional parameter with default value: "all"
accept frame types
optional
parameter
with
default
"disable-dual-tag"
enable/disable dual tagging indication
optional
parameter
with
default
"disable-pbit-mode"
enable/disable the copy pbit mode

Released

225

value:
value:

21- Link Aggregation Configuration Commands

21.1 Link Aggregation Configuration Command


21.2 Link Aggregation Group Configuration Command

226

Released

21-227
21-228

3HH-01016-AAAA-TCZZA

Edition 03

21 Link Aggregation Configuration Commands

21.1 Link Aggregation Configuration Command


Command Description
This commands configures the Link Aggregation on the Service Hub. It merely allows to enable or disable the Link
Aggregation feature.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure la [ no disable-lacp | disable-lacp ]

Command Parameters
Table 21.1-2 "Link Aggregation Configuration Command" Command Parameters
Parameter
[ no ] disable-lacp

Type

Description

<Shub::LaModuleState>

optional
parameter
with
default
"enable-lacp"
link aggregation protocol operation

3HH-01016-AAAA-TCZZA Edition 03

Released

227

value:

21 Link Aggregation Configuration Commands

21.2 Link Aggregation Group Configuration


Command
Command Description
This node allows to specify the Link Aggregation Group parameters. The configuration should be performed for the
primary link. Note that a Link Aggregation Group is identified my means of the primary link, also referred to as
aggregator-port. The primary link for an Aggregation Group is the link with the lowest port number within the
group, provided the operational state of the link is UP.
The configuration should be performed for the primary link. The settings configured for the primarly link of the
Aggregation Group apply to each and every link that is a member of the Link Aggregation Group.
The link which is denoted as primary link may change during the lifetime of the aggregation group. To cope with
this phenomenon, the operator is advised to repeat the configurations described in this section for each link of the
Aggregation Group. Care shall be taken to configure identical settings for all links within the Aggregation Group.
The primary link can be learned using a show command.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure la aggregator-port (network-port) name <Shub::AggName> [ no
link-up-down-trap | link-up-down-trap ][ no actor-sys-prio | actor-sys-prio
<Shub::LaPortActorSysPriority> ]actor-key <Shub::LacpKey> [ no actor-port-prio |
actor-port-prio <Shub::LaPortActorPortPriority> ][ no active-lacp | active-lacp ][ no
short-timeout | short-timeout ][ no aggregatable | aggregatable ]lacp-mode
<Shub::LacpMode>

Command Parameters
Table 21.2-1 "Link Aggregation Group Configuration Command" Resource Parameters
Resource Identifier
(network-port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

interface index of network port

Table 21.2-2 "Link Aggregation Group Configuration Command" Command Parameters


Parameter

Type

name
[ no
link-up-down-trap
[ no ] actor-sys-prio
actor-key

228

<Shub::AggName>
length: x<20
] <Shub::LaTrap>
<Shub::LaPortActorSysPriority>
range: [0...255]
<Shub::LacpKey>

Released

Description
optional parameter
aggregate name
optional
parameter
with
default
"no-link-up-down"
enable link up down trap
optional parameter with default value: "1"
actor system priority
optional parameter

3HH-01016-AAAA-TCZZA

Edition 03

value:

21 Link Aggregation Configuration Commands

Parameter
[ no ] actor-port-prio
[ no ] active-lacp
[ no ] short-timeout
[ no ] aggregatable
lacp-mode

Type

Description

range: [0...65535]
<Shub::LaPortActorPortPriority>
range: [0...255]
<Shub::ActorAdminLacpActivityState>

key for the actor


optional parameter with default value: "1"
port priority for the actor
optional
parameter
with
default
"passive-lacp"
set lacp active for the actor
<Shub::ActorAdminLacpTimeoutState>
optional
parameter
with
default
"long-timeout"
short timeout for the lacp protocol
<Shub::ActorAdminLacpAggregationState> optional
parameter
with
default
"non-aggregatable"
port is candidate to be aggregated
<Shub::LacpMode>
optional parameter
Possible values are :
lacp mode
- enable-lacp : enable lacp
- disable-lacp : disable lacp
- manual : manual aggregation

3HH-01016-AAAA-TCZZA Edition 03

Released

229

value:
value:
value:

22- Rapid Spanning Tree Configuration Commands

22.1 RSTP Configuration Command


22.2 RSTP Port Configuration Command

230

Released

22-231
22-232

3HH-01016-AAAA-TCZZA

Edition 03

22 Rapid Spanning Tree Configuration Commands

22.1 RSTP Configuration Command


Command Description
This node allows to specify Rapid Spanning Tree settings applicable to the SHub.
The parameters in this section are settings that apply to the bridge as a whole. Port specific RSTP parameters are
dealt with in subsequent chapters.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure rstp [ no disable-rstp | disable-rstp ][ no priority | priority
<Shub::RstpPriority> ][ no max-age | max-age <Shub::RstpMaxAge> ][ no hello-time |
hello-time <Shub::RstpHello> ][ no forward-delay | forward-delay <Shub::RstpFwdDelay>
][ no version | version <Shub::RstpVersion> ][ no tx-hold-count | tx-hold-count
<Shub::RstpTxHold> ][path-cost-type <Shub::RstpPathCost> ]

Command Parameters
Table 22.1-2 "RSTP Configuration Command" Command Parameters
Parameter

Type

Description

[ no ] disable-rstp

<Shub::RstpModuleState>

[ no ] priority

<Shub::RstpPriority>
range: [0...61440]
<Shub::RstpMaxAge>
range: [600...4000] unit: 10msec
<Shub::RstpHello>
range: [100...1000] unit: 10msec
<Shub::RstpFwdDelay>
range: [400...3000] unit: 10msec
<Shub::RstpVersion>
Possible values are :
- ieee-802.1d-stp : stp compatible
- ieee-802.1w-rstp : rstp compatible
<Shub::RstpTxHold>
range: [1...10]
<Shub::RstpPathCost>
Possible values are :
- 16-bit : stp-8021d-1998 path cost
- 32-bit : stp-8021t-2001 path cost

optional
parameter
with
default
value:
"enable-rstp"
rstp protocol operation
optional parameter with default value: 32768
stp bridge priority(n*4096)
optional parameter with default value: 2000
root bridge max age(1 sec. granularity)
optional parameter with default value: 200
root bridge hello timeout(1 sec. granularity)
optional parameter with default value: 1500
root bridge forward delay time(1 sec. granularity)
optional
parameter
with
default
value:
"ieee-802.1w-rstp"
bridge stp version

[ no ] max-age
[ no ] hello-time
[ no ] forward-delay
[ no ] version

[ no ] tx-hold-count
path-cost-type

3HH-01016-AAAA-TCZZA Edition 03

optional parameter with default value: 3


max transmission rate for BPDUs
optional parameter
version for the default path cost

Released

231

22 Rapid Spanning Tree Configuration Commands

22.2 RSTP Port Configuration Command


Command Description
This node allows to specify Rapid Spanning Tree settings applicable to a particular port the Service Hub.
Note that RSTP operates on a port rather than on a VLAN.
In addition to this configuration command, there is a need to trigger a specific SHub Port to revert to RSTP
protocol, versus stp-compatible protocol. The latter command is found in the admin node.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> configure rstp network-port (port) [ no priority | priority <Shub::RstpPortPriority>
][ no disable-stp | disable-stp ][path-cost <Shub::PortPathCost> ][ no edge-port |
edge-port ][ no admin-p2p | admin-p2p <Shub::AdminP2p> ]

Command Parameters
Table 22.2-1 "RSTP Port Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

identity of the network port

Table 22.2-2 "RSTP Port Configuration Command" Command Parameters


Parameter
[ no ] priority
[ no ] disable-stp
path-cost
[ no ] edge-port
[ no ] admin-p2p

232

Type

Description

<Shub::RstpPortPriority>
range: [0...240]
<Shub::RstpStatus>

optional parameter with default value: 128


priority(steps of 16)
optional parameter with default value: "enable-stp"
disable rstp for this port
optional parameter
port path cost
optional
parameter
with
default
value:
"no-edge-port"
configure the port as an edge port
optional parameter with default value: "auto"
admin point to point status

<Shub::PortPathCost>
range: [1...200000000]
<Shub::AdminEdge>
<Shub::AdminP2p>
Possible values are :
- force-true : point to point connection
- force-false : shared media connection
- auto : auto

Released

3HH-01016-AAAA-TCZZA

Edition 03

23- QoS Configuration Commands

23.1 QoS Configuration Command


23.2 QoS Single Dot1P Marker Configuration Command
23.3 QoS Single DSCP Marker Configuration Command
23.4 QoS DSCP Contract Table Marker Configuration
Command
23.5 QoS DSCP Contract Table Codepoint Configuration
Command For Dscp-contract
23.6 QoS Dot1P And DSCP Contract Table Marker
Configuration Command
23.7 DSCP Contract Table Codepoint Configuration
Command For D1p-dscp-contract
23.8 QoS Dot1P And Single DSCP Marker Configuration
Command
23.9 QoS Dot1P Alignment Marker Configuration
Command
23.10 QoS Policer profile Configuration Command
23.11 QoS Queue Profile Configuration Command
23.12 QoS Scheduler Profile Configuration Command
23.13 QoS CAC Profile Configuration Command
23.14 QoS Session Profile Configuration Command
23.15 QoS 802.1P Class to Queue Mapping Configuration
Command
23.16 QoS DSL Link Configuration Command
23.17 QoS LIM Queue Configuration Command
23.18 QoS DSCP to Dot1P L3 Traffic Configuration
Command
23.19 SHub QoS Queue Configuration Command
23.20 SHub QoS Traffic Class Configuration Command
23.21 SHub QoS Ingress Policing on Port
23.22 SHub QoS Flows to be Policed
23.23 SHub QoS Policer Configuration Command

3HH-01016-AAAA-TCZZA Edition 03

23-234
23-235
23-236
23-237
23-238
23-239
23-240
23-241
23-242
23-243
23-244
23-245
23-246
23-247
23-249
23-250
23-251
23-252
23-253
23-254
23-255
23-256
23-257

Released

233

23 QoS Configuration Commands

23.1 QoS Configuration Command


Command Description
This command allows the operator to specify global QoS parameters.
The ATM overhead factor is used to calculate ATM bandwidth required by streams for which bandwidth
parameters are specified as Ethernet bandwidth. The ATM overhead factor specifies in terms of percentage what
part of a given raw ATM bit rate will be available for Ethernet frames. The default value is 85%, which means a
typical overhead of 15% for ATM/AAL5.
QoS management will use this value to deduct the available Ethernet rate on ATM-based DSL interfaces.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos [ no atm-overhead-fact | atm-overhead-fact <Qos::AtmFactor> ][ no
enable-alignment | enable-alignment ]

Command Parameters
Table 23.1-2 "QoS Configuration Command" Command Parameters
Parameter

Type

[ no
atm-overhead-fact
[ no
enable-alignment

234

] <Qos::AtmFactor>
range: [1...100] unit: %
] <Qos::AlignmentStatus>

Released

Description
optional parameter with default value: 85
over head factor introduced by atm layer
optional
parameter
with
default
value:
"disable-alignment"
DSCP to P-bit alignment for all forwarded L3
traffic

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.2 QoS Single Dot1P Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for single dot1p.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p (name) default-dot1p <Qos::ExtVlanSysPrio> ]

Command Parameters
Table 23.2-1 "QoS Single Dot1P Marker Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.2-2 "QoS Single Dot1P Marker Configuration Command" Command Parameters
Parameter
default-dot1p

Type

Description

<Qos::ExtVlanSysPrio>
range: [0...7]

mandatory parameter
the default dot-1p bit value to be applied on all
frames

3HH-01016-AAAA-TCZZA Edition 03

Released

235

23 QoS Configuration Commands

23.3 QoS Single DSCP Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for a single DSCP.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> [ no alignment | alignment ]]

Command Parameters
Table 23.3-1 "QoS Single DSCP Marker Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.3-2 "QoS Single DSCP Marker Configuration Command" Command Parameters
Parameter
default-dscp
[ no ] alignment

236

Type

Description

<Qos::DscpToDot1PAlignmentDscpIndex> mandatory parameter


range: [0...63]
the default dscp value to be applied on all frames
<Qos::Alignment>
optional parameter with default value: "disable"
enable DSCP to P-bits alignment

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.4 QoS DSCP Contract Table Marker


Configuration Command
Command Description
This command allows an operator to configure a marker for a DSCP contract table.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] dscp-contract (name) [ no alignment | alignment
]]

Command Parameters
Table 23.4-1 "QoS DSCP Contract Table Marker Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.4-2 "QoS DSCP Contract Table Marker Configuration Command" Command Parameters
Parameter
[ no ] alignment

Type

Description

<Qos::Alignment>

optional parameter with default value: "disable"


enable DSCP to P-bits alignment

3HH-01016-AAAA-TCZZA Edition 03

Released

237

23 QoS Configuration Commands

23.5 QoS DSCP Contract Table Codepoint


Configuration Command For Dscp-contract
Command Description
This command allows the operator to configure a codepoint for a DSCP contract table.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker dscp-contract (name) codepoint (codepoint) [ no
dscp-value | dscp-value <Qos::DscpToDot1PAlignmentDscpIndex> ]

Command Parameters
Table 23.5-1 "QoS DSCP Contract Table Codepoint Configuration Command For Dscp-contract"
Resource Parameters
Resource Identifier
(name)
(codepoint)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<Qos::DscpCodePoint>
range: [0...63]

A unique profile name


the number of the codepoint

Table 23.5-2 "QoS DSCP Contract Table Codepoint Configuration Command For Dscp-contract"
Command Parameters
Parameter
[ no ] dscp-value

238

Type

Description

<Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default value: 0L


range: [0...63]
the dscp value to be assigned to the codepoint

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.6 QoS Dot1P And DSCP Contract Table Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for Dot1P and the DSCP contract table.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-dscp-contract (name) dot1p-value
<Qos::ExtVlanSysPrio> [ no alignment | alignment ]]

Command Parameters
Table 23.6-1 "QoS Dot1P And DSCP Contract Table Marker Configuration Command" Resource
Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.6-2 "QoS Dot1P And DSCP Contract Table Marker Configuration Command" Command
Parameters
Parameter

Type

Description

dot1p-value

<Qos::ExtVlanSysPrio>
range: [0...7]

[ no ] alignment

<Qos::Alignment>

mandatory parameter
the default dot-1p bit value to be applied on all
frames
optional parameter with default value: "disable"
enable DSCP to P-bits alignment

3HH-01016-AAAA-TCZZA Edition 03

Released

239

23 QoS Configuration Commands

23.7 DSCP Contract Table Codepoint Configuration


Command For D1p-dscp-contract
Command Description
This command allows the operator to configure a codepoint for a DSCP contract table.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker d1p-dscp-contract (name) codepoint (codepoint) [ no
dscp-value | dscp-value <Qos::DscpToDot1PAlignmentDscpIndex> ]

Command Parameters
Table 23.7-1 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Resource Parameters
Resource Identifier
(name)
(codepoint)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<Qos::DscpCodePoint>
range: [0...63]

A unique profile name


the number of the codepoint

Table 23.7-2 "DSCP Contract Table Codepoint Configuration Command For D1p-dscp-contract"
Command Parameters
Parameter
[ no ] dscp-value

240

Type

Description

<Qos::DscpToDot1PAlignmentDscpIndex> optional parameter with default value: 0L


range: [0...63]
the dscp value to be assigned to the codepoint

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.8 QoS Dot1P And Single DSCP Marker


Configuration Command
Command Description
This command allows the operator to configure a marker for Dot1P and single DSCP.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-dscp (name) default-dscp
<Qos::DscpToDot1PAlignmentDscpIndex> default-dot1p <Qos::ExtVlanSysPrio> [ no
alignment | alignment ]]

Command Parameters
Table 23.8-1 "QoS Dot1P And Single DSCP Marker Configuration Command" Resource
Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.8-2 "QoS Dot1P And Single DSCP Marker Configuration Command" Command
Parameters
Parameter
default-dscp
default-dot1p
[ no ] alignment

Type

Description

<Qos::DscpToDot1PAlignmentDscpIndex>
range: [0...63]
<Qos::ExtVlanSysPrio>
range: [0...7]

mandatory parameter
the default dscp value to be applied on all frames
mandatory parameter
the default dot-1p bit value to be applied on all
frames
optional parameter with default value: "disable"
enable DSCP to P-bits alignment

<Qos::Alignment>

3HH-01016-AAAA-TCZZA Edition 03

Released

241

23 QoS Configuration Commands

23.9 QoS Dot1P Alignment Marker Configuration


Command
Command Description
This command allows the operator to configure a marker for Dot1P alignment.
Default value for the global DSCP To Dot1P Alignment Table
DSCP Value

P-bit Value

0-7

8-15

16-23

24-31

32-39

40-47

48-55

56-63

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles marker [[no] d1p-alignment (name) (alignment) ]

Command Parameters
Table 23.9-1 "QoS Dot1P Alignment Marker Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.9-2 "QoS Dot1P Alignment Marker Configuration Command" Command Parameters
Parameter
(alignment)

242

Type

Description

<Qos::Dot1PAlignment>

mandatory parameter
enable dot1p alignment

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.10 QoS Policer profile Configuration Command


Command Description
This command allows the operator to configure a QoS policier profile. A QoS policer profile contains all settings
related to a policer. The ISAM supports single token bucket policers, where the action upon conformance is either
pass or discard.
The EBLT-C and EBLT-D units support both upstream and downstream policing. A policer profile can be used
within a QoS session profile for upstream and downstream policing.
The EALT-A and EBLT-A units do not support policing.
The SHub supports ingress policing but it does not use policer profiles. See the section about the QoS Ingress
Policing Configuration Command to set up ingress policing on the SHub.
The policer granularity on the EBLT-C and EBLT-D units is 8kbps. Values specified with 1kbps granularity are
always rounded upwards. A valid range is from 8kbps till 64Mbps, with a fixed granularity of 8kbps.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles [[no] policer (name) committed-info-rate <Qos::InfoRate>
committed-burst-size <Qos::CommittedBurstSize> ]

Command Parameters
Table 23.10-1 "QoS Policer profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.10-2 "QoS Policer profile Configuration Command" Command Parameters


Parameter
committed-info-rate
committed-burst-size

Type

Description

<Qos::InfoRate>
unit: kbps
<Qos::CommittedBurstSize>
range: [64...262144] unit: bytes

mandatory parameter
committed information rate of a policer
mandatory parameter
committed burst size of a policer

3HH-01016-AAAA-TCZZA Edition 03

Released

243

23 QoS Configuration Commands

23.11 QoS Queue Profile Configuration Command


Command Description
This command allows the operator to configure the QoS queue profile. A queue profile or buffer acceptance control
(BAC) profile contains configuration information on data plane queues. BAC profiles can be used on the EBLT-C
and EBLT-D units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles [[no] queue (name) (bac-complex-type) ]

Command Parameters
Table 23.11-1 "QoS Queue Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.11-2 "QoS Queue Profile Configuration Command" Command Parameters


Parameter

Type

(bac-complex-type)

244

Description

tail-drop : <Qos::MaxThreshold> | red : mandatory parameter


<Qos::MinThreshold>
: buffer acceptance control algorithm
<Qos::MaxThreshold>
:
<Qos::DiscardProbability>

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.12 QoS Scheduler Profile Configuration


Command
Command Description
This command allows the operator to configure the QoS scheduler profile. The scheduler profiles contain
configuration settings for the data plane schedulers. These scheduler profiles are applicable on downstream
schedulers on the EBLT-C and EBLT-D units. The scheduler settings on the aggregation function can be modified
separately.
On the EALT-A and EBLT-A units the schedulers have static settings.
There are two queues with WFQ scheduling method, so the only parameter to tune is the weight of the second
queue (also known as the controlled load queue), while the weight for the first queue is auto-adjusted to yield a sum
of 100%.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles [[no] scheduler (name) wfq-q1-weight <Qos::WfqQ1Weight> ]

Command Parameters
Table 23.12-1 "QoS Scheduler Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.12-2 "QoS Scheduler Profile Configuration Command" Command Parameters


Parameter
wfq-q1-weight

Type

Description

<Qos::WfqQ1Weight>
range: [0...100]

mandatory parameter
weight of DSL link WFQ scheduler for Queue one

3HH-01016-AAAA-TCZZA Edition 03

Released

245

23 QoS Configuration Commands

23.13 QoS CAC Profile Configuration Command


Command Description
This command allows the operator to configure the connection admission control (CAC) profile. The CAC profiles
are used primarily for multicast video admission control. A CAC profile can be attached to each DSL line. The
context of a CAC profile is a DSL link (and not a PVC), regardless of the number of PVCs on a DSL link.
The system derives the guaranteed line rate from the modems and calculates an estimate of the available Ethernet
bandwidth. From this permanent available bandwidth, a part can be reserved for voice and data applications and
the remaining part will be kept by the system as the available bandwidth for multicast video. Only pre-configured
multicast streams are considered for CAC. Note that unicast video (regardless of whether it is premium content or
generic Internet streaming video) is ignored by the CAC function.
The maximum bandwidth that video will occupy can be further constrained via the maximum multicast bandwidth
max-mcast-bandwidth parameter.
CAC profiles are applicable on line cards but are not applicable to interfaces on the SHub.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles [[no] cac (name) res-voice-bandwidth <Itf::mediumBandWidth>
max-mcast-bandwidth <Itf::mediumBandWidth> res-data-bandwidth <Itf::mediumBandWidth> ]

Command Parameters
Table 23.13-1 "QoS CAC Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.13-2 "QoS CAC Profile Configuration Command" Command Parameters


Parameter
res-voice-bandwidth
max-mcast-bandwidth
res-data-bandwidth

246

Type

Description

<Itf::mediumBandWidth>
unit: kbps
<Itf::mediumBandWidth>
unit: kbps

mandatory parameter
reserved bandwidth for the voice services
mandatory parameter
maximum allowed bandwidth for the multicast
video service
mandatory parameter
reserved bandwidth for all data services

<Itf::mediumBandWidth>
unit: kbps

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.14 QoS Session Profile Configuration Command


Command Description
This commmand allows the operator to configure the QoS session profile. The QoS session profile is the main
building block for conveying user traffic contractual rights and treatment. The QoS session profile is a
"macro"-profile, which consists of individual settings as well as references to smaller profiles.
The scope of a QoS session profile is always a user logical interface (for example, a session). The following
"logical interface" or "logical flow" types are supported:
VC : all frames on a PVC
PVC.VLAN : a VLAN on top of a PVC
PPP session : all frames on a locally terminated PPP session
802.1X session : all frames belonging to a 802.1X authenticated session
A QoS session profile is composed of a logical flow type, a marker profile, and two policer profiles for upstream
and downstream policing of the logical interface to which a certain session profile is attached.
The logical flow type will constrain the usage of a session profile to the intended interface type. However, if the
logical flow type is null, the session profile can be attached to any interface, provided that the settings inside the
profile can be configured on the target hardware. Operators must always create specific profiles for specific
interface types to avoid incorrect configurations.
QoS session profiles are supported on the EBLT-C and EBLT-D units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos profiles [[no] session (name) logical-flow-type <Qos::LogicalFlowType>
[ no up-policer | up-policer none | name : <Qos::IgnoredQosProfileName> ][ no
down-policer | down-policer none | name : <Qos::IgnoredQosProfileName> ][ no up-marker
| up-marker none | name : <Qos::IgnoredQosProfileName> ]]

Command Parameters
Table 23.14-1 "QoS Session Profile Configuration Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Table 23.14-2 "QoS Session Profile Configuration Command" Command Parameters


Parameter
logical-flow-type

Type

Description

<Qos::LogicalFlowType>
mandatory parameter
Possible values are :
a traffic stream up on which policy to be made
- generic : any defined logical flow
- pvc : all frames on a pvc
- dot-1x-session : frames on a pvc except

3HH-01016-AAAA-TCZZA Edition 03

Released

247

23 QoS Configuration Commands

Parameter

Type

[ no ] up-policer
[ no ] down-policer
[ no ] up-marker

248

Description

ppp frames
- pvc-vlan-combination : frames on
dot-1D port with the same vlan-id
- ppp-session : all frames on a ppp session
- ip-session : all frames in an IP session or
interface
none
|
name
: optional parameter with default value: "none"
<Qos::IgnoredQosProfileName>
policer profile name applicable on this session
upstream
none
|
name
: optional parameter with default value: "none"
<Qos::IgnoredQosProfileName>
policer profile applicable on this session
downstream
none
|
name
: optional parameter with default value: "none"
<Qos::IgnoredQosProfileName>
marker profile name applicable on this session
upstream

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.15 QoS 802.1P Class to Queue Mapping


Configuration Command
Command Description
This command allows the operator to configure the downstream traffic class mapping table. This table defines
which 802.1P codepoint is cast to which egress buffer on the EBLT-C and EBLT-D units.
There is a second class to the queue mapping table on the SHub but this class is independent (from the
configuration perspective) of this table. (See the traffic class configuration section for more information.) The
second class is used mainly for upstream traffic segregation into egress buffers on the SHub.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos tc-map-dot1p (index) queue <Qos::Queues>

Command Parameters
Table 23.15-1 "QoS 802.1P Class to Queue Mapping Configuration Command" Resource
Parameters
Resource Identifier
(index)

Type

Description

<Qos::Dot1pValue>
range: [0...7]

value of 802.1p filed

Table 23.15-2 "QoS 802.1P Class to Queue Mapping Configuration Command" Command
Parameters
Parameter
queue

Type

Description

<Qos::Queues>
range: [0...3]

optional parameter
output dsl port queue number

3HH-01016-AAAA-TCZZA Edition 03

Released

249

23 QoS Configuration Commands

23.16 QoS DSL Link Configuration Command


Command Description
This command allows the operator to configure DSL links. For each DSL link the operator can apply scheduling
and CAC settings.
A scheduler profile is used to configure egress scheduler settings for each egress DSL interface. A CAC profile is
used to configure CAC settings for each DSL interface.
The DSL link table can be configured on the EBLT-C and EBLT-D units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) [scheduler-profile name :
<Qos::IgnoredQosProfileName> ][cac-profile name : <Qos::IgnoredQosProfileName> ]

Command Parameters
Table 23.16-1 "QoS DSL Link Configuration Command" Resource Parameters
Resource Identifier
(index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ physical port of a dsl link

Table 23.16-2 "QoS DSL Link Configuration Command" Command Parameters


Parameter

250

Type

Description

scheduler-profile

name : <Qos::IgnoredQosProfileName>

cac-profile

name : <Qos::IgnoredQosProfileName>

optional parameter
the name of the scheduler profile to be mapped on
this dsl link
optional parameter
the name of the cac profile to be mapped on this dsl
link

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.17 QoS LIM Queue Configuration Command


Command Description
This command allows the operator to configure the QoS LIM queue. On the EBLT-C and EBLT-D units, each DSL
interface supports four downstream buffers which can be configured independently via buffer acceptance control
(BAC) profiles.
The operator can configure downstream buffers such that the total buffer pool is oversubscribed, however this is
not recommended because this allows QoS un-aware packet discard. If the total downstream buffer pool is
over-subscribed, the system logs a warning message.
Upstream buffers on any unit cannot be configured because there is no bottleneck upstream on the units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dsl-port (index) queue (queue) [ no queue-profile | queue-profile none
| name : <Qos::IgnoredQosProfileName> ]

Command Parameters
Table 23.17-1 "QoS LIM Queue Configuration Command" Resource Parameters
Resource Identifier
(index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Qos::Queues>
range: [0...3]

(queue)

Description
/ physical port of a dsl link
the queue with in the scope of one dsl link on a
line-interface-module

Table 23.17-2 "QoS LIM Queue Configuration Command" Command Parameters


Parameter
[ no ] queue-profile

Type
none
|
name
<Qos::IgnoredQosProfileName>

3HH-01016-AAAA-TCZZA Edition 03

Description
: optional parameter with default value: "none"
name of the queue profile

Released

251

23 QoS Configuration Commands

23.18 QoS DSCP to Dot1P L3 Traffic Configuration


Command
Command Description
This command allows the operator to configure DSCP to Dot1P traffic. When the alignment is enabled, it will align
the DSCP to P-bits for all the L3 forwarding traffic.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos dscp-map-dot1p (index) dot1p-value <Qos::DscpToDot1PAlign>

Command Parameters
Table 23.18-1 "QoS DSCP to Dot1P L3 Traffic Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Qos::DscpToDot1PAlignmentDscpIndex> the DSCP value


range: [0...63]

Table 23.18-2 "QoS DSCP to Dot1P L3 Traffic Configuration Command" Command Parameters
Parameter
dot1p-value

252

Type

Description

<Qos::DscpToDot1PAlign>
range: [0...7]

optional parameter
the DOT1P value

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.19 SHub QoS Queue Configuration Command


Command Description
This command allows the operator to configure the SHub QoS queue. The SHub features seven network interfaces
that can be used for network, subtending, or directly attached customer interfaces (known as "user" interfaces on
the SHub) in any combination.
Each network interface features a hierarchical scheduler with queues (0, 1) scheduled as weighted round robin
(WRR) and queues (2,3) scheduled as strict priority. Queue 3 being the highest priority.
The WRR weights, egress shaping rate, and ingress policing rate can be configured for each SHub interface. See
the section on the QoS Ingress Policing Configuration Command for more information.
The SHub can also send and receive pause frames but it is configured such that it will never generate pause frames
as a result of congestion on an egress interface. However, the SHub can correctly honor backpressure from peer
nodes that cannot handle the traffic.
Note that all SHub port settings will be the same within a link aggregate group.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub queue-config (port) [ no queue0-weight | queue0-weight
<Qos::ShubQueueWeight1> ][ no queue1-weight | queue1-weight <Qos::ShubQueueWeight1> ][
no rx-pause | rx-pause ][ no egress-rate | egress-rate <Qos::ShubPortRate> ]

Command Parameters
Table 23.19-1 "SHub QoS Queue Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

the unique id for the port

Table 23.19-2 "SHub QoS Queue Configuration Command" Command Parameters


Parameter
[ no ] queue0-weight
[ no ] queue1-weight
[ no ] rx-pause
[ no ] egress-rate

Type

Description

<Qos::ShubQueueWeight1>
range: [1...15]
<Qos::ShubQueueWeight1>
range: [1...15]
<Qos::ShubPauserxStatus>

optional parameter with default value: 1


queue zero weight
optional parameter with default value: 2
queue one weight
optional
parameter
with
default
value:
"no-rx-pause"
enable qos pause for receive
optional parameter with default value: 16383
port egress rate

<Qos::ShubPortRate>
range: [1...16383] unit: 64kbps

3HH-01016-AAAA-TCZZA Edition 03

Released

253

23 QoS Configuration Commands

23.20 SHub QoS Traffic Class Configuration


Command
Command Description
This command allows the operator to configure SHub QoS traffic classes. The SHub has four defined traffic
classes. The mapping of frames with 802.1P codepoint to egress buffers determines how each traffic class will be
put into egress buffers and in a later step, how each traffic class will be scheduled on the SHub egress interfaces.
This traffic class mapping table is not applicable on the units.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub tc-map-dot1p (tc-priority) traffic-class <Qos::ShubTrafficClass>

Command Parameters
Table 23.20-1 "SHub QoS Traffic Class Configuration Command" Resource Parameters
Resource Identifier
(tc-priority)

Type

Description

<Qos::ShubTcPriority>
range: [0...7]

priority value in the received frames

Table 23.20-2 "SHub QoS Traffic Class Configuration Command" Command Parameters
Parameter
traffic-class

254

Type

Description

<Qos::ShubTrafficClass>
range: [0...3]

optional parameter
the value of traffic class, the received frame is
mapped to

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.21 SHub QoS Ingress Policing on Port


Command Description
This command allows the operator to configure the various policing parameter information. The objects can be
associated with any flow on a specific port.
The values 1 and 2 cannot be used as a meter index to configure a meter. If these values are used, the system
returns a "bad-value" error.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub [[no] meter (index) [name <Qos::DisplayString> ]max-ingress-rate
<Qos::MeterIngressRate> burst-size <Qos::MeterBurstSize> ]

Command Parameters
Table 23.21-1 "SHub QoS Ingress Policing on Port" Resource Parameters
Resource Identifier
(index)

Type

Description

<Qos::MeterIndex>
range: [1...64]

index used to identify a meter

Table 23.21-2 "SHub QoS Ingress Policing on Port" Command Parameters


Parameter
name
max-ingress-rate
burst-size

Type

Description

<Qos::DisplayString>
length: x<255
<Qos::MeterIngressRate>
range: [1...16383]
<Qos::MeterBurstSize>
range: [0...7]

optional parameter
name of the meter
mandatory parameter
the max ingress rate applied on a port
mandatory parameter
max ingress burst size allowed

3HH-01016-AAAA-TCZZA Edition 03

Released

255

23 QoS Configuration Commands

23.22 SHub QoS Flows to be Policed


Command Description
This command allows the operator to configure various flows to be policed.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub [[no] flow (index) [name <Qos::DisplayString> ][(type) ]]

Command Parameters
Table 23.22-1 "SHub QoS Flows to be Policed" Resource Parameters
Resource Identifier
(index)

Type

Description

<Qos::FlowIndex>
range: [1...64]

index used to identify a flow

Table 23.22-2 "SHub QoS Flows to be Policed" Command Parameters


Parameter
name
(type)

256

Type

Description

<Qos::DisplayString>
optional parameter
length: x<255
name of the flow
port | vlan : <Qos::VlanId> | vlan-dot1p : optional parameter
<Qos::VlanId> : <Qos::FlowPriority> | type of qos flow
vlan-dscp
:
<Qos::VlanId>
:
<Qos::FlowDscp>

Released

3HH-01016-AAAA-TCZZA

Edition 03

23 QoS Configuration Commands

23.23 SHub QoS Policer Configuration Command


Command Description
This command allows the operator to configure the policing association. Multiple ports can have the same policer
and the same policer can be applied to multiple ports.

User Level
The command can be accessed by operators with qos privileges, and executed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> configure qos shub [[no] policer (port-id) flow <Qos::PolicerFlowIndex> meter
<Qos::PolicerMeterIndex> ]

Command Parameters
Table 23.23-1 "SHub QoS Policer Configuration Command" Resource Parameters
Resource Identifier
(port-id)
flow

Type

Description

<Qos::PortIndex>
range: [1...24]
<Qos::PolicerFlowIndex>
range: [0...64]

shub qos port index


index of an existing flow

Table 23.23-2 "SHub QoS Policer Configuration Command" Command Parameters


Parameter
meter

Type

Description

<Qos::PolicerMeterIndex>
range: [0...64]

mandatory parameter
index of an existing meter

3HH-01016-AAAA-TCZZA Edition 03

Released

257

24- PPPoX-Relay Configuration Commands

24.1 PPPoX CC Global Configuration Command


24.2 PPPoX CC Engine Configuration Command
24.3 PPPoX CC Engine Monitoring Configuration
Command
24.4 PPPoX CC Client Port Configuration Command
24.5 PPPoX CC Client Port Monitoring Configuration
Command

258

Released

24-259
24-260
24-261
24-262
24-263

3HH-01016-AAAA-TCZZA

Edition 03

24 PPPoX-Relay Configuration Commands

24.1 PPPoX CC Global Configuration Command


Command Description
This command allows the operator to specify the system wide configuration parameters applicable to all PPP
sessions.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect global-session [ no pado-timeout | pado-timeout
<PPPoX::PadTimeOut> ][ no pads-timeout | pads-timeout <PPPoX::PadTimeOut> ][ no
max-pad-attempts | max-pad-attempts <PPPoX::PadRRetrials> ][ no trans-max-age |
trans-max-age <PPPoX::TransactionMaxAge> ][ no cc-max-age | cc-max-age
<PPPoX::CcMaxAge> ]

Command Parameters
Table 24.1-2 "PPPoX CC Global Configuration Command" Command Parameters
Parameter

Type

[ no ] pado-timeout

<PPPoX::PadTimeOut>
range: [1...60] unit: sec
[ no ] pads-timeout
<PPPoX::PadTimeOut>
range: [1...60] unit: sec
[ no ] <PPPoX::PadRRetrials>
max-pad-attempts
range: [1...16]
[ no ] trans-max-age <PPPoX::TransactionMaxAge>
range: [1...300] unit: sec
[ no ] cc-max-age
<PPPoX::CcMaxAge>
range: [300...3000]

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: 3
timeout for PAD-O message
optional parameter with default value: 3
timeout for PAD-S message
optional parameter with default value: 10
maximum number of PAD-R messages
optional parameter with default value: 300
maximum age of PPP transaction
optional parameter with default value: 300
maximum age of PPP cross connection

Released

259

24 PPPoX-Relay Configuration Commands

24.2 PPPoX CC Engine Configuration Command


Command Description
This command allows the operator to configure the PPP cross-connect engine. The PPP cross-connect engine is
identified by a vlan-id. The name is the engine name used to identify the PPP cross-connect engine. The lock
command locks or unlocks the PPP control plane, for example, if the control plane is unlocked no new PPP cross
connections can be established but the existing connections remain until they are released by the PPP server or
client.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect [[no] engine (vlan-id) [ no name | name
<PPPoX::EngineName> ][ no lock | lock ][ no service-name | service-name
<PPPoX::EngineName> ]]

Command Parameters
Table 24.2-1 "PPPoX CC Engine Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

vlan identity

Table 24.2-2 "PPPoX CC Engine Configuration Command" Command Parameters


Parameter
[ no ] name
[ no ] lock
[ no ] service-name

260

Type

Description

<PPPoX::EngineName>
length: 1<=x<32
<PPPoX::CtlPlaneState>

optional parameter with default value: ""


name to identify the engine
optional parameter with default value: "unlock"
lock the control plane engine
optional parameter with default value: ""
service name issued by engine in PAD-I message

<PPPoX::EngineName>
length: 1<=x<32

Released

3HH-01016-AAAA-TCZZA

Edition 03

24 PPPoX-Relay Configuration Commands

24.3 PPPoX CC Engine Monitoring Configuration


Command
Command Description
This commands allows the operator to configure the exception event counters for the PPP cross-connect engine.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect engine (vlan-id) [[no] monitor ]

Command Parameters
Table 24.3-1 "PPPoX CC Engine Monitoring Configuration Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

vlan identity

3HH-01016-AAAA-TCZZA Edition 03

Released

261

24 PPPoX-Relay Configuration Commands

24.4 PPPoX CC Client Port Configuration


Command
Command Description
This command allows the operator to specify the PPP cross-connect client port.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect [[no] client-port (port) vlan-id
<Vlan::UVlanIndex> | <Vlan::SVlanIndex> : <Vlan::CVlanIndex> default-priority
<PPPoX::DefaultPriority> [ no max-cc | max-cc <PPPoX::MaxNumPppCc> ][ no qos-profile |
qos-profile none | name : <PPPoX::IgnoredQosProfileName> ]]

Command Parameters
Table 24.4-1 "PPPoX CC Client Port Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ client port identification
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 24.4-2 "PPPoX CC Client Port Configuration Command" Command Parameters


Parameter
vlan-id
default-priority
[ no ] max-cc
[ no ] qos-profile

262

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<PPPoX::DefaultPriority>
range: [0...7]
<PPPoX::MaxNumPppCc>
range: [0...3072]
none
|
name
<PPPoX::IgnoredQosProfileName>

Released

Description
| mandatory parameter
: The parameter is not visible during modification.
associates client port to cc-engine
mandatory parameter
indicates the p-bit for the client port
optional parameter with default value: 64
max no. of PPP cross connection on a port
: optional parameter with default value: "none"
qos profile name associated with client port

3HH-01016-AAAA-TCZZA

Edition 03

24 PPPoX-Relay Configuration Commands

24.5 PPPoX CC Client Port Monitoring


Configuration Command
Command Description
This command allows the operator to configure the exception event counters for the PPP cross-connect client port.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppox-relay cross-connect client-port (port) [[no] monitor ]

Command Parameters
Table 24.5-1 "PPPoX CC Client Port Monitoring Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ client port identification
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

3HH-01016-AAAA-TCZZA Edition 03

Released

263

25- PPPoE Configuration Commands

25.1 PPPoE Server Configuration Command


25.2 PPPoE Profile Configuration Command
25.3 PPPoX Interface Configuration Command

264

Released

25-265
25-266
25-267

3HH-01016-AAAA-TCZZA

Edition 03

25 PPPoE Configuration Commands

25.1 PPPoE Server Configuration Command


Command Description
This command allows the operator to configure the PPPoE access concentrator and admin state.
The access concentrator (server name) is used to send the AC_NAME tag in the PADO that is sent to host. The
default AC name is set to AlcatelPppoeServer.
The server admin state, when disabled, locks the PPPoE server and no more new PPPoE sessions are established.
When this value is set to disabled from the enabled state, it will not tear down the existing PPPoE sessions.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppoe server-name <PPPoE::ServerName> [ no enable-server | enable-server ]

Command Parameters
Table 25.1-2 "PPPoE Server Configuration Command" Command Parameters
Parameter
server-name
[ no ] enable-server

Type

Description

<PPPoE::ServerName>
length: 1<=x<32
<PPPoE::pppoeServerAdminState>

optional parameter
name of the access server
optional
parameter
with
"disable-server"
admin state of the server

3HH-01016-AAAA-TCZZA Edition 03

Released

default

265

value:

25 PPPoE Configuration Commands

25.2 PPPoE Profile Configuration Command


Command Description
This command allows the operator to configure PPP profile parameters.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppoe [[no] ppp-profile (index) [ no auth-type | auth-type
<PPPoE::pppProfileAuthenType> ][ no keep-alive-intvl | keep-alive-intvl
<PPPoE::ProfileKeepAliveInterval> ]]

Command Parameters
Table 25.2-1 "PPPoE Profile Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

name of the profile

Table 25.2-2 "PPPoE Profile Configuration Command" Command Parameters


Parameter

Type

[ no ] auth-type

<PPPoE::pppProfileAuthenType>
Possible values are :
- pap : only PAP negotiation
- chap : only CHAP negotiation
- pap-chap : negotiate PAP first, if it fails,
attempt CHAP
- chap-pap : negotiate CHAP first, if it
fails, attempt PAP
[ no ] keep-alive-intvl <PPPoE::ProfileKeepAliveInterval>
range: [0...65535] unit: sec

266

Released

Description
optional parameter with default value: "chap"
the type of PPP authentication used

optional parameter with default value: 30


keepalive timeout value, after sending echo request
packet

3HH-01016-AAAA-TCZZA

Edition 03

25 PPPoE Configuration Commands

25.3 PPPoX Interface Configuration Command


Command Description
This command allows the operator to configure the PPP sessions.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> configure pppoe [[no] pppox-interface (port) [ no max-num-session | max-num-session
<PPPoE::MaxNumSessions> ][ no ppp-profile-name | ppp-profile-name <AsamProfileName> ]]

Command Parameters
Table 25.3-1 "PPPoX Interface Configuration Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ configure the pppox interafce
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 25.3-2 "PPPoX Interface Configuration Command" Command Parameters


Parameter

Type

[ no
max-num-session

] <PPPoE::MaxNumSessions>
range: [-1...2147483647]

[ no
ppp-profile-name

] <AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter with default value: 4
max no of PPP sessions established in PPPoX
interface
optional
parameter
with
default
value:
"DefaultPppProfile"
the PPP profile to be used for PPP interface

Released

267

26- DHCP Relay Configuration Commands

26.1 DHCP Relay Agent Configuration Command


26.2 DHCP Relay SHub Configuration Command
26.3 DHCP Relay SHub Server Configuration Command
per VRF
26.4 DHCP Relay SHub Agent Configuration Command per
VRF

268

Released

26-269
26-271
26-272
26-273

3HH-01016-AAAA-TCZZA

Edition 03

26 DHCP Relay Configuration Commands

26.1 DHCP Relay Agent Configuration Command


vrfid
The vrfid is a unique value for each VRF assigned by the management.

bcast-vlan
The bcase-vlan is an index that represents a VLAN that is used for forwarding upstream broadcast DHCP packets
when the DHCP relay agent is disabled.

option-82
The operator can enable or disable option 82 information insertion in the upstream broadcast DHCP packets.

Command Description
This command allows the operator to configure the DHCP relay agent for each VRF interface.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay agent (vrfid) bcast-vlan none | l2-vlan : <Vlan::VlanIndex> [
no option-82 | option-82 ][ no circuit-id | circuit-id <Dhcp::CircuitId> ][ no
remote-id | remote-id <Dhcp::RemoteId> ]

Command Parameters
Table 26.1-1 "DHCP Relay Agent Configuration Command" Resource Parameters
Resource Identifier
(vrfid)

Type

Description

<Vrf::VrfIndex>
range: [1...127]

vrf index

Table 26.1-2 "DHCP Relay Agent Configuration Command" Command Parameters


Parameter

Type

Description

bcast-vlan

none | l2-vlan : <Vlan::VlanIndex>

[ no ] option-82

<Dhcp::Option82>

[ no ] circuit-id

<Dhcp::CircuitId>
Possible values are :
- customer-id : add customerId as circuitId

optional parameter
vlan used to forward upstream bcast DHCP packets
optional parameter with default value: "disable"
enable option82 info insertions in upstream bcast
pkts
optional parameter with default value: "notadd"
circuit id

3HH-01016-AAAA-TCZZA Edition 03

Released

269

26 DHCP Relay Configuration Commands

Parameter

[ no ] remote-id

270

Type

Description

- physical-id : add addPhysicalLineId as


circuitId
- notadd : not add circuitId
<Dhcp::RemoteId>
optional parameter with default value: "notadd"
Possible values are :
remote id
- customer-id : add customerId as
remoteId
- notadd : not add remoteId

Released

3HH-01016-AAAA-TCZZA

Edition 03

26 DHCP Relay Configuration Commands

26.2 DHCP Relay SHub Configuration Command


Command Description
This command allows the operator to configure the DHCP SHub parameters.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub [ no relaying | relaying ]

Command Parameters
Table 26.2-2 "DHCP Relay SHub Configuration Command" Command Parameters
Parameter
[ no ] relaying

Type

Description

<Dhcp::Relaying>

optional
parameter
with
"no-relaying"
relay agent active or not

3HH-01016-AAAA-TCZZA Edition 03

Released

default

271

value:

26 DHCP Relay Configuration Commands

26.3 DHCP Relay SHub Server Configuration


Command per VRF
Command Description
This command allows the operator to configure the list of DHCP relay servers to a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub [[no] server (index) ip-addr <Ip::V4Address> server-name
<PrintableString-0-32> ]

Command Parameters
Table 26.3-1 "DHCP Relay SHub Server Configuration Command per VRF " Resource Parameters
Resource Identifier
(index)
ip-addr

Type

Description

<Vrf::ShubVrfID>
range: [0...127]
<Ip::V4Address>

the vrf id
IP address given to this interface

Table 26.3-2 "DHCP Relay SHub Server Configuration Command per VRF " Command
Parameters
Parameter
server-name

272

Type

Description

<PrintableString-0-32>
length: x<32

mandatory parameter
The name of the Relay Server

Released

3HH-01016-AAAA-TCZZA

Edition 03

26 DHCP Relay Configuration Commands

26.4 DHCP Relay SHub Agent Configuration


Command per VRF
Command Description
This command allows the operator to configure the DHCP relay agent to a particular VRF.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> configure dhcp-relay shub agent (index) [ no enable-relaying | enable-relaying ][ no
secs-threshold | secs-threshold <Dhcp::SecsThreshold> ][ no hops-threshold |
hops-threshold <Dhcp::HopThreshold> ][ no context-lifetime | context-lifetime
<Dhcp::ContextLife> ][ no agent-ip-addr | agent-ip-addr <Ip::V4Address> ]

Command Parameters
Table 26.4-1 "DHCP Relay SHub Agent Configuration Command per VRF" Resource Parameters
Resource Identifier
(index)

Type

Description

<Vrf::ShubVrfID>
range: [0...127]

the vrf id

Table 26.4-2 "DHCP Relay SHub Agent Configuration Command per VRF" Command Parameters
Parameter
[ no ] enable-relaying

Type

Description

<Dhcp::RelayingPerVrf>

optional
parameter
with
default
value:
"disable-relaying"
relay agent status for this vrf
optional parameter with default value: 0
the time within a request must be answered
optional parameter with default value: 4
max nbr of hops the request may go through
optional parameter with default value: 30
availability of application context
optional parameter with default value: "0.0.0.0"
agent IP address

[ no ] secs-threshold

<Dhcp::SecsThreshold>
range: [0...5] unit: second
[ no ] hops-threshold <Dhcp::HopThreshold>
range: [1...16]
[ no ] <Dhcp::ContextLife>
context-lifetime
range: [1...120] unit: seconds
[ no ] agent-ip-addr
<Ip::V4Address>

3HH-01016-AAAA-TCZZA Edition 03

Released

273

27- OSPF Configuration Commands

27.1 OSPF Parameters Configuration Command


27.2 OSPF Area Configuration Command
27.3 OSPF Interface Configuration Command
27.4 OSPF Interface Timers Configuration Command
27.5 OSPF Interface MD5 Key Configuration Command
27.6 OSPF Interface Metric Configuration Command
27.7 OSPF Aggregate Configuration Command
27.8 OSPF Stub Area Configuration Command
27.9 OSPF Interface Configuration Command
27.10 OSPF Interface Timers Configuration Command
27.11 OSPF Interface MD5 Key Configuration Command
27.12 OSPF Interface Metric Configuration Command
27.13 OSPF Nssa Area Configuration Command
27.14 OSPF Interface Configuration Command
27.15 OSPF Interface Timers Configuration Command
27.16 OSPF Interface MD5 Key Configuration Command
27.17 OSPF Interface Metric Configuration Command
27.18 OSPF NSSA Aggregate Configuration Command
27.19 OSPF Redistribution Configuration Command
27.20 OSPF Redistribution Route Configuration Command

274

Released

27-275
27-276
27-277
27-278
27-279
27-281
27-282
27-283
27-284
27-285
27-286
27-288
27-289
27-290
27-291
27-292
27-294
27-295
27-296
27-297

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.1 OSPF Parameters Configuration Command


Command Description
This command allows the operator to configure the OSPF parameters and attributes.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf [ no enable | enable ]router-id <Ip::V4Address> [ no as-border-router
| as-border-router ][ no enable-opaque-lsa | enable-opaque-lsa ][ no overflow-state-it
| overflow-state-it <Ospf::OvrflowIntrvl> ][ no dis-rfc1583-comp | dis-rfc1583-comp ][
no abr-type | abr-type <Ospf::AbrType> ][ no passive-interface | passive-interface ]

Command Parameters
Table 27.1-2 "OSPF Parameters Configuration Command" Command Parameters
Parameter

Type

Description

[ no ] enable

<Ospf::EnableStatus>

router-id

<Ip::V4Address>

optional parameter with default value: "disable"


enable OSPF on the SHub
optional parameter
uniquely identifying the Shub in the autonomous
system
optional parameter with default value: "false"
shub configured as a autonomous system border
router
optional parameter with default value: "disable"
configure route to opaque capable
optional parameter with default value: 0
time the router attempts to leave the overflow state
optional parameter with default value: "enable"
LSA advertisements compatible with RFC 1583
optional parameter with default value: "standard"
type of area border router

[ no ] as-border-router <Ospf::ASBdrRtrStatus>
[ no
enable-opaque-lsa
[ no
overflow-state-it
[ no
dis-rfc1583-comp
[ no ] abr-type

[ no
passive-interface

] <Ospf::LSAOpaqueStatus>
] <Ospf::OvrflowIntrvl>
range: [0...65535] unit: sec
] <Ospf::rfc1583Compatblty>
<Ospf::AbrType>
Possible values are :
- standard : standard abr
- cisco : cisco abr
- ibm : ibm abr
] <Ospf::PassiveIntf>

3HH-01016-AAAA-TCZZA Edition 03

optional
parameter
with
"non-passive"
sets OSPF interface to passive

Released

default

275

value:

27 OSPF Configuration Commands

27.2 OSPF Area Configuration Command


Command Description
This command shows information describing the configured parameters and cumulative statistics of the router's
attached areas.
The area identifier is a 32-bit represented in decimal dotted notation.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf [[no] area (area-id) ]

Command Parameters
Table 27.2-1 "OSPF Area Configuration Command" Resource Parameters
Resource Identifier
(area-id)

276

Type

Description

<Ip::V4Address>

ospf area identifier

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.3 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) [[no] interface (ip-addr) [ no disable | disable ][ no
router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain : prompt | plain : plain : <Ospf::Key> ]]

Command Parameters
Table 27.3-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.3-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] disable

<Ospf::InterfaceStatus>

[ no ] router-priority

<Ospf::Priority>
range: [0...255]
<Ospf::PassiveIntface>

optional parameter with default value: "enable"


OSPF interface status
optional parameter with default value: 1
priority used in router election algorithm
optional
parameter
with
default
value:
"non-passive"
sets the interface as passive
optional parameter with default value: "broadcast"
ospf interface type

[ no ] passive
[ no ] itf-type

[ no ] authentication

<Ospf::ITFType>
Possible values are :
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
none | md5 | plain : prompt | plain : plain : optional parameter with default value: "none"
<Ospf::Key>
indicates the OSPF interface authentication

3HH-01016-AAAA-TCZZA Edition 03

Released

277

27 OSPF Configuration Commands

27.4 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) timers [ no transit-delay |
transit-delay <Ospf::TransDelay> ][ no retransmit-itvl | retransmit-itvl
<Ospf::RetransIntvl> ][ no hello-interval | hello-interval <Ospf::HelloIntvl> ][ no
dead-interval | dead-interval <Ospf::DeadIntvl> ][ no poll-interval | poll-interval
<Ospf::PollIntvl> ]

Command Parameters
Table 27.4-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.4-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter
[ no ] transit-delay
[ no ] retransmit-itvl
[ no ] hello-interval
[ no ] dead-interval
[ no ] poll-interval

278

Type

Description

<Ospf::TransDelay>
range: [0...3600] unit: sec
<Ospf::RetransIntvl>
range: [0...3600] unit: sec
<Ospf::HelloIntvl>
range: [1...65535] unit: sec
<Ospf::DeadIntvl>
range: [0...65535] unit: sec
<Ospf::PollIntvl>
range: [0...65535] unit: sec

optional parameter with default value: 1


time to transmit link update packets
optional parameter with default value: 5
interval between LSA retransmission
optional parameter with default value: 10
interval between sending hello packets
optional parameter with default value: 40
interval when no hello pkts are received
optional parameter with default value: 120
time between hello pkts sent to neighbour

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.5 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) [[no] md5-key (index) key prompt |
plain : <Ospf::Key> [ no accept-starts | accept-starts <Ospf::MD5startDelay> ][ no
generate-starts | generate-starts <Ospf::MD5startDelay> ]]

Command Parameters
Table 27.5-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)
(index)

Type

Description

<Ip::V4Address>
<Ip::V4Address>
<Ospf::Md5KeyIndex>
range: [1...5]

ospf area identifier


ip address identifying the interface
the number of the md5 key

Table 27.5-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

prompt | plain : <Ospf::Key>

[ no ] accept-starts

mandatory parameter
the md5 key
optional parameter with default value: "now"
when the key must be used to accept

<Ospf::MD5startDelay>
Possible values are :
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used
<Ospf::MD5startDelay>
optional parameter with default value: "now"
Possible values are :
when the key must be used to generate
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used

[ no ] generate-starts

Command Output
Table 27.5-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information

3HH-01016-AAAA-TCZZA Edition 03

Released

279

27 OSPF Configuration Commands

name
accept-expires

generate-expires

280

Type

Description

<Ospf::MD5expiryDelay>
delay before the key expires for accepting
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
<Ospf::MD5expiryDelay>
delay before the key expires for generating
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.6 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) interface (ip-addr) metric value <Ospf::Metric>

Command Parameters
Table 27.6-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.6-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter
value

Type

Description

<Ospf::Metric>
range: [1...65535]

optional parameter
the value for the metric

3HH-01016-AAAA-TCZZA Edition 03

Released

281

27 OSPF Configuration Commands

27.7 OSPF Aggregate Configuration Command


Command Description
This command allows the operator to configure an OSPF aggregate.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf area (area-id) [[no] aggregate-addr (dest-ip) [ no omit-advertise |
omit-advertise ]]

Command Parameters
Table 27.7-1 "OSPF Aggregate Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(dest-ip)

Type

Description

<Ip::V4Address>
ospf area identifier
<Ip::V4Address> / <Ip::PrefixLengthFull> ip address and mask of the destination route

Table 27.7-2 "OSPF Aggregate Configuration Command" Command Parameters


Parameter
[ no ] omit-advertise

282

Type

Description

<Ospf::Advertise>

optional parameter with default value: "advertise"


advertisement of the indicated aggregate

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.8 OSPF Stub Area Configuration Command


Command Description
This command allows the operator to configure the OSPF stub area.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf [[no] stub-area (area-id) [ no metric-type | metric-type
<Ospf::MetricType> ][ no metric | metric <Ospf::StubMetric> ][ no summary | summary ]]

Command Parameters
Table 27.8-1 "OSPF Stub Area Configuration Command" Resource Parameters
Resource Identifier
(area-id)

Type

Description

<Ip::V4Address>

ospf area identifier

Table 27.8-2 "OSPF Stub Area Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] metric-type

<Ospf::MetricType>

[ no ] metric

<Ospf::StubMetric>
range: [0...16777215]
<Ospf::Summary>

optional parameter with default value: "ospf"


type of metric advertised as a default route
optional parameter with default value: 0
metric value at the indicated TOS
optional
parameter
with
default
value:
"no-summary"
controls the import of summary LSAs into stub
areas

[ no ] summary

3HH-01016-AAAA-TCZZA Edition 03

Released

283

27 OSPF Configuration Commands

27.9 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) [[no] interface (ip-addr) [ no disable | disable
][ no router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain : prompt | plain : plain : <Ospf::Key> ]]

Command Parameters
Table 27.9-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.9-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] disable

<Ospf::InterfaceStatus>

[ no ] router-priority

<Ospf::Priority>
range: [0...255]
<Ospf::PassiveIntface>

optional parameter with default value: "enable"


OSPF interface status
optional parameter with default value: 1
priority used in router election algorithm
optional
parameter
with
default
value:
"non-passive"
sets the interface as passive
optional parameter with default value: "broadcast"
ospf interface type

[ no ] passive
[ no ] itf-type

[ no ] authentication

284

<Ospf::ITFType>
Possible values are :
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
none | md5 | plain : prompt | plain : plain : optional parameter with default value: "none"
<Ospf::Key>
indicates the OSPF interface authentication

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.10 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) timers [ no transit-delay |
transit-delay <Ospf::TransDelay> ][ no retransmit-itvl | retransmit-itvl
<Ospf::RetransIntvl> ][ no hello-interval | hello-interval <Ospf::HelloIntvl> ][ no
dead-interval | dead-interval <Ospf::DeadIntvl> ][ no poll-interval | poll-interval
<Ospf::PollIntvl> ]

Command Parameters
Table 27.10-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.10-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter
[ no ] transit-delay
[ no ] retransmit-itvl
[ no ] hello-interval
[ no ] dead-interval
[ no ] poll-interval

Type

Description

<Ospf::TransDelay>
range: [0...3600] unit: sec
<Ospf::RetransIntvl>
range: [0...3600] unit: sec
<Ospf::HelloIntvl>
range: [1...65535] unit: sec
<Ospf::DeadIntvl>
range: [0...65535] unit: sec
<Ospf::PollIntvl>
range: [0...65535] unit: sec

optional parameter with default value: 1


time to transmit link update packets
optional parameter with default value: 5
interval between LSA retransmission
optional parameter with default value: 10
interval between sending hello packets
optional parameter with default value: 40
interval when no hello pkts are received
optional parameter with default value: 120
time between hello pkts sent to neighbour

3HH-01016-AAAA-TCZZA Edition 03

Released

285

27 OSPF Configuration Commands

27.11 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) [[no] md5-key (index) key
prompt | plain : <Ospf::Key> [ no accept-starts | accept-starts <Ospf::MD5startDelay>
][ no generate-starts | generate-starts <Ospf::MD5startDelay> ]]

Command Parameters
Table 27.11-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)
(index)

Type

Description

<Ip::V4Address>
<Ip::V4Address>
<Ospf::Md5KeyIndex>
range: [1...5]

ospf area identifier


ip address identifying the interface
the number of the md5 key

Table 27.11-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

prompt | plain : <Ospf::Key>

[ no ] accept-starts

mandatory parameter
the md5 key
optional parameter with default value: "now"
when the key must be used to accept

<Ospf::MD5startDelay>
Possible values are :
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used
<Ospf::MD5startDelay>
optional parameter with default value: "now"
Possible values are :
when the key must be used to generate
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used

[ no ] generate-starts

Command Output
Table 27.11-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information

286

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

name
accept-expires

generate-expires

Type

Description

<Ospf::MD5expiryDelay>
delay before the key expires for accepting
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
<Ospf::MD5expiryDelay>
delay before the key expires for generating
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire

3HH-01016-AAAA-TCZZA Edition 03

Released

287

27 OSPF Configuration Commands

27.12 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf stub-area (area-id) interface (ip-addr) metric value <Ospf::Metric>

Command Parameters
Table 27.12-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.12-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter
value

288

Type

Description

<Ospf::Metric>
range: [1...65535]

optional parameter
the value for the metric

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.13 OSPF Nssa Area Configuration Command


Command Description
This command allows the operator to configure the OSPF NSSA area.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf [[no] nssa-area (area-id) [ no summary | summary ][ no translation |
translation <Ospf::Trnsltn> ][ no trans-itvl | trans-itvl <Ospf::TrnltnIntvl> ][ no
asbr-rtr-trans | asbr-rtr-trans ][ no metric-type | metric-type <Ospf::NSSAMetricType>
]]

Command Parameters
Table 27.13-1 "OSPF Nssa Area Configuration Command" Resource Parameters
Resource Identifier
(area-id)

Type

Description

<Ip::V4Address>

ospf area identifier

Table 27.13-2 "OSPF Nssa Area Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] summary

<Ospf::Summary>

[ no ] translation

<Ospf::Trnsltn>
Possible values are :
- always : always
- candidate : candidate
<Ospf::TrnltnIntvl>
range: [0...65535] unit: sec
<Ospf::Asbr>

optional
parameter
with
default
value:
"no-summary"
controls the import of summary LSAs into stub
areas
optional parameter with default value: "candidate"
NSSA routers ability to translate Type-7 to Type-5
LSAs

[ no ] trans-itvl
[ no ] asbr-rtr-trans
[ no ] metric-type

<Ospf::NSSAMetricType>
Possible values are :
- ospf : ospf metric
- comparable-metric : comparable cost
- non-comparable : non comparable

3HH-01016-AAAA-TCZZA Edition 03

optional parameter with default value: 40


time trsltr finds its service is not reqd
optional parameter with default value: "disable"
p-bit setting for the type-7 LSA generated by
ASBR
optional parameter with default value: "ospf"
type of metric advertised as a default route

Released

289

27 OSPF Configuration Commands

27.14 OSPF Interface Configuration Command


Command Description
This command allows the operator to configure an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) [[no] interface (ip-addr) [ no disable | disable
][ no router-priority | router-priority <Ospf::Priority> ][ no passive | passive ][ no
itf-type | itf-type <Ospf::ITFType> ][ no authentication | authentication none | md5 |
plain : prompt | plain : plain : <Ospf::Key> ]]

Command Parameters
Table 27.14-1 "OSPF Interface Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.14-2 "OSPF Interface Configuration Command" Command Parameters


Parameter

Type

Description

[ no ] disable

<Ospf::InterfaceStatus>

[ no ] router-priority

<Ospf::Priority>
range: [0...255]
<Ospf::PassiveIntface>

optional parameter with default value: "enable"


OSPF interface status
optional parameter with default value: 1
priority used in router election algorithm
optional
parameter
with
default
value:
"non-passive"
sets the interface as passive
optional parameter with default value: "broadcast"
ospf interface type

[ no ] passive
[ no ] itf-type

[ no ] authentication

290

<Ospf::ITFType>
Possible values are :
- broadcast : broadcast lans like ethernet
- nbma : non broadcast multiple access
- point-point : point to point
- point-multipoint : point to multi point
none | md5 | plain : prompt | plain : plain : optional parameter with default value: "none"
<Ospf::Key>
indicates the OSPF interface authentication

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.15 OSPF Interface Timers Configuration


Command
Command Description
This command allows the operator to configure the OSPF interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) timers [ no transit-delay |
transit-delay <Ospf::TransDelay> ][ no retransmit-itvl | retransmit-itvl
<Ospf::RetransIntvl> ][ no hello-interval | hello-interval <Ospf::HelloIntvl> ][ no
dead-interval | dead-interval <Ospf::DeadIntvl> ][ no poll-interval | poll-interval
<Ospf::PollIntvl> ]

Command Parameters
Table 27.15-1 "OSPF Interface Timers Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.15-2 "OSPF Interface Timers Configuration Command" Command Parameters


Parameter
[ no ] transit-delay
[ no ] retransmit-itvl
[ no ] hello-interval
[ no ] dead-interval
[ no ] poll-interval

Type

Description

<Ospf::TransDelay>
range: [0...3600] unit: sec
<Ospf::RetransIntvl>
range: [0...3600] unit: sec
<Ospf::HelloIntvl>
range: [1...65535] unit: sec
<Ospf::DeadIntvl>
range: [0...65535] unit: sec
<Ospf::PollIntvl>
range: [0...65535] unit: sec

optional parameter with default value: 1


time to transmit link update packets
optional parameter with default value: 5
interval between LSA retransmission
optional parameter with default value: 10
interval between sending hello packets
optional parameter with default value: 40
interval when no hello pkts are received
optional parameter with default value: 120
time between hello pkts sent to neighbour

3HH-01016-AAAA-TCZZA Edition 03

Released

291

27 OSPF Configuration Commands

27.16 OSPF Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) [[no] md5-key (index) key
prompt | plain : <Ospf::Key> [ no accept-starts | accept-starts <Ospf::MD5startDelay>
][ no generate-starts | generate-starts <Ospf::MD5startDelay> ]]

Command Parameters
Table 27.16-1 "OSPF Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)
(index)

Type

Description

<Ip::V4Address>
<Ip::V4Address>
<Ospf::Md5KeyIndex>
range: [1...5]

ospf area identifier


ip address identifying the interface
the number of the md5 key

Table 27.16-2 "OSPF Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

prompt | plain : <Ospf::Key>

[ no ] accept-starts

mandatory parameter
the md5 key
optional parameter with default value: "now"
when the key must be used to accept

<Ospf::MD5startDelay>
Possible values are :
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used
<Ospf::MD5startDelay>
optional parameter with default value: "now"
Possible values are :
when the key must be used to generate
- now : the key will be used from now on
- <Sys::Time> : the delay before the key
will be used

[ no ] generate-starts

Command Output
Table 27.16-3 "OSPF Interface MD5 Key Configuration Command" Display parameters
Specific Information

292

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

name
accept-expires

generate-expires

Type

Description

<Ospf::MD5expiryDelay>
delay before the key expires for accepting
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
<Ospf::MD5expiryDelay>
delay before the key expires for generating
Possible values are :
This element is only shown in detail mode.
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire

3HH-01016-AAAA-TCZZA Edition 03

Released

293

27 OSPF Configuration Commands

27.17 OSPF Interface Metric Configuration


Command
Command Description
This command allows the operator to configure the metric on an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) interface (ip-addr) metric value <Ospf::Metric>

Command Parameters
Table 27.17-1 "OSPF Interface Metric Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(ip-addr)

Type

Description

<Ip::V4Address>
<Ip::V4Address>

ospf area identifier


ip address identifying the interface

Table 27.17-2 "OSPF Interface Metric Configuration Command" Command Parameters


Parameter
value

294

Type

Description

<Ospf::Metric>
range: [1...65535]

optional parameter
the value for the metric

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.18 OSPF NSSA Aggregate Configuration


Command
Command Description
This command allows the operator to configure an OSPF NSSA aggregate.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf nssa-area (area-id) [[no] aggregate-addr (dest-ip) lsa-type
<Ospf::LSAType> [ no omit-advertise | omit-advertise ]]

Command Parameters
Table 27.18-1 "OSPF NSSA Aggregate Configuration Command" Resource Parameters
Resource Identifier
(area-id)
(dest-ip)
lsa-type

Type

Description

<Ip::V4Address>
ospf area identifier
<Ip::V4Address> / <Ip::PrefixLengthFull> ip address and mask of the destination route
<Ospf::LSAType>
type of address aggregate
Possible values are :
- summary : type-3, summary link
- nssa-external : type-7, nssa external link

Table 27.18-2 "OSPF NSSA Aggregate Configuration Command" Command Parameters


Parameter
[ no ] omit-advertise

Type

Description

<Ospf::Advertise>

optional parameter with default value: "advertise"


advertisement of the indicated aggregate

3HH-01016-AAAA-TCZZA Edition 03

Released

295

27 OSPF Configuration Commands

27.19 OSPF Redistribution Configuration


Command
Command Description
This command allows the operator to configure the redistribution of the OSPF.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf redistribution [ no enable | enable ][ no local | local ][ no static
| static ][ no rip | rip ]

Command Parameters
Table 27.19-2 "OSPF Redistribution Configuration Command" Command Parameters
Parameter

296

Type

Description

[ no ] enable

<Ospf::RRDStatus>

[ no ] local

<Ospf::Local>

[ no ] static

<Ospf::Static>

[ no ] rip

<Ospf::Rip>

optional parameter with default value: "disable"


enable OSPF route redistribution
optional parameter with default value: "no-local"
import local routes to OSPF
optional parameter with default value: "no-static"
import static routes to OSPF
optional parameter with default value: "no-rip"
import rip routes to OSPF

Released

3HH-01016-AAAA-TCZZA

Edition 03

27 OSPF Configuration Commands

27.20 OSPF Redistribution Route Configuration


Command
Command Description
This command allows the operator to configure the redistribution of the OSPF route parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure ospf redistribution [[no] route-destination (dest-ip) [ no metric-type |
metric-type <Ospf::RouteMetricType> ][ no metric | metric <Ospf::RouteMetric> ]]

Command Parameters
Table 27.20-1 "OSPF Redistribution Route Configuration Command" Resource Parameters
Resource Identifier
(dest-ip)

Type

Description

<Ip::V4Address> / <Ip::PrefixLengthFull> ip address and mask of the destination route

Table 27.20-2 "OSPF Redistribution Route Configuration Command" Command Parameters


Parameter
[ no ] metric-type

[ no ] metric

Type

Description

<Ospf::RouteMetricType>
Possible values are :
- as-ext-type1 : asexttype1 metric type
- as-ext-type2 : asexttype2 metric type
<Ospf::RouteMetric>
range: [1...16777215]

optional
parameter
with
"as-ext-type2"
metric type applied to the router

3HH-01016-AAAA-TCZZA Edition 03

default

optional parameter with default value: 10


metric value applied to the router

Released

297

value:

28- RIP Configuration Commands

28.1 RIP Common Configuration Command


28.2 RIP Redistribution Configuration Command
28.3 RIP Interface Configuration Command
28.4 RIP Interface Timers Configuration Command
28.5 RIP Interface MD5 Key Configuration Command
28.6 RIP Route Aggregation Command
28.7 RIP Route Map Command

298

Released

28-299
28-300
28-301
28-302
28-303
28-304
28-305

3HH-01016-AAAA-TCZZA

Edition 03

28 RIP Configuration Commands

28.1 RIP Common Configuration Command


Command Description
This command helps in configuration of global parameters of RIP.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip [ no max-peer | max-peer <Rip::Rip2Peer> ]

Command Parameters
Table 28.1-2 "RIP Common Configuration Command" Command Parameters
Parameter
[ no ] max-peer

Type

Description

<Rip::Rip2Peer>
range: [1...65535]

optional parameter with default value: 25


max nbr of peers in conversation with the RIP2
simultaneously

3HH-01016-AAAA-TCZZA Edition 03

Released

299

28 RIP Configuration Commands

28.2 RIP Redistribution Configuration Command


Command Description
This command allows the operator to configure RIP redistribution.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip redistribution [ no enable | enable ][ no default-metric |
default-metric <Rip::RouteMetric> ][ no local | local ][ no static | static ][ no ospf
| ospf ]

Command Parameters
Table 28.2-2 "RIP Redistribution Configuration Command" Command Parameters
Parameter

300

Type

Description

[ no ] enable

<Rip::GblStat>

[ no ] default-metric
[ no ] local

<Rip::RouteMetric>
range: [1...6]
<Rip::Local>

[ no ] static

<Rip::Static>

[ no ] ospf

<Rip::Ospf>

optional parameter with default value: "disable"


indicates which routes need to be redistributed
optional parameter with default value: 3
default metric used for the imported routes
optional parameter with default value: "no-local"
import local routes to RIP
optional parameter with default value: "no-static"
import static routes to RIP
optional parameter with default value: "no-ospf"
import ospf routes to RIP

Released

3HH-01016-AAAA-TCZZA

Edition 03

28 RIP Configuration Commands

28.3 RIP Interface Configuration Command


Command Description
This command allows the user to configure RIP interface parameters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip [[no] interface (ip-addr) [ no authentication | authentication none |
md5 | plain : prompt | plain : plain : <Rip::Key> ]default-metric <Rip::DefMetric> [
no send | send <Rip::ConfSend> ][ no receive | receive <Rip::ConfRcv> ][ no
split-horizon | split-horizon <Rip::SpltHorizon> ]]

Command Parameters
Table 28.3-1 "RIP Interface Configuration Command" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

interface IP address

Table 28.3-2 "RIP Interface Configuration Command" Command Parameters


Parameter
[ no ] authentication
default-metric
[ no ] send

[ no ] receive

[ no ] split-horizon

Type

Description

none | md5 | plain : prompt | plain : plain :


<Rip::Key>
<Rip::DefMetric>
range: [0...15]

optional parameter with default value: "none"


authentication method
mandatory parameter
The parameter is not visible during modification.
metric used for default route in RIP updates
optional
parameter
with
default
value:
"rip1-compatible"
RIP version used for sending RIP packets

<Rip::ConfSend>
Possible values are :
- disable : don't send any packets
- rip1 : rip version 1
- rip1-compatible : rip version 1 comptible
- rip2 : rip version 2
<Rip::ConfRcv>
Possible values are :
- rip1 : accept rip1 packets
- rip2 : accept rip2 packets
- rip1-or-rip2 : accept rip1 or rip2 packets
- disable : don't receive packets
<Rip::SpltHorizon>
Possible values are :
- enable : enable split horizon
- poison-reverse : split horizon with
Poison Reverse
- disable : disable split horizon

3HH-01016-AAAA-TCZZA Edition 03

optional
parameter
with
default
value:
"rip1-or-rip2"
RIP version used for accepting RIP packets

optional parameter with default value: "enable"


split horizon status used in the system

Released

301

28 RIP Configuration Commands

28.4 RIP Interface Timers Configuration Command


Command Description
This command allows the user to configure RIP interface timers.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) timers [ no update-timer | update-timer
<Rip::UpdateTmr> ][ no route-age-out | route-age-out <Rip::RouteAgeTmr> ][ no
junk-collection | junk-collection <Rip::GrbTmr> ]

Command Parameters
Table 28.4-1 "RIP Interface Timers Configuration Command" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

interface IP address

Table 28.4-2 "RIP Interface Timers Configuration Command" Command Parameters


Parameter
[ no ] update-timer
[ no ] route-age-out
[ no ] junk-collection

302

Type

Description

<Rip::UpdateTmr>
range: [10...3600] unit: secs
<Rip::RouteAgeTmr>
range: [30...500] unit: secs

optional parameter with default value: 30


interval between RIP updates in secs
optional parameter with default value: 180
time for an unrefreshed route to be put in garbage
bin in secs
optional parameter with default value: 120
lifetime of route in garbage bin in secs

<Rip::GrbTmr>
range: [120...180] unit: secs

Released

3HH-01016-AAAA-TCZZA

Edition 03

28 RIP Configuration Commands

28.5 RIP Interface MD5 Key Configuration


Command
Command Description
This command allows the operator to configure a MD5 key for a RIP interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip interface (ip-addr) [[no] md5-key (index) key prompt | plain :
<Rip::Key> starts <Rip::MD5startDelay> expires <Rip::MD5expiryDelay> ]

Command Parameters
Table 28.5-1 "RIP Interface MD5 Key Configuration Command" Resource Parameters
Resource Identifier
(ip-addr)
(index)

Type

Description

<Ip::V4Address>
<Rip::Md5KeyIndex>
range: [1...5]

interface IP address
the number of the md5 key

Table 28.5-2 "RIP Interface MD5 Key Configuration Command" Command Parameters
Parameter

Type

Description

key

prompt | plain : <Rip::Key>

starts

mandatory parameter
the md5 key
mandatory parameter
when the key must be used

<Rip::MD5startDelay>
Possible values are :
- now : the key will be used from now on
- <Rip::MD5startDelay> : the delay before
the key will be used
<Rip::MD5expiryDelay>
mandatory parameter
Possible values are :
delay before the key expires
- now : the key will expire now
- never : the key will never expire
- <Rip::MD5expiryDelay> : the delay
before the key will expire

expires

3HH-01016-AAAA-TCZZA Edition 03

Released

303

28 RIP Configuration Commands

28.6 RIP Route Aggregation Command


Command Description
This command allows the user to add or delete a route aggregation.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip [[no] aggregation (ip-addr) ]

Command Parameters
Table 28.6-1 "RIP Route Aggregation Command" Resource Parameters
Resource Identifier
(ip-addr)

304

Type

Description

<Ip::V4Address> / <Ip::PrefixLengthFull> aggregated IP address and subnetmask

Released

3HH-01016-AAAA-TCZZA

Edition 03

28 RIP Configuration Commands

28.7 RIP Route Map Command


Command Description
This command allows the user to define a route map.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> configure rip [[no] route-map (vlan-id) sub-index <Rip::SubIndex> ip-addr
<Ip::V4Address> / <Ip::PrefixLengthFull> [ no direction | direction
<Rip::RouteMapDirection> ][ no deny | deny ]]

Command Parameters
Table 28.7-1 "RIP Route Map Command" Resource Parameters
Resource Identifier
(vlan-id)
sub-index

Type

Description

<Vlan::VlanOamIndex>
range: [1...4093]
<Rip::SubIndex>
range: [1...128]

interface IP address
identifies the rule for each ip-address

Table 28.7-2 "RIP Route Map Command" Command Parameters


Parameter
ip-addr
[ no ] direction

[ no ] deny

Type

Description

<Ip::V4Address> / <Ip::PrefixLengthFull> mandatory parameter


IP address of the subnet that can be allowed or
disallowed
<Rip::RouteMapDirection>
optional parameter with default value: "transmit"
Possible values are :
Direction in which the RIP routes are advertised.
- transmit : route map in transmitting
direction
- receive : route map in receiving direction
<Rip::RouteMapAction>
optional parameter with default value: "permit"
Specifes the action to be allowed(permit/deny)

3HH-01016-AAAA-TCZZA Edition 03

Released

305

29- XDSL Bonding Configuration Commands

29.1 xDSL Bonding Group Profile Configuration Command


29.2 xDSL Bonding Configuration Command

306

Released

29-307
29-309

3HH-01016-AAAA-TCZZA

Edition 03

29 XDSL Bonding Configuration Commands

29.1 xDSL Bonding Group Profile Configuration


Command
Command Description
This node allows to manage the xDSL bonding group profile. A profile can be created in one step with all the
necessary parameters and making it active. It can also be created in several steps by specifying a few parameters in
each step and make the profile active in the last step.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding [[no] group-profile (index) name <AsamProfileName> (scope)
version <SignedInteger> [ no min-bitrate-up | min-bitrate-up <Xdsl::Bitrate> ][ no
min-bitrate-down | min-bitrate-down <Xdsl::Bitrate> ][ no plan-bitrate-up |
plan-bitrate-up <Xdsl::Bitrate> ][ no plan-bitrate-down | plan-bitrate-down
<Xdsl::Bitrate> ][ no max-bitrate-up | max-bitrate-up <Xdsl::Bitrate> ][ no
max-bitrate-down | max-bitrate-down <Xdsl::Bitrate> ][ no active | active ]]

Command Parameters
Table 29.1-1 "xDSL Bonding Group Profile Configuration Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::GroupProfileIndex>
range: [1...100]

index of the profile

Table 29.1-2 "xDSL Bonding Group Profile Configuration Command" Command Parameters
Parameter
name
(scope)

version

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<AsamProfileScope>
Possible values are :
- local-profile : the local profile
- network-profile : the network profile
<SignedInteger>

mandatory parameter
name of the profile
mandatory parameter
scope of the profile

[ no ] min-bitrate-up

<Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec
[ no ] <Xdsl::Bitrate>
min-bitrate-down
range: [0...65535] unit: kbits/sec
[ no ] plan-bitrate-up <Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec
[ no ] <Xdsl::Bitrate>

3HH-01016-AAAA-TCZZA Edition 03

mandatory parameter
version maintained by manager, usually 1 for new
profile
optional parameter with default value: 64
minimum upstream bit rate to be maintained
optional parameter with default value: 1024
minimum downstream bit rate to be maintained
optional parameter with default value: 128
planned bitrate in upstream
optional parameter with default value: 1536

Released

307

29 XDSL Bonding Configuration Commands

Parameter

Type

plan-bitrate-down
[ no ] max-bitrate-up
[ no
max-bitrate-down
[ no ] active

308

range: [0...65535] unit: kbits/sec


<Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec
] <Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec
<Xdsl::ActivateRowStatus>

Released

Description
planned bitrate in downstream
optional parameter with default value: 640
maximum bitrate in upstream
optional parameter with default value: 6144
maximum bitrate in downstream
optional parameter with default value: "not-active"
to activate the profile

3HH-01016-AAAA-TCZZA

Edition 03

29 XDSL Bonding Configuration Commands

29.2 xDSL Bonding Configuration Command


Command Description
This node allows to configure a bonding group, which consists of assigning a predefined bonding group profile.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> configure xdsl-bonding group (index) group-profile
<Xdsl::GroupProfileIndexWithRemove> [ no admin-status | admin-status ]

Command Parameters
Table 29.2-1 "xDSL Bonding Configuration Command" Resource Parameters
Resource Identifier
(index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ a unique interface index

Table 29.2-2 "xDSL Bonding Configuration Command" Command Parameters


Parameter
group-profile
[ no ] admin-status

Type

Description

<Xdsl::GroupProfileIndexWithRemove>
range: [0...100]
<Xdsl::GroupAdminStatus>

optional parameter
a valid profile index for the interface
optional
parameter
with
default
"admin-down"
set the admin-state of the group to down

3HH-01016-AAAA-TCZZA Edition 03

Released

309

value:

30- CPE Remote Configuration Commands

30.1 CPE Remote Management System Configuration


Commands

310

Released

30-311

3HH-01016-AAAA-TCZZA

Edition 03

30 CPE Remote Configuration Commands

30.1 CPE Remote Management System


Configuration Commands
Command Description
This node allows to configure CPE Remote Management System;

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> configure cpeproxy [ no proxy-mode | proxy-mode <CpeProxy::CpeProxySystemMode> ][ no
ip-address | ip-address <Ip::V4Address> ][ no udp-port | udp-port
<CpeProxy::CpeMgtStationPortNumber> ]

Command Parameters
Table 30.1-2 "CPE Remote Management System Configuration Commands" Command Parameters
Parameter
[ no ] proxy-mode

[ no ] ip-address
[ no ] udp-port

Type

Description

<CpeProxy::CpeProxySystemMode>
Possible values are :
- proxy-enabled : enable cpe proxy system
- proxy-disabled : disable cpe proxy
system
<Ip::V4Address>

optional
parameter
with
default
value:
"proxy-disabled"
enable to switch on the CPE Remote Proxy, disable
to switch off.

<CpeProxy::CpeMgtStationPortNumber>
range: [1...65535]

3HH-01016-AAAA-TCZZA Edition 03

optional parameter with default value: "0.0.0.0"


configure the IP address of CPE Management
Station.
optional parameter with default value: 162
configure the udp port by which cpeMM receive
trap from DSLAM.

Released

311

31- Equipment Status Commands

31.1 Slot Status Command


31.2 Applique Status Command
31.3 Shelf Summary Status Command
31.4 Protection Element Status Command
31.5 Protection Group Status Command
31.6 ISAM Status Command
31.7 Rack Status Command
31.8 Shelf Status Command

312

Released

31-313
31-316
31-319
31-321
31-322
31-324
31-325
31-327

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

31.1 Slot Status Command


Command Description
This commands shows the slot status. The following information is shown for each slot:
type : describes the type of the unit that is currently present in the slot.
oper-status: describes whether the unit is able to perform its normal operation.
error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the unit.
manufacturer: provides an identification of the unit manufacturer.
inventory-pba: provides the Alcatel Printed Board Assembly code of the unit.
inventory-fpba: provides the Alcatel Printed Board Assembly code of the unit which also identifies the boot
software.
inventory-ics: provides the Item Change Status iteration code of the unit.
inventory-clie: provides the (USA) Common Language Equipment Identification code of the unit.
serial-no: provides the serial number of the board.
failed-test: provides identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment slot (slot)

Command Parameters
Table 31.1-1 "Slot Status Command" Resource Parameters
Resource Identifier
(slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the physical slot position
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 31.1-2 "Slot Status Command" Display parameters
Specific Information

3HH-01016-AAAA-TCZZA Edition 03

Released

313

31 Equipment Status Commands

name

Type

Description
A string representing the board that is planned in
the slot.
This element is only shown in detail mode.
A string representing the board that is actually
present in the slot.
This element is always shown.
Specifies whether the plug-in unit is able to
perform its normal operation.
This element is always shown.

manufacturer

Possible values are depending on the


actual configuration and software,values
can be shown at online-help.
Possible values are depending on the
actual configuration and software,values
can be shown at online-help.
<Equipm::OperStatus>
Possible values are :
- enabled :
- disabled :
<Equipm::OperError>
Possible values are :
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed :
- configuration-failed :
- board-reset-protection :
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- unknown-error :
<Equipm::AvailStatus>
Possible values are :
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
<PrintableString>

mnemonic

<PrintableString>

pba-code

<PrintableString>

fpba-code

<PrintableString>

fpba-ics

<PrintableString>

clei-code

<PrintableString>

serial-no

<PrintableString>

planned-type
actual-type
oper-status
short name:enabled
error-status

availability

314

Released

Specifies for what reason the board is not


operational. These values correspond with the
alarms which are generated in case of a failure.
This element is always shown.

Specifies the state of the board. It is set to available


after a successfull selftest of the board (if
applicable).
This element is always shown.

Specifies the company of the board.


This element is only shown in detail mode.
Specifies the name of the board.
This element is only shown in detail mode.
Specifies the Alcatel printed board assembly code
of of the board.
This element is only shown in detail mode.
Specifies the Alcatel printed board assembly code
of the board, which also identifies the boot
software.
This element is only shown in detail mode.
pecifies the item change status iteration code of the
board.
This element is only shown in detail mode.
Specifies the common language equipment
identification code of the board.
This element is only shown in detail mode.
Specifies the serial number of the board.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

name
failed-test

Type

Description

<BinaryString>

Specifies the last failing test.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

315

31 Equipment Status Commands

31.2 Applique Status Command


Command Description
This command shows the applique status. The following information is shown for each applique slot:
type: provides the type of the applique that is currently present in the slot.
oper-status: describes whether the applique is able to perform its normal operation.
error-status: describes the reason why the applique is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the applique.
manufacturer: provides an identification of the applique manufacturer.
inventory-pba: provides the Alcatel Printed Board Assembly code of the applique.
inventory-fpba: provides the Alcatel Printed Board Assembly code of the applique which also identifies the boot
software.
inventory-ics: provides the Item Change Status iteration code of the qpplique.
inventory-clie: provides the (USA) Common Language Equipment Identification code of the applique.
serial-no: provides the serial number of the applique.
failed-test: provides the identification of the last failing test using four numbers, from MSB to LSB:
- - table number (1 byte)
- - segment number (1 byte)
- - case number (1 byte)
- - check number (1 byte)
As long as there has been no failing self test, the value of this attribute will be 0.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment applique (applique)

Command Parameters
Table 31.2-1 "Applique Status Command" Resource Parameters
Resource Identifier
(applique)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the physical applique position
<Eqpt::Applique>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Applique>= range: [1...21]

Command Output
Table 31.2-2 "Applique Status Command" Display parameters
Specific Information

316

Released

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

name

Type

Description
A string representing the board that is planned in
the slot.
This element is only shown in detail mode.
A string representing the board that is actually
present in the slot.
This element is always shown.
Specifies whether the plug-in unit is able to
perform its normal operation.
This element is always shown.

manufacturer

Possible values are depending on the


actual configuration and software,values
can be shown at online-help.
Possible values are depending on the
actual configuration and software,values
can be shown at online-help.
<Equipm::OperStatus>
Possible values are :
- enabled :
- disabled :
<Equipm::OperError>
Possible values are :
- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed :
- configuration-failed :
- board-reset-protection :
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- unknown-error :
<Equipm::AvailStatus>
Possible values are :
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
<PrintableString>

mnemonic

<PrintableString>

pba-code

<PrintableString>

fpba-code

<PrintableString>

fpba-ics

<PrintableString>

clei-code

<PrintableString>

serial-no

<PrintableString>

planned-type
actual-type
oper-status
short name:enabled
error-status

availability

3HH-01016-AAAA-TCZZA Edition 03

Specifies for what reason the board is not


operational. These values correspond with the
alarms which are generated in case of a failure.
This element is always shown.

Specifies the state of the board. It is set to available


after a successfull selftest of the board (if
applicable).
This element is always shown.

Specifies the company of the board.


This element is only shown in detail mode.
Specifies the name of the board.
This element is only shown in detail mode.
Specifies the Alcatel Printed Board Assembly code
of of the board.
This element is only shown in detail mode.
Specifies the Alcatel Printed Board Assembly code
of the board, which also identifies the boot
software.
This element is only shown in detail mode.
Specifies the item change status iteration code of
the board.
This element is only shown in detail mode.
Specifies the common language equipment
identification code of the board.
This element is only shown in detail mode.
Specifies the serial number of the board.
This element is only shown in detail mode.

Released

317

31 Equipment Status Commands

name
failed-test

318

Type

Description

<BinaryString>

Specifies the last failing test.


This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

31.3 Shelf Summary Status Command


Command Description
This commands shows a summary of the slots in a shelf.
The least significant bit of the first byte shown corresponds to the slot position 1.

User Level
none

Command Syntax
The command has the following syntax:
> show equipment shelf-summary (shelf)

Command Parameters
Table 31.3-1 "Shelf Summary Status Command" Resource Parameters
Resource Identifier
(shelf)

Type
<Eqpt::Rack> / <Eqpt::Shelf>
<Eqpt::Rack>=
range:
<Eqpt::Shelf>= range: [1...1]

Description
the physical shelf position
[1...1]/

Command Output
Table 31.3-2 "Shelf Summary Status Command" Display parameters
Specific Information
name

Type

Description

changes

<Counter>

occupied-slots

<Binary-08-08>
length: 8
<Binary-08-08>
length: 8

Number of configuration or status changes for


slots/boards within this shelf.
This element is always shown.
Specifies the occupation of slots.
This element is only shown in detail mode.
Specifies the administrative state of the boards
whether it is locked or not.
This element is only shown in detail mode.
Specifies the operational state of the boards
whether it is locked or not.
This element is only shown in detail mode.
Specifies the availability state of the boards
whether it is available or not.
This element is only shown in detail mode.
Specifies any mismatch between the actual
board-type and the planned board-type.
This element is always shown.
Specifies the boards which generated an alarm.

admin-unlocked
oper-unlocked

<Binary-08-08>
length: 8

avail-boards

<Binary-08-08>
length: 8

mismatches

<Binary-08-08>
length: 8

alarms

<Binary-08-08>

3HH-01016-AAAA-TCZZA Edition 03

Released

319

31 Equipment Status Commands

name

320

Type

Description

length: 8

This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

31.4 Protection Element Status Command


Command Description
This command shows the protected element-related parameter of the equipment.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment protection-element (slot-id)

Command Parameters
Table 31.4-1 "Protection Element Status Command" Resource Parameters
Resource Identifier
(slot-id)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ Index in eqpt Prot Element Table
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 31.4-2 "Protection Element Status Command" Display parameters
Specific Information
name
standby-status

redcy-ctrl-status

Type

Description

<Equipm::ProtElementStandbyStatus>
Possible values are :
- providing-service : providing services
- hot-standby : hot standby
- cold-standby : cold standby
- idle : idle
<Equipm::ProtElementRedcyCtrlStatus>
Possible values are :
- normal : normal
- forced_active : forced active

The standby status of the protection group element.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

the redcy ctrl status of the protection group


element.
This element is always shown.

Released

321

31 Equipment Status Commands

31.5 Protection Group Status Command


Command Description
This command shows the parameters related to protection groups.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment protection-group (prot-group-id)

Command Parameters
Table 31.5-1 "Protection Group Status Command" Resource Parameters
Resource Identifier
(prot-group-id)

Type

Description

<SignedInteger>

Index in eqpt Prot Group Table

Command Output
Table 31.5-2 "Protection Group Status Command" Display parameters
Specific Information
name

Type

Description
distinguishes the administration-status
This element is always shown.

prot-changes

<Equipm::PortGroupAdminStatus>
Possible values are :
- unlock : unlock
- lock : lock
<TimeTicks>
unit: msec
<Equipm::PortGroupType>
Possible values are :
- one-plus-one : one to one
- one-for-n : one to many
<Counter>

switchover-count

<Counter>

admin-status

eps-quenchfactor
prot-group-type

last-switchover-reason <Equipm::SwitchOverReason>
Possible values are :
- no-switch-over : no switch over has been

322

Released

distinguishes timervalue of quenching mechanism


This element is only shown in detail mode.
distinguishes between 1+1 and 1:N protection
groups
This element is always shown.
wrap around counter which indicates the number of
status changes in this protection group as well as
the status changes for the protecting elements
within this group
This element is only shown in detail mode.
wrap around counter for the number of switchovers
being performed
This element is only shown in detail mode.
contains the reason of the last switch over
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

name

alarm-bitmap

oper-prot-element

Type

Description

performed yet
- forced-active : chain A is forced
- board-not-present : board is removed or
not reachable
- extender-chain-failure : extender chain
failure
- link-failure : link failure
watchdog-timeout
:
redundancy
watchdog
- file-system-corrupt : curruption of file
system
- configuration-mismatch : mismatch in
boardType or Swversion
- board-unplanned : board has been
unplanned
- board-locked : board has been locked
- shelf-defense : shelf-error detected by
defense
- revertive-switchover : switchover
because protected board is operational
again (in case of 1:N)
- lanx-failure : lanx failure
<SignedInteger>
status bitmap: bit 0 set means no defect at all, bit 1 :
if bit set, loss of switch-over capabilities alarm is
set (excludes bit 0 setting),bit 2 .. 31 : reserved for
future extensions
This element is only shown in detail mode.
<SignedInteger>
only supported for 1:N protection groups,indicates
which element is currently protected by the spare
element, value 0 means that currently the spare
element is not protecting any element
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

323

31 Equipment Status Commands

31.6 ISAM Status Command


Command Description
This command shows the ISAM status.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment isam

Command Output
Table 31.6-2 "ISAM Status Command" Display parameters
Specific Information
name
planned-type

actual-type

description

324

Type

Description

<Equipm::SystemType>
Possible values are :
- laus : large ASAM US / ANSI market (6
racks, 3 shelves per rack)
- laeu : large ASAM EU / ETSI market (6
racks, 3 shelves per rack)
- leeu : large ISAM for EU / ETSI market
- maus : mini RAM ASAM for US / ANSI
market
- leus : large ISAM for US / ANSI market
<Equipm::SystemType>
Possible values are :
- laus : large ASAM US / ANSI market (6
racks, 3 shelves per rack)
- laeu : large ASAM EU / ETSI market (6
racks, 3 shelves per rack)
- leeu : large ISAM for EU / ETSI market
- maus : mini RAM ASAM for US / ANSI
market
- leus : large ISAM for US / ANSI market
<Description-127>
length: x<127

Specifies the planned isam type.


This element is only shown in detail mode.

Released

A string representing the system type that is


actually present.
This element is always shown.

Specifies the location of the system.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

31.7 Rack Status Command


Command Description
This command shows the rack status.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment rack (rack)

Command Parameters
Table 31.7-1 "Rack Status Command" Resource Parameters
Resource Identifier
(rack)

Type

Description

<Eqpt::Rack>
range: [1...1]

the rack identifier

Command Output
Table 31.7-2 "Rack Status Command" Display parameters
Specific Information
name
planned-type

actual-type

description

Type

Description

<Equipm::RackType>
Possible values are :
- altr-e : ISAM ETSI DSL line termination
rack (2200mm)
- altr-a : ISAM ANSI DSL line
termination rack
- not-planned : holder is not planned
- not-allowed : shelf is not allowed in this
position
<Equipm::RackType>
Possible values are :
- altr-e : ISAM ETSI DSL line termination
rack (2200mm)
- altr-a : ISAM ANSI DSL line
termination rack
- not-planned : holder is not planned
- not-allowed : shelf is not allowed in this
position
<Description-127>
length: x<127

Specifies the planned rack type.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

A string representing the racktype that is actually


present.
This element is always shown.

Specifies the location of the rack.


This element is only shown in detail mode.

Released

325

31 Equipment Status Commands

326

Released

3HH-01016-AAAA-TCZZA

Edition 03

31 Equipment Status Commands

31.8 Shelf Status Command


Command Description
This command shows the shelf status. The following information is shown in addition to configuration information:
oper-status: describes whether the board is able to perform its normal operation.
error-status: provides the reason why the board is not operational. These values correspond to the alarms
generated in case of a failure.
available-status: provides further information regarding the state of the board.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show equipment shelf (shelf)

Command Parameters
Table 31.8-1 "Shelf Status Command" Resource Parameters
Resource Identifier
(shelf)

Type
<Eqpt::Rack> / <Eqpt::Shelf>
<Eqpt::Rack>=
range:
<Eqpt::Shelf>= range: [1...1]

Description
a shelf identifier: <rack>/<shelf>
[1...1]/

Command Output
Table 31.8-2 "Shelf Status Command" Display parameters
Specific Information
name
planned-type
actual-type
admin-status
short name:locked
oper-status
short name:enabled
error-status

Type

Description

Possible values are depending on the


actual configuration and software,values
can be shown at online-help.
Possible values are depending on the
actual configuration and software,values
can be shown at online-help.
<Equipm::HolderAdminStatus>
Possible values are :
- lock : the holder is locked
- unlock : the holder is unlocked
<Equipm::OperStatus>
Possible values are :
- enabled :
- disabled :
<Equipm::OperError>

Specifies the planned shelf type.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

A string representing the shelftype that is actually


present in the rack.
This element is always shown.
Specifies the shelf is locked or not.
This element is only shown in detail mode.
Specifies whether or not the shelf is capable of
performing its normal functions.
This element is always shown.
Specifies for what reason the shelf is not

Released

327

31 Equipment Status Commands

name

availability

class

description

328

Type

Description

Possible values are :


- no-error :
- type-mismatch :
- board-missing :
- no-installation :
- no-planned-board :
- waiting-for-sw :
- init-boot-failed :
- init-download-failed :
- init-connection-failed :
- configuration-failed :
- board-reset-protection :
- invalid-parameter :
- temperature-alarm :
- tempshutdown :
- defense :
- board-not-licensed :
- unknown-error :
<Equipm::AvailStatus>
Possible values are :
- available :
- in-test :
- failed :
- power-off :
- not-installed :
- offline :
- dependency :
<Equipm::ShelfClass>
Possible values are :
- main-iq-hcl : main shelf - supports iqand hcl-based traffic
- ext-iq : extension shelf - supports only
iq-based traffic
- ext-hcl : extension shelf - support only
hcs-based traffic
- main-ethernet : main shelf - supports
ethernet-based traffic
- ext-ethernet : extension shelf - supports
ethernet-based traffic
<Description-127>
length: x<127

operational.
This element is always shown.

Released

Specifies whether the shelf is available or not.


This element is always shown.

Specifies classification of shelves.


This element is only shown in detail mode.

Specifies the location of the shelf.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

32- Trap Status Commands

32.1 Trap Manager Queue Status Command

3HH-01016-AAAA-TCZZA Edition 03

32-330

Released

329

32 Trap Status Commands

32.1 Trap Manager Queue Status Command


Command Description
This command shows the status of the trap manager queue.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show trap manager (address)

Command Parameters
Table 32.1-1 "Trap Manager Queue Status Command" Resource Parameters
Resource Identifier
(address)

Type

Description

<Ip::V4Address> : <Trap::Port>
the IP address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]

Command Output
Table 32.1-2 "Trap Manager Queue Status Command" Display parameters
Specific Information
name
last-reset-time
buffer-status

330

Type

Description

<Sys::Time>

time when the buffer has been reset.


This element is always shown.
<Trap::QueueStatus>
specifies whether the trap buffer is overflowed or
Possible values are :
not.
- no-traps-lost : the queue did not overflow This element is always shown.
- no traps were lost
- traps-lost : the queue did overflow - traps
were lost

Released

3HH-01016-AAAA-TCZZA

Edition 03

33- Alarm Log Status Commands

33.1 Alarm Log Status Command


33.2 Alarm Equipment Status Command
33.3 Alarm Equipment Holder Status Command
33.4 Alarm Plug in Unit Status Command
33.5 Alarm ATM Status Command
33.6 Alarm Ethernet Interface Log Status Command
33.7 Alarm Software Management Status Command
33.8 Alarm xDSL Common Status Command
33.9 Alarm xDSL Near End Status Command
33.10 Alarm xDSL Far End Status Command
33.11 Alarm TCA-xDSL Log Status Command
33.12 Alarm log Electrical to Optical Conversion Status
Command
33.13 Alarm Authentication Status Command
33.14 Alarm xDSL Bonding Status Command
33.15 Alarm Redundancy Status Command
33.16 Alarm Custom Status Command

3HH-01016-AAAA-TCZZA Edition 03

33-332
33-334
33-336
33-339
33-342
33-344
33-345
33-347
33-349
33-352
33-355
33-359
33-361
33-363
33-365
33-366

Released

331

33 Alarm Log Status Commands

33.1 Alarm Log Status Command


Command Description
This command displays the alarm log entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log table (index)

Command Parameters
Table 33.1-1 "Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.1-2 "Alarm Log Status Command" Display parameters
Specific Information
name
type

last-updated-on
log-info

332

Type

Description

<Alarm::alarmType>
unique id for an alarm.
Possible values are :
This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- redundancy : redundancy alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
- bonding : bonding-group related alarms
<Sys::Time>
network time in seconds when the alarm was
logged.
This element is always shown.
<Alarm::AdditionalInfo>
some additional information about the table entry.

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name

Type

Description

length: x<512

This element is always shown.

Only Show Details: alarm log table related information


name
Type
last-entry-index

<SignedInteger>

log-was-reset-on

<Sys::Time>
unit: UTC
<UnsignedInteger>

log-buffer-size
log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

Description
index of the last entry that was added to the log
table.
This element is always shown.
time when the alarm log was last reset.
This element is always shown.
size of the internal log buffer.
This element is always shown.
specifies whether log table is overflowed or not.
This element is always shown.

Released

333

33 Alarm Log Status Commands

33.2 Alarm Equipment Status Command


Command Description
This command shows the current status of the equipment.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log equipment (index)

Command Parameters
Table 33.2-1 "Alarm Equipment Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.2-2 "Alarm Equipment Status Command" Display parameters
Specific Information
name
persist-data

prev-status

sntp-comm

prev-status

nt-disk

334

Type

Description

<Alarm::persistDataLoss>
Possible values are :
- lost : persistant data is lost
- not-lost : persistant data is not lost
<Alarm::persistDataLoss>
Possible values are :
- lost : persistant data is lost
- not-lost : persistant data is not lost
<Alarm::sntpCommLoss>
Possible values are :
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
<Alarm::sntpCommLoss>
Possible values are :
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
<Alarm::ntDiskSpace>
Possible values are :
- ninty-perc-full : NT disk space is 90%

current status specifying persistant data is lost or


not
This element is always shown.

Released

status of persist-data with its previous logged value.


This element is only shown in detail mode.
current status of sntp communication is lost or not
This element is always shown.

status of sntp communication with its previous


logged value.
This element is only shown in detail mode.
current status of nt disk space is 90% full or less
than that
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name

prev-status

connection-lost

prev-status

Type
full
- less-than-ninty-perc : NT disk space
usage less that 90%
<Alarm::ntDiskSpace>
Possible values are :
- ninty-perc-full : NT disk space is 90%
full
- less-than-ninty-perc : NT disk space
usage less that 90%
<Alarm::ShubLoc>
Possible values are :
- lost : NT shub communication lost
- not-lost : NT shub communication intact
<Alarm::ShubLoc>
Possible values are :
- lost : NT shub communication lost
- not-lost : NT shub communication intact

3HH-01016-AAAA-TCZZA Edition 03

Description

status of nt disk space with its previous logged


value.
This element is only shown in detail mode.

current status of nt shub communication is lost or


intact
This element is always shown.
status of nt shub communication with its previous
logged value.
This element is only shown in detail mode.

Released

335

33 Alarm Log Status Commands

33.3 Alarm Equipment Holder Status Command


Command Description
This command shows the equipment holder logs.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log eqpt-holder (index)

Command Parameters
Table 33.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name
shelf
rack-power

prev-status

fan-unit1

prev-status

fan-unit2

336

Type
<Eqpt::Rack> / <Eqpt::Shelf>
<Eqpt::Rack>=
range:
<Eqpt::Shelf>= range: [1...1]
<Alarm::rackPower>
Possible values are :
- fuse-broken : the fuse is broken
- fuse-ok : the fuse is intact
<Alarm::rackPower>
Possible values are :
- fuse-broken : the fuse is broken
- fuse-ok : the fuse is intact
<Alarm::fanUnit1>
Possible values are :
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
<Alarm::fanUnit1>
Possible values are :
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
<Alarm::fanUnit2>
Possible values are :

Released

Description
speify which shelf the alarm occurred.
[1...1]/ This element is always shown.
current status of rack power alarm, indicating fuse
is broken or intact
This element is always shown.
status of rack power alarm with its previous logged
value.
This element is only shown in detail mode.
current status of fan-unit1
This element is always shown.
status of fan-unit1 with its previous logged value.
This element is only shown in detail mode.
current status of fan-unit2
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name
prev-status

shelf-mismatch

prev-status

ext-chain-instl

prev-status

door

prev-status

fuse

prev-status

single-fan-fail

prev-status

double-fan-fail

Type
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
<Alarm::fanUnit2>
Possible values are :
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
<Alarm::shelfTypeMismatch>
Possible values are :
- mismatch : installed and planned shelf
types are different
- no-mismatch : installed and planned
shelf types are the same
<Alarm::shelfTypeMismatch>
Possible values are :
- mismatch : installed and planned shelf
types are different
- no-mismatch : installed and planned
shelf types are the same
<Alarm::extChainInstl>
Possible values are :
- consistancy-problem : consistency
problem detected for installation of
extension chain
- no-consistancy-problem : no consistancy
problem
<Alarm::extChainInstl>
Possible values are :
- consistancy-problem : consistency
problem detected for installation of
extension chain
- no-consistancy-problem : no consistancy
problem
<Alarm::door>
Possible values are :
- failing : the cabinet door is opened
- ok : the cabinet door is closed
<Alarm::door>
Possible values are :
- failing : the cabinet door is opened
- ok : the cabinet door is closed
<Alarm::fuse>
Possible values are :
- failing : the fuse is broken
- ok : the fuse works properly
<Alarm::fuse>
Possible values are :
- failing : the fuse is broken
- ok : the fuse works properly
<Alarm::singleFanFail>
Possible values are :
- failing : single fan failure
- ok : the fan works properly
<Alarm::singleFanFail>
Possible values are :
- failing : single fan failure
- ok : the fan works properly
<Alarm::doubleFanFail>

3HH-01016-AAAA-TCZZA Edition 03

Description
status of fan-unit2 with its previous logged value.
This element is only shown in detail mode.
current status specifies installed and planned shelf
types are different
This element is always shown.

status of shelf-mismatch with its previous logged


value.
This element is only shown in detail mode.

current alarm status of consistency problem


detected for installation of extension chain
This element is always shown.

status of consistency problem with its previous


logged value.
This element is only shown in detail mode.

current status of door alarm, indicating the cabinet


door is opened
This element is always shown.
status of door power alarm with its previous logged
value.
This element is only shown in detail mode.
current status of fuse alarm, indicating the fuse is
broken
This element is always shown.
status of fuse alarm with its previous logged value.
This element is only shown in detail mode.
current status of single fan alarm, indicating the fan
is broken
This element is always shown.
status of single fan alarm with its previous logged
value.
This element is only shown in detail mode.
current status of double fans alarm, indicating the

Released

337

33 Alarm Log Status Commands

name

prev-status

ac-power-fail

prev-status

338

Type

Description

Possible values are :


fans are broken
- failing : double fan failure
This element is always shown.
- ok : the fans work properly
<Alarm::doubleFanFail>
status of double fans alarm with its previous logged
Possible values are :
value.
- failing : double fan failure
This element is only shown in detail mode.
- ok : the fans work properly
<Alarm::acPowerFail>
current status of AC power failure alarm, indicating
Possible values are :
the AC Power is broken
- failing : system AC power fails
This element is always shown.
- ok : the system AC power works
properly
<Alarm::acPowerFail>
status of AC power failure alarm with its previous
Possible values are :
logged value.
- failing : system AC power fails
This element is only shown in detail mode.
- ok : the system AC power works
properly

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.4 Alarm Plug in Unit Status Command


Command Description
This command shows the plug-in unit alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log plug-in-unit (index)

Command Parameters
Table 33.4-1 "Alarm Plug in Unit Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.4-2 "Alarm Plug in Unit Status Command" Display parameters
Specific Information
name
board-position

board-mismatch

prev-status

sw-download

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::boardMismatch>
Possible values are :
- yes : planned and plugged-in types are
different
- no : planned and plugged-in types are
same
<Alarm::boardMismatch>
Possible values are :
- yes : planned and plugged-in types are
different
- no : planned and plugged-in types are
same
<Alarm::swStatus>
Possible values are :
- waiting : not able to download all the
applicable SW files

identify where the alarm has occurred.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

alarm specifing the planned and plugged-in types


are different
This element is always shown.

status of board-mismatch with its previous logged


value.
This element is only shown in detail mode.

alarm specifing download of the software is


completed or not.
This element is always shown.

Released

339

33 Alarm Log Status Commands

name
prev-status

temperature

prev-status

temp-shutoff

prev-status

defense

prev-status

board-present

prev-status

board-inserted

prev-status

340

Type
- completed : download completed
<Alarm::swStatus>
Possible values are :
- waiting : not able to download all the
applicable SW files
- completed : download completed
<Alarm::tempStatus>
Possible values are :
- above-thres : temperature threshold on
board exceeded
- below-thres : board temperature within
threshold
<Alarm::tempStatus>
Possible values are :
- above-thres : temperature threshold on
board exceeded
- below-thres : board temperature within
threshold
<Alarm::tempShutoffStatus>
Possible values are :
- board-switched-off : board switched off excess temperature
- board-switched-on : board switched on
<Alarm::tempShutoffStatus>
Possible values are :
- board-switched-off : board switched off excess temperature
- board-switched-on : board switched on
<Alarm::defenseAction>
Possible values are :
- board-disconnected : board disconnected
from system
- board-connected : board still connected
to system
<Alarm::defenseAction>
Possible values are :
- board-disconnected : board disconnected
from system
- board-connected : board still connected
to system
<Alarm::boardPresence>
Possible values are :
- missing : board was present, but now
missing
- yes : board present
<Alarm::boardPresence>
Possible values are :
- missing : board was present, but now
missing
- yes : board present
<Alarm::boardInsertion>
Possible values are :
- never-inserted : board was never inserted
- inserted : board was inserted
<Alarm::boardInsertion>
Possible values are :
- never-inserted : board was never inserted

Released

Description
status of sw-download with its previous logged
value.
This element is only shown in detail mode.
alarm specifing board temperature is crossed the
threshold or not.
This element is only shown in detail mode.

status of board temperature with its previous logged


value.
This element is only shown in detail mode.

alarm specifing board is swiched off because of


excess temperature.
This element is only shown in detail mode.
status of temp-shutoff with its previous logged
value.
This element is only shown in detail mode.
indicates board is disconnected from the system or
not
This element is only shown in detail mode.

status of defense with its previous logged value.


This element is only shown in detail mode.

indicates the presence of the board.


This element is always shown.

status of board-present with its previous logged


value.
This element is only shown in detail mode.
indicates the status of board was inserted or not.
This element is only shown in detail mode.
status of board-inserted with its previous logged
value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name
board-init

prev-status

num-of-resets

prev-status

board-reset-cf

prev-status

Type
- inserted : board was inserted
<Alarm::boardInit>
Possible values are :
- failed : board initialization failed
- completed : board initialization
completed
<Alarm::boardInit>
Possible values are :
- failed : board initialization failed
- completed : board initialization
completed
<Alarm::boardReset>
Possible values are :
- exceeded-threshold : board initialization
failed
- within-threshold : board initialization
completed
<Alarm::boardReset>
Possible values are :
- exceeded-threshold : board initialization
failed
- within-threshold : board initialization
completed
<Alarm::boardResetCommFail>
Possible values are :
- occurred : board reset/communication
failure occurred
- ok : no board reset/communication
failure
<Alarm::boardResetCommFail>
Possible values are :
- occurred : board reset/communication
failure occurred
- ok : no board reset/communication
failure

3HH-01016-AAAA-TCZZA Edition 03

Description
specifies board initializaion is sucessful or failed.
This element is only shown in detail mode.

status of board-init with its previous logged value.


This element is only shown in detail mode.

specifies number of reset of board.


This element is only shown in detail mode.

status of num-of-resets with its previous logged


value.
This element is only shown in detail mode.

indicates there has been a reset


communication failure of the board.
This element is only shown in detail mode.

and/or

status of board-reset-cf with its previous logged


value.
This element is only shown in detail mode.

Released

341

33 Alarm Log Status Commands

33.5 Alarm ATM Status Command


Command Description
This command displays the ATM alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log atm (index)

Command Parameters
Table 33.5-1 "Alarm ATM Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.5-2 "Alarm ATM Status Command" Display parameters
Specific Information
name
port

vpi-vci
cell-dis-up

prev-status

cell-dis-down

342

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port>
This element is always shown.
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::VpiVciValues>
identify where the alarm has occurred.
This element is always shown.
<Alarm::CellDiscardUpstream>
specifies ATM cell is discarded or not in upstream
Possible values are :
direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
<Alarm::CellDiscardUpstream>
status of cell-dis-up with its previous logged value.
Possible values are :
This element is only shown in detail mode.
- discarded : ATM cell discarded in
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
<Alarm::CellDiscardDownstream>
specifies ATM cell is discarded or not in

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name

prev-status

mac-conflict

prev-status

Type

Description

Possible values are :


- discarded : ATM cell discarded in
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
<Alarm::CellDiscardDownstream>
Possible values are :
- discarded : ATM cell discarded in
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
<Alarm::MACconflict>
Possible values are :
- detected : duplicate MAC address from
this PVC
- not-detected : no duplicate MAC address
from this PVC
<Alarm::MACconflict>
Possible values are :
- detected : duplicate MAC address from
this PVC
- not-detected : no duplicate MAC address
from this PVC

downstream direction.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

status of cell-dis-down with its previous logged


value.
This element is only shown in detail mode.

specifies whether duplicate MAC address from the


PVC is occurred or not.
This element is always shown.

status of mac-conflict with its previous logged


value.
This element is only shown in detail mode.

Released

343

33 Alarm Log Status Commands

33.6 Alarm Ethernet Interface Log Status Command


Command Description
This command shows the Ethernet interface alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log ether-itf (index)

Command Parameters
Table 33.6-1 "Alarm Ethernet Interface Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.6-2 "Alarm Ethernet Interface Log Status Command" Display parameters
Specific Information
name
ether-ifindex
link-down

prev-status

344

Type

Description

<Ether::InterfaceIndex>
identify where the alarm has occurred.
range: [0...2147483647]
This element is always shown.
<Alarm::EtherLinkStatus>
specifies ethernet link status.
Possible values are :
This element is always shown.
- yes : board switched off - excess
temperature
- no : board switched on
<Alarm::EtherLinkStatus>
status of link-down with its previous logged value.
Possible values are :
This element is only shown in detail mode.
- yes : board switched off - excess
temperature
- no : board switched on

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.7 Alarm Software Management Status Command


Command Description
This command shows the software management alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log sw-mgmt (index)

Command Parameters
Table 33.7-1 "Alarm Software Management Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.7-2 "Alarm Software Management Status Command" Display parameters
Specific Information
name
nt-position

sw-rollback

prev-status

db-rollback

prev-status

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::SwRollback>
Possible values are :
- yes : implicit software rollback
performed
- no : no implicit software rollback
<Alarm::SwRollback>
Possible values are :
- yes : implicit software rollback
performed
- no : no implicit software rollback
<Alarm::DbRollback>
Possible values are :
- yes : implicit database rollback
performed
- no : no implicit database rollback
<Alarm::DbRollback>

identifies the physical position of the slot


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies implicit software rollback is performed or


not.
This element is always shown.
status of sw-rollback with its previous logged
value.
This element is only shown in detail mode.
specifies implicit database rollback is performed or
not.
This element is always shown.
status of db-rollback with its previous logged value.

Released

345

33 Alarm Log Status Commands

name

Type

Description

Possible values are :


This element is only shown in detail mode.
- yes : implicit database rollback
performed
- no : no implicit database rollback

346

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.8 Alarm xDSL Common Status Command


Command Description
This command displays the xDSL alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl misc (index)

Command Parameters
Table 33.8-1 "Alarm xDSL Common Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.8-2 "Alarm xDSL Common Status Command" Display parameters
Specific Information
name
port

line-config

prev-status

line-capacity

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::LineConfig>
Possible values are :
- config-error : line configuration data
cannot be used
- config-ok : Line configuration data OK
<Alarm::LineConfig>
Possible values are :
- config-error : line configuration data
cannot be used
- config-ok : Line configuration data OK
<Alarm::LineCapacity>
Possible values are :
- below-requirement : line capacity not
enough to set up requested profile
- meets-requirement : line capacity enough

identifies the physical position of the port


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether line configuration data is used or


not.
This element is always shown.
status of line-config with its previous logged value.
This element is only shown in detail mode.

specifies whether line capacity is set up or not.


This element is always shown.

Released

347

33 Alarm Log Status Commands

name
prev-status

xdsl-init

prev-status

peer-modem

prev-status

348

Type
to set up requested profile
<Alarm::LineCapacity>
Possible values are :
- below-requirement : line capacity not
enough to set up requested profile
- meets-requirement : line capacity enough
to set up requested profile
<Alarm::Initialization>
Possible values are :
- failed : initialization unsuccessful due to
comminication problem
- successful : initialization successful
<Alarm::Initialization>
Possible values are :
- failed : initialization unsuccessful due to
comminication problem
- successful : initialization successful
<Alarm::PeerModem>
Possible values are :
- not-detected : no peer modem detected
- detected : peer modem detected
<Alarm::PeerModem>
Possible values are :
- not-detected : no peer modem detected
- detected : peer modem detected

Released

Description
status of line-capacity with its previous logged
value.
This element is only shown in detail mode.

specifies xdsl line initialization is successful or not.


This element is always shown.

status of xdsl-init with its previous logged value.


This element is only shown in detail mode.

specifies whether peer modem detected or not.


This element is always shown.
status of peer-modem with its previous logged
value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.9 Alarm xDSL Near End Status Command


Command Description
This command displays the xDSL alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl near-end (index)

Command Parameters
Table 33.9-1 "Alarm xDSL Near End Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.9-2 "Alarm xDSL Near End Status Command" Display parameters
Specific Information
name
port

los

prev-status

lof

prev-status

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::NearEndLOS>
Possible values are :
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
<Alarm::NearEndLOS>
Possible values are :
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
<Alarm::NearEndLOF>
Possible values are :
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
<Alarm::NearEndLOF>
Possible values are :
- occured : near end loss of frame occured

Specifies where the alarm occurred.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies near end loss of signal occured or not.


This element is always shown.
status of los with its previous logged value.
This element is only shown in detail mode.
specifies near end loss of frame occured or not.
This element is always shown.
status of lof with its previous logged value.
This element is only shown in detail mode.

Released

349

33 Alarm Log Status Commands

name
lom

prev-status

ese

prev-status

bitrate

prev-status

ncd

prev-status

lcd

prev-status

350

Type
- not-occured : no near end loss of frame
<Alarm::NearEndLOM>
Possible values are :
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
<Alarm::NearEndLOM>
Possible values are :
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
<Alarm::NearEndESE>
Possible values are :
- occured : near end excessive server
errors occured
- not-occured : no near end excessive
server errors occured
<Alarm::NearEndESE>
Possible values are :
- occured : near end excessive server
errors occured
- not-occured : no near end excessive
server errors occured
<Alarm::NearEndBRthres>
Possible values are :
- below-plan : upstream planned bitrate
not reached after initialization
- meets-plan : upstream planned bitrate
reached
<Alarm::NearEndBRthres>
Possible values are :
- below-plan : upstream planned bitrate
not reached after initialization
- meets-plan : upstream planned bitrate
reached
<Alarm::NearEndNCD>
Possible values are :
- no-cell-deline : no near end cell
delineation
- cell-deline-occured : near end cell
delineation occured
<Alarm::NearEndNCD>
Possible values are :
- no-cell-deline : no near end cell
delineation
- cell-deline-occured : near end cell
delineation occured
<Alarm::NearEndLCD>
Possible values are :
- loss-of-cell-deline : loss of near end cell
deliniation
- no-loss-of-cell-deline : no loss of near
end cell deliniation
<Alarm::NearEndLCD>
Possible values are :
- loss-of-cell-deline : loss of near end cell
deliniation

Released

Description
specifies near end loss of margin occured or not.
This element is always shown.

status of lom with its previous logged value.


This element is only shown in detail mode.

specifies near end excessive server errors occured


or not.
This element is only shown in detail mode.

status of ese with its previous logged value.


This element is only shown in detail mode.

specifies whether upstream planned bitrate reached


or not after initialization.
This element is only shown in detail mode.

status of bitrate with its previous logged value.


This element is only shown in detail mode.

specifies whether near end cell delineation is


occured or not.
This element is only shown in detail mode.

status of ncd with its previous logged value.


This element is only shown in detail mode.

specifies whether loss of near end cell deliniation is


occured or not.
This element is always shown.

status of lcd with its previous logged value.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name

Type

Description

- no-loss-of-cell-deline : no loss of near


end cell deliniation

3HH-01016-AAAA-TCZZA Edition 03

Released

351

33 Alarm Log Status Commands

33.10 Alarm xDSL Far End Status Command


Command Description
This command displays the xDSL alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log xdsl far-end (index)

Command Parameters
Table 33.10-1 "Alarm xDSL Far End Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.10-2 "Alarm xDSL Far End Status Command" Display parameters
Specific Information
name
port

los

prev-status

lof

prev-status

352

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::FarEndLOS>
Possible values are :
- occured : far end loss of signal occured
- not-occured : no far end loss of signal
<Alarm::FarEndLOS>
Possible values are :
- occured : far end loss of signal occured
- not-occured : no far end loss of signal
<Alarm::FarEndLOF>
Possible values are :
- occured : far end loss of frame occured
- not-occured : no far end loss of frame
<Alarm::FarEndLOF>
Possible values are :
- occured : far end loss of frame occured

identifies where the alarm occurred


This element is always shown.

Released

specifies whether far end loss of signal occured or


not.
This element is always shown.
status of los with its previous logged value.
This element is only shown in detail mode.
specifies whether far end loss of frame occured or
not.
This element is always shown.
status of lof with its previous logged value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name
lpr

prev-status

lol

prev-status

lom

prev-status

ese

prev-status

bitrate

prev-status

ncd

prev-status

Type
- not-occured : no far end loss of frame
<Alarm::FarEndLPR>
Possible values are :
- detected : far end loss of power detected
- not-detected : no far end loss of power
<Alarm::FarEndLPR>
Possible values are :
- detected : far end loss of power detected
- not-detected : no far end loss of power
<Alarm::FarEndLOL>
Possible values are :
- detected : far end loss of link detected
- not-detected : no far end loss of link
<Alarm::FarEndLOL>
Possible values are :
- detected : far end loss of link detected
- not-detected : no far end loss of link
<Alarm::FarEndLOM>
Possible values are :
- occured : far end loss of margin occured
- not-occured : no far end loss of margin
<Alarm::FarEndLOM>
Possible values are :
- occured : far end loss of margin occured
- not-occured : no far end loss of margin
<Alarm::FarEndESE>
Possible values are :
- occured : far end excessive server errors
occured
- not-occured : no far end excessive server
errors occured
<Alarm::FarEndESE>
Possible values are :
- occured : far end excessive server errors
occured
- not-occured : no far end excessive server
errors occured
<Alarm::FarEndBRthres>
Possible values are :
- below-plan : downstream planned bitrate
not reached after initialization
- meets-plan : downstream planned bitrate
reached
<Alarm::FarEndBRthres>
Possible values are :
- below-plan : downstream planned bitrate
not reached after initialization
- meets-plan : downstream planned bitrate
reached
<Alarm::FarEndNCD>
Possible values are :
- no-cell-deline : no far end cell
delineation
- cell-deline-occured : far end cell
delineation occured
<Alarm::FarEndNCD>
Possible values are :

3HH-01016-AAAA-TCZZA Edition 03

Description
specifies whether far end loss of power detected or
not.
This element is always shown.
status of lpr with its previous logged value.
This element is only shown in detail mode.
specifies whether far end loss of link detected or
not.
This element is always shown.
status of lol with its previous logged value.
This element is only shown in detail mode.
specifies whether far end loss of margin occured or
not.
This element is always shown.
status of lom with its previous logged value.
This element is only shown in detail mode.
specifies whether far end excessive server errors
occured or not.
This element is only shown in detail mode.

status of ese with its previous logged value.


This element is only shown in detail mode.

specifies whether downstream planned bitrate


reached or not.
This element is only shown in detail mode.

status of bitrate with its previous logged value.


This element is only shown in detail mode.

specifies whether far end cell delineation occured


or not.
This element is only shown in detail mode.

status of ncd with its previous logged value.


This element is only shown in detail mode.

Released

353

33 Alarm Log Status Commands

name

lcd

prev-status

354

Type
- no-cell-deline : no far end cell
delineation
- cell-deline-occured : far end cell
delineation occured
<Alarm::FarEndLCD>
Possible values are :
- loss-of-cell-deline : loss of far end cell
deliniation
- no-loss-of-cell-deline : no loss of far end
cell deliniation
<Alarm::FarEndLCD>
Possible values are :
- loss-of-cell-deline : loss of far end cell
deliniation
- no-loss-of-cell-deline : no loss of far end
cell deliniation

Released

Description

specifies there is loss of far end cell deliniation or


not.
This element is always shown.

status of lcd with its previous logged value.


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.11 Alarm TCA-xDSL Log Status Command


Command Description
This command shows the xDSL threshold cross alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log tca-xdsl (index)

Command Parameters
Table 33.11-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.11-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name
port

errored-secs

prev-status

es-in-a-day

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::ErroredSeconds>
Possible values are :
- above-thres : number of errored seconds
exceeded threshold
- below-thres : number of errored seconds
below threshold
<Alarm::ErroredSeconds>
Possible values are :
- above-thres : number of errored seconds
exceeded threshold
- below-thres : number of errored seconds
below threshold
<Alarm::ErroredSecondsInAday>
Possible values are :
- above-thres : number of errored seconds

identifies where the alarm occurred


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

number of errored seconds exceeded or below


threshold
This element is always shown.

status of errored-secs with its previous logged


value.
This element is only shown in detail mode.

errored seconds in a day exceeded or below


threshold
This element is always shown.

Released

355

33 Alarm Log Status Commands

name

Type

prev-status

severely-es

prev-status

severely-es-in-a-day

prev-status

unavail-secs

prev-status

unavail-secs-in-a-day

prev-status

356

in a day, exceeded threshold


- below-thres : number of errored seconds
in a day, below threshold
<Alarm::ErroredSecondsInAday>
Possible values are :
- above-thres : number of errored seconds
in a day, exceeded threshold
- below-thres : number of errored seconds
in a day, below threshold
<Alarm::SeverelyErroredSeconds>
Possible values are :
- above-thres : number of severely errored
seconds exceeded threshold
- below-thres : number of severely errored
seconds below threshold
<Alarm::SeverelyErroredSeconds>
Possible values are :
- above-thres : number of severely errored
seconds exceeded threshold
- below-thres : number of severely errored
seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::UnavailableSeconds>
Possible values are :
- above-thres : number of unavailable
seconds exceeded threshold
- below-thres : number of unavailable
seconds below threshold
<Alarm::UnavailableSeconds>
Possible values are :
- above-thres : number of unavailable
seconds exceeded threshold
- below-thres : number of unavailable
seconds below threshold
<Alarm::UnavailSecsInAday>
Possible values are :
- above-thres : number of unavailable
seconds in a day, exceeded threshold
- below-thres : number of unavailable
seconds in a day, below threshold
<Alarm::UnavailSecsInAday>
Possible values are :
- above-thres : number of unavailable
seconds in a day, exceeded threshold
- below-thres : number of unavailable
seconds in a day, below threshold

Released

Description

status of es-in-a-day with its previous logged value.


This element is only shown in detail mode.

number of severely errored seconds exceeded or


below threshold
This element is only shown in detail mode.

status of es-in-a-day with its previous logged value.


This element is only shown in detail mode.

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

status of es-in-a-day with its previous logged value.


This element is only shown in detail mode.

number of unavailable seconds exceeded or below


threshold
This element is always shown.

status of unavail-secs with its previous logged


value.
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is always shown.

status of unavail-secs-in-a-day with its previous


logged value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name
es

prev-status

fe-severely-es

prev-status

fe-sev-es/day

prev-status

fe-unavail-secs

prev-status

fe-unavail-sec/day

prev-status

Type

Description

<Alarm::FarEndErroredSeconds>
Possible values are :
- above-thres : number of far end errored
seconds exceeded threshold
- below-thres : number of far end errored
seconds below threshold
<Alarm::FarEndErroredSeconds>
Possible values are :
- above-thres : number of far end errored
seconds exceeded threshold
- below-thres : number of far end errored
seconds below threshold
<Alarm::FarEndSevErroredSecs>
Possible values are :
- above-thres : number of far end severely
errored seconds exceeded threshold
- below-thres : number of far end severely
errored seconds below threshold
<Alarm::FarEndSevErroredSecs>
Possible values are :
- above-thres : number of far end severely
errored seconds exceeded threshold
- below-thres : number of far end severely
errored seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::FarEndUnavailSecs>
Possible values are :
- above-thres : number of far end
unavailable seconds exceeded threshold
- below-thres : number of far end
unavailable seconds below threshold
<Alarm::FarEndUnavailSecs>
Possible values are :
- above-thres : number of far end
unavailable seconds exceeded threshold
- below-thres : number of far end
unavailable seconds below threshold
<Alarm::FarEndUnavailSecsInAday>
Possible values are :
- above-thres : number of far end
unavailable seconds in a day, exceeded
threshold
- below-thres : number of far end
unavailable seconds in a day, below
threshold
<Alarm::FarEndUnavailSecsInAday>

number of far end errored seconds exceeded or


below threshold
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

status of es with its previous logged value.


This element is only shown in detail mode.

number of far end severely errored seconds


exceeded or below threshold
This element is only shown in detail mode.

status of fe-severely-es with its previous logged


value.
This element is only shown in detail mode.

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

status of fe-severely-es with its previous logged


value.
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

status of fe-unavail-secs with its previous logged


value.
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

status of fe-unavail-sec/day with its previous

Released

357

33 Alarm Log Status Commands

name

fe-es-in-a-day

prev-status

358

Type

Description

Possible values are :


- above-thres : number of far end
unavailable seconds in a day, exceeded
threshold
- below-thres : number of far end
unavailable seconds in a day, below
threshold
<Alarm::FarEndErroredSecsInAday>
Possible values are :
- above-thres : number of far end errored
seconds in a day, exceeded threshold
- below-thres : number of far end errored
seconds in a day, below threshold
<Alarm::FarEndErroredSecsInAday>
Possible values are :
- above-thres : number of far end errored
seconds in a day, exceeded threshold
- below-thres : number of far end errored
seconds in a day, below threshold

logged value.
This element is only shown in detail mode.

Released

number of far end errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

status of fe-es-in-a-day with its previous logged


value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.12 Alarm log Electrical to Optical Conversion


Status Command
Command Description
This command shows the electrical to optical conversion alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log eo-conversion (index)

Command Parameters
Table 33.12-1 "Alarm log Electrical to Optical Conversion Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.12-2 "Alarm log Electrical to Optical Conversion Status Command" Display parameters
Specific Information
name
port
loss-of-signal

prev-status

transmission

Type

Description

<SignedInteger>

identifies where the alarm occurred


This element is always shown.
<Alarm::EoConvLOS>
specifies whether loss of signal detected or not in
Possible values are :
the EO conversion module
- detected : loss of signal detected in the This element is always shown.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
<Alarm::EoConvLOS>
status of loss-of-signal with its previous logged
Possible values are :
value.
- detected : loss of signal detected in the This element is only shown in detail mode.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
<Alarm::EoConvTx>
specifies whether transmission fault is occurred or
Possible values are :
not in the EO module
- faulty : transmission fault in the EO This element is always shown.
module

3HH-01016-AAAA-TCZZA Edition 03

Released

359

33 Alarm Log Status Commands

name
prev-status

360

Type

Description

- ok : transmission OK
<Alarm::EoConvTx>
status of transmission with its previous logged
Possible values are :
value.
- faulty : transmission fault in the EO This element is only shown in detail mode.
module
- ok : transmission OK

Released

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.13 Alarm Authentication Status Command


Command Description
This command displays the authentication-related alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log authentication (index)

Command Parameters
Table 33.13-1 "Alarm Authentication Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.13-2 "Alarm Authentication Status Command" Display parameters
Specific Information
name
vrf-assignment

prev-status

vlan-assignment

prev-status

Type

Description

<Alarm::VRFassignment>
Possible values are :
- failed : failure to assign a VRF for a user
session
- successful : assigned a VRF for a user
session
<Alarm::VRFassignment>
Possible values are :
- failed : failure to assign a VRF for a user
session
- successful : assigned a VRF for a user
session
<Alarm::VLANassignment>
Possible values are :
- failed : failure to assign a VLAN for a
user session
- successful : assigned a VLAN for a user
session
<Alarm::VLANassignment>
Possible values are :
- failed : failure to assign a VLAN for a

specifies whether VRF for a user session is


assigned or failed
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

status of vrf-assignment with its previous logged


value.
This element is only shown in detail mode.

specifies whether a VLAN for a user session is


assigned or failed
This element is always shown.

status of vlan-assignment with its previous logged


value.
This element is only shown in detail mode.

Released

361

33 Alarm Log Status Commands

name

Type

ip-addr-pool-assign

prev-status

qos-param-assign

prev-status

ip-addr-assign

prev-status

radius-pool-id

prev-status

362

user session
- successful : assigned a VLAN for a user
session
<Alarm::IPaddrPoolAssign>
Possible values are :
- failed : failure to assign IP address pool
for a user session
- successful : assigned IP address pool for
a user session
<Alarm::IPaddrPoolAssign>
Possible values are :
- failed : failure to assign IP address pool
for a user session
- successful : assigned IP address pool for
a user session
<Alarm::QOSparamAssign>
Possible values are :
- failed : failure to assign QOS parameters
for a user session
- successful : assigned QOS parameters for
a user session
<Alarm::QOSparamAssign>
Possible values are :
- failed : failure to assign QOS parameters
for a user session
- successful : assigned QOS parameters for
a user session
<Alarm::IPaddrAssign>
Possible values are :
- failed : failure to assign IP address for a
user session
- successful : assigned IP address for a
user session
<Alarm::IPaddrAssign>
Possible values are :
- failed : failure to assign IP address for a
user session
- successful : assigned IP address for a
user session
<Alarm::RADIUSpoolId>
Possible values are :
- not-specified : RADIUS server did not
specify a pool-id
- specified : RADIUS specified the pool-id
<Alarm::RADIUSpoolId>
Possible values are :
- not-specified : RADIUS server did not
specify a pool-id
- specified : RADIUS specified the pool-id

Released

Description

specifies whether IP address pool for a user session


is assigned or failed
This element is always shown.

status of ip-addr-pool-assign with its previous


logged value.
This element is only shown in detail mode.

specifies whether QOS parameters for a user


session is assigned or failed
This element is always shown.

status of ip-addr-pool-assign with its previous


logged value.
This element is only shown in detail mode.

specifies whether IP address for a user session is


assigned or failed
This element is always shown.

status of ip-addr-assign with its previous logged


value.
This element is only shown in detail mode.

specifies whether pool-id is specified or not for a


RADIUS server.
This element is always shown.
status of radius-pool-id with its previous logged
value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.14 Alarm xDSL Bonding Status Command


Command Description
This command displays the xDSL bonding-related alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log bonding-group (index)

Command Parameters
Table 33.14-1 "Alarm xDSL Bonding Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.14-2 "Alarm xDSL Bonding Status Command" Display parameters
Specific Information
name
up-plan-bitrate

prev-status

down-plan-bitrate

prev-status

Type

Description

<Alarm::UpPlannedBitrate>
Possible values are :
- reached-threshold : upstream planned
bitrate threshold reached
- not-reached : upstream planned bitrate
threshold not reached
<Alarm::UpPlannedBitrate>
Possible values are :
- reached-threshold : upstream planned
bitrate threshold reached
- not-reached : upstream planned bitrate
threshold not reached
<Alarm::DownPlanBitrate>
Possible values are :
- reached-threshold : downstream planned
bitrate threshold reached
- not-reached : downstream planned bitrate
threshold not reached
<Alarm::DownPlanBitrate>
Possible values are :
- reached-threshold : downstream planned

specifies whether the group upstream planned bit


rate is reached threshold or not
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

status of up-plan-bitrate with its previous logged


value.
This element is only shown in detail mode.

specifies whether the downstream planned bit rate


is reached threshold or not
This element is always shown.

status of down-plan-bitrate with its previous logged


value.
This element is only shown in detail mode.

Released

363

33 Alarm Log Status Commands

name

up-min-bitrate

prev-status

down-min-bitrate

prev-status

up-config

prev-status

down-config

prev-status

364

Type
bitrate threshold reached
- not-reached : downstream planned bitrate
threshold not reached
<Alarm::UpMinBitrate>
Possible values are :
- reached-threshold : upstream minimum
bitrate threshold reached
- not-reached : upstream minimum bitrate
threshold not reached
<Alarm::UpMinBitrate>
Possible values are :
- reached-threshold : upstream minimum
bitrate threshold reached
- not-reached : upstream minimum bitrate
threshold not reached
<Alarm::DownMinBitrate>
Possible values are :
reached-threshold
:
downstream
minimum bitrate threshold reached
- not-reached : downstream minimum
bitrate threshold not reached
<Alarm::DownMinBitrate>
Possible values are :
reached-threshold
:
downstream
minimum bitrate threshold reached
- not-reached : downstream minimum
bitrate threshold not reached
<Alarm::UpConfig>
Possible values are :
- not-feasible : upstream configuration not
feasible
- feasible : upstream configuration not
feasible
<Alarm::UpConfig>
Possible values are :
- not-feasible : upstream configuration not
feasible
- feasible : upstream configuration not
feasible
<Alarm::DownConfig>
Possible values are :
- not-feasible : downstream configuration
not feasible
- feasible : downstream configuration not
feasible
<Alarm::DownConfig>
Possible values are :
- not-feasible : downstream configuration
not feasible
- feasible : downstream configuration not
feasible

Released

Description

specifies whether the upstream minimum bit rate is


reached threshold or not
This element is always shown.

status of up-min-bitrate with its previous logged


value.
This element is only shown in detail mode.

specifies whether the downstream minimum bit rate


is reached threshold or not
This element is only shown in detail mode.

status of down-min-bitrate with its previous logged


value.
This element is only shown in detail mode.

specifies whether the upstream configuraion is


feasible or not
This element is always shown.

status of up-config with its previous logged value.


This element is only shown in detail mode.

specifies whether the downstream configuraion is


feasible or not
This element is only shown in detail mode.

status of down-config with its previous logged


value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

33.15 Alarm Redundancy Status Command


Command Description
show the redundancy alarm log status

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log redundancy (index)

Command Parameters
Table 33.15-1 "Alarm Redundancy Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.15-2 "Alarm Redundancy Status Command" Display parameters
Specific Information
name
loss-swo-cap

loss-swo-cap

Type
<Alarm::SwoCap>
Possible values are :
- loss : system loss
capability
- not-loss : system
swichover capability
<Alarm::SwoCap>
Possible values are :
- loss : system loss
capability
- not-loss : system
swichover capability

3HH-01016-AAAA-TCZZA Edition 03

Description
identify the switchover capability in a redundant
system.
of the swichover This element is always shown.
not loss of the
identify the switchover capability in a redundant
system.
of the swichover This element is only shown in detail mode.
not loss of the

Released

365

33 Alarm Log Status Commands

33.16 Alarm Custom Status Command


Command Description
show the custom alarm log status

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm log custom (index)

Command Parameters
Table 33.16-1 "Alarm Custom Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm log table index

Command Output
Table 33.16-2 "Alarm Custom Status Command" Display parameters
Specific Information
name
custom-alarm1

prev-status

custom-alarm2

prev-status

366

Type

Description

<Alarm::custom1>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom1>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom2>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom2>
Possible values are :
- occured : Miscellaneous environment

identify the customizableAlarm1 .


This element is always shown.

Released

status of customizableAlarm1 with its previous


logged value.
This element is only shown in detail mode.

identify the customizableAlarm2 .


This element is always shown.

status of customizableAlarm2 with its previous


logged value.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

33 Alarm Log Status Commands

name

custom-alarm3

prev-status

custom-alarm4

prev-status

custom-alarm5

prev-status

Type
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom3>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom3>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom4>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom4>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom5>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom5>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm

3HH-01016-AAAA-TCZZA Edition 03

Description

identify the customizableAlarm3 .


This element is always shown.

status of customizableAlarm3 with its previous


logged value.
This element is only shown in detail mode.

identify the customizableAlarm4 .


This element is always shown.

status of customizableAlarm4 with its previous


logged value.
This element is only shown in detail mode.

identify the customizableAlarm5 .


This element is always shown.

status of customizableAlarm5 with its previous


logged value.
This element is only shown in detail mode.

Released

367

34- Current Alarm Status Commands

34.1 Alarm Current Status Command


34.2 Alarm Current Equipment Status Command
34.3 Alarm Equipment Holder Status Command
34.4 Alarm Plug In Unit Status Command
34.5 Alarm Current ATM Status Command
34.6 Alarm Current Ethernet Interface Status Command
34.7 Alarm Current Software Management Status
Command
34.8 Alarm Current xDSL Status Command
34.9 Alarm TCA-xDSL Log Status Command
34.10 Alarm Electrical to Optical Conversion Status
Command
34.11 Alarm Current Authentication Status Command
34.12 Alarm Current xDSL Bonding Status Command
34.13 Alarm Redundancy Status Command
34.14 Alarm Custom Status Command

368

Released

34-369
34-371
34-372
34-374
34-376
34-378
34-379
34-380
34-383
34-386
34-387
34-389
34-391
34-392

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.1 Alarm Current Status Command


Command Description
This command displays all the current alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current table (index)

Command Parameters
Table 34.1-1 "Alarm Current Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.1-2 "Alarm Current Status Command" Display parameters
Specific Information
name
type

last-updated-on

Type

Description

<Alarm::alarmType>
type of the alarms that are active.
Possible values are :
This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- redundancy : redundancy alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
- bonding : bonding-group related alarms
<Sys::Time>
time in seconds when the entry was updated.
This element is always shown.

Only Show Details: number of changes since start up and number of entires in the table

3HH-01016-AAAA-TCZZA Edition 03

Released

369

34 Current Alarm Status Commands

name

Type

Description

changes

<Counter>

entries

<Gauge>

tot-delta-log

<UnsignedInteger>

number of changes that have occurred since startup.


This element is always shown.
number of entries
This element is always shown.
total number of delta log entries
This element is always shown.

Only Show Details: active severities in the table


name
Type
indeterminate

warning

minor

major

critical

370

<Alarm::IndetSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::WarnSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::MinorSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::MajorSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::CriticalSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity

Released

Description
status of the severity type indeterminate
This element is always shown.

status of the severity type warning


This element is always shown.

status of the severity type minor


This element is always shown.

status of the severity type major


This element is always shown.

status of the severity type critical


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.2 Alarm Current Equipment Status Command


Command Description
This command displays the current equipment alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current equipment (index)

Command Parameters
Table 34.2-1 "Alarm Current Equipment Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.2-2 "Alarm Current Equipment Status Command" Display parameters
Specific Information
name
persist-data

sntp-comm

nt-disk

connection-lost

Type

Description

<Alarm::persistDataLoss>
Possible values are :
- lost : persistant data is lost
- not-lost : persistant data is not lost
<Alarm::sntpCommLoss>
Possible values are :
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
<Alarm::ntDiskSpace>
Possible values are :
- ninty-perc-full : NT disk space is 90%
full
- less-than-ninty-perc : NT disk space
usage less that 90%
<Alarm::ShubLoc>
Possible values are :
- lost : NT shub communication lost
- not-lost : NT shub communication intact

current status specifing persistant data is lost or not


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

current status of sntp communication is lost or not


This element is always shown.

current status of nt disk space is 90% full or less


than that
This element is always shown.

current status of nt shub communication is lost or


intact
This element is always shown.

Released

371

34 Current Alarm Status Commands

34.3 Alarm Equipment Holder Status Command


Command Description
This command displays the current alarms in the equipment holder.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current eqpt-holder (index)

Command Parameters
Table 34.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name
rack-power

fan-unit1

fan-unit2

shelf-type-mismatch

ext-chain-instl

372

Type

Description

<Alarm::rackPower>
Possible values are :
- fuse-broken : the fuse is broken
- fuse-ok : the fuse is intact
<Alarm::fanUnit1>
Possible values are :
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
<Alarm::fanUnit2>
Possible values are :
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
<Alarm::shelfTypeMismatch>
Possible values are :
- mismatch : installed and planned shelf
types are different
- no-mismatch : installed and planned
shelf types are the same
<Alarm::extChainInstl>
Possible values are :
- consistancy-problem : consistency

current status of rack power alarm, indicating fuse


is broken or intact
This element is always shown.

Released

current status of fan-unit1


This element is always shown.
current status of fan-unit2
This element is always shown.
current status specifies installed and planned shelf
types are different
This element is always shown.

current alarm status of consistency problem


detected for installation of extension chain
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name

door

fuse

single-fan-fail

double-fan-fail

ac-power-fail

Type
problem detected for installation of
extension chain
- no-consistancy-problem : no consistancy
problem
<Alarm::door>
Possible values are :
- failing : the cabinet door is opened
- ok : the cabinet door is closed
<Alarm::fuse>
Possible values are :
- failing : the fuse is broken
- ok : the fuse works properly
<Alarm::singleFanFail>
Possible values are :
- failing : single fan failure
- ok : the fan works properly
<Alarm::doubleFanFail>
Possible values are :
- failing : double fan failure
- ok : the fans work properly
<Alarm::acPowerFail>
Possible values are :
- failing : system AC power fails
- ok : the system AC power works
properly

3HH-01016-AAAA-TCZZA Edition 03

Description

current status of door alarm, indicating the cabinet


door is opened
This element is always shown.
current status of fuse alarm, indicating the fuse is
broken
This element is always shown.
current status of single fan alarm, indicating the fan
is broken
This element is always shown.
current status of double fans alarm, indicating the
fans are broken
This element is always shown.
current status of AC power failure alarm, indicating
the AC Power is broken
This element is always shown.

Released

373

34 Current Alarm Status Commands

34.4 Alarm Plug In Unit Status Command


Command Description
This command displays the logs generated for the plug-in unit alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current plug-in-unit (index)

Command Parameters
Table 34.4-1 "Alarm Plug In Unit Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.4-2 "Alarm Plug In Unit Status Command" Display parameters
Specific Information
name
board-position

board-mismatch

sw-download

temperature

374

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::boardMismatch>
Possible values are :
- yes : planned and plugged-in types are
different
- no : planned and plugged-in types are
same
<Alarm::swStatus>
Possible values are :
- waiting : not able to download all the
applicable SW files
- completed : download completed
<Alarm::tempStatus>
Possible values are :
- above-thres : temperature threshold on
board exceeded
- below-thres : board temperature within

identify where the alarm has occurred.


This element is always shown.

Released

alarm specifing the planned and plugged-in types


are different
This element is always shown.

alarm specifing download of the software is


completed or not.
This element is always shown.
alarm specifing board temperature is crossed the
threshold or not.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name
temp-shutoff

defense

board-present

board-inserted

board-init

number-of-resets

board-reset-cf

Type
threshold
<Alarm::tempShutoffStatus>
Possible values are :
- board-switched-off : board switched off excess temperature
- board-switched-on : board switched on
<Alarm::defenseAction>
Possible values are :
- board-disconnected : board disconnected
from system
- board-connected : board still connected
to system
<Alarm::boardPresence>
Possible values are :
- missing : board was present, but now
missing
- yes : board present
<Alarm::boardInsertion>
Possible values are :
- never-inserted : board was never inserted
- inserted : board was inserted
<Alarm::boardInit>
Possible values are :
- failed : board initialization failed
- completed : board initialization
completed
<Alarm::boardReset>
Possible values are :
- exceeded-threshold : board initialization
failed
- within-threshold : board initialization
completed
<Alarm::boardResetCommFail>
Possible values are :
- occurred : board reset/communication
failure occurred
- ok : no board reset/communication
failure

3HH-01016-AAAA-TCZZA Edition 03

Description
alarm specifing board is swiched off because of
excess temperature.
This element is only shown in detail mode.
indicates board disconnected from the system or
not
This element is only shown in detail mode.

indicates the presence of the board.


This element is only shown in detail mode.

indicates the status of board was inserted or not.


This element is only shown in detail mode.
specifies board initializaion is sucessful or failed.
This element is only shown in detail mode.

specifies number of reset of board.


This element is only shown in detail mode.

indicates there has been a reset


communication failure of the board.
This element is only shown in detail mode.

Released

375

and/or

34 Current Alarm Status Commands

34.5 Alarm Current ATM Status Command


Command Description
This command displays the current ATM alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current atm (index)

Command Parameters
Table 34.5-1 "Alarm Current ATM Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.5-2 "Alarm Current ATM Status Command" Display parameters
Specific Information
name
port

vpi-vci
cell-discard-up

cell-discard-down

mac-conflict

376

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port>
This element is always shown.
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::VpiVciValues>
identify where the alarm has occurred.
This element is always shown.
<Alarm::CellDiscardUpstream>
specifies ATM cell is discarded or not in upstream
Possible values are :
direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
<Alarm::CellDiscardDownstream>
specifies ATM cell is discarded or not in
Possible values are :
downstream direction.
- discarded : ATM cell discarded in This element is always shown.
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
<Alarm::MACconflict>
specifies whether duplicate MAC address from the

Released

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name

Type

Description

Possible values are :


PVC is occurred or not.
- detected : duplicate MAC address from This element is always shown.
this PVC
- not-detected : no duplicate MAC address
from this PVC

3HH-01016-AAAA-TCZZA Edition 03

Released

377

34 Current Alarm Status Commands

34.6 Alarm Current Ethernet Interface Status


Command
Command Description
This command shows the current Ethernet interface alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current ether-itf (index)

Command Parameters
Table 34.6-1 "Alarm Current Ethernet Interface Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.6-2 "Alarm Current Ethernet Interface Status Command" Display parameters
Specific Information
name
ether-ifindex
link-down

378

Type

Description

<Ether::InterfaceIndex>
range: [0...2147483647]
<Alarm::EtherLinkStatus>
Possible values are :
- yes : board switched off - excess
temperature
- no : board switched on

identify where the alarm has occurred.


This element is always shown.
specifies ethernet link status.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.7 Alarm Current Software Management Status


Command
Command Description
This command shows the software management alarm current status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current sw-mgmt (index)

Command Parameters
Table 34.7-1 "Alarm Current Software Management Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.7-2 "Alarm Current Software Management Status Command" Display parameters
Specific Information
name
nt-position

sw-rollback

db-rollback

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::SwRollback>
Possible values are :
- yes : implicit software rollback
performed
- no : no implicit software rollback
<Alarm::DbRollback>
Possible values are :
- yes : implicit database rollback
performed
- no : no implicit database rollback

identifies the physical position of the slot


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies implicit software rollback is performed or


not.
This element is always shown.
specifies implicit database rollback is performed or
not.
This element is always shown.

Released

379

34 Current Alarm Status Commands

34.8 Alarm Current xDSL Status Command


Command Description
This command displays the current xDSL alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current xdsl (index)

Command Parameters
Table 34.8-1 "Alarm Current xDSL Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.8-2 "Alarm Current xDSL Status Command" Display parameters
Specific Information
name
port

near-end-los

near-end-lof

near-end-lom

near-end-ese

380

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::NearEndLOS>
Possible values are :
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
<Alarm::NearEndLOF>
Possible values are :
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
<Alarm::NearEndLOM>
Possible values are :
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
<Alarm::NearEndESE>
Possible values are :

identifies the physical position of the port


This element is always shown.

Released

specifies near end loss of signal occured or not.


This element is only shown in detail mode.
specifies near end loss of frame occured or not.
This element is only shown in detail mode.
specifies near end loss of margin occured or not.
This element is only shown in detail mode.

specifies near end excessive server errors occured


or not.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name

line-config

line-capacity

near-end-bitrate

near-end-ncd

near-end-lcd

far-end-los

far-end-lof

far-end-lpr

far-end-lol

far-end-lom

far-end-ese

Type

Description

- occured : near end excessive server


errors occured
- not-occured : no near end excessive
server errors occured
<Alarm::LineConfig>
Possible values are :
- config-error : line configuration data
cannot be used
- config-ok : Line configuration data OK
<Alarm::LineCapacity>
Possible values are :
- below-requirement : line capacity not
enough to set up requested profile
- meets-requirement : line capacity enough
to set up requested profile
<Alarm::NearEndBRthres>
Possible values are :
- below-plan : upstream planned bitrate
not reached after initialization
- meets-plan : upstream planned bitrate
reached
<Alarm::NearEndNCD>
Possible values are :
- no-cell-deline : no near end cell
delineation
- cell-deline-occured : near end cell
delineation occured
<Alarm::NearEndLCD>
Possible values are :
- loss-of-cell-deline : loss of near end cell
deliniation
- no-loss-of-cell-deline : no loss of near
end cell deliniation
<Alarm::FarEndLOS>
Possible values are :
- occured : far end loss of signal occured
- not-occured : no far end loss of signal
<Alarm::FarEndLOF>
Possible values are :
- occured : far end loss of frame occured
- not-occured : no far end loss of frame
<Alarm::FarEndLPR>
Possible values are :
- detected : far end loss of power detected
- not-detected : no far end loss of power
<Alarm::FarEndLOL>
Possible values are :
- detected : far end loss of link detected
- not-detected : no far end loss of link
<Alarm::FarEndLOM>
Possible values are :
- occured : far end loss of margin occured
- not-occured : no far end loss of margin
<Alarm::FarEndESE>
Possible values are :
- occured : far end excessive server errors
occured

This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether line configuration data is used or


not.
This element is always shown.
specifies whether line capacity is set up or not.
This element is always shown.

specifies whether upstream planned bitrate reached


or not after initialization.
This element is only shown in detail mode.

specifies whether near end cell delineation is


occured or not.
This element is only shown in detail mode.

specifies whether loss of near end cell deliniation is


occured or not.
This element is only shown in detail mode.

specifies whether far end loss of signal occured or


not.
This element is only shown in detail mode.
specifies whether far end loss of frame occured or
not.
This element is only shown in detail mode.
specifies whether far end loss of power detected or
not.
This element is only shown in detail mode.
specifies whether far end loss of link detected or
not.
This element is only shown in detail mode.
specifies whether far end loss of margin occured or
not.
This element is only shown in detail mode.
specifies whether far end excessive server errors
occured or not.
This element is only shown in detail mode.

Released

381

34 Current Alarm Status Commands

name
xdsl-init

peer-modem

far-end-bitrate

far-end-ncd

far-end-lcd

382

Type
- not-occured : no far end excessive server
errors occured
<Alarm::Initialization>
Possible values are :
- failed : initialization unsuccessful due to
comminication problem
- successful : initialization successful
<Alarm::PeerModem>
Possible values are :
- not-detected : no peer modem detected
- detected : peer modem detected
<Alarm::FarEndBRthres>
Possible values are :
- below-plan : downstream planned bitrate
not reached after initialization
- meets-plan : downstream planned bitrate
reached
<Alarm::FarEndNCD>
Possible values are :
- no-cell-deline : no far end cell
delineation
- cell-deline-occured : far end cell
delineation occured
<Alarm::FarEndLCD>
Possible values are :
- loss-of-cell-deline : loss of far end cell
deliniation
- no-loss-of-cell-deline : no loss of far end
cell deliniation

Released

Description
specifies xdsl line initialization is successful or not.
This element is always shown.

specifies whether peer modem detected or not.


This element is always shown.
specifies whether downstream planned bitrate
reached or not.
This element is only shown in detail mode.

specifies whether far end cell delineation occured


or not.
This element is only shown in detail mode.

specifies there is loss of far end cell deliniation or


not.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.9 Alarm TCA-xDSL Log Status Command


Command Description
This command shows the xDSL threshold cross alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current tca-xdsl (index)

Command Parameters
Table 34.9-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.9-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name
port

errored-secs

es-in-a-day

severely-es

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::ErroredSeconds>
Possible values are :
- above-thres : number of errored seconds
exceeded threshold
- below-thres : number of errored seconds
below threshold
<Alarm::ErroredSecondsInAday>
Possible values are :
- above-thres : number of errored seconds
in a day, exceeded threshold
- below-thres : number of errored seconds
in a day, below threshold
<Alarm::SeverelyErroredSeconds>
Possible values are :
- above-thres : number of severely errored

identifies where the alarm occurred


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

number of errored seconds exceeded or below


threshold
This element is always shown.

errored seconds in a day exceeded or below


threshold
This element is always shown.

number of severely errored seconds exceeded or


below threshold
This element is only shown in detail mode.

Released

383

34 Current Alarm Status Commands

name

Type

severely-es-in-a-day

unavailable-secs

unavail-secs-in-a-day

far-end-es

fe-severely-es

fe-severely-es/day

fe-unavail-secs

fe-unavail-sec/day

fe-es-in-a-day

384

seconds exceeded threshold


- below-thres : number of severely errored
seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::UnavailableSeconds>
Possible values are :
- above-thres : number of unavailable
seconds exceeded threshold
- below-thres : number of unavailable
seconds below threshold
<Alarm::UnavailSecsInAday>
Possible values are :
- above-thres : number of unavailable
seconds in a day, exceeded threshold
- below-thres : number of unavailable
seconds in a day, below threshold
<Alarm::FarEndErroredSeconds>
Possible values are :
- above-thres : number of far end errored
seconds exceeded threshold
- below-thres : number of far end errored
seconds below threshold
<Alarm::FarEndSevErroredSecs>
Possible values are :
- above-thres : number of far end severely
errored seconds exceeded threshold
- below-thres : number of far end severely
errored seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::FarEndUnavailSecs>
Possible values are :
- above-thres : number of far end
unavailable seconds exceeded threshold
- below-thres : number of far end
unavailable seconds below threshold
<Alarm::FarEndUnavailSecsInAday>
Possible values are :
- above-thres : number of far end
unavailable seconds in a day, exceeded
threshold
- below-thres : number of far end
unavailable seconds in a day, below
threshold
<Alarm::FarEndErroredSecsInAday>
Possible values are :
- above-thres : number of far end errored
seconds in a day, exceeded threshold

Released

Description

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of unavailable seconds exceeded or below


threshold
This element is always shown.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is always shown.

number of far end errored seconds exceeded or


below threshold
This element is only shown in detail mode.

number of far end severely errored seconds


exceeded or below threshold
This element is only shown in detail mode.

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name

Type

Description

- below-thres : number of far end errored


seconds in a day, below threshold

3HH-01016-AAAA-TCZZA Edition 03

Released

385

34 Current Alarm Status Commands

34.10 Alarm Electrical to Optical Conversion Status


Command
Command Description
This command shows the electrical to optical conversion alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current eo-conversion (index)

Command Parameters
Table 34.10-1 "Alarm Electrical to Optical Conversion Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.10-2 "Alarm Electrical to Optical Conversion Status Command" Display parameters
Specific Information
name
port
loss-of-signal

transmission

386

Type

Description

<SignedInteger>

identifies where the alarm occurred.


This element is always shown.
<Alarm::EoConvLOS>
specifies whether loss of signal detected or not in
Possible values are :
the EO conversion module
- detected : loss of signal detected in the This element is always shown.
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
<Alarm::EoConvTx>
specifies whether transmission fault is occurred or
Possible values are :
not in the EO module
- faulty : transmission fault in the EO This element is always shown.
module
- ok : transmission OK

Released

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.11 Alarm Current Authentication Status


Command
Command Description
This command displays the authentication-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current authentication (index)

Command Parameters
Table 34.11-1 "Alarm Current Authentication Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.11-2 "Alarm Current Authentication Status Command" Display parameters
Specific Information
name
vrf-assignment

vlan-assignment

ip-addr-pool-assign

Type

Description

<Alarm::VRFassignment>
Possible values are :
- failed : failure to assign a VRF for a user
session
- successful : assigned a VRF for a user
session
<Alarm::VLANassignment>
Possible values are :
- failed : failure to assign a VLAN for a
user session
- successful : assigned a VLAN for a user
session
<Alarm::IPaddrPoolAssign>
Possible values are :
- failed : failure to assign IP address pool
for a user session
- successful : assigned IP address pool for
a user session

specifies whether VRF for a user session is


assigned or failed
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether a VLAN for a user session is


assigned or failed
This element is always shown.

specifies whether IP address pool for a user session


is assigned or failed
This element is always shown.

Released

387

34 Current Alarm Status Commands

name
qos-param-assign

ip-addr-assign

radius-pool-id

388

Type

Description

<Alarm::QOSparamAssign>
Possible values are :
- failed : failure to assign QOS parameters
for a user session
- successful : assigned QOS parameters for
a user session
<Alarm::IPaddrAssign>
Possible values are :
- failed : failure to assign IP address for a
user session
- successful : assigned IP address for a
user session
<Alarm::RADIUSpoolId>
Possible values are :
- not-specified : RADIUS server did not
specify a pool-id
- specified : RADIUS specified the pool-id

specifies whether QOS parameters for a user


session is assigned or failed
This element is always shown.

Released

specifies whether IP address for a user session is


assigned or failed
This element is always shown.

specifies whether pool-id is specified or not for a


RADIUS server.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.12 Alarm Current xDSL Bonding Status


Command
Command Description
This command displays the xDSL bonding-related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current bonding-group (index)

Command Parameters
Table 34.12-1 "Alarm Current xDSL Bonding Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.12-2 "Alarm Current xDSL Bonding Status Command" Display parameters
Specific Information
name
up-plan-bitrate

down-plan-bitrate

up-min-bitrate

Type

Description

<Alarm::UpPlannedBitrate>
Possible values are :
- reached-threshold : upstream planned
bitrate threshold reached
- not-reached : upstream planned bitrate
threshold not reached
<Alarm::DownPlanBitrate>
Possible values are :
- reached-threshold : downstream planned
bitrate threshold reached
- not-reached : downstream planned bitrate
threshold not reached
<Alarm::UpMinBitrate>
Possible values are :
- reached-threshold : upstream minimum
bitrate threshold reached
- not-reached : upstream minimum bitrate
threshold not reached

specifies whether the upstream planned bit rate is


reached threshold or not
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether the downstream planned bit rate


is reached threshold or not
This element is always shown.

specifies whether the upstream minimum bit rate is


reached threshold or not
This element is always shown.

Released

389

34 Current Alarm Status Commands

name
down-min-bitrate

up-config

down-config

390

Type

Description

<Alarm::DownMinBitrate>
Possible values are :
reached-threshold
:
downstream
minimum bitrate threshold reached
- not-reached : downstream minimum
bitrate threshold not reached
<Alarm::UpConfig>
Possible values are :
- not-feasible : upstream configuration not
feasible
- feasible : upstream configuration not
feasible
<Alarm::DownConfig>
Possible values are :
- not-feasible : downstream configuration
not feasible
- feasible : downstream configuration not
feasible

specifies whether the downstream minimum bit rate


is reached threshold or not
This element is only shown in detail mode.

Released

specifies whether the upstream configuraion is


feasible or not
This element is always shown.

specifies whether the downstream configuraion is


feasible or not
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

34.13 Alarm Redundancy Status Command


Command Description
This command displays the redundancy alarm logs generated.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current redundancy (index)

Command Parameters
Table 34.13-1 "Alarm Redundancy Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.13-2 "Alarm Redundancy Status Command" Display parameters
Specific Information
name
loss-swo-cap

Type

Description

<Alarm::SwoCap>
identify the switchover capability in a redundant
Possible values are :
system.
- loss : system loss of the swichover This element is always shown.
capability
- not-loss : system not loss of the
swichover capability

3HH-01016-AAAA-TCZZA Edition 03

Released

391

34 Current Alarm Status Commands

34.14 Alarm Custom Status Command


Command Description
This command displays the custom alarm logs generated.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm current custom (index)

Command Parameters
Table 34.14-1 "Alarm Custom Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 34.14-2 "Alarm Custom Status Command" Display parameters
Specific Information
name
custom-alarm1

custom-alarm2

custom-alarm3

custom-alarm4

392

Type

Description

<Alarm::custom1>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom2>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom3>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom4>
Possible values are :
- occured : Miscellaneous environment

identify the customizableAlarm1 .


This element is always shown.

Released

identify the customizableAlarm2 .


This element is always shown.

identify the customizableAlarm3 .


This element is always shown.

identify the customizableAlarm4 .


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

34 Current Alarm Status Commands

name

custom-alarm5

Type

Description

alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom5>
identify the customizableAlarm5 .
Possible values are :
This element is always shown.
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm

3HH-01016-AAAA-TCZZA Edition 03

Released

393

35- Alarm Snap-shot Status Commands

35.1 Alarm Snap-shot Status Command


35.2 Alarm Snap-shot Equipment Status Command
35.3 Alarm Equipment Holder Status Command
35.4 Alarm Plug In Unit Status Command
35.5 Alarm ATM Status Command
35.6 Alarm Snap-shot Ethernet Interface Status Command
35.7 Alarm Snap-shot Software Management Status
Command
35.8 Alarm xDSL Snap-shot Status Command
35.9 Alarm TCA-xDSL Log Status Command
35.10 Alarm Electrical to Optical Conversion for Snap-shot
35.11 Alarm Authentication Alarms for Snap-shot Status
Command
35.12 Alarm xDSL Bonding Snap Shot Status Command
35.13 Alarm IPoX Snap-shot Status Command
35.14 Alarm Redundancy Snap Shot Status Command
35.15 Alarm Custom Snap Shot Status Command

394

Released

35-395
35-398
35-399
35-401
35-403
35-405
35-406
35-407
35-410
35-413
35-414
35-416
35-418
35-419
35-420

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.1 Alarm Snap-shot Status Command


Command Description
This command displays the snap shot alarm entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot table (index)

Command Parameters
Table 35.1-1 "Alarm Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.1-2 "Alarm Snap-shot Status Command" Display parameters
Common Information
name
Type
timeout-period
entries
indeterminate

warning

minor

major

Description

<TimeTicks>

specifies the time out of the snapshot table


This element is always shown.
<Gauge>
specifies nbr of entries in the snapshot table.
This element is always shown.
<Alarm::IndetSevState>
active indeterminate severity levels of the alarms in
Possible values are :
the snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::WarnSevState>
active warning severity levels of the alarms in the
Possible values are :
snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::MinorSevState>
active minor severity levels of the alarms in the
Possible values are :
snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::MajorSevState>
active major severity levels of the alarms in the
Possible values are :
snapshot table.

3HH-01016-AAAA-TCZZA Edition 03

Released

395

35 Alarm Snap-shot Status Commands

name

critical

owner-id

Specific Information
name
type

last-updated-on

Type

Description

- active : at least one entry of this severity


is present
- not-active : no entries of this severity
<Alarm::CriticalSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::alarmSnapShotOwner>

This element is always shown.

Type

Description

entries
indeterminate

warning

minor

major

396

the actual owner of the snap-shot


This element is always shown.

<Alarm::alarmType>
unique id for an alarm.
Possible values are :
This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- redundancy : redundancy alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms
- xdsl-tca : xDSL threshold cross alarms
- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
- bonding : bonding-group related alarms
<Sys::Time>
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: general information


name
Type
timeout-period

active critical severity levels of the alarms in the


snapshot table.
This element is always shown.

Description

<TimeTicks>

specifies the time out of the snapshot table


This element is always shown.
<Gauge>
specifies nbr of entries in the snapshot table.
This element is always shown.
<Alarm::IndetSevState>
active indeterminate severity levels of the alarms in
Possible values are :
the snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::WarnSevState>
active warning severity levels of the alarms in the
Possible values are :
snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::MinorSevState>
active minor severity levels of the alarms in the
Possible values are :
snapshot table.
- active : at least one entry of this severity This element is always shown.
is present
- not-active : no entries of this severity
<Alarm::MajorSevState>
active major severity levels of the alarms in the
Possible values are :
snapshot table.
- active : at least one entry of this severity This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name
critical

owner-id

Type
is present
- not-active : no entries of this severity
<Alarm::CriticalSevState>
Possible values are :
- active : at least one entry of this severity
is present
- not-active : no entries of this severity
<Alarm::alarmSnapShotOwner>

3HH-01016-AAAA-TCZZA Edition 03

Description
active critical severity levels of the alarms in the
snapshot table.
This element is always shown.
the actual owner of the snap-shot
This element is always shown.

Released

397

35 Alarm Snap-shot Status Commands

35.2 Alarm Snap-shot Equipment Status Command


Command Description
This command shows the equipment snap shot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot equipment (index)

Command Parameters
Table 35.2-1 "Alarm Snap-shot Equipment Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.2-2 "Alarm Snap-shot Equipment Status Command" Display parameters
Specific Information
name
persist-data

sntp-comm

nt-disk

connection-lost

398

Type

Description

<Alarm::persistDataLoss>
Possible values are :
- lost : persistant data is lost
- not-lost : persistant data is not lost
<Alarm::sntpCommLoss>
Possible values are :
- lost : SNTP communication lost
- not-lost : SNTP communication is not
lost
<Alarm::ntDiskSpace>
Possible values are :
- ninty-perc-full : NT disk space is 90%
full
- less-than-ninty-perc : NT disk space
usage less that 90%
<Alarm::ShubLoc>
Possible values are :
- lost : NT shub communication lost
- not-lost : NT shub communication intact

current status specifing persistant data is lost or not


This element is always shown.

Released

current status of sntp communication is lost or not


This element is always shown.

current status of nt disk space is 90% full or less


than that
This element is always shown.

current status of nt shub communication is lost or


intact
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.3 Alarm Equipment Holder Status Command


Command Description
This command shows the snap shot equipment holder status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot eqpt-holder (index)

Command Parameters
Table 35.3-1 "Alarm Equipment Holder Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.3-2 "Alarm Equipment Holder Status Command" Display parameters
Specific Information
name
rack-power

fan-unit1

fan-unit2

shelf-type-mismatch

ext-chain-instl

Type

Description

<Alarm::rackPower>
Possible values are :
- fuse-broken : the fuse is broken
- fuse-ok : the fuse is intact
<Alarm::fanUnit1>
Possible values are :
- failing : fan unit 1 is failing
- ok : fan unit 1 is ok
<Alarm::fanUnit2>
Possible values are :
- failing : fan unit 2 is failing
- ok : fan unit 2 is ok
<Alarm::shelfTypeMismatch>
Possible values are :
- mismatch : installed and planned shelf
types are different
- no-mismatch : installed and planned
shelf types are the same
<Alarm::extChainInstl>
Possible values are :
- consistancy-problem : consistency

current status of rack power alarm, indicating fuse


is broken or intact
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

current status of fan-unit1


This element is always shown.
current status of fan-unit2
This element is always shown.
current status specifies installed and planned shelf
types are different
This element is always shown.

current alarm status of consistency problem


detected for installation of extension chain
This element is always shown.

Released

399

35 Alarm Snap-shot Status Commands

name

door

fuse

single-fan-fail

double-fan-fail

ac-power-fail

400

Type
problem detected for installation of
extension chain
- no-consistancy-problem : no consistancy
problem
<Alarm::door>
Possible values are :
- failing : the cabinet door is opened
- ok : the cabinet door is closed
<Alarm::fuse>
Possible values are :
- failing : the fuse is broken
- ok : the fuse works properly
<Alarm::singleFanFail>
Possible values are :
- failing : single fan failure
- ok : the fan works properly
<Alarm::doubleFanFail>
Possible values are :
- failing : double fan failure
- ok : the fans work properly
<Alarm::acPowerFail>
Possible values are :
- failing : system AC power fails
- ok : the system AC power works
properly

Released

Description

current status of door alarm, indicating the cabinet


door is opened
This element is always shown.
current status of fuse alarm, indicating the fuse is
broken
This element is always shown.
current status of single fan alarm, indicating the fan
is broken
This element is always shown.
current status of double fans alarm, indicating the
fans are broken
This element is always shown.
current status of AC power failure alarm, indicating
the AC Power is broken
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.4 Alarm Plug In Unit Status Command


Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot plug-in-unit (index)

Command Parameters
Table 35.4-1 "Alarm Plug In Unit Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.4-2 "Alarm Plug In Unit Status Command" Display parameters
Specific Information
name
board-position

board-mismatch

sw-download

temperature

temp-shutoff

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::boardMismatch>
Possible values are :
- yes : planned and plugged-in types are
different
- no : planned and plugged-in types are
same
<Alarm::swStatus>
Possible values are :
- waiting : not able to download all the
applicable SW files
- completed : download completed
<Alarm::tempStatus>
Possible values are :
- above-thres : temperature threshold on
board exceeded
- below-thres : board temperature within
threshold
<Alarm::tempShutoffStatus>

identify where the alarm has occurred.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

alarm specifing the planned and plugged-in types


are different
This element is always shown.

alarm specifing download of the software is


completed or not.
This element is always shown.
alarm specifing board temperature is crossed the
threshold or not.
This element is only shown in detail mode.

alarm specifing board is swiched off because of

Released

401

35 Alarm Snap-shot Status Commands

name

defense

board-present

board-inserted

board-init

number-of-resets

board-reset-cf

402

Type

Description

Possible values are :


- board-switched-off : board switched off excess temperature
- board-switched-on : board switched on
<Alarm::defenseAction>
Possible values are :
- board-disconnected : board disconnected
from system
- board-connected : board still connected
to system
<Alarm::boardPresence>
Possible values are :
- missing : board was present, but now
missing
- yes : board present
<Alarm::boardInsertion>
Possible values are :
- never-inserted : board was never inserted
- inserted : board was inserted
<Alarm::boardInit>
Possible values are :
- failed : board initialization failed
- completed : board initialization
completed
<Alarm::boardReset>
Possible values are :
- exceeded-threshold : board initialization
failed
- within-threshold : board initialization
completed
<Alarm::boardResetCommFail>
Possible values are :
- occurred : board reset/communication
failure occurred
- ok : no board reset/communication
failure

excess temperature.
This element is only shown in detail mode.

Released

indicates board is disconnected from the system or


not
This element is only shown in detail mode.

indicates the presence of the board.


This element is only shown in detail mode.

indicates the status of board was inserted or not.


This element is only shown in detail mode.
specifies board initializaion is sucessful or failed.
This element is only shown in detail mode.

specifies number of reset of board.


This element is only shown in detail mode.

indicates there has been a reset


communication failure of the board.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

and/or

35 Alarm Snap-shot Status Commands

35.5 Alarm ATM Status Command


Command Description
This command displays the ATM alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot atm (index)

Command Parameters
Table 35.5-1 "Alarm ATM Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.5-2 "Alarm ATM Status Command" Display parameters
Specific Information
name
port

vpi-vci
cell-discard-up

cell-discard-down

mac-conflict

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identify where the alarm has occurred.
<Eqpt::Slot> / <Eqpt::Port>
This element is always shown.
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::VpiVciValues>
identify where the alarm has occurred.
This element is always shown.
<Alarm::CellDiscardUpstream>
specifies ATM cell is discarded or not in upstream
Possible values are :
direction.
- discarded : ATM cell discarded in This element is always shown.
upstream direction
- no-discard : no ATM cell discarded in
upstream direction
<Alarm::CellDiscardDownstream>
specifies ATM cell is discarded or not in
Possible values are :
downstream direction.
- discarded : ATM cell discarded in This element is always shown.
downstream direction
- no-discard : no ATM cell discarded in
downstream direction
<Alarm::MACconflict>
specifies whether duplicate MAC address from the

3HH-01016-AAAA-TCZZA Edition 03

Released

403

35 Alarm Snap-shot Status Commands

name

Type

Description

Possible values are :


PVC is occurred or not.
- detected : duplicate MAC address from This element is always shown.
this PVC
- not-detected : no duplicate MAC address
from this PVC

404

Released

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.6 Alarm Snap-shot Ethernet Interface Status


Command
Command Description
This command shows the current Ethernet interface alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ether-itf (index)

Command Parameters
Table 35.6-1 "Alarm Snap-shot Ethernet Interface Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.6-2 "Alarm Snap-shot Ethernet Interface Status Command" Display parameters
Specific Information
name
ether-ifindex
link-down

Type

Description

<Ether::InterfaceIndex>
range: [0...2147483647]
<Alarm::EtherLinkStatus>
Possible values are :
- yes : board switched off - excess
temperature
- no : board switched on

identify where the alarm has occurred.


This element is always shown.
specifies ethernet link status.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

405

35 Alarm Snap-shot Status Commands

35.7 Alarm Snap-shot Software Management Status


Command
Command Description
This command shows the snap shot software management status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot sw-mgmt (index)

Command Parameters
Table 35.7-1 "Alarm Snap-shot Software Management Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.7-2 "Alarm Snap-shot Software Management Status Command" Display parameters
Specific Information
name
nt-position

sw-rollback

db-rollback

406

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Alarm::SwRollback>
Possible values are :
- yes : implicit software rollback
performed
- no : no implicit software rollback
<Alarm::DbRollback>
Possible values are :
- yes : implicit database rollback
performed
- no : no implicit database rollback

identifies the physical position of the slot


This element is always shown.

Released

specifies implicit software rollback is performed or


not.
This element is always shown.
specifies implicit database rollback is performed or
not.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.8 Alarm xDSL Snap-shot Status Command


Command Description
This command displays the status of the snap shot xDSL alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot xdsl (index)

Command Parameters
Table 35.8-1 "Alarm xDSL Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.8-2 "Alarm xDSL Snap-shot Status Command" Display parameters
Specific Information
name
port

near-end-los

near-end-lof

near-end-lom

near-end-ese

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::NearEndLOS>
Possible values are :
- occured : near end loss of signal occured
- not-occured : no near end loss of signal
<Alarm::NearEndLOF>
Possible values are :
- occured : near end loss of frame occured
- not-occured : no near end loss of frame
<Alarm::NearEndLOM>
Possible values are :
- occured : near end loss of margin
occured
- not-occured : no near end loss of margin
<Alarm::NearEndESE>
Possible values are :

identifies the physical position of the port


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies near end loss of signal occured or not.


This element is only shown in detail mode.
specifies near end loss of frame occured or not.
This element is only shown in detail mode.
specifies near end loss of margin occured or not.
This element is only shown in detail mode.

specifies near end excessive server errors occured


or not.

Released

407

35 Alarm Snap-shot Status Commands

name

line-config

line-capacity

near-end-bitrate

near-end-ncd

near-end-lcd

far-end-los

far-end-lof

far-end-lpr

far-end-lol

far-end-lom

far-end-ese

408

Type

Description

- occured : near end excessive server


errors occured
- not-occured : no near end excessive
server errors occured
<Alarm::LineConfig>
Possible values are :
- config-error : line configuration data
cannot be used
- config-ok : Line configuration data OK
<Alarm::LineCapacity>
Possible values are :
- below-requirement : line capacity not
enough to set up requested profile
- meets-requirement : line capacity enough
to set up requested profile
<Alarm::NearEndBRthres>
Possible values are :
- below-plan : upstream planned bitrate
not reached after initialization
- meets-plan : upstream planned bitrate
reached
<Alarm::NearEndNCD>
Possible values are :
- no-cell-deline : no near end cell
delineation
- cell-deline-occured : near end cell
delineation occured
<Alarm::NearEndLCD>
Possible values are :
- loss-of-cell-deline : loss of near end cell
deliniation
- no-loss-of-cell-deline : no loss of near
end cell deliniation
<Alarm::FarEndLOS>
Possible values are :
- occured : far end loss of signal occured
- not-occured : no far end loss of signal
<Alarm::FarEndLOF>
Possible values are :
- occured : far end loss of frame occured
- not-occured : no far end loss of frame
<Alarm::FarEndLPR>
Possible values are :
- detected : far end loss of power detected
- not-detected : no far end loss of power
<Alarm::FarEndLOL>
Possible values are :
- detected : far end loss of link detected
- not-detected : no far end loss of link
<Alarm::FarEndLOM>
Possible values are :
- occured : far end loss of margin occured
- not-occured : no far end loss of margin
<Alarm::FarEndESE>
Possible values are :
- occured : far end excessive server errors
occured

This element is only shown in detail mode.

Released

specifies whether line configuration data is used or


not.
This element is always shown.
specifies whether line capacity is set up or not.
This element is always shown.

specifies whether upstream planned bitrate reached


or not after initialization.
This element is only shown in detail mode.

specifies whether near end cell delineation is


occured or not.
This element is only shown in detail mode.

specifies whether loss of near end cell deliniation is


occured or not.
This element is only shown in detail mode.

specifies whether far end loss of signal occured or


not.
This element is only shown in detail mode.
specifies whether far end loss of frame occured or
not.
This element is only shown in detail mode.
specifies whether far end loss of power detected or
not.
This element is only shown in detail mode.
specifies whether far end loss of link detected or
not.
This element is only shown in detail mode.
specifies whether far end loss of margin occured or
not.
This element is only shown in detail mode.
specifies whether far end excessive server errors
occured or not.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name
xdsl-init

peer-modem

far-end-bitrate

far-end-ncd

far-end-lcd

Type
- not-occured : no far end excessive server
errors occured
<Alarm::Initialization>
Possible values are :
- failed : initialization unsuccessful due to
comminication problem
- successful : initialization successful
<Alarm::PeerModem>
Possible values are :
- not-detected : no peer modem detected
- detected : peer modem detected
<Alarm::FarEndBRthres>
Possible values are :
- below-plan : downstream planned bitrate
not reached after initialization
- meets-plan : downstream planned bitrate
reached
<Alarm::FarEndNCD>
Possible values are :
- no-cell-deline : no far end cell
delineation
- cell-deline-occured : far end cell
delineation occured
<Alarm::FarEndLCD>
Possible values are :
- loss-of-cell-deline : loss of far end cell
deliniation
- no-loss-of-cell-deline : no loss of far end
cell deliniation

3HH-01016-AAAA-TCZZA Edition 03

Description
specifies xdsl line initialization is successful or not.
This element is always shown.

specifies whether peer modem detected or not.


This element is always shown.
specifies whether downstream planned bitrate
reached or not.
This element is only shown in detail mode.

specifies whether far end cell delineation occured


or not.
This element is only shown in detail mode.

specifies there is loss of far end cell deliniation or


not.
This element is only shown in detail mode.

Released

409

35 Alarm Snap-shot Status Commands

35.9 Alarm TCA-xDSL Log Status Command


Command Description
This command shows the xDSL threshold cross alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot tca-xdsl (index)

Command Parameters
Table 35.9-1 "Alarm TCA-xDSL Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.9-2 "Alarm TCA-xDSL Log Status Command" Display parameters
Specific Information
name
port

errored-secs

es-in-a-day

severely-es

410

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::Slot> / <Eqpt::Port>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>=
range:
[1...21]/
<Eqpt::Port>= range: [1...48]
<Alarm::ErroredSeconds>
Possible values are :
- above-thres : number of errored seconds
exceeded threshold
- below-thres : number of errored seconds
below threshold
<Alarm::ErroredSecondsInAday>
Possible values are :
- above-thres : number of errored seconds
in a day, exceeded threshold
- below-thres : number of errored seconds
in a day, below threshold
<Alarm::SeverelyErroredSeconds>
Possible values are :
- above-thres : number of severely errored

identifies where the alarm occurred


This element is always shown.

Released

number of errored seconds exceeded or below


threshold
This element is always shown.

errored seconds in a day exceeded or below


threshold
This element is always shown.

number of severely errored seconds exceeded or


below threshold
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name

severely-es-in-a-day

unavailable-secs

unavail-secs-in-a-day

far-end-es

fe-severely-es

fe-severely-es/day

fe-unavail-secs

fe-unavail-sec/day

fe-es-in-a-day

Type
seconds exceeded threshold
- below-thres : number of severely errored
seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::UnavailableSeconds>
Possible values are :
- above-thres : number of unavailable
seconds exceeded threshold
- below-thres : number of unavailable
seconds below threshold
<Alarm::UnavailSecsInAday>
Possible values are :
- above-thres : number of unavailable
seconds in a day, exceeded threshold
- below-thres : number of unavailable
seconds in a day, below threshold
<Alarm::FarEndErroredSeconds>
Possible values are :
- above-thres : number of far end errored
seconds exceeded threshold
- below-thres : number of far end errored
seconds below threshold
<Alarm::FarEndSevErroredSecs>
Possible values are :
- above-thres : number of far end severely
errored seconds exceeded threshold
- below-thres : number of far end severely
errored seconds below threshold
<Alarm::SevErroredSecsInAday>
Possible values are :
- above-thres : number of severely errored
seconds in a day, exceeded threshold
- below-thres : number of severely errored
seconds in a day, below threshold
<Alarm::FarEndUnavailSecs>
Possible values are :
- above-thres : number of far end
unavailable seconds exceeded threshold
- below-thres : number of far end
unavailable seconds below threshold
<Alarm::FarEndUnavailSecsInAday>
Possible values are :
- above-thres : number of far end
unavailable seconds in a day, exceeded
threshold
- below-thres : number of far end
unavailable seconds in a day, below
threshold
<Alarm::FarEndErroredSecsInAday>
Possible values are :
- above-thres : number of far end errored
seconds in a day, exceeded threshold

3HH-01016-AAAA-TCZZA Edition 03

Description

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of unavailable seconds exceeded or below


threshold
This element is always shown.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is always shown.

number of far end errored seconds exceeded or


below threshold
This element is only shown in detail mode.

number of far end severely errored seconds


exceeded or below threshold
This element is only shown in detail mode.

number of severely errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end unavailable seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

number of far end errored seconds in a day,


exceeded or below threshold
This element is only shown in detail mode.

Released

411

35 Alarm Snap-shot Status Commands

name

Type

Description

- below-thres : number of far end errored


seconds in a day, below threshold

412

Released

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.10 Alarm Electrical to Optical Conversion for


Snap-shot
Command Description
This command shows the electrical to optical conversion alarm log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot eo-conversion (index)

Command Parameters
Table 35.10-1 "Alarm Electrical to Optical Conversion for Snap-shot" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.10-2 "Alarm Electrical to Optical Conversion for Snap-shot" Display parameters
Specific Information
name
loss-of-signal

transmission

Type

Description

<Alarm::EoConvLOS>
Possible values are :
- detected : loss of signal detected in the
EO conversion module
- not-detected : no loss of signal detected
in the EO conversion module
<Alarm::EoConvTx>
Possible values are :
- faulty : transmission fault in the EO
module
- ok : transmission OK

specifies whether loss of signal detected or not in


the EO conversion module
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether transmission fault is occurred or


not in the EO module
This element is always shown.

Released

413

35 Alarm Snap-shot Status Commands

35.11 Alarm Authentication Alarms for Snap-shot


Status Command
Command Description
This command displays the authentication-related alarm status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot authentication (index)

Command Parameters
Table 35.11-1 "Alarm Authentication Alarms for Snap-shot Status Command" Resource
Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.11-2 "Alarm Authentication Alarms for Snap-shot Status Command" Display parameters
Specific Information
name
vrf-assignment

vlan-assignment

ip-addr-pool-assign

414

Type

Description

<Alarm::VRFassignment>
Possible values are :
- failed : failure to assign a VRF for a user
session
- successful : assigned a VRF for a user
session
<Alarm::VLANassignment>
Possible values are :
- failed : failure to assign a VLAN for a
user session
- successful : assigned a VLAN for a user
session
<Alarm::IPaddrPoolAssign>
Possible values are :
- failed : failure to assign IP address pool
for a user session
- successful : assigned IP address pool for

specifies whether VRF for a user session is


assigned or failed
This element is always shown.

Released

specifies whether a VLAN for a user session is


assigned or failed
This element is always shown.

specifies whether IP address pool for a user session


is assigned or failed
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name
qos-param-assign

ip-addr-assign

radius-pool-id

Type
a user session
<Alarm::QOSparamAssign>
Possible values are :
- failed : failure to assign QOS parameters
for a user session
- successful : assigned QOS parameters for
a user session
<Alarm::IPaddrAssign>
Possible values are :
- failed : failure to assign IP address for a
user session
- successful : assigned IP address for a
user session
<Alarm::RADIUSpoolId>
Possible values are :
- not-specified : RADIUS server did not
specify a pool-id
- specified : RADIUS specified the pool-id

3HH-01016-AAAA-TCZZA Edition 03

Description
specifies whether QOS parameters for a user
session is assigned or failed
This element is always shown.

specifies whether IP address for a user session is


assigned or failed
This element is always shown.

specifies whether pool-id is specified or not for a


RADIUS server.
This element is always shown.

Released

415

35 Alarm Snap-shot Status Commands

35.12 Alarm xDSL Bonding Snap Shot Status


Command
Command Description
This command displays the alarms of the xDSL bonding snap shot.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot bonding-group (index)

Command Parameters
Table 35.12-1 "Alarm xDSL Bonding Snap Shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.12-2 "Alarm xDSL Bonding Snap Shot Status Command" Display parameters
Specific Information
name
up-plan-bitrate

down-plan-bitrate

up-min-bitrate

416

Type

Description

<Alarm::UpPlannedBitrate>
Possible values are :
- reached-threshold : upstream planned
bitrate threshold reached
- not-reached : upstream planned bitrate
threshold not reached
<Alarm::DownPlanBitrate>
Possible values are :
- reached-threshold : downstream planned
bitrate threshold reached
- not-reached : downstream planned bitrate
threshold not reached
<Alarm::UpMinBitrate>
Possible values are :
- reached-threshold : upstream minimum
bitrate threshold reached
- not-reached : upstream minimum bitrate
threshold not reached

specifies whether the group upstream planned bit


rate is reached threshold or not
This element is always shown.

Released

specifies whether the downstream planned bit rate


is reached threshold or not
This element is always shown.

specifies whether the upstream minimum bit rate is


reached threshold or not
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name
down-min-bitrate

up-config

down-config

Type

Description

<Alarm::DownMinBitrate>
Possible values are :
reached-threshold
:
downstream
minimum bitrate threshold reached
- not-reached : downstream minimum
bitrate threshold not reached
<Alarm::UpConfig>
Possible values are :
- not-feasible : upstream configuration not
feasible
- feasible : upstream configuration not
feasible
<Alarm::DownConfig>
Possible values are :
- not-feasible : downstream configuration
not feasible
- feasible : downstream configuration not
feasible

specifies whether the downstream minimum bit rate


is reached threshold or not
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether the upstream configuraion is


feasible or not
This element is always shown.

specifies whether the downstream configuraion is


feasible or not
This element is only shown in detail mode.

Released

417

35 Alarm Snap-shot Status Commands

35.13 Alarm IPoX Snap-shot Status Command


Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot ipox (index)

Command Parameters
Table 35.13-1 "Alarm IPoX Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.13-2 "Alarm IPoX Snap-shot Status Command" Display parameters
Specific Information
name
ip-addr-pool

418

Type
<Alarm::IPAddrPoolPreempt>
Possible values are :
- preempted : the ip addr pool on
DHCP server and the local pool
preempted
- no-preempt : the ip addr pool on
DHCP server and the local pool are
preempted

Released

Description
specifies whether the ip addr pool on the DHCP
server and the local pool are preempted or not
the This element is always shown.
are
the
not

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

35.14 Alarm Redundancy Snap Shot Status


Command
Command Description
This command displays the redundancy's Snap Shot related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot redundancy (index)

Command Parameters
Table 35.14-1 "Alarm Redundancy Snap Shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.14-2 "Alarm Redundancy Snap Shot Status Command" Display parameters
Specific Information
name
loss-swo-cap

Type

Description

<Alarm::SwoCap>
identify the switchover capability in a redundant
Possible values are :
system.
- loss : system loss of the swichover This element is always shown.
capability
- not-loss : system not loss of the
swichover capability

3HH-01016-AAAA-TCZZA Edition 03

Released

419

35 Alarm Snap-shot Status Commands

35.15 Alarm Custom Snap Shot Status Command


Command Description
This command displays the custom's Snap Shot related alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm snap-shot custom (index)

Command Parameters
Table 35.15-1 "Alarm Custom Snap Shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 35.15-2 "Alarm Custom Snap Shot Status Command" Display parameters
Specific Information
name
custom-alarm1

custom-alarm2

custom-alarm3

custom-alarm4

420

Type

Description

<Alarm::custom1>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom2>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom3>
Possible values are :
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom4>
Possible values are :
- occured : Miscellaneous environment

identify the customizableAlarm1 .


This element is always shown.

Released

identify the customizableAlarm2 .


This element is always shown.

identify the customizableAlarm3 .


This element is always shown.

identify the customizableAlarm4 .


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

35 Alarm Snap-shot Status Commands

name

custom-alarm5

Type

Description

alarm
- not-occured : no Miscellaneous
environment alarm
<Alarm::custom5>
identify the customizableAlarm5 .
Possible values are :
This element is always shown.
- occured : Miscellaneous environment
alarm
- not-occured : no Miscellaneous
environment alarm

3HH-01016-AAAA-TCZZA Edition 03

Released

421

36- Alarm Delta Log Status Commands

36.1 Alarm Generic Delta Alarm Log Status Command


36.2 Alarm Indeterminate Delta Alarm Log Status
Command
36.3 Alarm Warning Delta Alarm Log Status Command
36.4 Alarm Minor Delta Alarm Log Status Command
36.5 Alarm Major Delta Alarm Log Status Command
36.6 Alarm Critical Delta Alarm Log Status Command

422

Released

36-423
36-424
36-428
36-432
36-436
36-440

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

36.1 Alarm Generic Delta Alarm Log Status


Command
Command Description
This command displays common values related to the delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log alarm-changes

Command Output
Table 36.1-2 "Alarm Generic Delta Alarm Log Status Command" Display parameters
Specific Information
name

Type

Description

all

<Counter>

indeterminate

<Counter>

warning

<Counter>

minor

<Counter>

major

<Counter>

critical

<Counter>

total number of changes of all alarms since startup


and is independent of the alarm severity level.
This element is always shown.
total number of changes of all alarms with a
severity level indeterminate since startup.
This element is always shown.
total number of changes of all alarms with a
severity level warning since startup.
This element is always shown.
total number of changes of all alarms with a
severity level minor since startup.
This element is always shown.
total number of changes of all alarms with a
severity level major since startup.
This element is always shown.
total number of changes of all alarms with a
severity level critical since startup.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

423

36 Alarm Delta Log Status Commands

36.2 Alarm Indeterminate Delta Alarm Log Status


Command
Command Description
This command displays indeterminate values related to delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log indeterminate (index)

Command Parameters
Table 36.2-1 "Alarm Indeterminate Delta Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

delta log alarm table index

Command Output
Table 36.2-2 "Alarm Indeterminate Delta Alarm Log Status Command" Display parameters
Specific Information
name
type

424

Type

Description

<Alarm::alarmIndex>
unique id for an alarm.
Possible values are :
This element is always shown.
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

Type

Description

- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min


- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- auto-fetch-failure : not able to fetch file
from specified server
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction

3HH-01016-AAAA-TCZZA Edition 03

Released

425

36 Alarm Delta Log Status Commands

name

Type

Description

- cell-discard-down : cell discarded in the


downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption

426

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

state

last-updated-on

Type
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system
<Alarm::AlarmState>
Possible values are :
- active : alarm is active
- non-active : alarm is not active
<Sys::Time>

Description

reflect's the state of the alarm as either active or


non-active.
This element is always shown.
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: indeterminate alarm table related generic information


name
Type
Description
total-changes

<Counter>

last-entry-id

<SignedInteger>

last-reset

<Sys::Time>
unit: UTC

log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

total number of changes of all alarms with a


severity level indeterminate since startup.
This element is always shown.
last entry that was added to the indeterminate delta
log.
This element is always shown.
network time in seconds indicating when the
indeterminate delta log was last reset.
This element is always shown.
specifies whether the indeterminate delta log is
overflowed or not.
This element is always shown.

Released

427

36 Alarm Delta Log Status Commands

36.3 Alarm Warning Delta Alarm Log Status


Command
Command Description
This command displays warning values related to delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log warning (index)

Command Parameters
Table 36.3-1 "Alarm Warning Delta Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

delta log alarm table index

Command Output
Table 36.3-2 "Alarm Warning Delta Alarm Log Status Command" Display parameters
Specific Information
name
type

428

Type

Description

<Alarm::alarmIndex>
unique id for an alarm.
Possible values are :
This element is always shown.
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

Type

Description

- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min


- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- auto-fetch-failure : not able to fetch file
from specified server
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction

3HH-01016-AAAA-TCZZA Edition 03

Released

429

36 Alarm Delta Log Status Commands

name

Type

Description

- cell-discard-down : cell discarded in the


downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption

430

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

state

last-updated-on

Type
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system
<Alarm::AlarmState>
Possible values are :
- active : alarm is active
- non-active : alarm is not active
<Sys::Time>

Description

reflect's the state of the alarm as either active or


non-active.
This element is always shown.
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: warning alarm table related generic information


name
Type
Description
changes

<Counter>

last-entry-id

<SignedInteger>

last-reset

<Sys::Time>
unit: UTC

log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

total number of changes of all alarms with a


severity level warning since startup.
This element is always shown.
last entry that was added to the warning delta log.
This element is always shown.
network time in seconds indicating when the
warning delta log was last reset.
This element is always shown.
specifies whether the warning delta log is
overflowed or not.
This element is always shown.

Released

431

36 Alarm Delta Log Status Commands

36.4 Alarm Minor Delta Alarm Log Status


Command
Command Description
This command displays minor values related to delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log minor (index)

Command Parameters
Table 36.4-1 "Alarm Minor Delta Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

delta log alarm table index

Command Output
Table 36.4-2 "Alarm Minor Delta Alarm Log Status Command" Display parameters
Specific Information
name
type

432

Type

Description

<Alarm::alarmIndex>
unique id for an alarm.
Possible values are :
This element is always shown.
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

Type

Description

- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min


- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- auto-fetch-failure : not able to fetch file
from specified server
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction

3HH-01016-AAAA-TCZZA Edition 03

Released

433

36 Alarm Delta Log Status Commands

name

Type

Description

- cell-discard-down : cell discarded in the


downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption

434

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

state

last-updated-on

Type
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system
<Alarm::AlarmState>
Possible values are :
- active : alarm is active
- non-active : alarm is not active
<Sys::Time>

Description

reflect's the state of the alarm as either active or


non-active.
This element is always shown.
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: minor alarm table related generic information


name
Type
Description
changes

<Counter>

last-entry-id

<SignedInteger>

last-reset

<Sys::Time>
unit: UTC

log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

total number of changes of all alarms with a


severity level minor since startup.
This element is always shown.
last entry that was added to the minor delta log.
This element is always shown.
network time in seconds indicating when the minor
delta log was last reset.
This element is always shown.
specifies whether the minor delta log is overflowed
or not.
This element is always shown.

Released

435

36 Alarm Delta Log Status Commands

36.5 Alarm Major Delta Alarm Log Status Command


Command Description
This command displays major values related to delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log major (index)

Command Parameters
Table 36.5-1 "Alarm Major Delta Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

delta log alarm table index

Command Output
Table 36.5-2 "Alarm Major Delta Alarm Log Status Command" Display parameters
Specific Information
name
type

436

Type

Description

<Alarm::alarmIndex>
unique id for an alarm.
Possible values are :
This element is always shown.
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day
- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min
- xtca-fe-ses : xdsl far end TCA alarm -

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

Type

Description

severely errored secs in 15 min


- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- auto-fetch-failure : not able to fetch file
from specified server
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction
- cell-discard-down : cell discarded in the
downstream direction
- mac-conflict : duplcate mac addess from

3HH-01016-AAAA-TCZZA Edition 03

Released

437

36 Alarm Delta Log Status Commands

name

Type

Description

this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below

438

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

state

last-updated-on

Type
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system
<Alarm::AlarmState>
Possible values are :
- active : alarm is active
- non-active : alarm is not active
<Sys::Time>

Description

reflect's the state of the alarm as either active or


non-active.
This element is always shown.
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: major alarm table related generic information


name
Type
Description
changes

<Counter>

last-entry-id

<SignedInteger>

last-reset

<Sys::Time>
unit: UTC

log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

total number of changes of all alarms with a


severity level major since startup.
This element is always shown.
last entry that was added to the major delta log.
This element is always shown.
network time in seconds indicating when the major
delta log was last reset.
This element is always shown.
specifies whether the major delta log is overflowed
or not.
This element is always shown.

Released

439

36 Alarm Delta Log Status Commands

36.6 Alarm Critical Delta Alarm Log Status


Command
Command Description
This command displays critical values related to delta log alarm.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm delta-log critical (index)

Command Parameters
Table 36.6-1 "Alarm Critical Delta Alarm Log Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

delta log alarm table index

Command Output
Table 36.6-2 "Alarm Critical Delta Alarm Log Status Command" Display parameters
Specific Information
name
type

440

Type

Description

<Alarm::alarmIndex>
unique id for an alarm.
Possible values are :
This element is always shown.
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

Type

Description

- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min


- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day
- xdsl-ne-los : xdsl near end - loss of
signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- auto-fetch-failure : not able to fetch file
from specified server
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction

3HH-01016-AAAA-TCZZA Edition 03

Released

441

36 Alarm Delta Log Status Commands

name

Type

Description

- cell-discard-down : cell discarded in the


downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different
from planned type
- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption

442

Released

3HH-01016-AAAA-TCZZA

Edition 03

36 Alarm Delta Log Status Commands

name

state

last-updated-on

Type
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1
- custom2 : customizable alarm 2
- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system
<Alarm::AlarmState>
Possible values are :
- active : alarm is active
- non-active : alarm is not active
<Sys::Time>

Description

reflect's the state of the alarm as either active or


non-active.
This element is always shown.
network time in seconds when the alarm was
logged.
This element is always shown.

Only Show Details: critical alarm table related generic information


name
Type
Description
changes

<Counter>

last-entry-id

<SignedInteger>

last-reset

<Sys::Time>
unit: UTC

log-overflowed

<Alarm::OverflowStatus>
Possible values are :
- yes : buffer has overflowed
- no : no buffer overflow

3HH-01016-AAAA-TCZZA Edition 03

total number of changes of all alarms with a


severity level warning since startup.
This element is always shown.
last entry that was added to the warning delta log.
This element is always shown.
network time in seconds indicating when the
warning delta log was last reset.
This element is always shown.
specifies whether the warning delta log is
overflowed or not.
This element is always shown.

Released

443

37- SHub Alarm Status Command

37.1 SHub Alarm Current Status Command


37.2 SHub Alarm Current Equipment Status Command
37.3 SHub Alarm Current Ethernet Interface Status
Command
37.4 SHub Alarm Snap-shot Status Command
37.5 SHub Alarm Equipment Snap-shot Status Command
37.6 SHub Alarm Snap-shot Ethernet Interface Status
Command
37.7 SHub Alarm RIP Snap-shot Status Command
37.8 SHub Alarm OSPF Snap-shot Status Command
37.9 SHub Alarm Uplink group Snap-shot Status
Command
37.10 SHub Alarm Delta-Log Changes Status Command
37.11 SHub Alarm Entries Status Command

444

Released

37-445
37-447
37-449
37-450
37-452
37-454
37-455
37-456
37-458
37-459
37-460

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

37.1 SHub Alarm Current Status Command


Command Description
This command displays all the possible alarms at the agent. There is an entry for each alarm. Each entry consists
of an index for the table, alarm id, alarm category, alarm On/Off thresholds and timebases, and an alarm logging
mode. The severity, reporting, and logging are manageable objects for the SNMP Manager.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub current table (index)

Command Parameters
Table 37.1-1 "SHub Alarm Current Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 37.1-2 "SHub Alarm Current Status Command" Display parameters
Common Information
name
Type
changes

<Counter>

entries

<Gauge>

Specific Information
name
type

Type

Description
the number of changes that have occurred at the
current alarm table since startup.
This element is always shown.
the number of entries in the current alarm table.
This element is always shown.

Description

<Alarm::alarmType>
specifies the type of the alarm
Possible values are :
This element is always shown.
- equipment : equipment alarms
- eqpt-holder : equipment holder alarms
- plugin-unit : plugin unit alarms
- atm : ATM alarms
- custom : customizable alarms
- redundancy : redundancy alarms
- ether-itf : ethernet interface alarms
- software-mngt : software management
alarms
- xdsl : xDSL alarms

3HH-01016-AAAA-TCZZA Edition 03

Released

445

37 SHub Alarm Status Command

name

status
last-updated-on

additional-info

Type

Description

- xdsl-tca : xDSL threshold cross alarms


- eo-conv : E/O conversion related alarms
- authentication : authentication related
alarms
- bonding : bonding-group related alarms
<UnsignedInteger>
defines the status of alarms in an alarm type at the
time the snapshot was taken.
This element is always shown.
<Sys::Time>
gives the time information in seconds elapsed since
the 1st January 1970, when the entry was
updated/added.
This element is always shown.
<Alarm::AdditionalInfo>
specifies some additional information about the
length: x<512
considered table entry.
This element is always shown.

Only Show Details: number of changes since start up and number of entires in the table
name
Type
Description

446

changes

<Counter>

entries

<Gauge>

Released

the number of changes that have occurred at the


current alarm table since startup.
This element is always shown.
the number of entries in the current alarm table.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

37.2 SHub Alarm Current Equipment Status


Command
Command Description
This command shows the log generated for equipment-related persistent-data (data that is stored on the system's
data disk and that survives power failures and system resets), sntp-communication, nt-disk, and
shub-communication alarms. The log also gives the previous status of these alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub current equipment (index)

Command Parameters
Table 37.2-1 "SHub Alarm Current Equipment Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm type

Command Output
Table 37.2-2 "SHub Alarm Current Equipment Status Command" Display parameters
Specific Information
name
fan

power-fan

db-restore

emergency-reboot

Type

Description

<Alarm::ShubFanState>
Possible values are :
- failed : fan unit falied
- working : fan unit OK
<Alarm::ShubPowerFanState>
Possible values are :
- failed : power fan unit falied
- working : power fan unit OK
<Alarm::ShubDBrestore>
Possible values are :
- failed : DB restore falied
- successful : DB restore successful
<Alarm::ShubEmergencyRebbot>
Possible values are :
- occured : shub has rebooted from
emergency boot package

specifies whether the fan-unit is failed or not.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether the power fan unit is failed or


not.
This element is always shown.
specifies whether the DB restore is successful or
not.
This element is always shown.
status of shub reboot from emergency boot package
This element is always shown.

Released

447

37 SHub Alarm Status Command

name
sntp-comm

448

Type

Description

- not-occured : no shub reboot


<Alarm::ShubSNTPcommLoss>
status of shub - SNTP server communication
Possible values are :
This element is always shown.
- lost : SNTP server not responding to
shub messages
- ok : SNTP - shub communication OK

Released

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

37.3 SHub Alarm Current Ethernet Interface Status


Command
Command Description
This command displays whether or not the Ethernet interface link status has gone down. This command also shows
the previous status which allows the operator to see whether the link has gone down previously.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub current ethernet (index)

Command Parameters
Table 37.3-1 "SHub Alarm Current Ethernet Interface Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.3-2 "SHub Alarm Current Ethernet Interface Status Command" Display parameters
Specific Information
name
port-number
link-down

mac-conflict

Type

Description

<Alarm::ShubPortNumber>
range: [1...24]
<Alarm::ShubLinkDown>
Possible values are :
- yes : fan unit falied
- no : fan unit OK
<Alarm::ShubMACconflict>
Possible values are :
- yes : duplicate MAC address from
ethernet port of LAN switch
- no : no duplciate MAC address

port number of the shub


This element is always shown.
specifies whether the shub link is down or not.
This element is always shown.
specifies whether there is a duplicate MAC address
from the ethernet port of LAN switch.
This element is always shown.

Only Show Details: vlan id - applicable only in case of mac conflict


name
Type
Description
vlan-id

<SignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

identify where the alarm occurred


This element is only shown in detail mode.

Released

449

37 SHub Alarm Status Command

37.4 SHub Alarm Snap-shot Status Command


Command Description
This command displays the SHub snap shot table.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot table (index)

Command Parameters
Table 37.4-1 "SHub Alarm Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.4-2 "SHub Alarm Snap-shot Status Command" Display parameters
Common Information
name
Type
timeout-period

<TimeTicks>

entries

<Gauge>

owner-id

<Alarm::alarmSnapShotOwner>

Specific Information
name
type

last-updated-on

450

Type

Description
specifies the time out of the snapshot table
This element is always shown.
specifies nbr of entries inthe snapshot table, when
table status is in-use.
This element is always shown.
the actual owner of the snap-shot
This element is always shown.

Description

<Alarm::ShubAlarmType>
specifies the type of the alarm
Possible values are :
This element is always shown.
- shub-gen : general shub related alarms
- eth-shub : alarms related with the
ethernet interface
- ospf : alarms related with OSPF routing
protocol
- rip : alarms related with RIP routing
protocol
- uplink-group : alarms related with uplink
group
<Sys::Time>
gives the time information in seconds elapsed since

Released

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

name

additional-info

Type

<Alarm::AdditionalInfo>
length: x<512

Only Show Details: common


name
Type
timeout-period

<TimeTicks>

entries

<Gauge>

owner-id

<Alarm::alarmSnapShotOwner>

3HH-01016-AAAA-TCZZA Edition 03

Description
the 1st January 1970, when the entry was
updated/added.
This element is always shown.
specifies some additional information about the
considered table entry.
This element is always shown.

Description
specifies the time out of the snapshot table
This element is always shown.
specifies nbr of entries inthe snapshot table, when
table status is in-use.
This element is always shown.
the actual owner of the snap-shot
This element is always shown.

Released

451

37 SHub Alarm Status Command

37.5 SHub Alarm Equipment Snap-shot Status


Command
Command Description
This command shows the log generated for equipment-related persistent-data (data that is stored on the system's
data disk and that survives power failures and system resets), sntp-communication, nt-disk, and communication
alarms. The log also gives the previous status of the alarms.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot shub-gen (index)

Command Parameters
Table 37.5-1 "SHub Alarm Equipment Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.5-2 "SHub Alarm Equipment Snap-shot Status Command" Display parameters
Specific Information
name
fan

power-fan

db-restore

emergency-reboot

452

Type

Description

<Alarm::ShubFanState>
Possible values are :
- failed : fan unit falied
- working : fan unit OK
<Alarm::ShubPowerFanState>
Possible values are :
- failed : power fan unit falied
- working : power fan unit OK
<Alarm::ShubDBrestore>
Possible values are :
- failed : DB restore falied
- successful : DB restore successful
<Alarm::ShubEmergencyRebbot>
Possible values are :
- occured : shub has rebooted from
emergency boot package

specifies whether the fan-unit is failed or not.


This element is always shown.

Released

specifies whether the power fan unit is failed or


not.
This element is always shown.
specifies whether the DB restore is successful or
not.
This element is always shown.
status of shub reboot from emergency boot package
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

name
sntp-comm

arp-reply

vrf-id
next-hop

Type

Description

- not-occured : no shub reboot


<Alarm::ShubSNTPcommLoss>
status of shub - SNTP server communication
Possible values are :
This element is always shown.
- lost : SNTP server not responding to
shub messages
- ok : SNTP - shub communication OK
<Alarm::ShubArpReply>
status of the arp relay
Possible values are :
This element is always shown.
- not-ok : arp reply is not there
- ok : arp reply
<SignedInteger>
specifies where the alarm has occurred.
This element is only shown in detail mode.
<Alarm::NextHopIpAddr>
IP address of the next hop.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

453

37 SHub Alarm Status Command

37.6 SHub Alarm Snap-shot Ethernet Interface


Status Command
Command Description
This command displays whether or not the Ethernet interface link status has gone down. This command also shows
the previous status which allows the operator to see whether the link has gone down previously.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot eth-shub (index)

Command Parameters
Table 37.6-1 "SHub Alarm Snap-shot Ethernet Interface Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.6-2 "SHub Alarm Snap-shot Ethernet Interface Status Command" Display parameters
Specific Information
name
port-number
link-down

mac-conflict

vlan-id

454

Type

Description

<Alarm::ShubPortNumber>
port number of the shub
range: [1...24]
This element is always shown.
<Alarm::ShubLinkDown>
specifies whether the shub link is down or not.
Possible values are :
This element is always shown.
- yes : fan unit falied
- no : fan unit OK
<Alarm::ShubMACconflict>
specifies whether there is a duplicate MAC address
Possible values are :
from the ethernet port of LAN switch.
- yes : duplicate MAC address from This element is always shown.
ethernet port of LAN switch
- no : no duplciate MAC address
<SignedInteger>
specifies where the alarm has occurred.
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

37.7 SHub Alarm RIP Snap-shot Status Command


Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot rip (index)

Command Parameters
Table 37.7-1 "SHub Alarm RIP Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.7-2 "SHub Alarm RIP Snap-shot Status Command" Display parameters
Specific Information
name

Type

Description

vrf-id

<SignedInteger>

config-err

<Alarm::ShubConfigErr>
Possible values are :
- failed : configuration error occured
- ok : configuration error not occured
<Alarm::ShubAuthFail>
Possible values are :
- failed : authentication failed
- ok : authentication not failed
<Alarm::ShubRcvPkt>
Possible values are :
- yes : bad packets received
- no : no bad packets received
<SignedInteger>

specifies where the alarm has occurred.


This element is always shown.
RIP interface configuration error
This element is always shown.

auth-fail

rcv-bad-pkt

if-index

3HH-01016-AAAA-TCZZA Edition 03

RIP interface authentication failure


This element is always shown.
bad packet received on RIP interface
This element is always shown.
displays the interface index
This element is only shown in detail mode.

Released

455

37 SHub Alarm Status Command

37.8 SHub Alarm OSPF Snap-shot Status


Command
Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot ospf (index)

Command Parameters
Table 37.8-1 "SHub Alarm OSPF Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.8-2 "SHub Alarm OSPF Snap-shot Status Command" Display parameters
Specific Information
name

Type

Description

vrf-id

<SignedInteger>

config

<Alarm::ShubConfigErr>
Possible values are :
- failed : configuration error occured
- ok : configuration error not occured
<Alarm::ShubAuthFail>
Possible values are :
- failed : authentication failed
- ok : authentication not failed
<Alarm::ShubRcvPkt>
Possible values are :
- yes : bad packets received
- no : no bad packets received
<Alarm::ShubLSDB90>
Possible values are :
- yes : external LSA database reached 90%
of the limit
- no : external LSA database not reached
90% of the limit

specifies where the alarm has occurred.


This element is always shown.
interface configuration error
This element is always shown.

authen

rcv-bad-pkt

lsdb-90

456

Released

interface authentication failure


This element is always shown.
bad packet received on the interface
This element is always shown.
specifies whether the external LSA database
reached 90% of the limit
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

name
lsdb-ovfl

nhbr-statchg

nhbr-itfchg

if-index

Type

Description

<Alarm::ShubLSDBOverFlow>
Possible values are :
- yes : external LSA database count
reached overflow limit
- no : external LSA database count not
reached overflow limit
<Alarm::ShubNHBRstatchg>
Possible values are :
- yes : OSPF neighbor state has changed
- no : OSPF neighbor state has not
changed
<Alarm::ShubItfStatchg>
Possible values are :
- yes : OSPF interface state changed
- no : OSPF interface state change not
occured
<SignedInteger>

specifies whether the external LSA database count


reached overflow limit
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

specifies whether the OSPF neighbor state has


changed
This element is always shown.
specifies OSPF PDU corruption
This element is always shown.

displays the interface index


This element is only shown in detail mode.

Released

457

37 SHub Alarm Status Command

37.9 SHub Alarm Uplink group Snap-shot Status


Command
Command Description
User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub snap-shot uplink-group (index)

Command Parameters
Table 37.9-1 "SHub Alarm Uplink group Snap-shot Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Alarm::genAlarmIndex>

alarm snap shot table index

Command Output
Table 37.9-2 "SHub Alarm Uplink group Snap-shot Status Command" Display parameters
Specific Information
name

458

Type

Description

uplink-nbr

<SignedInteger>

uplink-down

<Alarm::ShubUplinkDown>
Possible values are :
- yes : uplink group down
- no : no uplink group down

specifies uplink group number


This element is always shown.
uplink group down
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

37.10 SHub Alarm Delta-Log Changes Status


Command
Command Description
This command shows a summary report of the number of alarms which occurred.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub nbr-changed-alarms

Command Output
Table 37.10-2 "SHub Alarm Delta-Log Changes Status Command" Display parameters
Specific Information
name

Type

Description

all

<Counter>

indeterminate

<Counter>

warning

<Counter>

minor

<Counter>

major

<Counter>

critical

<Counter>

total number of changes of all alarms since startup.


This element is always shown.
the total number of changes of all alarms with
severity level indeterminate since startup.
This element is always shown.
the total number of changes of all alarms with
severity level warning since startup.
This element is always shown.
the total number of changes of all alarms with
severity level minor since startup.
This element is always shown.
the total number of changes of all alarms with
severity level major since startup.
This element is always shown.
the total number of changes of all alarms with
severity level critical since startup.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

459

37 SHub Alarm Status Command

37.11 SHub Alarm Entries Status Command


Command Description
This command displays the alarm entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm shub entry (alarm-id)

Command Parameters
Table 37.11-1 "SHub Alarm Entries Status Command" Resource Parameters
Resource Identifier
(alarm-id)

460

Type

Description

<Alarm::ShubAlarmIndex>
alarm type
Possible values are :
- fan : shub fan failure
- power-fan : shub power fan failure
- db-restore : shub DB restore
- reboot : shub reboot from emergency
boot package
- sntp-comm : shub SNTP communication
- eth-link-down : shub ethernet link down
status
- mac-conflict : MAC conflict
- no-arp-reply : no ARP reply
ospf-itf-err
:
OSPF
interface
configuration error
- ospf-auth-err : OSPF interface
authetication error
- ospf-rx-bad-err : bad packets received on
OSPF interface
- ospf-lsdb-oflow-90 : external LSA
database reached 90% of the limit
- ospf-lsdb-oflow : external LSA database
reached 90% of the limit
- ospf-nhbr-statchg : OSPF neighbor state
change
- ospf-itf-statchg : OSPF interface state
change
rip-config-err
:
RIP
interface
configuration error
rip-auth-fail
:
RIP
interface
authentication failure

Released

3HH-01016-AAAA-TCZZA

Edition 03

37 SHub Alarm Status Command

Resource Identifier

Type

Description

- rip-rcv-bad-pkt : bad packet received on


RIP interface
- uplink-down : uplink group down

Command Output
Table 37.11-2 "SHub Alarm Entries Status Command" Display parameters
Specific Information
name
category

severity

service-affecting

Type

Description

<Alarm::category>
Possible values are :
- communications : communications
related alarms
- qos : QoS related alarms
- processing-error : processing failure
related alarms
- equipment : equipment related alarms
- environmental : environmental related
alarms
<Alarm::alarmSeverity>
Possible values are :
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
<Alarm::alarmServAffect>
Possible values are :
- service-affecting : make this alarm
service affecting
- noservice-affecting : make this alarm not
service affecting

defines the category of an alarm.


This element is always shown.

Only Show Details: alarm mode


name
Type
reporting

defined to assign a severity level to an alarm.


This element is always shown.

defines whether an alarm is service affecting or not.


This element is always shown.

Description

<Alarm::alarmAlarmMode>
to manage the reporting of the alarm.
Possible values are :
This element is always shown.
- enabled : reporting or logging is enabled
- disabled : reporting or logging is
disabled

3HH-01016-AAAA-TCZZA Edition 03

Released

461

38- Alarm Status Commands

38.1 Alarm Entries Status Command

462

Released

38-463

3HH-01016-AAAA-TCZZA

Edition 03

38 Alarm Status Commands

38.1 Alarm Entries Status Command


Command Description
This command displays the alarm entries.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show alarm entry (alarm-id)

Command Parameters
Table 38.1-1 "Alarm Entries Status Command" Resource Parameters
Resource Identifier
(alarm-id)

Type

Description

<Alarm::alarmIndex>
alarm type
Possible values are :
- eo-conv-loss : loss of signal in eo
conversion module
- eo-conv-tx : transmission fault in eo
conversion module
- xtca-ne-es : xdsl near end TCA alarm errored seconds in 15 min
- xtca-ne-ses : xdsl near end TCA alarm severely errored seconds in 15 min
- xtca-ne-uas : xdsl near end TCA alarm unavailable seconds in 15 min
- xtca-ne-day-es : xdsl near end TCA
alarm - errored seconds in 1 day
- xtca-ne-day-ses : xdsl near end TCA
alarm - severely errored seconds in 1 day
- xtca-ne-day-uas : xdsl near end TCA
alarm - unavailable seconds in 1 day
- xtca-fe-es : xdsl far end TCA alarm errored seconds in 15 min
- xtca-fe-ses : xdsl far end TCA alarm severely errored secs in 15 min
- xtca-fe-uas : xdsl far end TCA alarm unavailable seconds in 15 min
- xtca-fe-day-es : xdsl far end TCA alarm errored seconds in 1 day
- xtca-fe-day-ses : xdsl far end TCA alarm
- severely errored secs in 1 day
- xtca-fe-day-uas : xdsl far end TCA alarm
- unavailable seconds in 1 day

3HH-01016-AAAA-TCZZA Edition 03

Released

463

38 Alarm Status Commands

Resource Identifier

Type

Description

- xdsl-ne-los : xdsl near end - loss of


signal
- xdsl-ne-lof : xdsl near end - loss of frame
- xdsl-ne-lom : xdsl near end - loss of
margin
- xdsl-ne-ese : xdsl near end - excessive
server errors
- xdsl-act-cfg-error : xdsl - line
configuration data cannot be used
- xdsl-act-not-feas : xdsl - line capacity not
enough to setup requested profile
- xdsl-up-br-reach : xdsl upstream planned bitrate not reached after
initialization
- xdsl-ne-ncd : xdsl near end - no cell
delineation
- xdsl-ne-lcd : xdsl near end - loss of cell
delineation
- xdsl-fe-los : xdsl far end - loss of signal
- xdsl-fe-lof : xdsl far end - loss of frame
- xdsl-fe-lpr : xdsl far end - loss of power
- xdsl-fe-lol : xdsl far end - loss of link
- xdsl-fe-lom : xdsl far end - loss of
margin
- xdsl-fe-ese : xdsl far end - excessive
server errors
- xdsl-act-comm : xdsl - init not successful
due to communications problem
- xdsl-act-modem : xdsl - no peer modem
detected
- xdsl-do-br-reach : xdsl downstream planned bitrate not reached after init
- xdsl-fe-ncd : xdsl far end - no cell
delineation
- xdsl-fe-lcd : xdsl far end - loss of cell
delineation
- sw-rollback : non active oswp, db cannot
be operational - will rollback
- db-rollback : selected oswp and db
cannot be operational - will rollback
- ether-linkdown : ethernet link down
- cell-discard-up : cell discarded in the
upstream direction
- cell-discard-down : cell discarded in the
downstream direction
- mac-conflict : duplcate mac addess from
this pvc
- persit-data-loss : all data lost after restart
- system not configured
- sntp-comm-lost : sntp server not
responding
- nt-disk-90%full : nt disk 90% full
- shub-loc : communication lost with shub
- rack-power : power fuse broken
- rack-fan-unit1 : fan unit rack 1 failing
- rack-fan-unit2 : fan unit rack 2 failing
- shelf-mismatch : shelf type different

464

Released

3HH-01016-AAAA-TCZZA

Edition 03

38 Alarm Status Commands

Resource Identifier

Type

Description

from planned type


- ext-chain-instl : consistancy problem for
extension chain installation
- door : open cabinet door
- fuse : one power feed gone
- single-fan-fail : one or more fan of a
certain shelf failed
- double-fan-fail : two or more fans of the
main shelf failed
- ac-power-fail : external power failure shelf shutdown in 15 minutes
- board-mismatch : board inserted
different from planned
- waiting-for-sw : not able to download all
the applicable sw files
- temp-exceeded : temperature threshold
exceeded on the board
- temp-shutdown : board powered down
itself - too high temperature
- defense : plugin unit disconnected from
system by defense
- board-missing : board detected after
planning - now missing
- board-instl-missing : board never
detected after planning
- board-init : board initialisation failure
- board-reset-prot : number of resets
exceeded
- board-reset-cf : board reset and/or
communication failure
- vrf-assign-fail : failure to assigna VRF
for a user session
- vlan-assign-fail : failure to assign VLAN
for a user session
- ip-pool-assign-fail : failure to assign an
IP address pool
- qos-assign-fail : failure to assign a QoS
for a user session
- ip-addr-assign-fail : failure to assign IP
address for a user session
- missing-attributes : radius should always
specify pool id when it returns a VRF
- ip-addr-preempt : IP address preemption
- up-plan-bitrate : upstream bitrate is
above min and below planned
- up-min-bitrate : upstream bitrate is below
min bitrate
- up-config-not-feas : upstream bitrate is
not enough to set up config group
- down-plan-bitrate : downstream bitrate is
above min and below planned
- down-min-bitrate : downstream bitrate is
below min bitrate
- down-config-not-feas : downstream
bitrate is not enough to set up config
group
- custom1 : customizable alarm 1

3HH-01016-AAAA-TCZZA Edition 03

Released

465

38 Alarm Status Commands

Resource Identifier

Type

Description

- custom2 : customizable alarm 2


- custom3 : customizable alarm 3
- custom4 : customizable alarm 4
- custom5 : customizable alarm 5
- loss-over-cap : switch over capability in
a redundant system

Command Output
Table 38.1-2 "Alarm Entries Status Command" Display parameters
Specific Information
name
category

severity

service-affecting

Type

Description

<Alarm::category>
Possible values are :
- communications : communications
related alarms
- qos : QoS related alarms
- processing-error : processing failure
related alarms
- equipment : equipment related alarms
- environmental : environmental related
alarms
<Alarm::alarmSeverity>
Possible values are :
- indeterminate : not a definite known
severity level
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking
<Alarm::alarmServAffect>
Possible values are :
- service-affecting : make this alarm
service affecting
- noservice-affecting : make this alarm not
service affecting

category of an alarm
This element is always shown.

Only Show Details: alarm mode


name
Type
reporting

logging

466

<Alarm::alarmAlarmMode>
Possible values are :
- enabled : reporting or logging is enabled
- disabled : reporting or logging is
disabled
<Alarm::alarmAlarmMode>
Possible values are :
- enabled : reporting or logging is enabled
- disabled : reporting or logging is
disabled

Released

severity of the alarm, may be indeterminate,


warning, minor, major and critical.
This element is always shown.

defines whether an alarm is service affecting or not.


This element is always shown.

Description
specifies whether the alarm is reported or not.
This element is always shown.

specifies whether alarm is logged or not.


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

39- ATM Status Commands

39.1 ATM Interface Status Command


39.2 PVC Status Command
39.3 TC Adaptor Protocol Interval Status
39.4 TC Adaptor Protocol Current Quarter Performance
Data
39.5 TC Adaptor Protocol Current Day Performance Data
39.6 TC Adaptor Protocol Performance Data for Previous
Quarter Intervals
39.7 TC Adaptor Protocol Performance Data for Previous
Day Intervals

3HH-01016-AAAA-TCZZA Edition 03

39-468
39-469
39-470
39-471
39-473
39-475
39-477

Released

467

39 ATM Status Commands

39.1 ATM Interface Status Command


Command Description
This command displays the ATM interface configuration table.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm interface (port)

Command Parameters
Table 39.1-1 "ATM Interface Status Command" Resource Parameters
Resource Identifier
(port)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ ATM interface

Command Output
Table 39.1-2 "ATM Interface Status Command" Display parameters
Specific Information
name
type

number-of-pvcs

468

Type

Description

<Atm::asamAtmItfType>
Possible values are :
- not-specified : not specified
network-termination
:
network
termination
- access-to-access : access to access
interface
- user-to-access : user to access interface
- internal-server : internal server interface
- external-server : external server interface
<Atm::CrossConnectedPVccs>
range: [0...65535]

type of ATM interface.


This element is always shown.

Released

specifies the number of vcttp connections on this


ATM interface (only PVC).
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

39 ATM Status Commands

39.2 PVC Status Command


Command Description
This commands shows the status of the PVC.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm pvc (port-index)

Command Parameters
Table 39.2-1 "PVC Status Command" Resource Parameters
Resource Identifier
(port-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the ATM PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 39.2-2 "PVC Status Command" Display parameters
Specific Information
name
admin-status

opertional-status

last-change

Type

Description

<Atm::adminStatus>
specifies the desired administrative state of the
Possible values are :
VCL.
- admin-up : enable traffic flow
This element is always shown.
- admin-down : disable traffic flow
<Atm::atmVclOperStatus>
indicates the current operational status of the VCL.
Possible values are :
This element is always shown.
- up : traffic flow is enabled in the virtual
link
- down : traffic flow is disabled in the
virtual link
- unknown : state is unknown
<TimeTicks>
time the VCL entered its current operational state.
unit: msec
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

469

39 ATM Status Commands

39.3 TC Adaptor Protocol Interval Status


Command Description
This command displays the TC adaptor protocol interval status.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-int (port)

Command Parameters
Table 39.3-1 "TC Adaptor Protocol Interval Status" Resource Parameters
Resource Identifier
(port)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ ATM interface index (rack/shelf/slot/port)

Command Output
Table 39.3-2 "TC Adaptor Protocol Interval Status" Display parameters
Specific Information
name

Type

valid-15-min-intervals <SignedInteger>

valid-1-day-intervals

470

<SignedInteger>

Released

Description
the number of previous intervals (maximum 192)
for which valid data has been stored. The value of
this object will be 192 unless the device was
brought online within the last nx15 minutes, in
which case the value will be the number of
complete 15 minute intervals the device has been
online
This element is always shown.
The number of previous intervals (maximum 2) for
which valid data has been stored. The value of this
object will be 2 unless the device was brought
online within the last nx24 hours, in which case the
value will be the number of complete 24 hours
intervals the device has been online
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

39 ATM Status Commands

39.4 TC Adaptor Protocol Current Quarter


Performance Data
Command Description
This command displays the TC adaptor protocol current quarter performance data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-current-int fifteen-min (port)

Command Parameters
Table 39.4-1 "TC Adaptor Protocol Current Quarter Performance Data" Resource Parameters
Resource Identifier
(port)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ ATM interface

Command Output
Table 39.4-2 "TC Adaptor Protocol Current Quarter Performance Data" Display parameters
Specific Information
name

Type

Description

ocd-far-end

<Counter>

hec-far-end

<Counter>

ocd-near-end

<Counter>

hec-near-end

<Counter>

the number of out of cell delineations anomalies for


incoming cells on a far end ATM interface
connected to this ATM interface
This element is always shown.
the number of ATM cells discarded on the far end
ATM interface connected to this ATM interface
due to HEC errors
This element is always shown.
the number of out of cell delineations anomalies for
incoming cells on an ATM interface.An out of cell
delineation anomaly occurs when there are 7
consecutive ATM cells received which contain
HEC errors.
This element is always shown.
number of ATM cells discarded on the ATM
interface due to HEC errors
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

471

39 ATM Status Commands

472

Released

3HH-01016-AAAA-TCZZA

Edition 03

39 ATM Status Commands

39.5 TC Adaptor Protocol Current Day Performance


Data
Command Description
This command displays the TC adaptor protocol current day performance data.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-current-int one-day (port)

Command Parameters
Table 39.5-1 "TC Adaptor Protocol Current Day Performance Data" Resource Parameters
Resource Identifier
(port)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ ATM interface

Command Output
Table 39.5-2 "TC Adaptor Protocol Current Day Performance Data" Display parameters
Specific Information
name

Type

Description

ocd-far-end

<Counter>

hec-far-end

<Counter>

ocd-near-end

<Counter>

hec-near-end

<Counter>

the number of out of cell delineations anomalies for


incoming cells on a far end ATM interface
connected to this ATM interface
This element is always shown.
the number of ATM cells discarded on the far end
ATM interface connected to this ATM interface
due to HEC errors
This element is always shown.
the number of out of cell delineations anomalies for
incoming cells on an ATM interface.An out of cell
delineation anomaly occurs when there are 7
consecutive ATM cells received which contain
HEC errors.
This element is always shown.
number of ATM cells discarded on the ATM
interface due to HEC errors
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

473

39 ATM Status Commands

474

Released

3HH-01016-AAAA-TCZZA

Edition 03

39 ATM Status Commands

39.6 TC Adaptor Protocol Performance Data for


Previous Quarter Intervals
Command Description
This command displays the TC adaptor protocol monitoring 15 min interval data parameters.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-15min-int (port) intvl-number <Atm::AtmItvlNumber>

Command Parameters
Table 39.6-1 "TC Adaptor Protocol Performance Data for Previous Quarter Intervals" Resource
Parameters
Resource Identifier
(port)
intvl-number

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Atm::AtmItvlNumber>
range: [1...192]

Description
/ ATM interface
interval for which statistics are available

Command Output
Table 39.6-2 "TC Adaptor Protocol Performance Data for Previous Quarter Intervals" Display
parameters
Specific Information
name

Type

Description

ocd-near-end

<Counter>

hec-near-end

<Counter>

ocd-far-end

<Counter>

the number of out of cell delineations anomalies for


incoming cells on an ATM interface.An out of cell
delineation anomaly occurs when there are 7
consecutive ATM cells received which contain
HEC errors
This element is always shown.
number of ATM cells discarded on the ATM
interface due to HEC errors
This element is always shown.
the number of out of cell delineations anomalies for
incoming cells on a far end ATM interface
connected to this ATM interface
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

475

39 ATM Status Commands

name
hec-far-end

476

Type

Description

<Counter>

the number of ATM cells discarded on the far end


ATM interface connected to this ATM interface
due to HEC errors
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

39 ATM Status Commands

39.7 TC Adaptor Protocol Performance Data for


Previous Day Intervals
Command Description
This command displays the TC adaptor protocol monitoring 1 day interval data parameters.

User Level
The command can be accessed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> show atm tc-1day-int (port) intvl-number <Atm::AtmItvlNo1day>

Command Parameters
Table 39.7-1 "TC Adaptor Protocol Performance Data for Previous Day Intervals" Resource
Parameters
Resource Identifier
(port)
intvl-number

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Atm::AtmItvlNo1day>
range: [1...2]

Description
/ ATM interface
interval for which statistics are available

Command Output
Table 39.7-2 "TC Adaptor Protocol Performance Data for Previous Day Intervals" Display
parameters
Specific Information
name

Type

Description

ocd-near-end

<Counter>

hec-near-end

<Counter>

ocd-far-end

<Counter>

the number of out of cell delineations anomalies for


incoming cells on an ATM interface.An out of cell
delineation anomaly occurs when there are 7
consecutive ATM cells received which contain
HEC errors.
This element is always shown.
number of ATM cells discarded on the ATM
interface due to HEC errors
This element is always shown.
the number of out of cell delineations anomalies for
incoming cells on a far end ATM interface
connected to this ATM interface
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

477

39 ATM Status Commands

name
hec-far-end

478

Type

Description

<Counter>

the number of ATM cells discarded on the far end


ATM interface connected to this ATM interface
due to HEC errors
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

40- Bridge Status Commands

40.1 Bridge Port Status Command


40.2 Bridge Port to ATM PVC mapping Status Command
40.3 SHub Bridge Status Command
40.4 SHub Bridge Port Status Command

3HH-01016-AAAA-TCZZA Edition 03

40-480
40-482
40-483
40-484

Released

479

40 Bridge Status Commands

40.1 Bridge Port Status Command


Command Description
This command shows the current settings for the bridge port. The initial configuration may be overruled by
dynamic data as a result of port authentication using Radius protocol. When any of the settings has been overruled,
the status parameter will indicate 'dynamic'.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge port (port)

Command Parameters
Table 40.1-1 "Bridge Port Status Command" Resource Parameters
Resource Identifier

Type

(port)

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 40.1-2 "Bridge Port Status Command" Display parameters
Specific Information
name

<Vlan::BridgePort>
range: [1...3104]

pvid

<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Vlan::Priority>
range: [0...7]

default-priority

480

Type

bridge-port

qos-profile

none
|
name
<Vlan::IgnoredQosProfileName>

status

<Vlan::DataStatus>
Possible values are :
- static : data configured by operator

Released

Description
the port identifier assigned by the system to this
terminated VCL. A port identifier identifies
uniquely a port of the VLAN-Bridge within the
system.
This element is always shown.
| the dynamic or static (if no dynamic) default
: VLAN assigned to a port
This element is always shown.
port dynamic or static (if no dynamic) default
priority
This element is always shown.
: QOS profile, dynamically or statically (if no
dynamic) assigned to a port
This element is always shown.
nature of the data shown. The value true indicates
that any or all of the displayed parameters is
dynamic.

3HH-01016-AAAA-TCZZA

Edition 03

40 Bridge Status Commands

name

Type

Description

- dynamic : dynamic data

This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

481

40 Bridge Status Commands

40.2 Bridge Port to ATM PVC mapping Status


Command
Command Description
This command shows the mapping between a bridge port and its ATM interface.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge port-to-atm-pvc (bridge-port)

Command Parameters
Table 40.2-1 "Bridge Port to ATM PVC mapping Status Command" Resource Parameters
Resource Identifier
(bridge-port)

Type

Description

<Vlan::BridgePort>
range: [1...3104]

bridge port

Command Output
Table 40.2-2 "Bridge Port to ATM PVC mapping Status Command" Display parameters
Specific Information
name
port

482

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the atm static Interface with vpi and vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
: This element is always shown.
<Atm::DefaultVpi> : <Atm::DefaultVci>

Released

3HH-01016-AAAA-TCZZA

Edition 03

40 Bridge Status Commands

40.3 SHub Bridge Status Command


Command Description
This command shows global information regarding the bridge on the Service Hub.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge shub-info

Command Output
Table 40.3-2 "SHub Bridge Status Command" Display parameters
Specific Information
name

Type

Description

mac-address

<Vlan::MacAddr>
length: 6

learnt-entry-discards

<UnsignedInteger>

the MAC address used by this bridge when it must


be referred to in a unique fashion
This element is always shown.
the total number of Filtering Database entries,
which have been or would have been learnt, but
have been discarded due to a lack of space in the
FDB. If this Counter is increasing it indicates that
the Filtering Database is regularly becoming full.
This event may be of temporary nature.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

483

40 Bridge Status Commands

40.4 SHub Bridge Port Status Command


Command Description
This command shows port related parameters for a bridge port on the Service Hub.
When detailled information is requested, statistics regarding frames received and transmitted on the bridge port
are displayed.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show bridge network-port (port)

Command Parameters
Table 40.4-1 "SHub Bridge Port Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

port number

Command Output
Table 40.4-2 "SHub Bridge Port Status Command" Display parameters
Common Information
name
Type
mac-address

<Vlan::MacAddr>
length: 6

learned-entry-discards <UnsignedInteger>

Specific Information
name
operation-status

max-frame-info

484

Description
the MAC address used by this bridge when it must
be referred to in a unique fashion
This element is always shown.
the total number of Filtering Database entries,
which have been or would have been learnt, but
have been discarded due to a lack of space in the
FDB. If this Counter is increasing it indicates that
the Filtering Database is regularly becoming full.
This event may be of temporary nature.
This element is always shown.

Type

Description

<Shub::PortOperStatus>
Possible values are :
- down : down
- up : up
<SignedInteger>

the operational status of the port. This status is only


valid if the administrative status of the
corresponding interface is up.
This element is always shown.
the maximum size of the INFO (non-MAC) field

Released

3HH-01016-AAAA-TCZZA

Edition 03

40 Bridge Status Commands

name
traffic-class

Type
<Shub::TrafficClass>
range: [1...8]

Only Show Details: bridge parameters


name
Type
mac-address

<Vlan::MacAddr>
length: 6

learned-entry-discards <UnsignedInteger>

Only Show Details: frame stats


name
Type
in-frames

<UnsignedInteger>

in-overflow-frames

<UnsignedInteger>

out-frames

<UnsignedInteger>

out-overflow-frames

<UnsignedInteger>

discard-valid-frames

<UnsignedInteger>

discard-valid-overflow <UnsignedInteger>

delay-exceed-discards <UnsignedInteger>
mtu-exceed-discards

<UnsignedInteger>

bcast-out-frames

<UnsignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

Description
that this port will receive or transmit
This element is always shown.
The number of egress traffic classes supported on
this port.
This element is always shown.

Description
the MAC address used by this bridge when it must
be referred to in a unique fashion
This element is always shown.
the total number of Filtering Database entries,
which have been or would have been learnt, but
have been discarded due to a lack of space in the
FDB. If this Counter is increasing it indicates that
the Filtering Database is regularly becoming full.
This event may be of temporary nature.
This element is always shown.

Description
32 bits counter holding the number of frames that
have been received by this port from its segment;
only frames for a protocol being processed by the
local bridging function are counted
This element is only shown in detail mode.
the high order 32 bits of a 64 bits in-frames
counter, in case of high capacity interfaces
This element is only shown in detail mode.
32 bits counter holding the number of frames that
have been transmitted by this port port to its
segment; only frames for a protocol being
processed by the local bridging function are
counted
This element is only shown in detail mode.
the high order 32 bits of a 64 bits out-frames
counter, in case of high capacity interfaces
This element is only shown in detail mode.
32 bits counter holding the number of valid frames
received which were discarded (i.e., filtered) by the
Forwarding Process
This element is only shown in detail mode.
the high order 32 bits of a 64 bits
discard-valid-frames counter, in case of high
capacity interfaces
This element is only shown in detail mode.
the number of frames discarded by this port due to
excessive transit delay through the bridge
This element is only shown in detail mode.
the number of frames discarded by this port due to
an excessive size
This element is only shown in detail mode.
count of broadcasted frame that are transmitted
through this interface. This counter is only
incremented for frames with broadcast destination
address (ff.ff.ff.ff.ff.ff) and frames which are
broadcasted because of no learned entry in the
Filtering Database.

Released

485

40 Bridge Status Commands

name
mcast-out-frames

486

Type
<UnsignedInteger>

Released

Description
This element is only shown in detail mode.
count of frames transmitted through this interface
with destination address in which the Mac layer
multicast bit set. This counter is not incremented
for frames tranmitted with broadcast destination
address (i.e ff.ff.ff.ff.ff.ff).
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

41- VLAN Status Commands

41.1 Global VLAN Status Command


41.2 Residential Bridge VLAN Status Command
41.3 Cross-connect VLAN Status Command
41.4 Stacked VLAN Status Command
41.5 Stacked QoS VLAN Status Command
41.6 Layer-2 terminated VLAN Status Command
41.7 VLAN Name mapping Status Command
41.8 VLAN Filtering Database Status Command
41.9 Bridge Port Filtering Database Status Command
41.10 Port VLAN association Status Command
41.11 VLAN Priority Regeneration Profile Status Command
41.12 Duplicate Mac Alarm Status Command
41.13 Port Event Status Command
41.14 Port Statistics for Current Quarter Status Command
41.15 Port Statistics for Current Day Status Command
41.16 Port Statistics for Previous Quarter Intervals Status
Command
41.17 Port Statistics for Previous Day Intervals Status
Command
41.18 VLAN Port Statistics for Current Quarter Status
Command
41.19 VLAN Port Statistics for Current Day Status
Command
41.20 VLAN Port Statistics for Previous Quarter Intervals
Status Command
41.21 VLAN Port Statistics for Previous Day Intervals
Status Command
41.22 SHub Port VLAN association Status Command
41.23 SHub VLAN Name mapping Status Command
41.24 SHub VLAN Filtering Database Status Command
41.25 SHub Filtering Database Entry Status Command
41.26 SHub Duplicate Mac Alarm Status Command

3HH-01016-AAAA-TCZZA Edition 03

41-488
41-489
41-490
41-491
41-492
41-493
41-494
41-495
41-497
41-499
41-500
41-502
41-503
41-505
41-507
41-509
41-511
41-513
41-515
41-517
41-519
41-521
41-522
41-523
41-525
41-527

Released

487

41 VLAN Status Commands

41.1 Global VLAN Status Command


Command Description
This command shows information common to all VLANs.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan global

Command Output
Table 41.1-2 "Global VLAN Status Command" Display parameters
Common Information
name
Type
configured-vlans

<UnsignedInteger>

management

max-rb-vlan

<Vlan::MgntVlanMode>
Possible values are :
- inband : inband
- outband : outband
<UnsignedInteger>

max-layer2-term-vlan

<UnsignedInteger>

Only Show Details: vlan parameters


name
Type

488

configured-vlans

<UnsignedInteger>

management

max-rb-vlan

<Vlan::MgntVlanMode>
Possible values are :
- inband : inband
- outband : outband
<UnsignedInteger>

max-layer2-term-vlan

<UnsignedInteger>

Released

Description
current number of vlans that are configured
This element is always shown.
specifies how the node is managed
This element is always shown.
maximum number of residential bridge vlans that
are supported
This element is always shown.
maximum number of layer2 terminated vlans that
are supported
This element is always shown.

Description
current number of vlans that are configured
This element is always shown.
specifies how the node is managed
This element is always shown.
maximum number of residential bridge vlans that
are supported
This element is always shown.
maximum number of layer2 terminated vlans that
are supported
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.2 Residential Bridge VLAN Status Command


Command Description
This command shows all parameters for a particular VLAN of the type Residential Bridge VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan residential-bridge (vlan-id) bridge-port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci>

Command Parameters
Table 41.2-1 "Residential Bridge VLAN Status Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

bridge-port

Command Output
Table 41.2-2 "Residential Bridge VLAN Status Command" Display parameters
Specific Information
name

Type

qos-profile

none
|
name
<Vlan::IgnoredQosProfileName>

status

<Vlan::DataStatus>
Possible values are :
- static : data configured by operator
- dynamic : dynamic data

3HH-01016-AAAA-TCZZA Edition 03

Description
: QOS profile, dynamically or statically (if no
dynamic) assigned to a port
This element is always shown.
nature of the data shown. The value true indicates
that any or all of the displayed parameters is
dynamic.
This element is only shown in detail mode.

Released

489

41 VLAN Status Commands

41.3 Cross-connect VLAN Status Command


Command Description
This command shows all parameters for a particular VLAN of the type Cross-connect VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan cross-connect (vlan-id)

Command Parameters
Table 41.3-1 "Cross-connect VLAN Status Command" Resource Parameters
Resource Identifier
(vlan-id)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Description
| vlan id
:

Command Output
Table 41.3-2 "Cross-connect VLAN Status Command" Display parameters
Specific Information
name

490

Type

bridge-port

<Vlan::Port>

port
fdb-id

<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot>
/
<Eqpt::Port>
<Atm::DefaultVpi> : <Atm::DefaultVci>
<UnsignedInteger>

filter-entries

<UnsignedInteger>

qos-profile

none
|
name
<Vlan::IgnoredQosProfileName>

status

<Vlan::DataStatus>
Possible values are :
- static : data configured by operator
- dynamic : dynamic data

Released

Description
bridge port
This element is always shown.
/ the atm static Interface with vpi and vci
: This element is always shown.
identity of the filtering database
This element is always shown.
number of entries in the filtering database
This element is always shown.
: QOS profile, dynamically or statically (if no
dynamic) assigned to a port
This element is always shown.
nature of the data shown. The value true indicates
that any or all of the displayed parameters is
dynamic.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.4 Stacked VLAN Status Command


Command Description
This command shows the Stacked Vlans configured in the system and their status.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan stacked-vlan (s-vlanid) vlan-id <Vlan::UVlanIndex> | <Vlan::SVlanIndex> :
<Vlan::CVlanIndex>

Command Parameters
Table 41.4-1 "Stacked VLAN Status Command" Resource Parameters
Resource Identifier
(s-vlanid)
vlan-id

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

3HH-01016-AAAA-TCZZA Edition 03

Description
| vlan id
:
| customer vlan
:

Released

491

41 VLAN Status Commands

41.5 Stacked QoS VLAN Status Command


Command Description
This command shows the Stacked Vlans configured in the system and their status.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan stacked-qos-vlan (s-vlanid) vlan-id <Vlan::UVlanIndex> |
<Vlan::SVlanIndex> : <Vlan::CVlanIndex>

Command Parameters
Table 41.5-1 "Stacked QoS VLAN Status Command" Resource Parameters
Resource Identifier
(s-vlanid)
vlan-id

492

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Released

Description
| vlan id
:
| customer vlan
:

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.6 Layer-2 terminated VLAN Status Command


Command Description
This command shows all parameters for a particular VLAN of the type Layer-2 terminated VLAN.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan layer2-terminated (vlanid)

Command Parameters
Table 41.6-1 "Layer-2 terminated VLAN Status Command" Resource Parameters
Resource Identifier
(vlanid)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Description
| vlan id
:

Command Output
Table 41.6-2 "Layer-2 terminated VLAN Status Command" Display parameters
Specific Information
name

Type

Description

fdb-id

<UnsignedInteger>

filter-entries

<UnsignedInteger>

network-ifindex

<SignedInteger>

identity of the filtering database


This element is always shown.
number of entries in the filtering database
This element is always shown.
interface index of the IpoE interface related to this
VLAN, at the network side
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

493

41 VLAN Status Commands

41.7 VLAN Name mapping Status Command


Command Description
This command shows the VLAN identity that corresponds to a given VLAN name.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan name (name)

Command Parameters
Table 41.7-1 "VLAN Name mapping Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Vlan::AdminString>
length: x<32

name used to identify the vlan

Command Output
Table 41.7-2 "VLAN Name mapping Status Command" Display parameters
Specific Information
name
id

494

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Released

Description
| the vlan identity
: This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.8 VLAN Filtering Database Status Command


Command Description
This command shows, given a particular VLAN, a unicast MAC address and a bridge port, an entry of the Filtering
Database if any. The filtering dabatase is used by the bridging function in determining how to propagate a received
frame.
The status parameter indicates what the trigger was for creation of the Filtering Database entry, i.e. a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan fdb (vlanid) mac <Vlan::MacAddr> port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci>

Command Parameters
Table 41.8-1 "VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier
(vlanid)

Type

Description

<Vlan::VlanIndexOrZero>
vlan id
range: [0...4092]
<Vlan::MacAddr>
mac address
length: 6
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

mac
port

Command Output
Table 41.8-2 "VLAN Filtering Database Status Command" Display parameters
Specific Information
name
bridge-port

status

Type

Description

<Vlan::BridgePort>
range: [1...3104]

the port identifier assigned by the system to this


terminated VCL. A port identifier identifies
uniquely a port of the VLAN-Bridge within the
system.
This element is always shown.
<Vlan::FdbEntryStatus>
the origin of the entry, unless invalid. Invalid
Possible values are :
indicates the entry is in progress of being deleted.
- other : entry does not determine the This element is always shown.
forwarding of frames
- invalid : entry is being removed

3HH-01016-AAAA-TCZZA Edition 03

Released

495

41 VLAN Status Commands

name

Type

Description

- learned : entry has been learned


dynamically
- self : entry represents one of the device's
addresses
- static : entry has been configured by a
manager

496

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.9 Bridge Port Filtering Database Status


Command
Command Description
This command shows all entries of the Filtering Database for a particular bridge port. The filtering dabatase is
used by the bridging function in determining how to propagate a received frame.
The status parameter indicates what the trigger was for creation of the Filtering Database entry, i.e. a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan bridge-port-fdb (port)

Command Parameters
Table 41.9-1 "Bridge Port Filtering Database Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.9-2 "Bridge Port Filtering Database Status Command" Display parameters
Specific Information
name
vlan-id
mac
status

Type

Description

<Vlan::UVlanIndex>
|
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Vlan::MacAddr>
length: 6
<Vlan::FdbEntryStatus>
Possible values are :
- other : entry does not determine the
forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned
dynamically
- self : entry represents one of the device's

vlan id
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

mac address
This element is always shown.
the origin of the entry, unless invalid
This element is always shown.

Released

497

41 VLAN Status Commands

name

Type

Description

addresses
- static : entry has been configured by a
manager

498

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.10 Port VLAN association Status Command


Command Description
This command shows all VLANs associated to a given port.
Such assocation is either static while it has been configured by the operator or the association has been established
dynamically as a result of port authentication via Radius protocol.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-vlan-map (port)

Command Parameters
Table 41.10-1 "Port VLAN association Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.10-2 "Port VLAN association Status Command" Display parameters
Specific Information
name
vlanid
association

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>
<Vlan::DataStatus>
Possible values are :
- static : data configured by operator
- dynamic : dynamic data

3HH-01016-AAAA-TCZZA Edition 03

Description
| vlan id
: This element is always shown.
the way the association was established
This element is always shown.

Released

499

41 VLAN Status Commands

41.11 VLAN Priority Regeneration Profile Status


Command
Command Description
This command shows for a given Priority Regeneration Profile the mapping of the external p-bit codepoints versus
the internal priority. Such a profile provides a mapping for both the upstream and the downstream direction.
These Priority Regeneration Profiles and their contents are predetermined and cannot be changed by the operator.
A Priority Regeneration Profile is assigned to a bridge port when configuring the bridge port.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan priority-regen (profile-id)

Command Parameters
Table 41.11-1 "VLAN Priority Regeneration Profile Status Command" Resource Parameters
Resource Identifier
(profile-id)

Type

Description

<Vlan::PrioRegenProfile>
profile id
Possible values are :
- trusted-port : trusted port
- best-effort : best effort
- cl-all-prio-3 : controlled load, all priority
3 traffic
- cl-all-prio-4 : controlled load, all priority
4 traffic
- background : background
- be-cl-voice : best effort, controlled load,
voice
- be-cl-1d-voice : best effort, controlled
load, 802.Id Annex G voice
- be-voice : best effort voice
- l2-vpn-3 : L2 VPN with 3 traffic classes
- l2-vpn-4 : L2 VPN with 4 traffic classes

Command Output
Table 41.11-2 "VLAN Priority Regeneration Profile Status Command" Display parameters
Specific Information

500

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

name
name

Type

Description

<Vlan::AdminString>
length: x<32

name of the profile


This element is always shown.

Only Show Details: priority regeneration for up stream


name
Type
priority-0

<Vlan::NibbleMask_0>

priority-1

<Vlan::NibbleMask_1>

priority-2

<Vlan::NibbleMask_2>

priority-3

<Vlan::NibbleMask_3>

priority-4

<Vlan::NibbleMask_4>

priority-5

<Vlan::NibbleMask_5>

priority-6

<Vlan::NibbleMask_6>

priority-7

<Vlan::NibbleMask_7>

Only Show Details: priority regeneration for down stream


name
Type
priority-0

<Vlan::NibbleMask_0>

priority-1

<Vlan::NibbleMask_1>

priority-2

<Vlan::NibbleMask_2>

priority-3

<Vlan::NibbleMask_3>

priority-4

<Vlan::NibbleMask_4>

priority-5

<Vlan::NibbleMask_5>

priority-6

<Vlan::NibbleMask_6>

priority-7

<Vlan::NibbleMask_7>

3HH-01016-AAAA-TCZZA Edition 03

Description
the regenerated priority for .1p priority codepoint 0
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 1
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 2
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 3
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 4
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 5
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 6
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 7
This element is only shown in detail mode.

Description
the regenerated priority for .1p priority codepoint 0
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 1
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 2
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 3
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 4
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 5
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 6
This element is only shown in detail mode.
the regenerated priority for .1p priority codepoint 7
This element is only shown in detail mode.

Released

501

41 VLAN Status Commands

41.12 Duplicate Mac Alarm Status Command


Command Description
This command is usefull when a Duplicate MAC Alarm has occured. A Duplicate MAC Alarm is raised when a new
MAC Address could not be learned on a port because this MAC Address already exists on another port for the
same VLAN, i.e.within the same Filtering Database. The information displayed indicates the port where the MAC
address is assigned, the original port.
The Duplicate MAC Alarm information is available as long as the alarm is on.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan dup-mac-alarm (dup-port) dup-vlan-id <Vlan::UVlanIndex> |
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> dup-mac <Vlan::MacAddr>

Command Parameters
Table 41.12-1 "Duplicate Mac Alarm Status Command" Resource Parameters
Resource Identifier
(dup-port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<Vlan::UVlanIndex>
| duplicate vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Vlan::MacAddr>
duplicate mac address
length: 6

dup-vlan-id
dup-mac

Command Output
Table 41.12-2 "Duplicate Mac Alarm Status Command" Display parameters
Specific Information
name
port

502

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the atm static Interface with vpi and vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
: This element is always shown.
<Atm::DefaultVpi> : <Atm::DefaultVci>

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.13 Port Event Status Command


Command Description
This commands shows all kind of events that ocurred on a given port. These events relate to error cases.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-event (port)

Command Parameters
Table 41.13-1 "Port Event Status Command" Resource Parameters
Resource Identifier

Type

(port)

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.13-2 "Port Event Status Command" Display parameters
Specific Information
name
bridge-port
event-time
aal5-fcs-error
short name:aal5-fcs
llc-error
short name:llc
no-mac-learn
short name:no-mac
dup-mac

Type

Description

<Vlan::BridgePort>
range: [1...3104]
<Vlan::StatsTime>
unit: sec
<Vlan::Aal5FcsError>
Possible values are :
- aal5-fcs : aal5 or fcs error
- no-aal5-fcs : no aal5 or fcs error
<Vlan::LlcError>
Possible values are :
- llc : incorrect llc
- no-llc : correct llc
<Vlan::MacNoLearnError>
Possible values are :
- mac-learn-error : mac learn error
- no-mac-learn-error : no mac learn error
<Vlan::MacDuplicateError>
Possible values are :
- mac-dup-error : mac duplicate error

bridge port
This element is always shown.
the time in seconds when the event ocurred
This element is always shown.
error of the aal5 frame or fcs error
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

incorrect llc format


This element is always shown.
new MAC address could not be learned, upstream
pkt is discarded
This element is always shown.
failure of MAC address learning while MAC
address already exists on another port within the
same VLAN

Released

503

41 VLAN Status Commands

name

Type

Description

- no-mac-dup-error : no mac duplicate This element is always shown.


error

504

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.14 Port Statistics for Current Quarter Status


Command
Command Description
This commands shows Performance Statistics for the current quarter for a particular port. Counters for upstream
and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE Relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-curr-15min-stats (port)

Command Parameters
Table 41.14-1 "Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.14-2 "Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

<Vlan::StatsTime>
unit: sec

measure-time

<Vlan::StatsTime>
unit: sec

elapsed time in this interval, i.e. for the current 15


minutes interval; expressed in seconds
This element is always shown.
actually measured time in this interval; expressed in
seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

3HH-01016-AAAA-TCZZA Edition 03

Description
number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.

Released

505

41 VLAN Status Commands

name

Type

Description

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

number of bytes forwarded in upstream direction


on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in upstream direction
on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in upstream direction on
a bridge port, for the specified interval
This element is always shown.

Only Show Details: down stream counters


name
Type

506

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of bytes forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in downstream direction
on a bridge port, for the specified interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.15 Port Statistics for Current Day Status


Command
Command Description
This command shows Performance Statistics for the current day for a particular port. Counters for upstream and
downstream traffic are displayed. These counters include all traffic on the port, including PPPoE Relayed and
PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-curr-day-stats (port)

Command Parameters
Table 41.15-1 "Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.15-2 "Port Statistics for Current Day Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

<Vlan::StatsTime>
unit: sec

measure-time

<Vlan::StatsTime>
unit: sec

elapsed time in this interval, i.e. for the current day


interval; expressed in seconds
This element is always shown.
actually measured time in this interval; expressed in
seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

3HH-01016-AAAA-TCZZA Edition 03

Description
number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.

Released

507

41 VLAN Status Commands

name

Type

Description

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

number of bytes forwarded in upstream direction


on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in upstream direction
on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in upstream direction on
a bridge port, for the specified interval
This element is always shown.

Only Show Details: down stream counters


name
Type

508

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of bytes forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in downstream direction
on a bridge port, for the specified interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.16 Port Statistics for Previous Quarter Intervals


Status Command
Command Description
This command shows Performance Statistics for the previous quarter intervals, for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
Relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent though completed quarter interval, from there
onwards interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-15min-stats (port) interval-number <SignedInteger>

Command Parameters
Table 41.16-1 "Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier
(port)
interval-number

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<SignedInteger>
interval number, where 1 is the most recent
completed interval

Command Output
Table 41.16-2 "Port Statistics for Previous Quarter Intervals Status Command" Display parameters
Specific Information
name
measure-time

Type

Description

<Vlan::StatsTime>
unit: sec

actually measured time in this interval; expressed in


seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

3HH-01016-AAAA-TCZZA Edition 03

Description
number of frames forwarded in upstream direction

Released

509

41 VLAN Status Commands

name

Type

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Only Show Details: down stream counters


name
Type

510

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
on a bridge port, for the specified interval
This element is always shown.
number of bytes forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in upstream direction
on a bridge port, for the specified interval. Frames
are discarded as a result of buffer acceptance or
policing
This element is always shown.
number of discarded bytes in upstream direction on
a bridge port, for the specified interval. Discarding
is a result of buffer acceptance or policing
This element is always shown.

Description
number of frames forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of bytes forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in downstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.17 Port Statistics for Previous Day Intervals


Status Command
Command Description
This command shows Performance Statistics for the previous day intervals for a particular port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
Relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.
The interval is specified. Interval number 1 identifies the most recent though completed day interval, from there
onwards interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan port-prev-day-stats (port) interval-number <SignedInteger>

Command Parameters
Table 41.17-1 "Port Statistics for Previous Day Intervals Status Command" Resource Parameters
Resource Identifier
(port)
interval-number

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<SignedInteger>
interval number

Command Output
Table 41.17-2 "Port Statistics for Previous Day Intervals Status Command" Display parameters
Specific Information
name
measure-time

Type

Description

<Vlan::StatsTime>
unit: sec

actually measured time in this interval; expressed in


seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

3HH-01016-AAAA-TCZZA Edition 03

Description
number of frames forwarded in upstream direction
on a bridge port, for the specified interval
This element is always shown.

Released

511

41 VLAN Status Commands

name

Type

Description

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

number of bytes forwarded in upstream direction


on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in upstream direction
on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in upstream direction on
a bridge port, for the specified interval
This element is always shown.

Only Show Details: down stream counters


name
Type

512

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of bytes forwarded in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded frames in downstream
direction on a bridge port, for the specified interval
This element is always shown.
number of discarded bytes in downstream direction
on a bridge port, for the specified interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.18 VLAN Port Statistics for Current Quarter


Status Command
Command Description
This commands shows Performance Statistics for the current quarter for a particular vlan and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
Relayed and PPPoE terminated traffic.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan current-15min-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci>

Command Parameters
Table 41.18-1 "VLAN Port Statistics for Current Quarter Status Command" Resource Parameters
Resource Identifier
(vlanid)
port

Type

Description

<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.18-2 "VLAN Port Statistics for Current Quarter Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

<Vlan::StatsTime>
unit: sec

measure-time

<Vlan::StatsTime>
unit: sec

elapsed time in this interval, i.e. for the current 15


minutes interval; expressed in seconds
This element is always shown.
actually measured time in this interval; expressed in
seconds
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

3HH-01016-AAAA-TCZZA Edition 03

Description
number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified

Released

513

41 VLAN Status Commands

name

Type

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Only Show Details: down stream counters


name
Type

514

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
interval
This element is always shown.
number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded frames in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded bytes in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

Description
number of frames forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of bytes forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded frames in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded bytes in downstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.19 VLAN Port Statistics for Current Day Status


Command
Command Description
This commands shows Performance Statistics for the current day for a particular vlan and port. Counters for
upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
Relayed and PPPoE terminated traffic.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan current-day-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci>

Command Parameters
Table 41.19-1 "VLAN Port Statistics for Current Day Status Command" Resource Parameters
Resource Identifier
(vlanid)
port

Type

Description

<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 41.19-2 "VLAN Port Statistics for Current Day Status Command" Display parameters
Specific Information
name

Type

Description

elapsed-time

<Vlan::StatsTime>
unit: sec

measure-time

<Vlan::StatsTime>
unit: sec

elapsed time in this interval, i.e. for the current 15


minutes interval; expressed in seconds
This element is always shown.
actually measured time in this interval; expressed in
seconds
This element is always shown.

Only Show Details: up stream counters

3HH-01016-AAAA-TCZZA Edition 03

Released

515

41 VLAN Status Commands

name

Type

Description

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

number of frames forwarded in upstream direction


per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of bytes forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded frames in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded bytes in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

Only Show Details: down stream counters


name
Type

516

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of bytes forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded frames in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded bytes in downstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.20 VLAN Port Statistics for Previous Quarter


Intervals Status Command
Command Description
This command shows Performance Statistics for the previous quarter intervals for a particular vlan and port.
Counters for upstream and downstream traffic are displayed. These counters include all traffic on the port,
including PPPoE Relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent though completed quarter interval, from there
onwards interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan previous-15min-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> interval-number
<SignedInteger>

Command Parameters
Table 41.20-1 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Resource
Parameters
Resource Identifier
(vlanid)
port
interval-number

Type

Description

<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<SignedInteger>
interval number

Command Output
Table 41.20-2 "VLAN Port Statistics for Previous Quarter Intervals Status Command" Display
parameters
Specific Information
name
measure-time

Type

Description

<Vlan::StatsTime>
unit: sec

actually measured time in this interval; expressed in


seconds

3HH-01016-AAAA-TCZZA Edition 03

Released

517

41 VLAN Status Commands

name

Type

Description
This element is always shown.

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Only Show Details: down stream counters


name
Type

518

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of bytes forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded frames in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded bytes in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

Description
number of frames forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of bytes forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded frames in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded bytes in downstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.21 VLAN Port Statistics for Previous Day


Intervals Status Command
Command Description
This command shows Performance Statistics for the previous day intervals for a particular vlan and port. Counters
for upstream and downstream traffic are displayed. These counters include all traffic on the port, including PPPoE
Relayed and PPPoE terminated traffic.
The interval is specified. Interval number 1 identifies the most recent though completed day interval, from there
onwards interval numbers are incremented by 1. Higher interval numbers relate to less recent intervals.
Counters for discarded frames are displayed. Frames are discarded as a result of buffer acceptance control or
policing.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan vlan-day-stats (vlanid) port <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot>
/ <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> interval-number <SignedInteger>

Command Parameters
Table 41.21-1 "VLAN Port Statistics for Previous Day Intervals Status Command" Resource
Parameters
Resource Identifier
(vlanid)
port
interval-number

Type

Description

<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identity of the PVC
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<SignedInteger>
interval number

Command Output
Table 41.21-2 "VLAN Port Statistics for Previous Day Intervals Status Command" Display
parameters
Specific Information
name
measure-time

Type

Description

<Vlan::StatsTime>
unit: sec

actually measured time in this interval; expressed in


seconds
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

519

41 VLAN Status Commands

Only Show Details: up stream counters


name
Type
forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Only Show Details: down stream counters


name
Type

520

forward-frame

<Vlan::OctetCounter>

forward-byte

<Vlan::OctetCounter>

discard-frame

<Vlan::OctetCounter>

discard-byte

<Vlan::OctetCounter>

Released

Description
number of frames forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of bytes forwarded in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded frames in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.
number of discarded bytes in upstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

Description
number of frames forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of bytes forwarded in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded frames in downstream
direction per VLAN on a bridge port, for the
specified interval
This element is always shown.
number of discarded bytes in downstream direction
per VLAN on a bridge port, for the specified
interval
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.22 SHub Port VLAN association Status


Command
Command Description
This command shows all VLANs associated to a given port on the Service Hub. This association is configured but
can be overruled as a result of authentication of the port using Radius protocol.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-port-vlan-map (port) vlan-id <Vlan::VlanIndex>

Command Parameters
Table 41.22-1 "SHub Port VLAN association Status Command" Resource Parameters
Resource Identifier
(port)
vlan-id

Type

Description

lt : <Eqpt::Rack> / <Eqpt::Shelf> / port


<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt
<Vlan::VlanIndex>
identity of the vlan
range: [1...4093]

3HH-01016-AAAA-TCZZA Edition 03

Released

521

41 VLAN Status Commands

41.23 SHub VLAN Name mapping Status Command


Command Description
This command shows the VLAN identity that corresponds to a given VLAN name, for a VLAN configured on the
Service Hub.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-vlan-name (name)

Command Parameters
Table 41.23-1 "SHub VLAN Name mapping Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Vlan::AdminString>
length: x<32

name identifying the vlan

Command Output
Table 41.23-2 "SHub VLAN Name mapping Status Command" Display parameters
Specific Information
name
vlan-id

522

Type

Description

<Vlan::VlanIndex>
range: [1...4093]

vlan identity
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.24 SHub VLAN Filtering Database Status


Command
Command Description
This command shows all entries of the Filtering Database given a particular VLAN on the Serice Hub. The filtering
dabatase is used by the bridging function in determining how to propagate a received frame.
The status parameter indicates what the trigger was for creation of the Filtering Database entry, i.e. a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-fdb (vlanid)

Command Parameters
Table 41.24-1 "SHub VLAN Filtering Database Status Command" Resource Parameters
Resource Identifier
(vlanid)

Type

Description

<Vlan::VlanIndex>
range: [1...4093]

vlan id

Command Output
Table 41.24-2 "SHub VLAN Filtering Database Status Command" Display parameters
Specific Information
name
mac
bridge-port
status

Type

Description

<Vlan::MacAddr>
length: 6
lt : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt
<Vlan::FdbEntryStatus>
Possible values are :
- other : entry does not determine the
forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned
dynamically
- self : entry represents one of the device's
addresses

mac address
This element is always shown.
bridge port
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

the origin of the entry, unless invalid


This element is always shown.

Released

523

41 VLAN Status Commands

name
fdb-id
filter-entries

524

Type

Description

- static : entry has been configured by a


manager
<UnsignedInteger>
filtering database identity
This element is only shown in detail mode.
<UnsignedInteger>
current number of entries in this fdb
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.25 SHub Filtering Database Entry Status


Command
Command Description
This command shows one entry of the Filtering Database -if any- given a particular VLAN, a unicast MAC address
and a bridge port on the Service Hub. The filtering dabatase is used by the bridging function in determining how to
propagate a received frame.
The status parameter indicates what the trigger was for creation of the Filtering Database entry, i.e. a filtering
entry can be configured or dynamically learned.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-filter-entry (vlanid) unicast-mac <Vlan::MacAddr>

Command Parameters
Table 41.25-1 "SHub Filtering Database Entry Status Command" Resource Parameters
Resource Identifier
(vlanid)
unicast-mac

Type

Description

<Vlan::VlanIndex>
range: [1...4093]
<Vlan::MacAddr>
length: 6

vlan id
mac address

Command Output
Table 41.25-2 "SHub Filtering Database Entry Status Command" Display parameters
Specific Information
name
learnt-port
status

Type

Description

<Shub::LearntBridgePort>
range: [0...24]
<Vlan::FdbEntryStatus>
Possible values are :
- other : entry does not determine the
forwarding of frames
- invalid : entry is being removed
- learned : entry has been learned
dynamically
- self : entry represents one of the device's
addresses

port where the mac address was learnt


This element is always shown.
the origin of the entry, unless invalid
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

525

41 VLAN Status Commands

name

Type

Description

- static : entry has been configured by a


manager

526

Released

3HH-01016-AAAA-TCZZA

Edition 03

41 VLAN Status Commands

41.26 SHub Duplicate Mac Alarm Status Command


Command Description
This command is usefull when a Duplicate MAC Alarm has occured. A Duplicate MAC Alarm is raised when a new
MAC Address could not be learned on a Port of the Service Hub because this MAC Address already exists on
another Port of the Service Hub for the same VLAN, i.e.within the same Filtering Database.
When a Duplicate MAC Alarm is raised it provides the Port and Vlan identity where the alarm occured but it does
not carry the MAC Address itself.
This command is helpful in displaying the list of duplicate MAC Addresses on the specific Port and Vlan.
The Duplicate MAC Alarm information is available as long as the alarm is "on".

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show vlan shub-dup-mac-alarm (dup-port) dup-vlan-id <Vlan::VlanIndex>

Command Parameters
Table 41.26-1 "SHub Duplicate Mac Alarm Status Command" Resource Parameters
Resource Identifier
(dup-port)
dup-vlan-id

Type

Description

lt : <Eqpt::Rack> / <Eqpt::Shelf> / duplicate bridge port


<Eqpt::LtSlot>
|
network
:
<Shub::NetworkPort> | nt
<Vlan::VlanIndex>
duplicate vlan id
range: [1...4093]

Command Output
Table 41.26-2 "SHub Duplicate Mac Alarm Status Command" Display parameters
Specific Information
name
duplicate-mac

Type

Description

<Vlan::MacAddr>
length: 6

duplicate mac address


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

527

42- Link Aggregation Status Commands

42.1 Link Aggregation Group Status Command


42.2 Link Aggregation Member List Status Command
42.3 Link Aggregate Member Link Status Command

528

Released

42-529
42-532
42-533

3HH-01016-AAAA-TCZZA

Edition 03

42 Link Aggregation Status Commands

42.1 Link Aggregation Group Status Command


Command Description
This command shows information about a Link Aggregation Group configured on the Service Hub. The information
pertains to the Group. The operator will identify the Group by means of the primary link or primary port.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la aggregator-info (port)

Command Parameters
Table 42.1-1 "Link Aggregation Group Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

interface index of the port

Command Output
Table 42.1-2 "Link Aggregation Group Status Command" Display parameters
Specific Information
name
mac-address
aggregate

actor-oper-key
short name:actor-key

Type

Description

<Vlan::MacAddr>
length: 6
<Shub::AggregateFlag>
Possible values are :
- aggregate : aggregate
- individual : individual
<Shub::LacpKey>
range: [0...65535]

Specifies MAC address assigned to the Aggregator.


This element is shown in normal mode.
Specifies whether the aggregator represents an
aggregate or an individual link.
This element is shown in normal mode.

partner-sys-id

<Vlan::MacAddr>
length: 6

partner-sys-priority
short name:prio

<Shub::LaPartnerSysPriority>
range: [0...65535]

partner-oper-key

<Shub::LacpKey>
short range: [0...65535]

name:partner-key

The current operational value of the key for the


aggregator.
This element is shown in normal mode.
Specifies MAC address for the current protocol
partner of this aggregator
This element is shown in normal mode.
Specifies priority value associated with the
partner's system id.
This element is shown in normal mode.
The current operational value for the aggregator's
current protocol partner.
This element is shown in normal mode.

Only Show Details: aggregator parameters

3HH-01016-AAAA-TCZZA Edition 03

Released

529

42 Link Aggregation Status Commands

name
mac-address
aggregate

actor-oper-key

Type

Description

<Vlan::MacAddr>
length: 6
<Shub::AggregateFlag>
Possible values are :
- aggregate : aggregate
- individual : individual
<Shub::LacpKey>
range: [0...65535]

Specifies MAC address assigned to the Aggregator.


This element is always shown.
Specifies whether the aggregator represents an
aggregate or an individual link.
This element is always shown.

partner-sys-id

<Vlan::MacAddr>
length: 6

partner-sys-priority

<Shub::LaPartnerSysPriority>
range: [0...65535]

partner-oper-key

<Shub::LacpKey>
range: [0...65535]

Only Show Details: statistics


name
Type
rx-octets

<UnsignedInteger>

rx-frames

<UnsignedInteger>

rx-ucast-frames

<UnsignedInteger>

rx-mcast-frames

<UnsignedInteger>

rx-bcast-frames

<UnsignedInteger>

rx-discard-frames

<UnsignedInteger>

rx-error-frames

<UnsignedInteger>

rx-unknown-prot-frames<UnsignedInteger>

530

Released

The current operational value of the key for the


aggregator.
This element is always shown.
Specifies MAC address for the current protocol
partner of this aggregator
This element is always shown.
Specifies priority value associated with the
partner's system id.
This element is always shown.
The current operational value for the aggregator's
current protocol partner.
This element is always shown.

Description
A count of the data and padding octets received by
the aggregator, from the aggregation ports that are
members of the aggregation.
This element is always shown.
A count of the data frames received by the
aggregator, from the aggregation ports that are
members of the aggregation.
This element is always shown.
The total number of unicast user data frames
received by the aggregation.
This element is always shown.
A count of the data frames received by this
aggregator, from the aggregation ports that are
members of the aggregation,that were addressed to
an active group address other than the broadcast
address.
This element is always shown.
A count of the broadcast data frames received by
this Aggregator, from the Aggregation Ports that
are members of the aggregation.
This element is always shown.
A count of data frames,received on all ports that are
members of the aggregation,that were discarded by
the collection function of the aggregator as they
were received on ports whose collection function
was disabled.
This element is always shown.
A count of data frames discarded on reception by
all ports that are members of the aggregation,or that
were discarded by the collection function of the
aggregator,or that were discarded by the aggregator
due to the detection of an illegal slow protocols
PDU
This element is always shown.
A count of data frames discarded on reception by
all ports that are members of the aggregation,due to

3HH-01016-AAAA-TCZZA

Edition 03

42 Link Aggregation Status Commands

name

Type

tx-octets

<UnsignedInteger>

tx-frames

<UnsignedInteger>

tx-ucast-frames

<UnsignedInteger>

tx-mcast-frames

<UnsignedInteger>

tx-bcast-frames

<UnsignedInteger>

tx-discard-frames

<UnsignedInteger>

tx-error-frames

<UnsignedInteger>

trap-port

<SignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

Description
the detection of an unknown slow protocols PDU .
This element is always shown.
A count of the data and padding octets transmitted
by this aggregator on all aggregation ports that are
members of the aggregation.
This element is always shown.
A count of the data frames transmitted by this
aggregator on all aggregation ports that are
members of the aggregation.
This element is always shown.
The total number of unicast user data frames
transmitted by aggregation.
This element is always shown.
A count of the data frames transmitted by this
aggregator on all aggregation ports that are
members of the aggregation,to a group destination
address other than the broadcast address.
This element is always shown.
A count of the broadcast data frames transmitted by
this aggregator on all aggregation ports that are
members of the aggregation.
This element is always shown.
A count of data frames requested to be transmitted
by this aggregator that were discarded by the
distribution function of the aggregator when
conversations are re-allocated to different ports,due
to the requirement to ensure that the conversations
are flushed on the old ports in order to maintain
proper frame ordering ,or discarded as a result of
excessive collisions by ports that are members of
the aggregation.
This element is always shown.
A count of data frames requested to be transmitted
by this aggregator that experienced transmission
errors on ports that are members of the
aggregation.This count does not include frames
discarded due to excess collisions.
This element is always shown.
Specifies index used to generate TRAP for the
particular aggregator
This element is always shown.

Released

531

42 Link Aggregation Status Commands

42.2 Link Aggregation Member List Status


Command
Command Description
This command show the list of ports that are members of a Link Aggregation Group.
The Link Aggregation Group should be identified by means of its primary link, else the list of ports will be empty.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la aggregate-list (network-port) participant-port <Shub::NetworkPort>

Command Parameters
Table 42.2-1 "Link Aggregation Member List Status Command" Resource Parameters
Resource Identifier
(network-port)
participant-port

532

Type

Description

<Shub::NetworkPort>
range: [1...7]
<Shub::NetworkPort>
range: [1...7]

port

Released

participants in the aggregation group

3HH-01016-AAAA-TCZZA

Edition 03

42 Link Aggregation Status Commands

42.3 Link Aggregate Member Link Status Command


Command Description
This command shows information for a member of a Link Aggregation Group configured on the SHub. The member
link is identified by its port number.
Detailled information can be obtained on LACP protocol statistics and debugging information.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show la network-port-info (port)

Command Parameters
Table 42.3-1 "Link Aggregate Member Link Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

interface index of the network port

Command Output
Table 42.3-2 "Link Aggregate Member Link Status Command" Display parameters
Specific Information
name
aggregate

standby

Type

Description

<Shub::AggregateFlag>
Possible values are :
- aggregate : aggregate
- individual : individual
<Shub::SbyStatus>
Possible values are :
- active : active
- standby : standby

specifies whether the aggregation port is able to


aggregate or only able to operate as an individual
link.
This element is always shown.
specifies whether aggregation port is in active or
standby
This element is always shown.

Only Show Details: aggregate/individual parameters


name
Type
actor-sys-id

<Vlan::MacAddr>
length: 6

actor-key

<Shub::LacpKey>
range: [0...65535]

3HH-01016-AAAA-TCZZA Edition 03

Description
specifies MAC addr that defines the value of the
system id for the system that contains this
aggregation port.
This element is always shown.
current operational value of the key for the
aggregation port.
This element is always shown.

Released

533

42 Link Aggregation Status Commands

name

Type

Description

partner-sys-priority

<Shub::LaPortPartnerAdminSysPrio>
range: [0...255]

partner-sys-id

<Vlan::MacAddr>
length: 6

partner-key

<Shub::LacpKey>
range: [0...65535]

operational value of priority associated with the


partner's system id.
This element is always shown.
specifies MAC addr value representing the current
value of the aggregation port's protocol partner's
system id.
This element is always shown.
current operational value of the key for the protocol
partner.
This element is always shown.
specifies the aggregator that this aggregation port
has currently selected
This element is always shown.
specifies the aggregator that this aggregation port is
currently attached to. Zero indicates that the
aggregation port is not currently attached to an
aggregator.
This element is always shown.
port number locally assigned to the aggregation
port.
This element is always shown.
operational port number assigned to this
aggregation port by the aggregation port's protocol
partner.
This element is always shown.
priority value assigned to this aggregation port by
the partner.
This element is always shown.
actor oper lacp synch state
This element is always shown.

actual-aggregator-port <Shub::NetworkPort>
range: [1...7]
attached-aggreg-port

<SignedInteger>

actor-port

<Shub::LaPartnerAdminPort>
range: [0...65535]

partner-port

<Shub::LaPartnerAdminPort>
range: [0...65535]

partner-port-priority

<Shub::LaPortActorPortPriority>
range: [0...255]

actor-synch-state

<Shub::ActorOperLacpSynchState>
Possible values are :
- synchronised : actor is syncronised
- not-synchronised : actor is not
synchronised
<Shub::ActorOperLacpCollectState>
Possible values are :
- collecting : the actor is collecting
- not-collecting : the actor is not collecting
<Shub::ActorOperLacpDistributeState>
Possible values are :
- distributing : the actor is distributing
- not-distributing : the actor is not
distributing
<Shub::ActorOperLacpDefaultedState>
Possible values are :
- is-defaulted : the actor is defaulted
- is-not-defaulted : the actor is not
defaulted
<Shub::ActorOperLacpExpiredState>
Possible values are :
- is-expired : actor is in lacp expired state
- is-not-expired : actor is not in lacp
expired state
<Shub::ActorOperLacpSynchState>
Possible values are :
- synchronised : actor is syncronised
- not-synchronised : actor is not
synchronised

actor-collect-state

actor-distribute-state

actor-defaulted-state

actor-expired-state

partner-synch-state

534

Released

actor oper lacp collecting state


This element is always shown.
actor oper lacp distributing state
This element is always shown.

actor oper lacp defaulted state


This element is always shown.

actor oper lacp expired state


This element is always shown.

partner oper lacp synch state


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

42 Link Aggregation Status Commands

name
partner-collect-state

partn-distribute-state

partn-defaulted-state

partner-expired-state

Type

Description

<Shub::ActorOperLacpCollectState>
Possible values are :
- collecting : the actor is collecting
- not-collecting : the actor is not collecting
<Shub::ActorOperLacpDistributeState>
Possible values are :
- distributing : the actor is distributing
- not-distributing : the actor is not
distributing
<Shub::ActorOperLacpDefaultedState>
Possible values are :
- is-defaulted : the actor is defaulted
- is-not-defaulted : the actor is not
defaulted
<Shub::ActorOperLacpExpiredState>
Possible values are :
- is-expired : actor is in lacp expired state
- is-not-expired : actor is not in lacp
expired state

partner oper lacp collecting state


This element is always shown.
partner oper lacp distributing state
This element is always shown.

partner oper lacp defaulted state


This element is always shown.

partner oper lacp expired state


This element is always shown.

Only Show Details: link aggregation control protocol statistics


name
Type
Description
lacp-pdus-rx

<UnsignedInteger>

marker-rx

<UnsignedInteger>

marker-response-rx

<UnsignedInteger>

unknown-rx

<UnsignedInteger>

illegal-rx

<UnsignedInteger>

lacp-pdus-tx

<UnsignedInteger>

marker-tx

<UnsignedInteger>

marker-response-tx

<UnsignedInteger>

Only Show Details: debugging information


name
Type
rx-state

<Vlan::LaRxState>
Possible values are :
- present : present
- expired : expired
- defaulted : defaulted

3HH-01016-AAAA-TCZZA Edition 03

number of valid LACPDUs received on this


aggregation port.
This element is only shown in detail mode.
nbr of valid marker PDUs received on this
aggregation port.
This element is only shown in detail mode.
nbr of valid marker response PDUs received on this
aggregation port.
This element is only shown in detail mode.
nbr of frames rx that either: carry the slow
protocols ethernet type value, but contain an
unknown PDU,or: are addressed to the slow
protocols group MAC addr, but do not carry the
slow protocols ethernet type.
This element is only shown in detail mode.
nbr of frames rx that carry the slow protocols
ethernet type value, but contain a badly formed
PDU or an illegal value of protocol subtype.
This element is only shown in detail mode.
number of LACPDUs transmitted on this
aggregation port.
This element is only shown in detail mode.
number of marker PDUs transmitted on this
aggregation port.
This element is only shown in detail mode.
nbr of marker response PDUs transmitted on this
aggregation port.
This element is only shown in detail mode.

Description
specifies receive state machine for the aggregation
port
This element is only shown in detail mode.

Released

535

42 Link Aggregation Status Commands

name

Type

Description

- initialize : initialize
- lacpdisabled : lacp Disabled
- portdisabled : port Disabled
mux-state
<Shub::LaMuxState>
specifies the mux state machine for the aggregation
Possible values are :
port
- detached : detached
This element is only shown in detail mode.
- waiting : waiting
- attached : attached
- collecting : collecting
- distributing : distributing
- collect-distributing : collecting and
distributing
mux-reason
<PrintableString>
specifies the reason for the most recent change of
mux machine state.
This element is only shown in detail mode.
actor-churn-state
<Shub::LaChurnState>
specifies the state of the actor churn detection
Possible values are :
machine for the aggregation port.
- no-churn : no churn
This element is only shown in detail mode.
- churn : churn
- churn-monitor : churn monitor
actor-churn-count
<UnsignedInteger>
nbr of times the actor churn state machine has
entered the ACTOR_CHURN state.
This element is only shown in detail mode.
actor-sync-transit-cnt <UnsignedInteger>
nbr of times the actor's mux state machine has
entered the IN_SYNC state.
This element is only shown in detail mode.
actor-lag-id-chg-count <UnsignedInteger>
nbr of times the actor's perception of the lag id for
this aggregation port has changed.
This element is only shown in detail mode.
partner-churn-state
<Shub::LaChurnState>
specifies the state of the partner churn detection
Possible values are :
machine for the aggregation port.
- no-churn : no churn
This element is only shown in detail mode.
- churn : churn
- churn-monitor : churn monitor
partner-churn-count
<UnsignedInteger>
nbr of times the partner churn state machine has
entered the PARTNER_CHURN state.
This element is only shown in detail mode.
partn-sync-transit-cnt <UnsignedInteger>
nbr of times the partner's mux state machine has
entered the IN_SYNC state.
This element is only shown in detail mode.
partner-lag-id-chg-cnt <UnsignedInteger>
nbr of times the partner's perception of the lag id
for this aggregation port has changed.
This element is only shown in detail mode.

536

Released

3HH-01016-AAAA-TCZZA

Edition 03

43- RSTP Status Commands

43.1 RSTP Bridge and Port Status Command

3HH-01016-AAAA-TCZZA Edition 03

43-538

Released

537

43 RSTP Status Commands

43.1 RSTP Bridge and Port Status Command


Command Description
This command shows information regarding the Rapid Spanning Tree of the Bridge.
Spanning tree information is shown for the bridge and for the particular bridge port specified in the request,
mainly operational information is displayed.
Detailled statistics can be obtained on the RSTP protocol regarding the reception and transmission of BPDUs.

User Level
The command can be accessed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> show rstp port-info (port)

Command Parameters
Table 43.1-1 "RSTP Bridge and Port Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

interface index of the port

Command Output
Table 43.1-2 "RSTP Bridge and Port Status Command" Display parameters
Common Information
name
Type
protocol

version

designated-root

538

<Shub::StpProtocolSpec>
Possible values are :
- unknown : unknown
- dec-lb-100 : dec lb 100
- spanning-tree : ieee 802 id
<Shub::RstpVersion>
Possible values are :
- ieee-802.1d-stp : stp compatible
- ieee-802.1w-rstp : rstp compatible
<Vlan::Binary-08-08>
length: 8

root-cost

<SignedInteger>

root-port

<SignedInteger>

Released

Description
Indicates the version of the spanning tree protocol
being run.
This element is always shown.
Indicates the stp version running on the bridge
This element is always shown.
Specifies the bridge identifier of the root of the
spanning tree as determined by the spanning tree
protocol.
This element is always shown.
Specifies the cost of the path to the root.
This element is always shown.
The port number of the port which offers the lowest

3HH-01016-AAAA-TCZZA

Edition 03

43 RSTP Status Commands

name

Type

max-age

<SignedInteger>

hello-time

<SignedInteger>

hold-time

<SignedInteger>

fwd-delay

<SignedInteger>

Specific Information
name
role

state

oper-edge-port

oper-p2p

fwd-transition-count

designated-root

cost path from this bridge to the root bridge.


This element is always shown.
Specifies the maximum age of information learned
from the network on any port before it is discarded
This element is always shown.
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
This element is always shown.
Specifies the interval length during which no more
than two configuration bridge PDUs shall be
transmitted
This element is always shown.
Specifies how long the port stays in a particular
state before moving to the next state.
This element is always shown.

Type

Description

<Shub::StpPortRole>
Possible values are :
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
<Shub::StpPortState>
Possible values are :
- disabled : disabled
- blocking : blocking
- listening : listening
- learning : learning
- forwarding : forwarding
- broken : broken
<Shub::OperEdgeStatus>
Possible values are :
- no-edge-port : no edge port
- edge-port : edge port
<Shub::OperP2pStatus>
Possible values are :
- no-p2p : no point to point
- p2p : point to point

Specifies the current state of the port role selection


state machine.
This element is shown in normal mode.

<UnsignedInteger>

Only Show Details: stp port parameters


name
Type
state

Description

<Shub::StpPortState>
Possible values are :
- disabled : disabled
- blocking : blocking
- listening : listening
- learning : learning
- forwarding : forwarding
- broken : broken
<Vlan::Binary-08-08>

3HH-01016-AAAA-TCZZA Edition 03

Specifies the port's current state.


This element is shown in normal mode.

The operational value of the edge port parameter.


This element is shown in normal mode.
The operational point-to-point status of the LAN
segment attached to this port. It indicates whether a
port is considered to have a point-to-point
connection or not.
This element is shown in normal mode.
The number of times this port has transitioned from
the learning state to the forwarding state.
This element is always shown.

Description
Specifies the port's current state.
This element is always shown.

The unique bridge identifier of the bridge recorded

Released

539

43 RSTP Status Commands

name

Type

Description

length: 8

as the root in the configuration BPDUs transmitted


by the designated bridge for the segment to which
the port is attached.
This element is always shown.
The path cost of the designated port of the segment
connected to this port.
This element is always shown.
The bridge identifier of the bridge which this port
considers to be the designated bridge for this port's
segment.
This element is always shown.
The port identifier of the port on the designated
bridge for this port's segment.
This element is always shown.
The number of times this port has transitioned from
the learning state to the forwarding state.
This element is always shown.
The operational value of the edge port parameter.
This element is always shown.

designated-cost

<SignedInteger>

designated-bridge

<Vlan::Binary-08-08>
length: 8

designated-port

<Vlan::Binary-02-02>
length: 2

fwd-transition-count

<UnsignedInteger>

oper-edge-port

<Shub::OperEdgeStatus>
Possible values are :
- no-edge-port : no edge port
- edge-port : edge port
<Shub::OperP2pStatus>
Possible values are :
- no-p2p : no point to point
- p2p : point to point

oper-p2p

role

<Shub::StpPortRole>
Possible values are :
- disabled : disabled
- alternate : alternate
- backup : backup
- root : root
- designated : designated
<Shub::RstpVersion>
Possible values are :
- ieee-802.1d-stp : stp compatible
- ieee-802.1w-rstp : rstp compatible

oper-stp-version

Only Show Details: stp port protocol statistics


name
Type
rx-rst-bpdu-frames

<UnsignedInteger>

rx-config-bpdu-frames <UnsignedInteger>
rx-tcn-bpdu-frames

<UnsignedInteger>

tx-rst-bpdu-frames

<UnsignedInteger>

tx-config-bpdu-frames <UnsignedInteger>
tx-tcn-bpdu-frames

540

<UnsignedInteger>

Released

The operational point-to-point status of the LAN


segment attached to this port. It indicates whether a
port is considered to have a point-to-point
connection or not.
This element is always shown.
This indicates the current port role assumed by this
port.
This element is always shown.

This indicates whether the port is operationally in


the rstp mode or the stp-compatible mode.
This element is always shown.

Description
The number of RST BPDUs that have
received on this port.
This element is only shown in detail mode.
The number of Config BPDUs that have
received on this port.
This element is only shown in detail mode.
The number of TCN BPDUs that have
received on this port.
This element is only shown in detail mode.
The number of RST BPDUs that have
transmitted by this port.
This element is only shown in detail mode.
The number of config BPDUs that have
transmitted by this port.
This element is only shown in detail mode.
The number of TCN BPDUs that have
transmitted by this port.

3HH-01016-AAAA-TCZZA

Edition 03

been
been
been
been
been
been

43 RSTP Status Commands

name
invalid-bpdu-frames

Type
<UnsignedInteger>

Only Show Details: stp bridge parameters


name
Type
protocol

version

designated-root

<Shub::StpProtocolSpec>
Possible values are :
- unknown : unknown
- dec-lb-100 : dec lb 100
- spanning-tree : ieee 802 id
<Shub::RstpVersion>
Possible values are :
- ieee-802.1d-stp : stp compatible
- ieee-802.1w-rstp : rstp compatible
<Vlan::Binary-08-08>
length: 8

root-cost

<SignedInteger>

root-port

<SignedInteger>

max-age

<SignedInteger>

hello-time

<SignedInteger>

hold-time

<SignedInteger>

fwd-delay

<SignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is only shown in detail mode.
The number of invalid BPDUs that have been
received on this port.
This element is only shown in detail mode.

Description
Indicates the version of the spanning tree protocol
being run.
This element is always shown.
Indicates the stp version running on the bridge
This element is always shown.
Specifies the bridge identifier of the root of the
spanning tree as determined by the spanning tree
protocol.
This element is always shown.
Specifies the cost of the path to the root.
This element is always shown.
The port number of the port which offers the lowest
cost path from this bridge to the root bridge.
This element is always shown.
Specifies the maximum age of information learned
from the network on any port before it is discarded
This element is always shown.
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
This element is always shown.
Specifies the interval length during which no more
than two configuration bridge PDUs shall be
transmitted
This element is always shown.
Specifies how long the port stays in a particular
state before moving to the next state.
This element is always shown.

Released

541

44- QOS Status Commands

44.1 QoS Session Profile Status Command


44.2 QoS Marker Profile Status Command
44.3 QoS Policer Profile Status Command
44.4 QoS Queue Profile Status Command
44.5 QoS Scheduler Profile Status Command
44.6 QoS CAC Profile Status Command
44.7 QoS DSL Bandwidth Status Command
44.8 QoS Buffer Overflow Statistics for Previous Quarter
44.9 QoS Buffer Overflow Statistics for Current Quarter
44.10 QoS Buffer Overflow Statistics for Previous Day
44.11 QoS Buffer Overflow Statistics for Current Day
44.12 QoS Buffer Overflow Statistics Total Status
Command
44.13 QoS SHub Meter Statistics Status Command
44.14 QoS SHub Flow Statistics Status Command

542

Released

44-543
44-544
44-545
44-546
44-547
44-548
44-549
44-551
44-553
44-555
44-557
44-559
44-562
44-563

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.1 QoS Session Profile Status Command


Command Description
This command shows the QoS session profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS session profiles. The QoS session profile usage represents the
total user sessions (both for statically-configured and dynamic sessions).

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage session (name)

Command Parameters
Table 44.1-1 "QoS Session Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.1-2 "QoS Session Profile Status Command" Display parameters
Specific Information
name
ref-count

Type

Description

<AsamProfileRefCount>
range: [0...65535]

Indicates the number of entities using this profile. If


the reference count is greater than 0, then this
profile is 'in use', and may NOT be deleted. If the
value is 0, then this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

543

44 QOS Status Commands

44.2 QoS Marker Profile Status Command


Command Description
This command shows the QoS marker profile status. A QoS profile that is in use cannot be deleted, so the operator
can ue this command to display the usage of QoS marker profiles. The QoS marker profile usage shows the
references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage marker (name)

Command Parameters
Table 44.2-1 "QoS Marker Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.2-2 "QoS Marker Profile Status Command" Display parameters
Specific Information
name
ref-count

544

Type

Description

<AsamProfileRefCount>
range: [0...65535]

Indicates the number of entities using this profile. If


the reference count is greater than 0, then this
profile 'is in use', and may NOT be deleted. If the
value is 0, then this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.3 QoS Policer Profile Status Command


Command Description
This command shows the QoS policer profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS policer profiles. The QoS policer profile usage shows the
references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage policer (name)

Command Parameters
Table 44.3-1 "QoS Policer Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.3-2 "QoS Policer Profile Status Command" Display parameters
Specific Information
name
ref-count

Type

Description

<AsamProfileRefCount>
range: [0...65535]

Indicates the number of entities using this profile. If


the reference count is greater than 0, then this
profile is 'in use', and may NOT be deleted. If the
value is 0, then this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

545

44 QOS Status Commands

44.4 QoS Queue Profile Status Command


Command Description
This command shows the QoS queue profile status. A QoS profile that is in use cannot be deleted, so the operator
can use this command to display the usage of QoS queue profiles. The QoS queue profile usage shows the
references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage queue (name)

Command Parameters
Table 44.4-1 "QoS Queue Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.4-2 "QoS Queue Profile Status Command" Display parameters
Specific Information
name
ref-count

546

Type

Description

<AsamProfileRefCount>
range: [0...65535]

indicates the number of entities using this profile. If


the reference count is not 0, then this profile is 'in
use', and can not be deleted. If the value is 0, then
this profile is 'not in use', and can be deleted.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.5 QoS Scheduler Profile Status Command


Command Description
This command shows the QoS scheduler profile status. A QoS profile that is in use cannot be deleted, so the
operator can use this command to display the usage of QoS scheduler profiles. The QoS scheduler profile usage
shows the references from existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage scheduler (name)

Command Parameters
Table 44.5-1 "QoS Scheduler Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.5-2 "QoS Scheduler Profile Status Command" Display parameters
Specific Information
name
ref-count

Type

Description

<AsamProfileRefCount>
range: [0...65535]

Indicates the number of entities using this profile. If


the reference count is greater than 0, then this
profile is 'in use', and may NOT be deleted. If the
value is 0, then this profile is 'not in use', and can
be deleted.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

547

44 QOS Status Commands

44.6 QoS CAC Profile Status Command


Command Description
This command shows the QoS CAC profile status. A QoS profile that is in use cannot be deleted so the operator can
use this command to display the usage of QoS CAC profiles. The QoS CAC profile usage shows the references from
existing QoS session profiles because these profiles are not applied on their own.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos profile-usage cac (name)

Command Parameters
Table 44.6-1 "QoS CAC Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

A unique profile name

Command Output
Table 44.6-2 "QoS CAC Profile Status Command" Display parameters
Specific Information
name
ref-count

548

Type

Description

<AsamProfileRefCount>
range: [0...65535]

indicates the number of entities using this profile. If


the reference count is greater than 0, then this
profile is 'in use', and may NOT be deleted. If the
value is 0, then this profile is 'not in use', and can
be deleted.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.7 QoS DSL Bandwidth Status Command


Command Description
This command displays the bandwidth allocation and usage for each DSL link.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos dsl-bandwidth (index)

Command Parameters
Table 44.7-1 "QoS DSL Bandwidth Status Command" Resource Parameters
Resource Identifier
(index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ physical port of a dsl link

Command Output
Table 44.7-2 "QoS DSL Bandwidth Status Command" Display parameters
Specific Information
name

Type

Description

frame-net-bw

<SignedInteger>

res-data-bw

<SignedInteger>

res-voice-bw

<SignedInteger>

m-cast-max-bw

<SignedInteger>

Represents the approximate bandwidth available


for Ethernet frames, which is guaranteed to be
available by the physical layer. This approximation
is made by the configurable ATM overhead factor.
This element is always shown.
The portion the frame-net-bw that is reserved for
all data services (typically HSI user traffic). This is
a reserved value per DSL interface (and not per
user session) and applicable in the downstream
direction only.
This element is only shown in detail mode.
The portion of the frame-net-bw that is reserved for
all voice services (typically HSI user traffic). This
is a reserved value per DSL interface (and not per
voice call) and applicable in the downstream
direction only. The usage of this value is to set
apart a minimum rate such that video and voice
services can never impact each other.
This element is only shown in detail mode.
Represents the rate limitation imposed by the

3HH-01016-AAAA-TCZZA Edition 03

Released

549

44 QOS Status Commands

name

550

Type

m-cast-avail-bw

<SignedInteger>

m-cast-used-bw

<SignedInteger>

Released

Description
operator upon the maximum bandwidth to be
consumed by user multicast video sessions. This
limit can enforce a smaller value than actually
available on the DSL link.
This element is only shown in detail mode.
Represents the bandwidth available for multicast
services, calculated by the ISAM. This value is
what is left from frame-net-bw after deducting from
it res-data-bw and res-voice-bw. The minimum of
m-cast-avail-bw and m-cast-max-bw will be the
actual limitation for user multicast bandwidth usage
per DSL link.
This element is always shown.
Shows the bandwidth currently in use by
pre-configured multicast streams.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.8 QoS Buffer Overflow Statistics for Previous


Quarter
Command Description
This command shows the QoS buffer overflow statistics of the previous 15 minute interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-15min (equip-slot) interval-num
<Qos::CounterInterval>

Command Parameters
Table 44.8-1 "QoS Buffer Overflow Statistics for Previous Quarter" Resource Parameters
Resource Identifier
(equip-slot)

interval-num

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<Qos::CounterInterval>
time interval interms of 15 min
range: [1...32]

Command Output
Table 44.8-2 "QoS Buffer Overflow Statistics for Previous Quarter" Display parameters
Specific Information
name

Type

Description

upstream

<Counter>

upstream-obc

<Counter>

the number of buffer overflows on an EBLT LIM


module in the upstream direction on a 15 minute
interval basis. The upstream direction on the LIM is
non-blocking, hence this value should always read
zero under normal working conditions.
This element is always shown.
number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
15 minute interval basis. In some special conditions
such as system startup or re-start packet loss may
occur here but under normal circumstances this
counter should read zero.

3HH-01016-AAAA-TCZZA Edition 03

Released

551

44 QOS Status Commands

name

Type

downstream-obc

<Counter>

downstream-unicast

<Counter>

downstream-multicast <Counter>

552

obc-injected

<Counter>

measured-time

<TimeTicks>
unit: msec

Released

Description
This element is always shown.
the number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic downstream
on a 15 minute interval basis. Under normal
circumstances this counter should always read zero.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream unicast pool. This even should not
occur. Queue fill-up and tail drop is a normal
condition for data traffic (individual queues) but
not for voice and video on demand services
(individual queues). If the total downstream pool is
filled, that means that non-QoS aware packet loss
will occur.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream multicast pool. This even should
be a rather rare event. On the long term, buffer
overflow in the multicast pool may occur a few
times a day (less than a few tens under heavy
multicast usage).
This element is always shown.
Previous 15 minute for OBC-injected buffer
overflow event on LIM, This event happens if the
processor cannot cope with the extensive load of
the system and cannot reassemble a frame in due
time. This event should not occur under normal
working conditions. This counter is used for both
upstream and downstream OBC-injected frames on
an EBLT LIM.
This element is always shown.
the amount of time, that statistics for this entry
have been counted.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.9 QoS Buffer Overflow Statistics for Current


Quarter
Command Description
This command shows the QoS buffer overflow statistics of the current 15 minute interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-15min (equip-slot)

Command Parameters
Table 44.9-1 "QoS Buffer Overflow Statistics for Current Quarter" Resource Parameters
Resource Identifier
(equip-slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 44.9-2 "QoS Buffer Overflow Statistics for Current Quarter" Display parameters
Specific Information
name

Type

Description

upstream

<Counter>

upstream-obc

<Counter>

number of buffer overflows on an EBLT LIM


module in the upstream direction on a 15 minute
interval basis in the current measurement epoch.
The upstream direction on the LIM is
non-blocking, hence this value should read always
zero under normal working conditions.
This element is always shown.
number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
15 minute interval basis in the current
measurement. In some special conditions such as
system startup or re-start packet loss may occur
here but under normal circumstances this counter
should read zero.

3HH-01016-AAAA-TCZZA Edition 03

Released

553

44 QOS Status Commands

name

Type

downstream-obc

<Counter>

downstream-unicast

<Counter>

downstream-multicast <Counter>

554

obc-injected

<Counter>

elapse-time

<TimeTicks>
unit: msec

measured-time

<TimeTicks>
unit: msec

Released

Description
This element is always shown.
number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic downstream
on a 15 minute interval basis in the current
measurement.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream unicast pool. This even should not
occur. Queue fill-up and tail drop is a normal
condition for data traffic (individual queues) but
not for voice and video on demand services
(individual queues). If the total downstream pool is
filled, that means that QoS un-aware packet loss
will occur.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream multicast pool. This even should
be a rather rare event. On the long term, buffer
overflow in the multicast pool may occur a few
times a day (less than a few tens under heavy
multicast usage).
This element is always shown.
Current 15 minute for OBC-injected buffer
overflow event on LIM, there is a reserved buffer
pool for OBC-injected traffic which under very
heavy load conditions may eventually get full, and
the LIM OBC will be unable to communicate with
the external world for a very short time interval.
This element is always shown.
elapsed time interval since the last measurement
epoch started.
This element is always shown.
amount of time, that statistics for this entry have
been counted.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.10 QoS Buffer Overflow Statistics for Previous


Day
Command Description
This command shows the QoS buffer overflow statistics of the previous 1 day interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow prev-1day (equip-slot)

Command Parameters
Table 44.10-1 "QoS Buffer Overflow Statistics for Previous Day " Resource Parameters
Resource Identifier
(equip-slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 44.10-2 "QoS Buffer Overflow Statistics for Previous Day " Display parameters
Specific Information
name

Type

Description

upstream

<Counter>

upstream-obc

<Counter>

downstream-obc

<Counter>

number of buffer overflows on an EBLT LIM


module in the upstream direction on a one day
interval basis. The upstream direction on the LIM is
non-blocking, hence this value should read always
zero under normal working conditions.
This element is always shown.
number of buffer overflows on an EBLT LIM
module for the OBC-directed traffic upstream on a
one day interval basis. In some special conditions
such as system startup or re-start packet loss may
occur here but under normal circumstances this
counter should read zero.
This element is always shown.
number of buffer overflows on a EBLT LIM

3HH-01016-AAAA-TCZZA Edition 03

Released

555

44 QOS Status Commands

name

Type

downstream-unicast

<Counter>

downstream-multicast <Counter>

556

obc-injected

<Counter>

measured-time

<TimeTicks>
unit: msec

Released

Description
module for the OBC-directed traffic downstream
on a one day interval basis. Under normal
circumstances this counter should always read zero.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream unicast pool. This even should not
occur. Queue fill-up and tail drop is a normal
condition for data traffic (individual queues) but
not for voice and video on demand services
(individual queues). If the total downstream pool is
filled, that means that non-QoS aware packet loss
will occur.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream multicast pool. On the long term,
buffer overflow in the multicast pool may occur a
few times a day (less than a few tens under heavy
multicast usage).
This element is always shown.
previous one day OBC-injected buffer-pool
overflow. In some heavy load conditions this event
may occur as the OBC-injected frames fill up
completely the buffer space reserved for this
purpose.
This element is always shown.
actual time elapsed during which the measurement
was made
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.11 QoS Buffer Overflow Statistics for Current


Day
Command Description
This command shows the QoS buffer overflow statistics of the current 1 day interval.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow current-1day (equip-slot)

Command Parameters
Table 44.11-1 "QoS Buffer Overflow Statistics for Current Day" Resource Parameters
Resource Identifier
(equip-slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 44.11-2 "QoS Buffer Overflow Statistics for Current Day" Display parameters
Specific Information
name

Type

Description

upstream

<Counter>

upstream-obc

<Counter>

number of buffer overflows on EBLT LIM modules


in the upstream direction on a one day interval
basis in the current measurement period. The
upstream direction on the LIM is non-blocking,
hence this value should read always zero under
normal working conditions.
This element is always shown.
number of buffer overflows on EBLT LIM modules
for the OBC-directed traffic upstream on a one day
interval basis in the current measurement period. In
some special conditions such as system startup or
re-start packet loss may occur here but under
normal circumstances this counter should read zero.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

557

44 QOS Status Commands

name

Type

Description

downstream-obc

<Counter>

downstream-unicast

<Counter>

number of buffer overflows on an EBLT LIM


module for the OBC-directed traffic downstream
on a one day interval basis in the current
measurement epoch. under normal circumstances
this counter should always read zero.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream unicast pool. Queue fill-up and tail
drop is a normal condition for data traffic
(individual queues) but not for voice and video on
demand services (individual queues). If the total
downstream pool is filled, that means that QoS
un-aware packet loss will occur.
This element is always shown.
Specifies number of times, current one day
downstream multicast total buffer pool overflow total buffer overflow of the downstream multicast
pool. This even should be a rather rare event. On
the long term, buffer overflow in the multicast pool
may occur a few times a day (less than a few tens
under heavy multicast usage).
This element is always shown.
Specifies number of times, current one day
obc-injected buffer overflow occurred. There is a
reserved buffer pool for obc-injected traffic which
under very heavy load conditions may eventually
get full, and the LIM OBC will be unable to
communicate with the external world for a very
short time interval.
This element is always shown.
elapsed time interval since the last measurement
period started.
This element is always shown.
The measured time interval since the last
measurement period started.
This element is always shown.

downstream-multicast <Counter>

558

obc-injected

<Counter>

elapse-time

<TimeTicks>
unit: msec

measured-time

<TimeTicks>
unit: msec

Released

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.12 QoS Buffer Overflow Statistics Total Status


Command
Command Description
This command shows the buffer overflow for each unit applicable on dedicated buffer pools and not on individual
queues. The EBLT-C and EBLT-D units have four isolated buffer pools for upstream, downstream, multicast, and
OBC-injected traffic. Under normal working conditions all these counters should read zero. Check these counters
for QoS problems which can occur under heavy load conditions.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos statistics buffer-overflow total (equip-slot)

Command Parameters
Table 44.12-1 "QoS Buffer Overflow Statistics Total Status Command" Resource Parameters
Resource Identifier
(equip-slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ physical position of the board
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 44.12-2 "QoS Buffer Overflow Statistics Total Status Command" Display parameters
Specific Information
name

Type

Description

upstream

<Counter>

upstream-obc

<Counter>

Number of buffer overflows per EBLT LIM


module in the upstream direction since the statistics
were last reset. The upstream direction on the LIM
is non-blocking, hence this value should read
always zero under normal working conditions.
This element is always shown.
Number of buffer overflows on a LIM module for
the OBC-directed traffic upstream since the statistic
was last reset. In some special conditions such as
system startup or re-start packet loss may occur
here but under normal circumstances this counter

3HH-01016-AAAA-TCZZA Edition 03

Released

559

44 QOS Status Commands

name

Type

downstream-obc

<Counter>

downstream-unicast

<Counter>

downstream-multicast <Counter>

560

obc-injected

<Counter>

elapse-time

<TimeTicks>
unit: msec

measured-time

<TimeTicks>
unit: msec

valid-15min-intervals

<Qos::Valid15mInterval>
range: [0...96]

valid-1day-intervals

<Qos::Valid1dInterval>
range: [0...1]

total-policer-inuse

<SignedInteger>

policers-in-vlan

<SignedInteger>

policers-in-dot1x

<SignedInteger>

policers-in-ppp

<SignedInteger>

policers-in-ip

<SignedInteger>

Released

Description
should read zero.
This element is always shown.
number of buffer overflows on a LIM module for
the OBC-directed traffic downstream since the
statistic was last reset. Under normal circumstances
this counter should always read zero.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream unicast pool. This even should not
occur. Queue fill-up and tail drop is a normal
condition for data traffic (individual queues) but
not for voice and video on demand services
(individual queues). If the total downstream pool is
filled, that means that QoS un-aware packet loss
will occur.
This element is always shown.
a counter for the event of total buffer overflow of
the downstream multicast pool. This even should
be a rather rare event. On the long term, buffer
overflow in the multicast pool may occur a few
times a day (less than a few tens under heavy
multicast usage).
This element is always shown.
Total OBC-injected buffer overflow event on
EBLT LIMs. There is a reserved buffer pool for
OBC-injected traffic which under very heavy load
conditions may eventually get full, and the LIM
OBC will be unable to communicate with the
external world for a very short time interval.
This element is always shown.
The elapsed time interval since the last
measurement period started.
This element is always shown.
The measured time interval since the last
measurement period started.
This element is always shown.
number of statistics of 15 minutes collected so far.
At most 96 such entries are stored.
This element is always shown.
number of statistics of one day collected so far. At
most one entry is stored from the past.
This element is always shown.
the total number of policers in use per EBLT LIM.
The policers are managed in hardware in pairs, so
even if a Session is using both up and downstream
policers, it is counted as one policer.
This element is always shown.
the number of policers in use by static sessions
(PVC, PVC.VLAN) per EBLT LIM.
This element is always shown.
the number of policers in use by Dot1X sessions
per EBLT LIM.
This element is always shown.
the number of policers in use by PPP sessions per
EBLT LIM.
This element is always shown.
the number of policers in use by IP sessions per

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

name

Type

Description
EBLT LIM.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

561

44 QOS Status Commands

44.13 QoS SHub Meter Statistics Status Command


Command Description
This command displays the number of times the meter entry has been instantiated on any port.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos shub meter (index)

Command Parameters
Table 44.13-1 "QoS SHub Meter Statistics Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Qos::MeterIndex>
range: [1...64]

index used to identify a meter

Command Output
Table 44.13-2 "QoS SHub Meter Statistics Status Command" Display parameters
Specific Information
name
ref-count

562

Type

Description

<SignedInteger>

nbr of times the meter is instantiated/used on any


port
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

44 QOS Status Commands

44.14 QoS SHub Flow Statistics Status Command


Command Description
This commandn displays the number of times the flow has been instantiated on any port.

User Level
The command can be accessed by operators with qos privileges.

Command Syntax
The command has the following syntax:
> show qos shub flow (index)

Command Parameters
Table 44.14-1 "QoS SHub Flow Statistics Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Qos::FlowIndex>
range: [1...64]

index used to identify a flow

Command Output
Table 44.14-2 "QoS SHub Flow Statistics Status Command" Display parameters
Specific Information
name
ref-count

Type

Description

<SignedInteger>

nbr of times the meter is instantiated/used on any


port
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

563

45- IP Status Commands

45.1 IP VRF Statistics


45.2 IP Interface Status Command
45.3 IP VRF Interface User Port Status Command
45.4 IP VRF Interface User Port Status Command
45.5 IP VRF Routes Status Command
45.6 IP VRF Net To Media Statistics
45.7 IP VRF Mapping
45.8 IP VRF Next Index
45.9 IP SHub VRF Status Command
45.10 IP SHub VRF Route Status Command
45.11 IP SHub ARP VRF Based Statistics Command
45.12 IP Traceroute Status Command

564

Released

45-565
45-566
45-569
45-571
45-573
45-574
45-575
45-576
45-577
45-578
45-579
45-581

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.1 IP VRF Statistics


Command Description
This command shows virtual routing and forwarding statistics.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-statistics (vrf-id)

Command Parameters
Table 45.1-1 "IP VRF Statistics" Resource Parameters
Resource Identifier
(vrf-id)

Type

Description

<AsamProfileIndex>
range: [1...65535]

an unique id of a VRF.

Command Output
Table 45.1-2 "IP VRF Statistics" Display parameters
Specific Information
name

Type

Description

ip-route-entries

<Counter>

ip-net2media-entries

<Counter>

the total number of routes in the system.


This element is always shown.
the total number net2media entries.
This element is always shown.

Only Show Details: system statistics


name
Type
ip-route-entries

<Counter>

ip-net2media-entries

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
the total number of IP routes in the system.
This element is always shown.
the total number of IP net2media entries.
This element is always shown.

Released

565

45 IP Status Commands

45.2 IP Interface Status Command


Command Description
This command displays the IP interface status parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip ip-statistics (index)

Command Parameters
Table 45.2-1 "IP Interface Status Command" Resource Parameters
Resource Identifier

Type

(index)

<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::NtSlot> : <Itf::EthernetId>

Description
/ specifies the if-index uniquely indentifying each
interface

Command Output
Table 45.2-2 "IP Interface Status Command" Display parameters
Specific Information
name

Type

Description

description

<PrintableString>

oper-status

shows the description of the interface


This element is only shown in detail mode.
shows the operational status of the interface
This element is always shown.

<Ip::OperStatus>
Possible values are :
- up : the interface in operational state
- down : the interface in down state
- testing : testing state, no operational
packet can be passed
- unknown : state not known
- dormant : ready to transmit, but waiting
for action
<TimeTicks>
shows the time when the interface is changed for
unit: msec
the last-time
This element is only shown in detail mode.
<Counter>
shows the total number of octets recieved on the
interface
This element is only shown in detail mode.
<Counter>
shows the number of packets delivered by this
sub-layer, which were not addressed to a multicast
or broadcast address at this sub-layer

last-changed
in-octets
in-ucast-pkts

566

Released

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

name

Type

in-nucast-pkts

<Counter>

in-discards

<Counter>

in-errors

<Counter>

in-unknown-proto

<Counter>

out-octets

<Counter>

out-ucast-pkts

<Counter>

out-nucast-pkts

<Counter>

out-discards

<Counter>

out-errors

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is only shown in detail mode.
shows the number of packets, delivered by this
sub-layer to a higher (sub-)layer, which were
addressed to a multicast or broadcast address at this
sub-layer
This element is only shown in detail mode.
shows the number of inbound packets which were
chosen to be discarded even though no errors had
been detected to prevent their being deliverable to a
higher-layer protocol. One possible reason for
discarding such a packet could be to free up buffer
space
This element is only shown in detail mode.
shows for packet-oriented interfaces, the number of
inbound packets that contained errors preventing
them from being deliverable to a higher-layer
protocol and shows for character-oriented or
fixed-length interfaces, the number of inbound
transmission units that contained errors preventing
them from being deliverable to a higher-layer
protocol
This element is only shown in detail mode.
shown for packet-oriented interfaces, the number of
packets received via the interface which were
discarded because of an unknown or unsupported
protocol and shows for character-oriented or
fixed-length interfaces which support protocol
multiplexing the number of transmission units
received via the interface which were discarded
because of an unknown or unsupported protocol.
For any interface which does not support protocol
multiplexing, this counter will always be 0
This element is only shown in detail mode.
shows the total number of octets transmitted out of
the interface, including framing characters
This element is only shown in detail mode.
shows the total number of packets that higher-level
protocols requested be transmitted, and which were
addressed to a multicast or broadcast address at this
sub-layer, including those that were discarded or
not sent
This element is only shown in detail mode.
shows the total number of packets that higher-level
protocols requested be transmitted, and which were
addressed to a multicast or broadcast address at this
sub-layer, including those that were discarded or
not sent
This element is only shown in detail mode.
shows the number of outbound packets which were
chosen to be discarded even though no errors had
been detected to prevent their being transmitted.
One possible reason for discarding such a packet
could be to free up buffer space
This element is only shown in detail mode.
shows for packet-oriented interfaces, the number of
outbound packets that could not be transmitted
because of errors and shows for character-oriented

Released

567

45 IP Status Commands

name

out-queue-len

568

Type

<Gauge>

Released

Description
or fixed-length interfaces, the number of outbound
transmission units that could not be transmitted
because of errors
This element is only shown in detail mode.
shows the length of the output packet queue (in
packets)
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.3 IP VRF Interface User Port Status Command


Command Description
This command displays the user side VRF IP interface statistic parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-interface user port (port-interface)

Command Parameters
Table 45.3-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier
(port-interface)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 45.3-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name
rx-pkts
rx-octets
rx-drop-pkts

Type

Description

<Binary-08-08>
length: 8
<Binary-08-08>
length: 8
<Binary-08-08>
length: 8

show the number of received packets


This element is always shown.
show the number of received octets
This element is only shown in detail mode.
show the number of received packets which
dropped
This element is always shown.
show the number of received octets which
dropped
This element is only shown in detail mode.
show the number of transmitted packets
This element is always shown.
show the number of transmitted octets
This element is only shown in detail mode.
show the number of transmitted packets which
dropped
This element is only shown in detail mode.
show the number of transmitted octets which
dropped

rx-drop-octets

<Binary-08-08>
length: 8

tx-pkts

<Binary-08-08>
length: 8
<Binary-08-08>
length: 8
<Binary-08-08>
length: 8

tx-octets
tx-drop-pkts
tx-drop-octets

<Binary-08-08>
length: 8

3HH-01016-AAAA-TCZZA Edition 03

Released

569

are
are

are
are

45 IP Status Commands

name

Type

Description
This element is only shown in detail mode.

570

Released

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.4 IP VRF Interface User Port Status Command


Command Description
This command displays the user side VRF IP interface statistic parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-interface user bridgeport (port-interface)

Command Parameters
Table 45.4-1 "IP VRF Interface User Port Status Command" Resource Parameters
Resource Identifier
(port-interface)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 45.4-2 "IP VRF Interface User Port Status Command" Display parameters
Specific Information
name
rx-pkts
rx-octets
rx-drop-pkts

Type

Description

<Binary-08-08>
length: 8
<Binary-08-08>
length: 8
<Binary-08-08>
length: 8

show the number of received packets


This element is always shown.
show the number of received octets
This element is only shown in detail mode.
show the number of received packets which
dropped
This element is always shown.
show the number of received octets which
dropped
This element is only shown in detail mode.
show the number of transmitted packets
This element is always shown.
show the number of transmitted octets
This element is only shown in detail mode.
show the number of transmitted packets which
dropped
This element is only shown in detail mode.
show the number of transmitted octets which
dropped

rx-drop-octets

<Binary-08-08>
length: 8

tx-pkts

<Binary-08-08>
length: 8
<Binary-08-08>
length: 8
<Binary-08-08>
length: 8

tx-octets
tx-drop-pkts
tx-drop-octets

<Binary-08-08>
length: 8

3HH-01016-AAAA-TCZZA Edition 03

Released

571

are
are

are
are

45 IP Status Commands

name

Type

Description
This element is only shown in detail mode.

572

Released

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.5 IP VRF Routes Status Command


Command Description
This command displays the VRF routes.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-route (index) dest-ip-address <Ip::V4Address> / <Ip::PrefixLengthFull>
next-hop-address <Ip::V4Address>

Command Parameters
Table 45.5-1 "IP VRF Routes Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Vrf::VrfIndex>
an unique index of a vrf
range: [1...127]
<Ip::V4Address> / <Ip::PrefixLengthFull> inet-address with prefix
<Ip::V4Address>
next hop IP address

dest-ip-address
next-hop-address

Command Output
Table 45.5-2 "IP VRF Routes Status Command" Display parameters
Specific Information
name

Type

Description

layer3-itf

<Ip::Layer3ID>

route-type

<Vrf::RouteType>
Possible values are :
- local : local destination or direct route
- remote : remote destination or indirect
route
<Vrf::RouteProtocol>
Possible values are :
- local : direct route
- net-mgnt : indirect route
<Ip::Age>

the ipox interface on NT.


This element is always shown.
the type of route.
This element is only shown in detail mode.

route-proto

last-changed

3HH-01016-AAAA-TCZZA Edition 03

the routing protocol via which this route was


learned.
This element is only shown in detail mode.
the network time when this was last changed.
This element is only shown in detail mode.

Released

573

45 IP Status Commands

45.6 IP VRF Net To Media Statistics


Command Description
This command displays the VRF net to media statistics.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-media (equip-slot) ip-address <Ip::V4Address>

Command Parameters
Table 45.6-1 "IP VRF Net To Media Statistics" Resource Parameters
Resource Identifier

Type

(equip-slot)

<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> : <Vrf::VrfIndex>
<Ip::V4Address>

ip-address

Description
/ equipment slot ID.
the IP-address.

Command Output
Table 45.6-2 "IP VRF Net To Media Statistics" Display parameters
Specific Information
name
physical-addr
last-changed

574

Type

Description

<Ip::PhysicalAddress>
length: x<65535
<Ip::Age>

the physical IP-address.


This element is always shown.
date when it is changed for the last time.
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.7 IP VRF Mapping


Command Description
This command shows the VRF mapping.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-mapping (name)

Command Parameters
Table 45.7-1 "IP VRF Mapping" Resource Parameters
Resource Identifier
(name)

Type

Description

<Vrf::VrfName>
length: 1<=x<22

name of the vrf

Command Output
Table 45.7-2 "IP VRF Mapping" Display parameters
Specific Information
name
vrf-index

Type

Description

<Vrf::VrfIndex>
range: [1...127]

A number which uniquely identifies a particular


VRF context within the system.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

575

45 IP Status Commands

45.8 IP VRF Next Index


Command Description
This command shows the next VRF index.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip vrf-next-index

Command Output
Table 45.8-2 "IP VRF Next Index" Display parameters
Specific Information
name
next-vrf-index

576

Type

Description

<Vrf::VrfIndex>
range: [1...127]

The next free Virtual Routing and Forwarding


(VRF) index.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.9 IP SHub VRF Status Command


Command Description
This command displays SHub IP VRF information.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf (index) vlan-id <Vlan::VlanIndex>

Command Parameters
Table 45.9-1 "IP SHub VRF Status Command" Resource Parameters
Resource Identifier
(index)
vlan-id

Type

Description

<Vrf::ShubVrfID>
range: [0...127]
<Vlan::VlanIndex>
range: [1...4093]

the VRF ID.


vlan id

Command Output
Table 45.9-2 "IP SHub VRF Status Command" Display parameters
Specific Information
name

Type

Description
the administrative status of the VLAN IP interface.
This element is always shown.

name

<Vrf::ShubIpIfAdminStatus>
Possible values are :
- up : ready to pass packets
- down : not ready
- testing : in some test mode
<Vrf::ShubIpIfOperStatus>
Possible values are :
- up : ready to pass packets
- down : not ready
- testing : in some test mode
<PrintableString>

ip-address

<Ip::V4Address>

mask

<Ip::V4Address>

admin-status

oper-status

3HH-01016-AAAA-TCZZA Edition 03

the operational status of the VLAN IP interface.


This element is always shown.

the name of the VLAN IP interface.


This element is only shown in detail mode.
the IP-address of the VLAN IP interface.
This element is always shown.
the mask of the VLAN IP interface.
This element is always shown.

Released

577

45 IP Status Commands

45.10 IP SHub VRF Route Status Command


Command Description
This command displays the IP SHub VRF route status parameters.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub vrf-route (index) dest <Ip::V4Address> / <Ip::PrefixLength> next-hop
<Ip::V4Address>

Command Parameters
Table 45.10-1 "IP SHub VRF Route Status Command" Resource Parameters
Resource Identifier
(index)
dest
next-hop

Type

Description

<Vrf::ShubVrfID>
range: [0...127]
<Ip::V4Address> / <Ip::PrefixLength>
<Ip::V4Address>

the vrf id
the destination ip address and mask of this route
the next hop ip address of this route

Command Output
Table 45.10-2 "IP SHub VRF Route Status Command" Display parameters
Specific Information
name

Type

Description
The routing mechanism that was responsible for
adding this route
This element is always shown.

vlan-index

<Vrf::ShubRouteProtocol>
Possible values are :
- other : not specified
- local : local interface
- netmgmt : static route
- rip : rip route
- ospf : ospf route
<Itf::ShubVlanAlias>

age

<SignedInteger>

protocol

578

Released

The local interface through which the next hop


should be reached
This element is always shown.
The number of seconds since this route was last
updated
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.11 IP SHub ARP VRF Based Statistics Command


Command Description
This command displays the IP SHub ARP statistics for each VRF.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ip shub arp (vrf-id)

Command Parameters
Table 45.11-1 "IP SHub ARP VRF Based Statistics Command" Resource Parameters
Resource Identifier
(vrf-id)

Type

Description

<Vrf::ShubVrfID>
range: [0...127]

the vrf number

Command Output
Table 45.11-2 "IP SHub ARP VRF Based Statistics Command" Display parameters
Common Information
name
Type
in-packets

<Counter>

discard

<Counter>

in-request

<Counter>

in-resp

<Counter>

out-request

<Counter>

out-resp

<Counter>

Specific Information
name

Description
total number of arp datagrams received from
interfaces, including those received in error.
This element is always shown.
total number of packets discarded
This element is always shown.
number of arp request packets received
This element is always shown.
number of arp response packets received
This element is always shown.
number of arp requests transmitted
This element is always shown.
number of arp responses transmitted
This element is always shown.

Type

Description

rx-arp-pkts

<Counter>

arp-discards

<Counter>

rx-arp-req

<Counter>

number of arp received packets


This element is always shown.
number of arp discard packets
This element is always shown.
number of received arp request packets

3HH-01016-AAAA-TCZZA Edition 03

Released

579

45 IP Status Commands

name

Type

rx-arp-resp

<Counter>

tx-arp-req

<Counter>

tx-arp-resp

<Counter>

Only Show Details: common statistics


name
Type

580

in-packets

<Counter>

discard

<Counter>

in-request

<Counter>

in-resp

<Counter>

out-request

<Counter>

out-resp

<Counter>

Released

Description
This element is always shown.
number of received arp response packets
This element is always shown.
show number of transmitted arp packets
This element is always shown.
number of transmitted arp repsonse packets
This element is always shown.

Description
total number of arp datagrams received from
interfaces, including those received in error.
This element is always shown.
total number of packets discarded
This element is always shown.
number of arp request packets received
This element is always shown.
number of arp response packets received
This element is always shown.
number of arp requests transmitted
This element is always shown.
number of arp responses transmitted
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

45 IP Status Commands

45.12 IP Traceroute Status Command


Command Description
This command shows the results of a traceroute action.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show ip traceroute (ip-addr) hop <UnsignedInteger>

Command Parameters
Table 45.12-1 "IP Traceroute Status Command" Resource Parameters
Resource Identifier
(ip-addr)
hop

Type

Description

<Ip::V4Address>
<UnsignedInteger>

the ip-address of the destination node


the hop number in the route towards the destination

Command Output
Table 45.12-2 "IP Traceroute Status Command" Display parameters
Specific Information
name

Type

Description

intermediate

<Ip::V4Address>

time-1st

the ip-address of the intermediate node or hop


This element is always shown.
the time to reach this node if at all successful, 1st
attempt
This element is always shown.

<Ip::TraceReachTime>
Possible values are :
- none : no response
- <Ip::TraceReachTime> : the time to
reach this node
<Ip::TraceReachTime>
the time to reach this node if at all successful, 2nd
Possible values are :
attempt
- none : no response
This element is always shown.
- <Ip::TraceReachTime> : the time to
reach this node
<Ip::TraceReachTime>
the time to reach this node if at all successful, 3rd
Possible values are :
attempt
- none : no response
This element is always shown.
- <Ip::TraceReachTime> : the time to
reach this node

time-2nd

time-3rd

3HH-01016-AAAA-TCZZA Edition 03

Released

581

46- xDSL Status Commands

46.1 xDSL Profiles Status Command


46.2 xDSL PM Interval Per Interface Status Command
46.3 xDSL Operational Data Near End Line Status
Command
46.4 xDSL Operational Data Near End Channel Status
Command
46.5 xDSL Operational Data Far End Line Status Command
46.6 xDSL Operational Data Far End Channel Status
Command
46.7 xDSL Operational Data Statistics
46.8 xDSL Carrier Data Near End Status Command
46.9 xDSL Carrier Data Far End Status Command
46.10 xDSL Failure Status Near End Status Command
46.11 xDSL Failure Status Far End Status Command
46.12 xDSL Counters Near End Line Current 15 Min
46.13 xDSL Counters Near End Line Current Day
46.14 xDSL Counters Near End Line Previous 15 Min
46.15 xDSL Counters Near End Of Line Previous Day
46.16 xDSL Counters Near End Channel Current 15 Min
46.17 xDSL Counters Near End Channel Current Day
46.18 xDSL Counters Near End Channel Previous 15 Min
46.19 xDSL Counters Near End Channel Previous Day
46.20 xDSL Counters Far End Line Current 15 Min
46.21 xDSL Counters Far End Line Current Day
46.22 xDSL Counters Far End Line Previous 15 Min
46.23 xDSL Counters Far End Line Previous Day
46.24 xDSL Counters Far End Channel Current 15 Min
46.25 xDSL Counters Far End Channel Current Day
46.26 xDSL Counters Far End Channel Previous 15 Min
46.27 xDSL Counters Far End Channel Previous Day
46.28 xDSL Inventory XT/RT Status Command
46.29 xDSL Board Capability Status Command

582

Released

46-583
46-584
46-586
46-590
46-591
46-595
46-596
46-598
46-600
46-602
46-603
46-604
46-606
46-608
46-610
46-612
46-613
46-614
46-615
46-616
46-618
46-620
46-622
46-624
46-625
46-626
46-627
46-628
46-629

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.1 xDSL Profiles Status Command


Command Description
This command displays xDSL profiles.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl profiles

Command Output
Table 46.1-2 "xDSL Profiles Status Command" Display parameters
Specific Information
name
next-av-serv-pr
max-serv-pr
next-av-spec-pr
max-spec-pr

Type

Description

<AsamNextProfileIndex>
range: [0...65535]
<AsamMaxProfileIndex>
range: [0...65535]
<AsamNextProfileIndex>
range: [0...65535]
<AsamMaxProfileIndex>
range: [0...65535]

next available index for the profile


This element is always shown.
max number of profile indices that can be created
This element is always shown.
next available spectrum index
This element is always shown.
max number of spectrum indices that can be
created
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

583

46 xDSL Status Commands

46.2 xDSL PM Interval Per Interface Status


Command
Command Description
This command displays the number of available pm intervals per xdsl interface.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl xdsl-int (if-index)

Command Parameters
Table 46.2-1 "xDSL PM Interval Per Interface Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.2-2 "xDSL PM Interval Per Interface Status Command" Display parameters
Specific Information
name

Type

Description

cur-int-elapsedtime

<SignedInteger>

cur-1day-elapsedtime

<SignedInteger>

valid-intervals

<SignedInteger>

valid-1days

<SignedInteger>

nbr of sec elapsed in cur intvl err-measurement


This element is always shown.
nbr of sec elapsed in cur one day err-measurement
This element is always shown.
nbr of prev intvl for which valid data has been
stored
This element is always shown.
nbr of prev 1Days for which valid data has been
stored
This element is always shown.

Only Show Details: global settings


name
Type
xdsl-coding-type

584

<Xdsl::Coding>
Possible values are :
- other : other type
- dmt : DMT type
- cap : CAP type

Released

Description
nbr of prev 1 day for which valid data has been
stored
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

3HH-01016-AAAA-TCZZA Edition 03

Released

585

46 xDSL Status Commands

46.3 xDSL Operational Data Near End Line Status


Command
Command Description
This command displays the xDSL operational data for the near and of line.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end line (if-index)

Command Parameters
Table 46.3-1 "xDSL Operational Data Near End Line Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.3-2 "xDSL Operational Data Near End Line Status Command" Display parameters
Specific Information
name
rel-cap-occ-up
noise-margin-up
output-power-down

586

Type

Description

<Xdsl::CapacityUtil>
range: [0...100] unit: %
<Xdsl::DB>
unit: 1/10 db
<Xdsl::DB>
unit: 1/10 db

ratio of actual bitrate over the max attainable bitrate


This element is always shown.
current noise margin for the upstream direction
This element is always shown.
actual aggregate output power for the downstream
carriers
This element is always shown.
diff btw pwr at far-end rx-ver and that tx-ed from
near-end
This element is always shown.
diff btw pwr at far-end rx-ver and that tx-ed from
near-end over all sub-carriers
This element is always shown.
bitmap which represents the operational modes of
the ATU-C
This element is always shown.

sig-attenuation-up

<Xdsl::DB>
unit: 1/10 db

loop-attenuation-up

<Xdsl::DB>
unit: 1/10 db

actual-opmode

<Xdsl::OpModeTypeLinePreDef>
Possible values are :
- default : default value
- ansi-t1413-1998 : ANSI T1.413-1998

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name

xtu-c-opmode

Type

Description

- etsi-dts-tm06006 : ETSI DTS/TM06006


g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
g992-5-b
:
G.992.5
POTS
non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
- <Xdsl::OpModeType> : octet string
defining the operation mode
<Xdsl::OpModeTypeLinePreDef>
bitmap which represents the operational modes
Possible values are :
This element is always shown.
- default : default value
- ansi-t1413-1998 : ANSI T1.413-1998
- etsi-dts-tm06006 : ETSI DTS/TM06006
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
g992-5-b
:
G.992.5
POTS
non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1

3HH-01016-AAAA-TCZZA Edition 03

Released

587

46 xDSL Status Commands

name

ansi-t1413

etsi-dts

g992-1-a

g992-1-b

g992-2-a

g992-3-a

g992-3-b

g992-3-l1

g992-3-l2

588

Type
- ieee-802.3ah : IEEE 802.3ah
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
- <Xdsl::OpModeType> : octet string
defining the operation mode
<Xdsl::T1413>
Possible values are :
- dis-ansi-t1413-1998 : disable ANSI
T1.413-1998
- ansi-t1413-1998 : ANSI T1.413-1998
<Xdsl::Etsidts>
Possible values are :
- dis-etsi-dts-tm06006 : disable ETSI
DTS/TM06006
- etsi-dts-tm06006 : ETSI DTS/TM06006
<Xdsl::G21potsnos>
Possible values are :
- dis-g992-1-a : disable G.992.1 POTS
non-overlapped spectrum
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
<Xdsl::G21isdnnos>
Possible values are :
- dis-g992-1-b : disable G.992.1 ISDN
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
<Xdsl::G22potsnos>
Possible values are :
- dis-g992-2-a : disable G.992.2 POTS
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
<Xdsl::G23potsnos>
Possible values are :
- dis-g992-3-a : disable G.992.3 POTS
non-overlapped spectrum
g992-3-a
:
G.992.3
POTS
non-overlapped spectrum
<Xdsl::G23isdnnos>
Possible values are :
- dis-g992-3-b : disable G.992.3 ISDN
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
<Xdsl::G23PotsnosUs1>
Possible values are :
- dis-g992-3-l1 : disable G.992.3 POTS
non-overlapped spectrum US mask 1
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
<Xdsl::G23PotsNosUs2>
Possible values are :
- dis-g992-3-l2 : disable G.992.3 POTS
non-overlapped spectrum US mask 2
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2

Released

Description

ANSI T1.413-1998
This element is only shown in detail mode.

ETSI DTS/TM06006
This element is only shown in detail mode.

G.992.1 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.1 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.2 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum US mask


1
This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum US mask


2
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
g992-3-am

g992-5-a

g992-5-b

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

g992-5-am

actual-psd-down

Type

Description

<Xdsl::G23ExtPotsNos>
Possible values are :
- dis-g992-3-am : disable G.992.3
extended POTS with non-overlapped
spectrum
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
<Xdsl::G25PotsNos>
Possible values are :
- dis-g992-5-a : disable G.992.5 POTS
non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
<Xdsl::G25IsdnNos>
Possible values are :
- dis-g992-5-b : disable G.992.5 ISDN
non-overlapped spectrum
g992-5-b
:
G.992.5
ISDN
non-overlapped spectrum
<Xdsl::AnsiT1424>
Possible values are :
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
<Xdsl::EtsiTs>
Possible values are :
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
<Xdsl::ItuG9931>
Possible values are :
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
<Xdsl::Ieee802.3Ah>
Possible values are :
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
<Xdsl::G25ExtPotsNos>
Possible values are :
- dis-g992-5-am : disable G.992.5
extended POTS non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
<Xdsl::DBHZ>
unit: 1/10 dbm/hz

G.992.3 extended POTS with non-overlapped


spectrum
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

G.992.5 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.5 ISDN non-overlapped spectrum


This element is only shown in detail mode.

ansi T1.424
This element is only shown in detail mode.
ETSI TS 101 270
This element is only shown in detail mode.
ITU G993-1
This element is only shown in detail mode.
IEEE 802.3ah
This element is only shown in detail mode.
G.992.5 extended POTS non-overlapped spectrum
This element is only shown in detail mode.

avg transmit power spectrum density over used


carriers
This element is always shown.

Released

589

46 xDSL Status Commands

46.4 xDSL Operational Data Near End Channel


Status Command
Command Description
This command displays the xDSL operational data for the near and of line.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data near-end channel (if-index)

Command Parameters
Table 46.4-1 "xDSL Operational Data Near End Channel Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.4-2 "xDSL Operational Data Near End Channel Status Command" Display parameters
Specific Information
name

Type

Description

actual-bitrate-up

<Xdsl::bitrate>
unit: kbits/sec

attain-bitrate-up

<Xdsl::bitrate>
unit: kbits/sec

atm bitrate for upstream fast or interleaved data


flow
This element is always shown.
maximum attainable atm rate the modem can
support
This element is always shown.
delay caused by the interleaving and deinterleaving
functionality
This element is always shown.
actual impulse noise protection
This element is always shown.

interleave-delay-down <Xdsl::milliseconds>
unit: msec
imp-noise-prot-down

590

<Xdsl::impNoise>
unit: 1/10 symbols

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.5 xDSL Operational Data Far End Line Status


Command
Command Description
This command displays the xDSL operational data for the line far end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end line (if-index)

Command Parameters
Table 46.5-1 "xDSL Operational Data Far End Line Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.5-2 "xDSL Operational Data Far End Line Status Command" Display parameters
Specific Information
name
rel-cap-occ-down
noise-margin-down
output-power-up
sig-attenuation-down

Type

Description

<Xdsl::CapacityUtil>
range: [0...100] unit: %
<Xdsl::DB>
unit: 1/10 db
<Xdsl::DB>
unit: 1/10 db

ratio of actual bitrate over the max attainable bitrate


This element is always shown.
current noise margin for the downstream direction
This element is always shown.
actual aggregate output power for the upstream
carriers
This element is always shown.
diff btw pwr at far-end rx-ver and that tx-ed from
near-end
This element is always shown.
diff btw pwr at far-end rx-ver and that tx-ed from
near-end over all sub-carriers
This element is always shown.
bitmap which represents the operational modes
This element is always shown.

<Xdsl::DB>
unit: 1/10 db

loop-attenuation-down <Xdsl::DB>
unit: 1/10 db
xtu-r-opmode

<Xdsl::OpModeTypeLinePreDef>
Possible values are :
- default : default value
- ansi-t1413-1998 : ANSI T1.413-1998

3HH-01016-AAAA-TCZZA Edition 03

Released

591

46 xDSL Status Commands

name

ansi-t1413

etsi-dts

g992-1-a

g992-1-b

g992-2-a

592

Type
- etsi-dts-tm06006 : ETSI DTS/TM06006
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
g992-5-b
:
G.992.5
POTS
non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
- <Xdsl::OpModeType> : octet string
defining the operation mode
<Xdsl::T1413>
Possible values are :
- dis-ansi-t1413-1998 : disable ANSI
T1.413-1998
- ansi-t1413-1998 : ANSI T1.413-1998
<Xdsl::Etsidts>
Possible values are :
- dis-etsi-dts-tm06006 : disable ETSI
DTS/TM06006
- etsi-dts-tm06006 : ETSI DTS/TM06006
<Xdsl::G21potsnos>
Possible values are :
- dis-g992-1-a : disable G.992.1 POTS
non-overlapped spectrum
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
<Xdsl::G21isdnnos>
Possible values are :
- dis-g992-1-b : disable G.992.1 ISDN
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
<Xdsl::G22potsnos>
Possible values are :
- dis-g992-2-a : disable G.992.2 POTS
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum

Released

Description

ANSI T1.413-1998
This element is only shown in detail mode.

ETSI DTS/TM06006
This element is only shown in detail mode.

G.992.1 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.1 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.2 POTS non-overlapped spectrum


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
g992-3-a

g992-3-b

g992-3-l1

g992-3-l2

g992-3-am

g992-5-a

g992-5-b

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

Type

Description

<Xdsl::G23potsnos>
Possible values are :
- dis-g992-3-a : disable G.992.3 POTS
non-overlapped spectrum
g992-3-a
:
G.992.3
POTS
non-overlapped spectrum
<Xdsl::G23isdnnos>
Possible values are :
- dis-g992-3-b : disable G.992.3 ISDN
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
<Xdsl::G23PotsnosUs1>
Possible values are :
- dis-g992-3-l1 : disable G.992.3 POTS
non-overlapped spectrum US mask 1
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
<Xdsl::G23PotsNosUs2>
Possible values are :
- dis-g992-3-l2 : disable G.992.3 POTS
non-overlapped spectrum US mask 2
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
<Xdsl::G23ExtPotsNos>
Possible values are :
- dis-g992-3-am : disable G.992.3
extended POTS with non-overlapped
spectrum
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
<Xdsl::G25PotsNos>
Possible values are :
- dis-g992-5-a : disable G.992.5 POTS
non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
<Xdsl::G25IsdnNos>
Possible values are :
- dis-g992-5-b : disable G.992.5 ISDN
non-overlapped spectrum
g992-5-b
:
G.992.5
ISDN
non-overlapped spectrum
<Xdsl::AnsiT1424>
Possible values are :
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
<Xdsl::EtsiTs>
Possible values are :
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
<Xdsl::ItuG9931>
Possible values are :
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
<Xdsl::Ieee802.3Ah>
Possible values are :

G.992.3 POTS non-overlapped spectrum


This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

G.992.3 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum US mask


1
This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum US mask


2
This element is only shown in detail mode.

G.992.3 extended POTS with non-overlapped


spectrum
This element is only shown in detail mode.

G.992.5 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.5 ISDN non-overlapped spectrum


This element is only shown in detail mode.

ansi T1.424
This element is only shown in detail mode.
ETSI TS 101 270
This element is only shown in detail mode.
ITU G993-1
This element is only shown in detail mode.
IEEE 802.3ah
This element is only shown in detail mode.

Released

593

46 xDSL Status Commands

name
g992-5-am

actual-psd-up

594

Type
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
<Xdsl::G25ExtPotsNos>
Possible values are :
- dis-g992-5-am : disable G.992.5
extended POTS non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
<Xdsl::DBHZ>
unit: 1/10 dbm/hz

Released

Description
G.992.5 extended POTS non-overlapped spectrum
This element is only shown in detail mode.

avg transmit power spectrum density over used


carriers
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.6 xDSL Operational Data Far End Channel


Status Command
Command Description
This command displays the xDSL operational data for the far end of the channel.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data far-end channel (if-index)

Command Parameters
Table 46.6-1 "xDSL Operational Data Far End Channel Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.6-2 "xDSL Operational Data Far End Channel Status Command" Display parameters
Specific Information
name

Type

Description

actual-bitrate-down

<Xdsl::bitrate>
unit: kbits/sec

attain-bitrate-down

<Xdsl::bitrate>
unit: kbits/sec

interleave-delay-up

<Xdsl::milliseconds>
unit: msec

imp-noise-prot-up

<Xdsl::impNoise>
unit: 1/10 symbols

atm bitrate for downstream fast or interleaved data


flow
This element is always shown.
maximum attainable atm rate the modem can
support
This element is always shown.
delay caused by the interleaving and deinterleaving
functionality
This element is always shown.
actual impulse noise protection
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

595

46 xDSL Status Commands

46.7 xDSL Operational Data Statistics


Command Description
This command displays the xDSL operational data statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl operational-data line (if-index)

Command Parameters
Table 46.7-1 "xDSL Operational Data Statistics" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.7-2 "xDSL Operational Data Statistics" Display parameters
Specific Information
name
adm-state

opr-state/tx-rate-ds
tx-rate-us
tx-rate-ds
max-tx-rate-us
max-tx-rate-ds

596

Type

Description

<Itf::ifAdminStatus>
Possible values are :
- not-applicable : not-applicable
- admin-up : admin status is up
- admin-down : admin status is down
- testing : no operational packets can be
passed
down:0 | down:0 | down:0 | down:0 |
<Xdsl::bitrate>
unit: kbits/sec
<Xdsl::bitrate>
unit: kbits/sec
<Xdsl::bitrate>
unit: kbits/sec
<Xdsl::bitrate>
unit: kbits/sec

specifies state of the interface


This element is always shown.

<Xdsl::bitrate>
unit: kbits/sec

Released

current operational state of the interface.


This element is always shown.
bitrate for upstream fast or interleaved data flow
This element is always shown.
bitrate for downstream fast or interleaved data flow
This element is always shown.
maximum attainable atm rate the modem can
support
This element is always shown.
maximum attainable atm rate the modem can
support
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
snr-us
snr-ds
interl-us

Type

Description

<Xdsl::impNoise>
unit: 1/10 symbols
<Xdsl::impNoise>
unit: 1/10 symbols
<Xdsl::milliseconds>
unit: msec

actual impulse noise protection


This element is always shown.
actual impulse noise protection
This element is always shown.
delay caused by the interleaving
non-interleaving functionality
This element is always shown.
delay caused by the interleaving
non-interleaving functionality
This element is always shown.
operational mode allowed by this profile
This element is always shown.

and

interl-ds

<Xdsl::milliseconds>
unit: msec

cur-op-mode

<Xdsl::OpModeTypeLinePreDef>
Possible values are :
- default : default value
- ansi-t1413-1998 : ANSI T1.413-1998
- etsi-dts-tm06006 : ETSI DTS/TM06006
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
g992-5-b
:
G.992.5
POTS
non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
- <Xdsl::OpModeType> : octet string
defining the operation mode
<Counter>
number of times the modem re-initialize the line in
a day
This element is always shown.

rinit-1d

3HH-01016-AAAA-TCZZA Edition 03

Released

597

and

46 xDSL Status Commands

46.8 xDSL Carrier Data Near End Status Command


Command Description
This command displays xDSL carrier data near end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl carrier-data near-end (if-index)

Command Parameters
Table 46.8-1 "xDSL Carrier Data Near End Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.8-2 "xDSL Carrier Data Near End Status Command" Display parameters
Specific Information
name

Type

spacing

<Xdsl::CarrierSpacingType>
Possible values are :
- single : single
- double : double
- half : half
- quarter : quarter
load-distribution-down <BinaryString>

598

gain-allocation-down

<BinaryString>

tss-down

<Xdsl::CustomPsdShape>
length: x<60

snr-up

<BinaryString>

qln-up

<BinaryString>

Released

Description
nbr of bits per carrier over the downstream
passband
This element is always shown.

gain allocation over the downstream passband


This element is always shown.
transmit spectrum shaping for the downstream
direction
This element is always shown.
signal to noise ratio per carrier over the upstream
passband
This element is always shown.
quiet line noise per carrier over the upstream
passband
This element is always shown.
char function values in linear scale over upstream
passband
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name

Type

Description

char-func-complex

<BinaryString>

char-func-real

<BinaryString>

provides the channel characteristics function


complex values in linear scale for each carrier over
upstream passband
This element is always shown.
provides the channel characteristics function real
values in linear scale for each carrier over upstream
passband
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

599

46 xDSL Status Commands

46.9 xDSL Carrier Data Far End Status Command


Command Description
This command displays xDSL carrier data far end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl carrier-data far-end (if-index)

Command Parameters
Table 46.9-1 "xDSL Carrier Data Far End Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.9-2 "xDSL Carrier Data Far End Status Command" Display parameters
Specific Information
name

Type

Description
the actual carrier spacing used on the XDSL line in
the downstream direction
This element is always shown.

load-distribution-up

<Xdsl::CarrierSpacingType>
Possible values are :
- single : single
- double : double
- half : half
- quarter : quarter
<BinaryString>

gain-allocation-up

<BinaryString>

tss-up

<Xdsl::CustomPsdShape>
length: x<60

snr-down

<BinaryString>

qln-down

<BinaryString>

char-func-complex

<BinaryString>

spacing

600

Released

nbr of bits per carrier over the upstream passband


This element is always shown.
gain allocation over the upstream passband
This element is always shown.
transmit spectrum shaping for the upstream
direction
This element is always shown.
signal to noise ratio per carrier over the
downstream passband
This element is always shown.
quiet line noise per carrier over the downstream
passband
This element is always shown.
char function values in linear scale over

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
char-func-real

Type

Description

<BinaryString>

downstream passband
This element is always shown.
char func real values in dB over downstream
passband
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

601

46 xDSL Status Commands

46.10 xDSL Failure Status Near End Status


Command
Command Description
This command displays the xDSL failure status near end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status near-end (if-index)

Command Parameters
Table 46.10-1 "xDSL Failure Status Near End Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.10-2 "xDSL Failure Status Near End Status Command" Display parameters
Specific Information
name
status

602

Type

Description

<SignedInteger>

failure status of the xdsl near end line


This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.11 xDSL Failure Status Far End Status


Command
Command Description
This command displays the xDSL failure of the far end.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl failure-status far-end (if-index)

Command Parameters
Table 46.11-1 "xDSL Failure Status Far End Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.11-2 "xDSL Failure Status Far End Status Command" Display parameters
Specific Information
name
status

Type

Description

<SignedInteger>

failure status of xdsl far end line


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

603

46 xDSL Status Commands

46.12 xDSL Counters Near End Line Current 15 Min


Command Description
This command displays xDSL counters near end line current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-interval (if-index)

Command Parameters
Table 46.12-1 "xDSL Counters Near End Line Current 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.12-2 "xDSL Counters Near End Line Current 15 Min" Display parameters
Specific Information
name

604

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

ese

<Counter>

es

<Counter>

sec

<Counter>

uas

<Counter>

re-init

<Counter>

failed-init

<Counter>

number of occurences of an LOS failure event


This element is always shown.
number of occurences of an LOF failure event
This element is always shown.
number of occurences of a LOM failure event
This element is always shown.
number of occurences of an ESE failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line
This element is always shown.
number of times the modem re-initialize the line
This element is always shown.
number of times the modem failed to initialize the
line

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type
<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

605

46 xDSL Status Commands

46.13 xDSL Counters Near End Line Current Day


Command Description
This command displays the xDSL counters near end line current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line current-1day (if-index)

Command Parameters
Table 46.13-1 "xDSL Counters Near End Line Current Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.13-2 "xDSL Counters Near End Line Current Day" Display parameters
Specific Information
name

606

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

ese

<Counter>

es

<Counter>

sec

<Counter>

uas

<Counter>

re-init

<Counter>

failed-init

<Counter>

number of occurences of an LOS failure event


This element is always shown.
number of occurences of an LOF failure event
This element is always shown.
number of occurences of a LOM failure event
This element is always shown.
number of occurences of an ESE failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line
This element is always shown.
number of times the modem re-initialize the line
This element is always shown.
number of times the modem failed to initialize the
line

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type
<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

607

46 xDSL Status Commands

46.14 xDSL Counters Near End Line Previous 15


Min
Command Description
This command displays the xDSL counters near end line previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-interval (if-index) interval-no
<Xdsl::IntervalNumber15min>

Command Parameters
Table 46.14-1 "xDSL Counters Near End Line Previous 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber15min>
range: [1...192]

interval-no

Description
/ interface index of the port
nbr identifying previous 15 min intvl time, value 1
is the most recently completed 15 min intvl

Command Output
Table 46.14-2 "xDSL Counters Near End Line Previous 15 Min" Display parameters
Specific Information
name

608

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

ese

<Counter>

es

<Counter>

sec

<Counter>

uas

<Counter>

number of occurences of an LOS failure event


This element is always shown.
number of occurences of an LOF failure event
This element is always shown.
number of occurences of a LOM failure event
This element is always shown.
number of occurences of an ESE failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name

Type

re-init

<Counter>

failed-init

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
number of times the modem re-initialize the line
This element is always shown.
number of times the modem failed to initialize the
line
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

609

46 xDSL Status Commands

46.15 xDSL Counters Near End Of Line Previous


Day
Command Description
This command displays the xDSL counters near end of the previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end line previous-1day (if-index) interval-no
<Xdsl::IntervalNumber1day>

Command Parameters
Table 46.15-1 "xDSL Counters Near End Of Line Previous Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber1day>
range: [1...7]

interval-no

Description
/ interface index of the port
nbr identifying previous 1 day intvl time, value 1 is
the most recently completed 1 day intvl

Command Output
Table 46.15-2 "xDSL Counters Near End Of Line Previous Day" Display parameters
Specific Information
name

610

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

ese

<Counter>

es

<Counter>

sec

<Counter>

uas

<Counter>

number of occurences of an LOS failure event


This element is always shown.
number of occurences of an LOF failure event
This element is always shown.
number of occurences of a LOM failure event
This element is always shown.
number of occurences of an ESE failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name

Type

re-init

<Counter>

failed-init

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
number of times the modem re-initialize the line
This element is always shown.
number of times the modem failed to initialize the
line
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

611

46 xDSL Status Commands

46.16 xDSL Counters Near End Channel Current 15


Min
Command Description
This command displays xDSL counters near end channel current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-interval (if-index)

Command Parameters
Table 46.16-1 "xDSL Counters Near End Channel Current 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.16-2 "xDSL Counters Near End Channel Current 15 Min" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations encountered by the


channel
This element is always shown.
number of corrected codewords encountered by the
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

612

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.17 xDSL Counters Near End Channel Current


Day
Command Description
This command displays xDSL counters near end channel current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel current-1day (if-index)

Command Parameters
Table 46.17-1 "xDSL Counters Near End Channel Current Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.17-2 "xDSL Counters Near End Channel Current Day" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations encountered by the


channel
This element is always shown.
number of corrected codewords encountered by the
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Released

613

46 xDSL Status Commands

46.18 xDSL Counters Near End Channel Previous


15 Min
Command Description
This command displays xDSL counters near end channel previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-interval (if-index) interval-no
<Xdsl::IntervalNumber15min>

Command Parameters
Table 46.18-1 "xDSL Counters Near End Channel Previous 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber15min>
range: [1...192]

interval-no

Description
/ interface index of the port
nbr identifying previous 15 min intvl time, value 1
is the most recently completed 15 min intvl

Command Output
Table 46.18-2 "xDSL Counters Near End Channel Previous 15 Min" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations encountered by the


channel
This element is always shown.
number of corrected codewords encountered by the
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

614

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.19 xDSL Counters Near End Channel Previous


Day
Command Description
This command displays xDSL counters near end channel previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters near-end channel previous-1day (if-index) interval-no
<Xdsl::IntervalNumber1day>

Command Parameters
Table 46.19-1 "xDSL Counters Near End Channel Previous Day" Resource Parameters
Resource Identifier
(if-index)
interval-no

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber1day>
range: [1...7]

Description
/ interface index of the port
nbr identifying previous 1 day intvl time, value 1 is
the most recently completed 1 day intvl

Command Output
Table 46.19-2 "xDSL Counters Near End Channel Previous Day" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations encountered by the


channel
This element is always shown.
number of corrected codewords encountered by the
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Released

615

46 xDSL Status Commands

46.20 xDSL Counters Far End Line Current 15 Min


Command Description
This command displays xDSL counters far end line current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-interval (if-index)

Command Parameters
Table 46.20-1 "xDSL Counters Far End Line Current 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the xdsl port

Command Output
Table 46.20-2 "xDSL Counters Far End Line Current 15 Min" Display parameters
Specific Information
name

616

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

lpr

<Counter>

lol

<Counter>

ese

<Counter>

es

<Counter>

ses

<Counter>

uas

<Counter>

number of occurences of an los failure event


This element is always shown.
number of occurences of an lof failure event
This element is always shown.
number of occurences of an lom failure event
This element is always shown.
number of occurences of an lpr failure event
This element is always shown.
number of occurences of an lol failure event
This element is always shown.
number of occurences of an ese failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type

Description

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

amt of time in sec that statistics have been counted


This element is always shown.
validity of the corresponding PM data
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

617

46 xDSL Status Commands

46.21 xDSL Counters Far End Line Current Day


Command Description
This command displays xDSL counters far end line current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line current-1day (if-index)

Command Parameters
Table 46.21-1 "xDSL Counters Far End Line Current Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.21-2 "xDSL Counters Far End Line Current Day" Display parameters
Specific Information
name

618

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

lpr

<Counter>

lol

<Counter>

ese

<Counter>

es

<Counter>

ses

<Counter>

uas

<Counter>

number of occurences of an los failure event


This element is always shown.
number of occurences of an lof failure event
This element is always shown.
number of occurences of an lom failure event
This element is always shown.
number of occurences of an lpr failure event
This element is always shown.
number of occurences of an lol failure event
This element is always shown.
number of occurences of an ese failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the
line
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type

Description

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

amt of time in sec that statistics have been counted


This element is always shown.
validity of the corresponding PM data
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

619

46 xDSL Status Commands

46.22 xDSL Counters Far End Line Previous 15 Min


Command Description
This command displays xDSL counters far end line previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-interval (if-index) interval-no
<Xdsl::IntervalNumber15min>

Command Parameters
Table 46.22-1 "xDSL Counters Far End Line Previous 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber15min>
range: [1...192]

interval-no

Description
/ interface index of the port
nbr identifying previous 15 min intvl time, value 1
is the most recently completed 15 min intvl

Command Output
Table 46.22-2 "xDSL Counters Far End Line Previous 15 Min" Display parameters
Specific Information
name

620

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

lpr

<Counter>

lol

<Counter>

ese

<Counter>

es

<Counter>

ses

<Counter>

uas

<Counter>

number of occurences of an los failure event


This element is always shown.
number of occurences of an lof failure event
This element is always shown.
number of occurences of an lom failure event
This element is always shown.
number of occurences of an lpr failure event
This element is always shown.
number of occurences of an lol failure event
This element is always shown.
number of occurences of an ese failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type
<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

3HH-01016-AAAA-TCZZA Edition 03

Description
line
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

621

46 xDSL Status Commands

46.23 xDSL Counters Far End Line Previous Day


Command Description
This command displays xDSL counters far end line previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end line previous-1day (if-index) interval-no
<Xdsl::IntervalNumber1day>

Command Parameters
Table 46.23-1 "xDSL Counters Far End Line Previous Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber1day>
range: [1...7]

interval-no

Description
/ interface index of the port
nbr identifying previous 1 day intvl time, value 1 is
the most recently completed 1 day intvl

Command Output
Table 46.23-2 "xDSL Counters Far End Line Previous Day" Display parameters
Specific Information
name

622

Type

Description

los

<Counter>

lof

<Counter>

lom

<Counter>

lpr

<Counter>

lol

<Counter>

ese

<Counter>

es

<Counter>

ses

<Counter>

uas

<Counter>

number of occurences of an los failure event


This element is always shown.
number of occurences of an lof failure event
This element is always shown.
number of occurences of an lom failure event
This element is always shown.
number of occurences of an lpr failure event
This element is always shown.
number of occurences of an lol failure event
This element is always shown.
number of occurences of an ese failure event
This element is always shown.
number of errored seconds encountered by the line
This element is always shown.
number of severely errored seconds encountered by
the line
This element is always shown.
number of unavailable seconds encountered by the

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
measured-time
in-valid-flag

Type
<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

3HH-01016-AAAA-TCZZA Edition 03

Description
line
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

Released

623

46 xDSL Status Commands

46.24 xDSL Counters Far End Channel Current 15


Min
Command Description
This command displays xDSL counters far end channel current 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-interval (if-index)

Command Parameters
Table 46.24-1 "xDSL Counters Far End Channel Current 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.24-2 "xDSL Counters Far End Channel Current 15 Min" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

nbr of coding violations encountered by far end


channel
This element is always shown.
nbr of corrected codewords encountered by far end
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

624

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.25 xDSL Counters Far End Channel Current Day


Command Description
This command displays xDSL counters far end channel current day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel current-1day (if-index)

Command Parameters
Table 46.25-1 "xDSL Counters Far End Channel Current Day" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.25-2 "xDSL Counters Far End Channel Current Day" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

nbr of coding violations encountered by far end


channel
This element is always shown.
nbr of corrected codewords encountered by far end
channel
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Released

625

46 xDSL Status Commands

46.26 xDSL Counters Far End Channel Previous 15


Min
Command Description
This command displays xDSL counters far end channel previous 15 min.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-interval (if-index) interval-no
<Xdsl::IntervalNumber15min>

Command Parameters
Table 46.26-1 "xDSL Counters Far End Channel Previous 15 Min" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber15min>
range: [1...192]

interval-no

Description
/ interface index of the port
nbr identifying previous 15 min intvl time, value 1
is the most recently completed 15 min intvl

Command Output
Table 46.26-2 "xDSL Counters Far End Channel Previous 15 Min" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations in the past 24 hours


This element is always shown.
number of corrected codewords in the past 24 hours
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

626

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.27 xDSL Counters Far End Channel Previous


Day
Command Description
This command displays xDSL counters far end channel previous day.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl counters far-end channel previous-1day (if-index) interval-no
<Xdsl::IntervalNumber1day>

Command Parameters
Table 46.27-1 "xDSL Counters Far End Channel Previous Day" Resource Parameters
Resource Identifier
(if-index)
interval-no

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>
<Xdsl::IntervalNumber1day>
range: [1...7]

Description
/ interface index of the port
nbr identifying previous 1 day intvl time, value 1 is
the most recently completed 1 day intvl

Command Output
Table 46.27-2 "xDSL Counters Far End Channel Previous Day" Display parameters
Specific Information
name

Type

Description

cv

<Counter>

fecc

<Counter>

measured-time

<Xdsl::IntervalMeasureTime>
range: [0...86400] unit: sec
<Xdsl::IntervalValidityFlag>
Possible values are :
- true : data is not valid
- false : data is valid

number of coding violations in the previous one


day
This element is always shown.
number of corrected codewords in the previous one
day
This element is always shown.
amt of time in sec that statistics have been counted
This element is always shown.
validity of the corresponding PM data
This element is always shown.

in-valid-flag

3HH-01016-AAAA-TCZZA Edition 03

Released

627

46 xDSL Status Commands

46.28 xDSL Inventory XT/RT Status Command


Command Description
This command displays xDSL inventory XT/RT.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl cpe-inventory (if-index)

Command Parameters
Table 46.28-1 "xDSL Inventory XT/RT Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.28-2 "xDSL Inventory XT/RT Status Command" Display parameters
Specific Information
name
modem-vendor-id
sys-serial-no
sys-vendor-id
sys-version-no
self-test-result

628

Type

Description

<Xdsl::VendorID>
length: x<16
<Xdsl::SystemSerialNumber>
length: x<32
<Xdsl::VendorID>
length: x<16
<Xdsl::SystemVersionNo>
length: x<34
<Xdsl::SelfTestResult>
length: x<8

vendor ID retrieved during handshaking


This element is always shown.
serial number that identifies the vendor equipment
This element is always shown.
vendor ID retrieved via the xdsl EOC
This element is always shown.
version number retrieved via the the xdsl EOC
This element is always shown.
self test results value retrieved via the the xdsl EOC
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

46.29 xDSL Board Capability Status Command


Command Description
This command displays xDSL board capability.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl board (if-index)

Command Parameters
Table 46.29-1 "xDSL Board Capability Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Command Output
Table 46.29-2 "xDSL Board Capability Status Command" Display parameters
Specific Information
name
capability

Type

Description

<Xdsl::OpModeTypeLinePreDef>
operational mode supported by the board
Possible values are :
This element is always shown.
- default : default value
- ansi-t1413-1998 : ANSI T1.413-1998
- etsi-dts-tm06006 : ETSI DTS/TM06006
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-a
:
G.992.2
POTS
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
- g992-3-am : G.992.3 extended POTS

3HH-01016-AAAA-TCZZA Edition 03

Released

629

46 xDSL Status Commands

name

ansi-t1413

etsi-dts

g992-1-a

g992-1-b

g992-2-a

g992-3-a

g992-3-b

g992-3-l1

630

Type
with non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
g992-5-b
:
G.992.5
POTS
non-overlapped spectrum
- ansi-t1.424 : ANSI T1.424
- etsi-ts : ETSI TS
- itu-g993-1 : ITU G993-1
- ieee-802.3ah : IEEE 802.3ah
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum
- <Xdsl::OpModeType> : octet string
defining the operation mode
<Xdsl::T1413>
Possible values are :
- dis-ansi-t1413-1998 : disable ANSI
T1.413-1998
- ansi-t1413-1998 : ANSI T1.413-1998
<Xdsl::Etsidts>
Possible values are :
- dis-etsi-dts-tm06006 : disable ETSI
DTS/TM06006
- etsi-dts-tm06006 : ETSI DTS/TM06006
<Xdsl::G21potsnos>
Possible values are :
- dis-g992-1-a : disable G.992.1 POTS
non-overlapped spectrum
g992-1-a
:
G.992.1
POTS
non-overlapped spectrum
<Xdsl::G21isdnnos>
Possible values are :
- dis-g992-1-b : disable G.992.1 ISDN
non-overlapped spectrum
g992-1-b
:
G.992.1
ISDN
non-overlapped spectrum
<Xdsl::G22potsnos>
Possible values are :
- dis-g992-2-a : disable G.992.2 POTS
non-overlapped spectrum
g992-2-a
:
G.992.2
POTS
non-overlapped spectrum
<Xdsl::G23potsnos>
Possible values are :
- dis-g992-3-a : disable G.992.3 POTS
non-overlapped spectrum
g992-3-a
:
G.992.3
POTS
non-overlapped spectrum
<Xdsl::G23isdnnos>
Possible values are :
- dis-g992-3-b : disable G.992.3 ISDN
non-overlapped spectrum
g992-3-b
:
G.992.3
ISDN
non-overlapped spectrum
<Xdsl::G23PotsnosUs1>
Possible values are :
- dis-g992-3-l1 : disable G.992.3 POTS
non-overlapped spectrum US mask 1

Released

Description

ANSI T1.413-1998
This element is only shown in detail mode.

ETSI DTS/TM06006
This element is only shown in detail mode.

G.992.1 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.1 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.2 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 ISDN non-overlapped spectrum


This element is only shown in detail mode.

G.992.3 POTS non-overlapped spectrum US mask


1
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

46 xDSL Status Commands

name
g992-3-l2

g992-3-am

g992-5-a

g992-5-b

ansi-t1.424

etsi-ts

itu-g993-1

ieee-802.3ah

g992-5-am

Type
g992-3-l1
:
G.992.3
POTS
non-overlapped spectrum US mask 1
<Xdsl::G23PotsNosUs2>
Possible values are :
- dis-g992-3-l2 : disable G.992.3 POTS
non-overlapped spectrum US mask 2
g992-3-l2
:
G.992.3
POTS
non-overlapped spectrum US mask 2
<Xdsl::G23ExtPotsNos>
Possible values are :
- dis-g992-3-am : disable G.992.3
extended POTS with non-overlapped
spectrum
- g992-3-am : G.992.3 extended POTS
with non-overlapped spectrum
<Xdsl::G25PotsNos>
Possible values are :
- dis-g992-5-a : disable G.992.5 POTS
non-overlapped spectrum
g992-5-a
:
G.992.5
POTS
non-overlapped spectrum
<Xdsl::G25IsdnNos>
Possible values are :
- dis-g992-5-b : disable G.992.5 ISDN
non-overlapped spectrum
g992-5-b
:
G.992.5
ISDN
non-overlapped spectrum
<Xdsl::AnsiT1424>
Possible values are :
- dis-ansi-t1.424 : disable ANSI T1.424
- ansi-t1.424 : ANSI T1.424
<Xdsl::EtsiTs>
Possible values are :
- dis-etsi-ts : disable ETSI TS
- etsi-ts : ETSI TS
<Xdsl::ItuG9931>
Possible values are :
- dis-itu-g993-1 : disable ITU G993-1
- itu-g993-1 : ITU G993-1
<Xdsl::Ieee802.3Ah>
Possible values are :
- dis-ieee-802.3ah : disable IEEE 802.3ah
- ieee-802.3ah : IEEE 802.3ah
<Xdsl::G25ExtPotsNos>
Possible values are :
- dis-g992-5-am : disable G.992.5
extended POTS non-overlapped spectrum
- g992-5-am : G.992.5 extended POTS
non-overlapped spectrum

3HH-01016-AAAA-TCZZA Edition 03

Description
G.992.3 POTS non-overlapped spectrum US mask
2
This element is only shown in detail mode.

G.992.3 extended POTS with non-overlapped


spectrum
This element is only shown in detail mode.

G.992.5 POTS non-overlapped spectrum


This element is only shown in detail mode.

G.992.5 ISDN non-overlapped spectrum


This element is only shown in detail mode.

ansi T1.424
This element is only shown in detail mode.
ETSI TS 101 270
This element is only shown in detail mode.
ITU G993-1
This element is only shown in detail mode.
IEEE 802.3ah
This element is only shown in detail mode.
G.992.5 extended POTS non-overlapped spectrum
This element is only shown in detail mode.

Released

631

47- xDSL Bonding Status Commands

47.1 xDSL Bonding Profiles Status Command


47.2 xDSL Bonding Near End Operational Data Status
Command
47.3 xDSL Bonding Far End Operational Data Status
Command
47.4 xDSL Bonding Near End Failure Status Command
47.5 xDSL Bonding Far End Failure Status Command

632

Released

47-633
47-634
47-635
47-636
47-638

3HH-01016-AAAA-TCZZA

Edition 03

47 xDSL Bonding Status Commands

47.1 xDSL Bonding Profiles Status Command


Command Description
This command displays the xDSL bonding profiles.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding profiles (index)

Command Parameters
Table 47.1-1 "xDSL Bonding Profiles Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Xdsl::GroupProfileIndex>
range: [1...100]

a unique interface index

Command Output
Table 47.1-2 "xDSL Bonding Profiles Status Command" Display parameters
Specific Information
name
name
used-status

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32
<Xdsl::UsedStatus>
range: [0...65535]

name of the bonding group profile


This element is always shown.
specifies the number of entities using this profile.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

633

47 xDSL Bonding Status Commands

47.2 xDSL Bonding Near End Operational Data


Status Command
Command Description
This command shows the operational data near end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data near-end (if-index)

Command Parameters
Table 47.2-1 "xDSL Bonding Near End Operational Data Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ a unique interface index

Command Output
Table 47.2-2 "xDSL Bonding Near End Operational Data Status Command" Display parameters
Specific Information
name
actual-bitrate-up

634

Type

Description

<Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec

when the bonding group is in service, this will give


the actual ATM bitrate and 0 when not in service
also in case no data is available.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

47 xDSL Bonding Status Commands

47.3 xDSL Bonding Far End Operational Data


Status Command
Command Description
This command shows the operational data far end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding operational-data far-end (if-index)

Command Parameters
Table 47.3-1 "xDSL Bonding Far End Operational Data Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ a unique interface index

Command Output
Table 47.3-2 "xDSL Bonding Far End Operational Data Status Command" Display parameters
Specific Information
name
actual-bitrate-down

Type

Description

<Xdsl::Bitrate>
range: [0...65535] unit: kbits/sec

when the bonding group is in service, this will give


the actual ATM bitrate and 0 when not in service
also in case no data is available.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

635

47 xDSL Bonding Status Commands

47.4 xDSL Bonding Near End Failure Status


Command
Command Description
This command displays the xDSL bonding failure near end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding failure-status near-end (if-index)

Command Parameters
Table 47.4-1 "xDSL Bonding Near End Failure Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ a unique interface index

Command Output
Table 47.4-2 "xDSL Bonding Near End Failure Status Command" Display parameters
Specific Information
name
no-defect

up-min-bitrate

up-config

up-plan-bitrate

636

Type

Description

<Xdsl::FailureStatusNEDefect>
Possible values are :
- no : defect in the near-end failure status
- yes : no defect in the near-end failure
status
<Xdsl::FailureStatusNEUpMinBitrate>
Possible values are :
- not-reached : minimum upstream bitrate
threshold is not reached
- reached : minimum upstream bitrate
threshold is reached
<Xdsl::FailureStatusNEUpConfig>
Possible values are :
- feasible : upstream configuration feasible
- not-feasible : upstream configuration not
feasible
<Xdsl::FailureStatusNEUpPlanBitrate>

specifies the defect status in the near-end


This element is always shown.

Released

specifies the upstream bitrate threshold alarm status


This element is always shown.

specifies the upstream configuration status


This element is always shown.

specifies the upstream planned bitrate threshold

3HH-01016-AAAA-TCZZA

Edition 03

47 xDSL Bonding Status Commands

name

Type

Description

Possible values are :


alarm status
- not-planned : upstream bitrate thresold is This element is always shown.
not planned
- planned : upstream bitrate thresold is
planned

3HH-01016-AAAA-TCZZA Edition 03

Released

637

47 xDSL Bonding Status Commands

47.5 xDSL Bonding Far End Failure Status


Command
Command Description
This command displays the xDSL bonding failure far end statistics.

User Level
The command can be accessed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> show xdsl-bonding failure-status far-end (if-index)

Command Parameters
Table 47.5-1 "xDSL Bonding Far End Failure Status Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ a unique interface index

Command Output
Table 47.5-2 "xDSL Bonding Far End Failure Status Command" Display parameters
Specific Information
name
no-defect

down-min-bitrate

down-config

638

Type

Description

<Xdsl::FailureStatusFEDefect>
Possible values are :
- no : defect in the far-end failure status
- yes : no defect in the far-end failure
status
<Xdsl::FailureStatusFEDownMinBitrate>
Possible values are :
- not-reached : minimum downstream
bitrate threshold is not reached
- reached : minimum downstream bitrate
threshold is reached
<Xdsl::FailureStatusFEDownConfig>
Possible values are :
- feasible : downstream configuration
feasible
- not-feasible : downstream configuration
not feasible

specifies the defect status in the far-end


This element is always shown.

Released

specifies the downstream bitrate threshold alarm


status
This element is always shown.

specifies the downstream configuration status


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

47 xDSL Bonding Status Commands

name
down-plan-bitrate

Type

Description

<Xdsl::FailureStatusFEDownPlanBitrate> specifies the downstream planned bitrate threshold


Possible values are :
alarm status
- not-planned : downstream bitrate This element is always shown.
thresold is not planned
- planned : downstream bitrate thresold is
planned

3HH-01016-AAAA-TCZZA Edition 03

Released

639

48- PPPoE Status Commands

48.1 PPPoE Sessions Status Command


48.2 PPPoE Sessions/Connection Status Command
48.3 PPPoE Interface Status Command
48.4 PPPoX Interface Statistics
48.5 PPPoE Interface Statistics
48.6 PPPoE Interface Received Statistics
48.7 PPPoE Interface Transmitted Statistics
48.8 PPPoE Profile Status Command
48.9 Ip-address Related PPP Status Command
48.10 Mac-address Related PPP Status Command

640

Released

48-641
48-642
48-643
48-645
48-647
48-648
48-650
48-651
48-653
48-654

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.1 PPPoE Sessions Status Command


Command Description
This command shows the PPPoE session parameters such as the PPPoE session id, PPPoE session lowerlayer
Ifindex, PPPoE session local MAC address, and PPPoE remote MAC address.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe session (port)

Command Parameters
Table 48.1-1 "PPPoE Sessions Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId>

Command Output
Table 48.1-2 "PPPoE Sessions Status Command" Display parameters
Specific Information
name

Type

Description

session-id

<SignedInteger>

local-mac

<Vlan::MacAddr>
length: 6

remote-mac

<Vlan::MacAddr>
length: 6

PPPoE session id associated for a PPP session


This element is always shown.
The MAC address of the PPPoE server on which
PPPoE session is established.
This element is always shown.
The MAC address of the user who established the
PPPoE session.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

641

48 PPPoE Status Commands

48.2 PPPoE Sessions/Connection Status Command


Command Description
User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe connection (connection)

Command Parameters
Table 48.2-1 "PPPoE Sessions/Connection Status Command" Resource Parameters
Resource Identifier
(connection)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of a pppoe interface
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 48.2-2 "PPPoE Sessions/Connection Status Command" Display parameters
Specific Information
name
session

session-id
local-mac
remote-mac

642

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of a session
<Eqpt::LtSlot>
/
<Eqpt::Port>
: This element is always shown.
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId>
<SignedInteger>
PPPoE session id associated for a PPP session
This element is always shown.
<Vlan::MacAddr>
The MAC address of the PPPoE server on which
length: 6
PPPoE session is established.
This element is always shown.
<Vlan::MacAddr>
The MAC address of the user who established the
length: 6
PPPoE session.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.3 PPPoE Interface Status Command


Command Description
This command shows the PPPoE interface parameters.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe if-table (session)

Command Parameters
Table 48.3-1 "PPPoE Interface Status Command" Resource Parameters
Resource Identifier
(session)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of a pppoe session
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId>

Command Output
Table 48.3-2 "PPPoE Interface Status Command" Display parameters
Specific Information
name
state

user-name
local-ip-addr
remote-ip-addr
local-mru

Type

Description

<PPPoE::pppIfState>
current PPP state of the session.
Possible values are :
This element is always shown.
- lcp : PPP session reaches LCP phase
- authenticating : PPP session reaches
Authentication phase
- ipcp : PPP session reaches IPCP phase
- up : PPP session is UP
- down : PPP session is down
<PrintableString>
username (along with the domain name) who
established the PPPoE session.
This element is always shown.
<Ip::V4Address>
IP address of the system on which PPPoE session is
established
This element is only shown in detail mode.
<Ip::V4Address>
IP address of the user who established the PPPoE
session.
This element is only shown in detail mode.
<SignedInteger>
The MRU of the system link, on which PPPoE

3HH-01016-AAAA-TCZZA Edition 03

Released

643

48 PPPoE Status Commands

name

644

Type

remote-mru

<SignedInteger>

prim-dns-addr

<Ip::V4Address>

sec-dns-addr

<Ip::V4Address>

prim-nbns-addr

<Ip::V4Address>

sec-nbns-addr

<Ip::V4Address>

qos-profile

<PPPoE::SnmpAdminString>
length: 19

in-pkts

<PPPoE::InOutSize>

out-pkts

<PPPoE::InOutSize>

in-octet

<PPPoE::InOutSize>

out-octet

<PPPoE::InOutSize>

in-dropped-pkts

<PPPoE::InOutSize>

out-dropped-pkts

<PPPoE::InOutSize>

in-dropped-octet

<PPPoE::InOutSize>

out-dropped-octet

<PPPoE::InOutSize>

start-time

<Sys::Time>

remaining-time

<PPPoE::Time>
range: [0...[0-9]+]

acc-itvl

<SignedInteger>

vrf-id

<SignedInteger>

Released

Description
session is established.
This element is only shown in detail mode.
The MRU of the user link, who established the
PPPoE session.
This element is only shown in detail mode.
remote primary DNS IP address, obtained from the
authentication service
This element is only shown in detail mode.
remote secondary DNS IP address, obtained from
the authentication service
This element is only shown in detail mode.
remote primary NBNS IP address, obtained from
the authentication service
This element is only shown in detail mode.
remote secondary NBNS IP address, obtained from
the authentication service
This element is only shown in detail mode.
the dynamic or static QOS profile assigned to a
PPP interface
This element is always shown.
total number of packets received in this session.
This element is only shown in detail mode.
total number of packets transmitted in this session.
This element is only shown in detail mode.
total number of octets received in this session.
This element is only shown in detail mode.
total number of octets transmitted in this session.
This element is only shown in detail mode.
total number of packets dropped in this session
during up stream.
This element is only shown in detail mode.
total number of packets dropped in this session
during down stream.
This element is only shown in detail mode.
total number of octets dropped in this session
during up stream.
This element is only shown in detail mode.
total number of octets dropped in this session
during down stream.
This element is only shown in detail mode.
system time when the session is established.
This element is only shown in detail mode.
max duration for the session, after which the
session will terminated by the system.
This element is only shown in detail mode.
interval that must elapse between generation of
accounting records for this session.
This element is always shown.
identifier of the VRF that this session belongs to.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.4 PPPoX Interface Statistics


Command Description
Shows the statistics of PPP on PPPoX interface. This command takes the rack/subrack/slot/port and vpi and vci
values as argument on which the pppoe was configured, or for which to show the arguments.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe ppp-statistics (port)

Command Parameters
Table 48.4-1 "PPPoX Interface Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 48.4-2 "PPPoX Interface Statistics" Display parameters
Specific Information
name
open-sess

Type

Description

<Counter>

total number of opened sessions.


This element is always shown.
total number of session terminates due to link down
events.
This element is always shown.
total number of CHAP authentication failure.
This element is always shown.
total number of PAP authentication failure.
This element is always shown.
total number of failed retrievals for local IP
address.
This element is only shown in detail mode.
total number of negotiation mismatch occurred in
LCP phase.
This element is only shown in detail mode.
total number of negotiation mismatch occurred in
IPCP phase.
This element is only shown in detail mode.

low-layer-down-event <Counter>
chap-auth-fail

<Counter>

pap-auth-fail

<Counter>

ip-addr-fail

<Counter>

lcp-nego-mis

<Counter>

ipcp-nego-mis

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Released

645

48 PPPoE Status Commands

name

646

Type

Description

usr-term

<Counter>

sys-term

<Counter>

total number of user terminate requests received.


This element is only shown in detail mode.
total number of system terminate requests sent.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.5 PPPoE Interface Statistics


Command Description
This command shows the PPPoE interface statistics. This command takes the rack/subrack/slot/port and vpi and
vci values as argument on which the PPPoE was configured, or for which to show the arguments.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf stats (port)

Command Parameters
Table 48.5-1 "PPPoE Interface Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 48.5-2 "PPPoE Interface Statistics" Display parameters
Specific Information
name

Type

Description

act-sess

<Gauge>

estab-sess

<Counter>

error

<Counter>

padi-inv-id

<Counter>

padr-inv-id

<Counter>

Total number of active PPPoE sessions.


This element is always shown.
Total number of PPPoE sessions established after
the system has been reset.
This element is always shown.
The statistics indicates the number of errors
experienced in performing the host request.
This element is always shown.
Total number of invalid session-id received in
PADI packets.
This element is always shown.
Total number of invalid session-id received in
PADR packets.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

647

48 PPPoE Status Commands

48.6 PPPoE Interface Received Statistics


Command Description
This command displays the PPPoE interface recieved statistics.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf rx-pkt (port)

Command Parameters
Table 48.6-1 "PPPoE Interface Received Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 48.6-2 "PPPoE Interface Received Statistics" Display parameters
Specific Information
name

648

Type

Description

inv-header

<Counter>

inv-type

<Counter>

inv-code

<Counter>

invl-tag

<Counter>

invl-length

<Counter>

padi

<Counter>

padr

<Counter>

Total number of PPPoE invalid header packets


received.
This element is always shown.
Total number of PPPoE invalid type packets
received.
This element is always shown.
Total number of PPPoE invalid code packets
received.
This element is always shown.
Total number of invalid tag received in the PPPoE
header.
This element is always shown.
Total number packets received with invalid length
in PPPoE header.
This element is always shown.
Total number of PPPoE active discovery initiation
(PADI) packets received.
This element is always shown.
Total number of PPPoE active discovery request

Released

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

name
padt

Type

Description

<Counter>

(PADR) packets received.


This element is always shown.
Total number of PPPoE active discovery terminate
(PADT) packets received
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

649

48 PPPoE Status Commands

48.7 PPPoE Interface Transmitted Statistics


Command Description
This command displays the PPPoE interface transmitted statistics.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe statistics-pppoe-itf tx-pkt (port)

Command Parameters
Table 48.7-1 "PPPoE Interface Transmitted Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 48.7-2 "PPPoE Interface Transmitted Statistics" Display parameters
Specific Information
name

650

Type

Description

pado

<Counter>

pads

<Counter>

padt

<Counter>

rej-padi

<Counter>

rej-padr

<Counter>

Total number of PPPoE active discovery offer


(PADO) packets transmitted
This element is always shown.
Total number of PPPoE active discovery
session-confirmation (PADS) packets transmitted
This element is always shown.
Total number of PPPoE active discovery terminate
(PADT) packets transmitted
This element is always shown.
Total number of PPPoE active discovery initiation
(PADI) packets that were rejected
This element is always shown.
Total number of PPPoE active discovery request
(PADR) packets that were rejected
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.8 PPPoE Profile Status Command


Command Description
This command shows the value of the ppp-profile name, used-status, and the version of the profile.
The manager can associate a version number to the profile. The version number is set to 1 when the profile is first
created and will be incremented by the manager when the profile is modified.
The profile used-status indicates the number of entities using this profile. If the reference count is greater than 0,
then this profile is 'in use', and must not be deleted. If the value is 0, then this profile is 'not in use' and can be
deleted.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe ppp-profile (name)

Command Parameters
Table 48.8-1 "PPPoE Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

name of the profile

Command Output
Table 48.8-2 "PPPoE Profile Status Command" Display parameters
Specific Information
name
used-status
version
auth-type

keep-alive-intvl

Type

Description

<AsamProfileRefCount>
range: [0...65535]
<SignedInteger>

indicates the number of entities using this profile.


This element is always shown.
version number associated with the profile.
This element is always shown.
specifies the type of PPP authentication used.
This element is always shown.

<PPPoE::pppProfileAuthenType>
Possible values are :
- pap : only PAP negotiation
- chap : only CHAP negotiation
- pap-chap : negotiate PAP first, if it fails,
attempt CHAP
- chap-pap : negotiate CHAP first, if it
fails, attempt PAP
<PPPoE::ProfileKeepAliveInterval>
keep alive time, after the request packet is sent.
range: [0...65535] unit: sec
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

651

48 PPPoE Status Commands

652

Released

3HH-01016-AAAA-TCZZA

Edition 03

48 PPPoE Status Commands

48.9 Ip-address Related PPP Status Command


Command Description
This command shows the PPP data for each IP address.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe ip-address (remote-ip-addr)

Command Parameters
Table 48.9-1 "Ip-address Related PPP Status Command" Resource Parameters
Resource Identifier
(remote-ip-addr)

Type

Description

<Ip::V4Address>

IP address of the user who established the PPPoE


session.

Command Output
Table 48.9-2 "Ip-address Related PPP Status Command" Display parameters
Specific Information
name
session

state

user-name

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId>
<PPPoE::pppIfState>
Possible values are :
- lcp : PPP session reaches LCP phase
- authenticating : PPP session reaches
Authentication phase
- ipcp : PPP session reaches IPCP phase
- up : PPP session is UP
- down : PPP session is down
<PrintableString>

the identification of a pppoe session


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

current PPP state of the session.


This element is always shown.

username (along with the domain name) who


established the PPPoE session.
This element is always shown.

Released

653

48 PPPoE Status Commands

48.10 Mac-address Related PPP Status Command


Command Description
This command shows the PPP data for each MAC address.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppoe mac-address (remote-mac)

Command Parameters
Table 48.10-1 "Mac-address Related PPP Status Command" Resource Parameters
Resource Identifier
(remote-mac)

Type

Description

<Vlan::MacAddr>
length: 6

The MAC address of the user who established the


PPPoE session.

Command Output
Table 48.10-2 "Mac-address Related PPP Status Command" Display parameters
Specific Information
name
session

user-name

654

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of a PPPoE session
<Eqpt::LtSlot>
/
<Eqpt::Port>
: This element is always shown.
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId>
<PrintableString>
username (along with the domain name) who
established the PPPoE session.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

49- Interface Status Commands

49.1 Interface Alarm Status Command


49.2 Physical Interface Status Command
49.3 Interface Status Command
49.4 Interface Test Status Command
49.5 Interface Stack Status Command
49.6 SHub Interface Status Command
49.7 SHub Interface Port Control Status Command
49.8 SHub Interface Uplink Group Status Command
49.9 Interface Extensive Status Command

3HH-01016-AAAA-TCZZA Edition 03

49-656
49-657
49-658
49-661
49-663
49-665
49-666
49-668
49-669

Released

655

49 Interface Status Commands

49.1 Interface Alarm Status Command


Command Description
This command shows the alarm configured for the interface and the default minimal severity with which the alarm
is reported.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface alarm (interface-type)

Command Parameters
Table 49.1-1 "Interface Alarm Status Command" Resource Parameters
Resource Identifier
(interface-type)

Type

Description

<Itf::AlarmItfType>

type of the interface

Command Output
Table 49.1-2 "Interface Alarm Status Command" Display parameters
Specific Information
name
default-severity

656

Type

Description

<Itf::asamIfExtAlmReportingSeverityDefault>
The default minimal severity for an alarm to be
Possible values are :
reported that will be used for interfaces.
- indeterminate : not a definite known This element is always shown.
severity
- warning : just to inform as a warning
- minor : not service affecting
- major : service affecting
- critical : service breaking

Released

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

49.2 Physical Interface Status Command


Command Description
This command shows the summary of the physical interface, for example, the number of changes which occurred,
bitmap for the operational-status, and the bitmap for the presence of the physical interface.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface phy-itf-status (shelf)

Command Parameters
Table 49.2-1 "Physical Interface Status Command" Resource Parameters
Resource Identifier
(shelf)

Type
<Eqpt::Rack> / <Eqpt::Shelf>
<Eqpt::Rack>=
range:
<Eqpt::Shelf>= range: [1...1]

Description
the physical position of the shelf
[1...1]/

Command Output
Table 49.2-2 "Physical Interface Status Command" Display parameters
Specific Information
name

Type

Description

no-of-change-occur

<Counter>

opr-status-bitmap

<PrintableString>

bitmap-phy-itf

<PrintableString>

Number of state changes of physical lines,


equipped on boards within this shelf.
This element is always shown.
Operational status of the physical interfaces of
boards which can be equipped within this shelf.
This element is always shown.
Specifies the presence of the physical interfaces of
boards which can be equipped within this shelf.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

657

49 Interface Status Commands

49.3 Interface Status Command


Command Description
This command shows all the parameters related to the interface such as the type of interface, current bandwidth of
the interface, maximum size of the packet supported, and the connector present.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface port (port)

Command Parameters
Table 49.3-1 "Interface Status Command" Resource Parameters
Resource Identifier
(port)

658

Type

Description

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface index


<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVci>
:
<PPPoE::LogicalSesId> | atm-bonding :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | bridge-port :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /

Released

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

Resource Identifier

Type
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::NtSlot> : <Ip::LogicalId>
sw-loopback
:
<Eqpt::Rack>
<Eqpt::Shelf> / <Eqpt::NtSlot>

Description
:
/
|
/

Command Output
Table 49.3-2 "Interface Status Command" Display parameters
Specific Information
name

Type

Description

if-index

<SignedInteger>

info

<PrintableString>

type

specifies a unique value for each interface.


This element is only shown in detail mode.
A textual string containing information about the
interface. This string include the name of the
manufacturer, the product name and the version of
the interface hardware/software.
This element is only shown in detail mode.
Specifies the type of interface.
This element is only shown in detail mode.

<Itf::IANAifType>
Possible values are :
- ethernet : ethernet csmacd
- sw-loopback : software loopback
interface
- slip : generic SLIP interface
- atm : atm interface
- atm-bonding : atm bonding
- xdsl-line : xdsl line
- xdsl-channel : xdsl channel
- atm-vci-ep : ATM VCI end point
- bridge-port : transparent bridge interface
- pppoe : pppoe interface
- pppoe-session : pppoe session
- l2-vlan : layer 3 VLAN using IPX
- ip-fwd : IP forwarding interface
<Itf::packetSize>
The size of the largest packet which can be
unit: octets
sent/received on the interface, specified in octets.
For interfaces that are used for transmitting
network datagrams, this is the size of the largest
network datagram that can be sent on the interface.
This element is only shown in detail mode.
<Itf::bandWidth>
Specifies the interface's current bandwidth.
unit: bits/sec
This element is only shown in detail mode.
<Vlan::MacAddr>
interface's address at its protocol sub-layer.
length: 6
This element is only shown in detail mode.
<Itf::ifAdminStatus>
Specifies state of the interface.
Possible values are :
This element is always shown.
- not-applicable : not-applicable
- admin-up : admin status is up
- admin-down : admin status is down
- testing : no operational packets can be
passed
<Itf::ifOperStatus>
The current operational state of the interface.
Possible values are :
This element is always shown.
- up : permanent virtual circuit
- down : bridge port
- testing : l2 VLAN

largest-pkt-size

current-bandwidth
phy-addr
admin-status

opr-status

3HH-01016-AAAA-TCZZA Edition 03

Released

659

49 Interface Status Commands

name

Description

last-chg-opr-stat

- unknown : IPoE
- dormant : PPPoE
<Itf::ElapsedTime10Msec>

in-octets

<Counter>

in-ucast-pkts

<Counter>

in-discard-pkts

<Counter>

in-err-pkts

<Counter>

pkts-unknown-proto

<Counter>

out-octets

<Counter>

out-err-pkts

<Counter>

name

<PrintableString>

high-speed

<Itf::highBandWidth>
unit: Mbit/sec
<Itf::ifConnectorPresent>
Possible values are :
- not-applicable : not-applicable
- has-connector : interface sublayer has a
physical connector
- no-connector : interface sublayer doesn't
have a physical connector
<Object>
Specifies information about the particular media
being used to realize the interface.
This element is only shown in detail mode.

connector-present

media

660

Type

Released

The value of system up time at the time the


interface entered its current operational state. If the
current state was entered prior to the last
re-initialization of the local network management
subsystem, then this contains a zero value.
This element is only shown in detail mode.
The total number of octets received on the
interface, including framing characters.
This element is only shown in detail mode.
The number of packets, delivered by this sub-layer
to a higher (sub-)layer, which were not addressed to
a multicast or broadcast address at this sub-layer.
This element is only shown in detail mode.
The number of inbound packets which were chosen
to be discarded even though no errors had been
detected to prevent their being deliverable to a
higher-layer protocol. One possible reason for
discarding such a packet could be to free up buffer
space.
This element is only shown in detail mode.
Number of inbound packets(for packet-oriented
interfaces)
or
transmission
units(for
character-oriented interfaces) that contained errors
preventing them from being deliverable to a
higher-layer protocol.
This element is only shown in detail mode.
Number of packets(for packet-oriented interfaces)
or transmission units(for character-oriented
interfaces) received via the interface which were
discarded because of an unknown or unsupported
protocol.
This element is only shown in detail mode.
The total number of octets transmitted out of the
interface, including framing characters.
This element is only shown in detail mode.
The
number
of
outbound
packets(for
packet-oriented interfaces) or transmission units(for
character-oriented interfaces) that could not be
transmitted because of errors.
This element is only shown in detail mode.
Name of the interface.
This element is only shown in detail mode.
Specifies interface's current bandwidth.
This element is only shown in detail mode.
Specifies the interface sublayer has a physical
connector or not.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

49.4 Interface Test Status Command


Command Description
This command shows the parameters related to the testing of an interface.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface test (port)

Command Parameters
Table 49.4-1 "Interface Test Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / index (1/1/3/0..) of rack/shelf/slot/port


<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVci>
:
<PPPoE::LogicalSesId> | atm-bonding :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | bridge-port :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :

3HH-01016-AAAA-TCZZA Edition 03

Released

661

49 Interface Status Commands

Resource Identifier

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::NtSlot> : <Ip::LogicalId>
sw-loopback
:
<Eqpt::Rack>
<Eqpt::Shelf> / <Eqpt::NtSlot>

Description
/
|
/

Command Output
Table 49.4-2 "Interface Test Status Command" Display parameters
Specific Information
name
id
result

code

662

Type

Description

<TestAndIncr>
range: [0...2147483647]

Specifies the current invocation of the interface's


test.
This element is always shown.
<Itf::ifTestResult>
Specifies the result of the most recently requested
Possible values are :
test
- none : no tests have been requested since This element is always shown.
the last reset
- success : test successfully completed
- in-progress : test is still in progress
- not-supported : test is not supported
- unable-to-run : test is unable to run
- aborted : test is aborted
- failed : test is failed
<Object>
Specifies a code which contains more specific
information on the test result
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

49.5 Interface Stack Status Command


Command Description
This command shows the status of the stack.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface stack (higher) lower xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> | slip : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> |
ethernet : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> : <Itf::EthernetId> |
pppoeses : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::DefaultVpi> : <Atm::DefaultVci> : <PPPoE::LogicalSesId> | no-interface |
ip-gateway : <Vrf::VrfIndex> | atm-bonding : <Eqpt::Rack> / <Eqpt::LtSlot> /
<Eqpt::Port> | xdsl-channel : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> /
<Eqpt::Port> | atm-if : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> |
atm-pvc : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> :
<Atm::DefaultVpi> : <Atm::DefaultVci> | bridge-port : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> | pppoe :
<Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> :
<Vlan::VlanIndex> | ip : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot> :
<Ip::LogicalId> | sw-loopback : <Eqpt::Rack> / <Eqpt::Shelf> / <Eqpt::NtSlot>

Command Parameters
Table 49.5-1 "Interface Stack Status Command" Resource Parameters
Resource Identifier
(higher)

Type

Description

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / a higher layer interface index


<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId> | no-interface |
ip-gateway
:
<Vrf::VrfIndex>
|
atm-bonding
:
<Eqpt::Rack>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | bridge-port :

3HH-01016-AAAA-TCZZA Edition 03

Released

663

49 Interface Status Commands

Resource Identifier

lower

664

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback
:
<Eqpt::Rack>
/
<Eqpt::Shelf> / <Eqpt::NtSlot>
xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / a lower layer interface index
<Eqpt::LtSlot> / <Eqpt::Port> | slip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> :
<PPPoE::LogicalSesId> | no-interface |
ip-gateway
:
<Vrf::VrfIndex>
|
atm-bonding
:
<Eqpt::Rack>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-if : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | bridge-port :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback
:
<Eqpt::Rack>
/
<Eqpt::Shelf> / <Eqpt::NtSlot>

Released

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

49.6 SHub Interface Status Command


Command Description
This command shows the current operational state of an interface.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub vlan (vlan-id)

Command Parameters
Table 49.6-1 "SHub Interface Status Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanIndex>
range: [1...4093]

vlan id

Command Output
Table 49.6-2 "SHub Interface Status Command" Display parameters
Specific Information
name
admin-status

oper-status

port

Type

Description

<Shub::AdminStatus>
Possible values are :
- up : up
- down : down
- testing : testing
- auto-up : autoup
<Shub::OperStatus>
Possible values are :
- up : ready to pass packets
- down : down
- testing : in some test mode
- unknown : status can not be determined
forsome reason
- dormant : dormant
- not-present : some component is missing
- lower-layer-down : down due to state of
lower-layer interface
<Itf::ShubInterfaceIndex>
range: [25...278,280]

The administrative state of the vlan interface.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

The current operational state of the vlan interface.


This element is always shown.

the local port.


This element is only shown in detail mode.

Released

665

49 Interface Status Commands

49.7 SHub Interface Port Control Status Command


Command Description
This node shows the port control status.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show interface shub port (port)

Command Parameters
Table 49.7-1 "SHub Interface Port Control Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

control index of the port

Command Output
Table 49.7-2 "SHub Interface Port Control Status Command" Display parameters
Specific Information
name
admin-status

oper-status

speed

type

666

Type

Description

<Shub::AdminStatus>
Possible values are :
- up : up
- down : down
- testing : testing
- auto-up : autoup
<Shub::AdminStatus>
Possible values are :
- up : up
- down : down
- testing : testing
- auto-up : autoup
<Sys::Speed>
Possible values are :
- ten-mbps : speed of 10MBPS
- hundred-mbps : speed of 100MBPS
- one-gb : speed of 1GB
<Sys::Type>
Possible values are :
- user : port to a directly connected user

Specifies the administrative status of the interface


This element is always shown.

Released

Specifies the operational status of the interface


This element is always shown.

Specifies the interface speed.


This element is always shown.

Specifies the type of port.


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

name

duplex

mode

max-mac-addr
mc-flood-mode

Type
- subtending : port to a subtended ISAM
- network : port to the service provider
(ISP)
- data : port used internally for data traffic
- control : port used internally for control
traffic
- unused : port is not in use
- outband-mngt : port is used for
outband-management
<Sys::Duplex>
Possible values are :
- unknown-trsf-mode : transfer mode
unknown
- full : data transfer in full duplex
- half : data transfer in half duplex
automatic | [10mbps | 100mbps | 1gbps] :
full | half
Possible values are :
- automatic : determine the parameters of
interface automatically
- 10mbps : mode of interface is 10Mbps
- 100mbps : mode of interface is 100Mbps
- 1gbps : mode of interface is 1Gbps
- full : data transfer in full duplex
- half : data transfer in half duplex
<SignedInteger>

Description

Specifies whether interface data transfer mode is


full-duplex or half-duplex.
This element is always shown.

Speficies the mode in which the speed, duplex


modes and flow control of the interface is
determined.
This element is only shown in detail mode.

Specifies the maximum number of new MAC


addresses that can be learnt over the interface.
This element is only shown in detail mode.
<Sys::FloodMode>
Specifies the multicast flooding mode of the port is
Possible values are :
enabled or not.
- unknown-flooding : mc flooding state This element is only shown in detail mode.
unknown
- mc-flooding : enable multicast flooding
- no-mc-flooding : disable multicast
flooding

3HH-01016-AAAA-TCZZA Edition 03

Released

667

49 Interface Status Commands

49.8 SHub Interface Uplink Group Status Command


Command Description
This node allows the user to view the current state of an interface

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface shub group (group-id)

Command Parameters
Table 49.8-1 "SHub Interface Uplink Group Status Command" Resource Parameters
Resource Identifier
(group-id)

Type

Description

<Itf::GroupId>
range: [1...7]

groupid number

Command Output
Table 49.8-2 "SHub Interface Uplink Group Status Command" Display parameters
Specific Information
name
group-status

threshold
up-links
port-list

668

Type

Description

<Itf::GroupStatus>
Possible values are :
- up : uplink group status up
- down : uplink group status down
- invalid : uplink group status invalid
<Itf::Threshold>
range: [0...7]
<SignedInteger>

the current uplink group status


This element is always shown.

<Shub::PortList>
length: 3

Released

the min nbr of links to be operational UP in grp


This element is always shown.
available number of links in the group
This element is always shown.
The set of ports members of the uplink group
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

49 Interface Status Commands

49.9 Interface Extensive Status Command


Command Description
This command shows the parameters related to an interface such as next avalable port type, counter indicating
number of state changes, and number of network interfaces.

User Level
The command can be accessed by operators with equipment privileges.

Command Syntax
The command has the following syntax:
> show interface availability (port-type)

Command Parameters
Table 49.9-1 "Interface Extensive Status Command" Resource Parameters
Resource Identifier
(port-type)

Type

Description

<Itf::AvailablePortType>

the port type

Command Output
Table 49.9-2 "Interface Extensive Status Command" Display parameters
Common Information
name
Type

Description

change-count

<Counter>

interface-cnt

<SignedInteger>

Number of state changes of the physical line.


This element is always shown.
The number of network interfaces (regardless of
their current state) present on this system.
This element is always shown.

Type

Description

Specific Information
name
next-available

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / Specifies the next available physical interface can
<Eqpt::LtSlot> / <Eqpt::Port> | none
be retrieved.
This element is always shown.

Only Show Details: common


name
Type
change-count

<Counter>

interface-cnt

<SignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

Description
Number of state changes of the physical line.
This element is always shown.
The number of network interfaces (regardless of
their current state) present on this system.
This element is always shown.

Released

669

50- SNTP Status Commands

50.1 SNTP Status Command

670

Released

50-671

3HH-01016-AAAA-TCZZA

Edition 03

50 SNTP Status Commands

50.1 SNTP Status Command


Command Description
This node displays the information about the SNTP and its related parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show sntp

Command Output
Table 50.1-2 "SNTP Status Command" Display parameters
Specific Information
name

Type

Description
specifies the operating mode for the SNTP
application at the SNMP agent.
This element is always shown.

system-time

<Sys::SNTPOperatingMode>
Possible values are :
- unicast : operating mode unicast value 1
- anycast : operating mode anycast value 2
- multicast : operating mode multicast
value 3
<Sys::Time>

shub-time

<Sys::Time>

operating-mode

3HH-01016-AAAA-TCZZA Edition 03

specifies the network time.


This element is always shown.
specifies shub network time.
This element is always shown.

Released

671

51- System Status Commands

51.1 SHub System IP Status Command


51.2 SHub System Version Status Command
51.3 SHub System HTTP Status Command
51.4 SHub System Common Status Command
51.5 SHub System Control Status Command
51.6 SHub IP Filter Status Command
51.7 SHub System Manager Status Command
51.8 System Statistics
51.9 System Licenses Status Command

672

Released

51-673
51-674
51-675
51-676
51-677
51-678
51-681
51-682
51-683

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

51.1 SHub System IP Status Command


Command Description
This node shows the SHub IP parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry ip

Command Output
Table 51.1-2 "SHub System IP Status Command" Display parameters
Specific Information
name

Type

Description
Specifies the mode by which the default interface
in the device gets the IP address.
This element is always shown.

def-ip-addr

<Sys::DefIpAddr>
Possible values are :
- manual : ip address got from the system
- dynamic : ip address got through
dynamic IP address
<Ip::V4Address>

eff-ip-addr

<Ip::V4Address>

subnet-mask

<Ip::V4Address>

def-gateway

<Ip::V4Address>

ip-addr-cfg-mode

3HH-01016-AAAA-TCZZA Edition 03

Specifies default IP Address of the system. and if


modified, will take effect only when the
configuration is stored and restored.
This element is always shown.
Specifies Effective IP address of the switch to be
used for contacting through SNMP interface or web
interface.
This element is always shown.
Specifies IP subnet mask for the default IP address
and if modified, will take effect only when the
configuration is stored and restored.
This element is always shown.
Specifies default IP Address of the system and if
modified, will take effect only when the
configuration is stored and restored.
This element is always shown.

Released

673

51 System Status Commands

51.2 SHub System Version Status Command


Command Description
This node shows the version of the SHub system parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry version

Command Output
Table 51.2-2 "SHub System Version Status Command" Display parameters
Specific Information
name
sw-ver-name
sw-release-num
hw-ver
fw-ver

674

Type

Description

<Sys::FileName>
length: 1<=x<256
<Sys::ReleaseNum>
length: 1<=x<7
<Sys::DisplayString>
length: 1<=x<15
<Sys::DisplayString>
length: 1<=x<15

Specifies the name of the shub software release.


This element is always shown.
Specifies the software version number.
This element is always shown.
Specifies version number of the hardware.
This element is always shown.
Specifies version number of the firmware.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

51.3 SHub System HTTP Status Command


Command Description
This node shows the last changed time of the status of the SHub HTTP access.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry status

Command Output
Table 51.3-2 "SHub System HTTP Status Command" Display parameters
Specific Information
name
last-chg-status

http-status

Type

Description

<PrintableString>

Specifies whether last configuration change has


been saved in flash/remote and current status of
restore.
This element is always shown.
<Sys::HttpStatus>
Specifies whether http access for the users is
Possible values are :
enabled or disabled.
- http-access : enable http access for the This element is always shown.
users
- no-http-access : disable http access for
the users

3HH-01016-AAAA-TCZZA Edition 03

Released

675

51 System Status Commands

51.4 SHub System Common Status Command


Command Description
This node shows the common system parameters of the SHub.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub entry misc

Command Output
Table 51.4-2 "SHub System Common Status Command" Display parameters
Specific Information
name

676

Type

Description

def-intf

<Sys::DefInterface>
length: 1<=x<16

base-bdg-addr

<Vlan::MacAddr>
length: 6

sys-mac-addr

<Vlan::MacAddr>
length: 6

Name of the default interface that can be used for


communicating with the system for configuration
through SNMP.
This element is always shown.
Specifies the MAC address used by the bridge
when it must be referred to in a unique fashion.
This element is always shown.
Specifies the system MAC address used by this
bridge when it must be referred to in a unique
fashion.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

51.5 SHub System Control Status Command


Command Description
This node displays the system control parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub config-control (ctrl-index)

Command Parameters
Table 51.5-1 "SHub System Control Status Command" Resource Parameters
Resource Identifier
(ctrl-index)

Type

Description

<Shub::NetworkPort>
range: [1...7]

control index of the config

Command Output
Table 51.5-2 "SHub System Control Status Command" Display parameters
Specific Information
name
egress

collection

ctrl-status

Type

Description

<Sys::EgressStatus>
Specifies the transmission of egress traffic over this
Possible values are :
interface is enabled or not.
- egress-enabled : enable this status
This element is always shown.
- egress-disabled : disable this status
<Sys::CollectionStatus>
Specifies the statistics collection for this interface is
Possible values are :
enabled or not.
- collection : enable the collection of This element is always shown.
statistics
- no-collection : disable the collection of
statistics
<Sys::ConfigCtrlStatus>
Specifies the config control status.
Possible values are :
This element is always shown.
- enable : makes the entry valid
- disable : makes the entry invalid

3HH-01016-AAAA-TCZZA Edition 03

Released

677

51 System Status Commands

51.6 SHub IP Filter Status Command


Command Description
This node displays IP filter related information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub filters ip (index-num)

Command Parameters
Table 51.6-1 "SHub IP Filter Status Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L3 Filter rule number

Command Output
Table 51.6-2 "SHub IP Filter Status Command" Display parameters
Specific Information
name
protocol

msg-type

678

Type

Description

<Sys::Protocol>
Possible values are :
- icmp : check the packet for icmp
- igmp : check the packet for igmp
- ggp : check the packet for ggp
- ip : check the packet for ip
- tcp : check the packet for tcp
- egp : check the packet for egp
- igp : check the packet for igp
- nvp : check the packet for nvp
- udp : check the packet for udp
- irtp : check the packet for irtp
- idrp : check the packet for idrp
- rsvp : check the packet for rsvp
- msrp : check the packet for msrp
- igrp : check the packet for igrp
- ospf : check the packet for ospf
- any : check the all packets
<Sys::MsgType>
Possible values are :

Specifies the type of protocol to be checked against


the packet.
This element is always shown.

Released

Specifies the message type to be checked against


the packet. If the message type matches with the

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

name

Type

Description
packet, then the packet will be dropped / allowed
based on the action set.
This element is always shown.

dst-ip-addr

- echo-reply :
- dest-unreach :
- src-quench :
- redirect :
- echo-request :
- time-exceeded :
- param-prob :
- time-stamp-req :
- time-stamp-reply :
- infor-req :
- infor-reply :
- addr-mask-req :
- addr-mask-reply :
- no-icmp-type :
<Sys::MsgCode>
Possible values are :
- network-unreach :
- host-unreach :
- protocol-unreach :
- port-unreach :
- fragment-need :
- src-route-fail :
- dest-nwk-unknown :
- dest-host-unknown :
- src-host-isolated :
- dest-nwk-prohibit :
- dest-host-prohibit :
- nwk-unreach-tos :
- host-unreach-tos :
- no-icmp-code :
<Ip::V4Address>

src-ip-addr

<Ip::V4Address>

dst-mask

<Ip::V4Address>

src-mask

<Ip::V4Address>

min-dst-port

<SignedInteger>

max-dst-port

<SignedInteger>

min-src-port

<SignedInteger>

max-src-port

<SignedInteger>

in-port-list

<Shub::PortList>
length: 3

msg-code

3HH-01016-AAAA-TCZZA Edition 03

Specifies the message code to be checked against


the packet. If the packet matches with the message
code, then the packet will be dropped / allowed
based on the action set
This element is always shown.

Specifies the destination IP address to be matched


with the packet.
This element is always shown.
Specifies the source IP address to be matched with
the packet.
This element is always shown.
Specifies the IP subnet mask for Destination IP
address.
This element is always shown.
Specifies the IP subnet mask for Source IP address.
This element is always shown.
Specifies the minimum port in the destination
TCP/UDP port range.
This element is always shown.
Specifies the maximum port in the destination
TCP/UDP port range.
This element is always shown.
Specifies the minimum port in the source
TCP/UDP port range.
This element is always shown.
Specifies the maximum port in the source
TCP/UDP port range.
This element is always shown.
Specifies the complete set of ports over which if the
packet arrives the filter rule will be applicable. If
the incoming port list is '0', the filter rule is
applicable for all the incoming ports.

Released

679

51 System Status Commands

name
out-port-list

<Shub::PortList>
length: 3

ack-bit

<Sys::AckBit>
Possible values are :
- establish : establish the bit
- not-establish : not establish the bit
- any : default value
<Sys::RstBit>
Possible values are :
- set : set the bit
- not-set : not set the bit
- any : default value
<Sys::Tos>
Possible values are :
- any : any
- high-reliable : high reliable
- high-throughput : high through put
- high-relia-thro : high reliable and
through put
- low-delay : low delay
- low-delay-high-relai : low delay and high
reliability
- low-delay-high-thro : low delay and high
through put
- best-tos : low delay, high reliability and
through put
<Sys::Direction>
Possible values are :
- in : incoming packets
- out : outgoing packets
<Sys::L3Action>
Possible values are :
- action-allow : the packet will be
forwarded
- action-drop : the packet will be discarded
<Counter>

rst-bit

tos

direction

action

match-cnt

680

Type

Released

Description
This element is always shown.
Specifies the complete set of ports over which the
packet will be sent.
This element is always shown.
Specifies whether TCP ACK bit to be checked or
not against the packet.
This element is always shown.
Specifies whether TCP RST bit to be checked or
not against the packet.
This element is always shown.
Specifies whether IP TOS bit to be checked or not
against the packet.
This element is always shown.

Specifies in which direction the Filters are to be


applied on the packets, either to incoming or
outgoing packets.
This element is always shown.
Specifies the action to be taken on the packet if the
filter rule matches.
This element is always shown.
Specifies the number of times this filter is matched.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

51.7 SHub System Manager Status Command


Command Description
This node displays the manager parameters.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system shub filters shub-manager (index)

Command Parameters
Table 51.7-1 "SHub System Manager Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Sys::SrcIpIndex>
range: [1...100]

index number of the SrcIp

Command Output
Table 51.7-2 "SHub System Manager Status Command" Display parameters
Specific Information
name
src-ip-addr

Type

Description

<Ip::V4Address>

Specifies the management vlan filter IP address to


be matched with the packet.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

681

51 System Status Commands

51.8 System Statistics


Command Description
This command shows the status of the list commands.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system entry

Command Output
Table 51.8-2 "System Statistics" Display parameters
Specific Information
name

Type

Description

status-bit-map

<Sys::AsamSysStatusBitMap>

mib-version

<Sys::asamMibVersion>
length: x<21
<Sys::AsamSystemInitProgress>
range: [0...100] unit: percent

Specifies the status bitmap.


This element is always shown.
Specifies the version of the management interface.
This element is always shown.
Specifies the progress of the system initialization
indicated as a percentage.
This element is always shown.

init-progress

682

Released

3HH-01016-AAAA-TCZZA

Edition 03

51 System Status Commands

51.9 System Licenses Status Command


Command Description
The counter depicts the number of software licenses for the features.
For ADSL2+, the counter indicates the number of XDSL lines for which an ADSL2+ operational mode (POTS
and/or ISDN) is enabled in its onfiguration and supported by the LT board and for which the XDSL board is
equipped.
READSL2 operational mode (US mode 1 and/or US mode2) is enabled in its configuration and supported by the LT
board and for which the XDSL board is equipped.
For IGMP, the counter indicates the number of PVCs for which an IGMP control channel has been configured.
For IP-Forwarding, the counter indicates the number of PVCs configured
For PPPoX Relay, the counter indicates the number of PVCs configured
For PPPoX Termination, the counter indicates the number of PVCs for which PPPoE termination or PPPoA
termination has been configured.
For 802.1x, the counter indicates the number of PVCs for which 802.1x has been configured as 'enabled'

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show system license (feature)

Command Parameters
Table 51.9-1 "System Licenses Status Command" Resource Parameters
Resource Identifier
(feature)

Type

Description

<Sys::LicenseFeatureIndex>
table index
Possible values are :
- adsl2-plus : number of xdsl lines for
which ADSL2 is enabled
- readsl2 : number of xdsl lines for which
READSL2 is enabled
- igmp : number of DSL subscribers
configured for IGMP
- ip-forward : number of DSL subscribers
configured for Ip-forwarding
- pppox-relay : number of DSL subscribers
configured for PPPOX relay
- pppox-termination : number of DSL
subscribers configured for PPPOX
termination

3HH-01016-AAAA-TCZZA Edition 03

Released

683

51 System Status Commands

Resource Identifier

Type

Description

- 802dot1x : number of DSL subscribers


configured for 802.1x
- annex-m : number of DSL subscribers
configured for annex-m

Command Output
Table 51.9-2 "System Licenses Status Command" Display parameters
Common Information
name
Type
routing-licence

Specific Information
name
number-license

shows the status of the routing license.


This element is always shown.

Type

Description

<SignedInteger>

Specifies number of license.


This element is always shown.

Only Show Details: routing-licence


name
Type
routing-licence

684

Description

<Sys::RoutingLicStatus>
Possible values are :
- not-active : routing license unavailable
- active : routing license available

<Sys::RoutingLicStatus>
Possible values are :
- not-active : routing license unavailable
- active : routing license available

Released

Description
shows the status of the routing license.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

52- Transaction Status Commands

52.1 Transaction Log Status Command


52.2 Transaction Log Entry Status Command

3HH-01016-AAAA-TCZZA Edition 03

52-686
52-687

Released

685

52 Transaction Status Commands

52.1 Transaction Log Status Command


Command Description
This command displays the transaction set log parameters.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show transaction set-log-table (log-table-index)

Command Parameters
Table 52.1-1 "Transaction Log Status Command" Resource Parameters
Resource Identifier
(log-table-index)

Type

Description

<SignedInteger>

the key in the set Log table

Command Output
Table 52.1-2 "Transaction Log Status Command" Display parameters
Specific Information
name

686

Type

Description

log-ipaddr

<Ip::V4Address>

changed-object-id

<Object>

IP address of the Manager who changed this object


This element is always shown.
the Object Identifier of an object which has been
changed.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

52 Transaction Status Commands

52.2 Transaction Log Entry Status Command


Command Description
This command shows the transaction log entry-related parameters.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show transaction log-entry

Command Output
Table 52.2-2 "Transaction Log Entry Status Command" Display parameters
Specific Information
name

Type

Description

set-log-lastentry

<SignedInteger>

set-log-resettime

set-log-buffersize

<Sys::Time>
unit: UTC
<Trans::overflowed>
Possible values are :
- not-overflowed : log buffer
overflowed is 1
- overflowed : log buffer overflowed is 2
<SignedInteger>

nbr-of-sets

<SignedInteger>

set-log-overflowed

3HH-01016-AAAA-TCZZA Edition 03

index of the last entry that has been added to the set
log table.
This element is always shown.
time when set log has been reset
This element is always shown.
specifies whether the set log buffer is overflowed
or not.
not This element is always shown.
the size of the internal set log buffer.
This element is always shown.
nbr of successfull sets since systme is up.
This element is always shown.

Released

687

53- Error Status Command

53.1 Error Log Status Command

688

Released

53-689

3HH-01016-AAAA-TCZZA

Edition 03

53 Error Status Command

53.1 Error Log Status Command


Command Description
This command displays the error log status.

User Level
The command can be accessed by operators with alarm privileges.

Command Syntax
The command has the following syntax:
> show error (id)

Command Parameters
Table 53.1-1 "Error Log Status Command" Resource Parameters
Resource Identifier
(id)

Type

Description

<SignedInteger>

error number

Command Output
Table 53.1-2 "Error Log Status Command" Display parameters
Common Information
name
Type
last-entry

<Error::ErrLogLastEntry>

reset-time

<Sys::Time>
unit: UTC
<SignedInteger>

buffer-size
overflowed

Specific Information
name
timestamp
originator
description
info

<Error::LogOverFlow>
Possible values are :
- no : when log buffer is reset
- yes : full action set to warp around

Description
index of the last entry that is added to the error log
table.
This element is always shown.
time value when the error log is resetted
This element is always shown.
size of the internal log buffer.
This element is always shown.
specifies whether log buffer is overflowed or not.
This element is always shown.

Type

Description

<Sys::Time>
unit: UTC
<SignedInteger> @ <Ip::V4Address>

network time when the error is generated.


This element is always shown.
request-id and IP address that generated the error
This element is only shown in detail mode.
description of the error.
This element is always shown.
additional information to guide to correct the error
This element is only shown in detail mode.

<Description-127>
length: x<127
<PrintableString>

3HH-01016-AAAA-TCZZA Edition 03

Released

689

53 Error Status Command

name

Type

Description

obj-id

<Alarm::MibName>

obj-value

<PrintableString>

object identifier in the request that caused the error.


This element is always shown.
value received from the manager for the object that
generated the error.
This element is only shown in detail mode.

Only Show Details: error-log related information


name
Type
last-entry

<Error::ErrLogLastEntry>

reset-time

<Sys::Time>
unit: UTC
<SignedInteger>

buffer-size
overflowed

690

<Error::LogOverFlow>
Possible values are :
- no : when log buffer is reset
- yes : full action set to warp around

Released

Description
index of the last entry that is added to the error log
table.
This element is always shown.
time value when the error log is resetted
This element is always shown.
size of the internal log buffer.
This element is always shown.
specifies whether log buffer is overflowed or not.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

54- Software Status Commands

54.1 Database Status Command


54.2 Disk Status Command
54.3 Overall Software Package Status Command
54.4 Software Package Status Command
54.5 File Status Command
54.6 Upload/Download Status Command
54.7 SHub Software Management Status Command
54.8 SHub Configuration File Status Command
54.9 Status of the SHub Boot ROM update

3HH-01016-AAAA-TCZZA Edition 03

54-692
54-693
54-694
54-696
54-697
54-699
54-701
54-702
54-703

Released

691

54 Software Status Commands

54.1 Database Status Command


Command Description
This commands displays the various database parameters.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt database (db-container) oswp-number <SwMngt::DbmOswpIndex>

Command Parameters
Table 54.1-1 "Database Status Command" Resource Parameters
Resource Identifier
(db-container)

oswp-number

Type

Description

<SwMngt::dbmDatabaseIndex>
Possible values are :
- first : first container
- second : second container
- third : third container
<SwMngt::DbmOswpIndex>
range: [1...2]

the database container ID

index in the database table

Command Output
Table 54.1-2 "Database Status Command" Display parameters
Specific Information
name

Type

Description

name

<PrintableString-0-32>
length: x<32

oper-status

<SwMngt::dBaseOperStatus>
Possible values are :
- actual : actual oper status
- preferable : preferable oper status
- previous : previous oper status
- failed : failed oper status
- not-useful : not useful oper status
<PrintableString-0-32>
length: x<32

A string representing the database. The value


'NO-NAME' will be used by the system for the
default databases.
This element is always shown.
The operational status of the database.
This element is always shown.

version

692

Released

The version of the database.


This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

54.2 Disk Status Command


Command Description
This command displays the values of the various attributes of the SWM disk file.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt descriptor-files (index)

Command Parameters
Table 54.2-1 "Disk Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<SwMngt::oswpName>
range: [a-zA-Z0-9-_.-/]

index to the swm disk file table

Command Output
Table 54.2-2 "Disk Status Command" Display parameters
Specific Information
name
type

file-size

Type

Description

<SwMngt::diskFileType>
Possible values are :
- overall-descriptor : over all descriptor
file
- descriptor : descriptor file
- file-type-a : file type a
- file-type-b : file type b
- not-specified : file type not specified
<SwMngt::DiskFileSize>
unit: bytes

Specifies the type of the file.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Specifies the size of the file.


This element is always shown.

Released

693

54 Software Status Commands

54.3 Overall Software Package Status Command


Command Description
This command displays various OSWP states and attributes.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt oswp (index)

Command Parameters
Table 54.3-1 "Overall Software Package Status Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<SwMngt::swmOswpIdx>
range: [1...2]

index to the swm oswp table

Command Output
Table 54.3-2 "Overall Software Package Status Command" Display parameters
Specific Information
name

Type

Description

name

<PrintableString-0-32>
length: x<32

availability

<SwMngt::operAvailStatus>
Possible values are :
- empty : no OSWP is related to
asamSwmOswpIndex
- enabled : related OSWP is active
- disabled : download of related OSWP
failed
- downloading : download of related
OSWP is ongoing
- aborting : not related to OSWP files are
removed
<SwMngt::operActStatus>
Possible values are :
- active : related OSWP is active
- not-active : related OSWP is not active
<SwMngt::operCommitStatus>

Name of the OSWP. The name of an OSWP


corresponds
to
the
path
name:
/path_to_OSWP/file_name.
This element is always shown.
Specifies the availability status of the OSWP.
This element is always shown.

act-status

commit-status

694

Released

Specifies the related OSWP is currently active or


not.
This element is always shown.
Specifies the OSWP is committed or uncommitted

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

name

download-error

err-file-name
err-file-server

Type

Description

Possible values are :


- committed : Committed
- un-committed : Un committed
- committing : OSWP is committing
<SwMngt::oswpDldErr>
Possible values are :
- not-defined : not defined
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation : illegal TFTP
operation
- unknown-transfer-id : transfer id is
unknown
- file-exists : file is already existing
- no-such-user : no such user
- syntax-error : Syntax error
- lack-of-storage : Lack of storage
resource
- system-restart : system restart
- no-error : no error in download
<PrintableString-0-32>
length: x<32
<Ip::V4Address>

or whether the commit-operation is still ongoing.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Specifies for what reason the download of the


OSWP failed for the requested set of files.
This element is only shown in detail mode.

The name of the file that caused the error.


This element is only shown in detail mode.
Specifies the IP address of the file server where the
file can be found.
This element is only shown in detail mode.

Released

695

54 Software Status Commands

54.4 Software Package Status Command


Command Description
This command shows the parameters of the dynamic SWP table which represent the SWPs that belong to at least
one of the OSWPs available in the system.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt swp (name)

Command Parameters
Table 54.4-1 "Software Package Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<PrintableString-0-32>
length: x<32

index to the swm-swp table

Command Output
Table 54.4-2 "Software Package Status Command" Display parameters
Specific Information
name
type

dbase-ver-no

696

Type

Description

<SwMngt::swmSwpType>
Possible values are :
- asam-core : asam core
- vdsl-gateway : vdsl gateway
- ip-server : ip server
<PrintableString-0-32>
length: x<32

Specifies the type of the software package.


This element is always shown.

primary-file-id

<Ip::V4Address>

secondary-file-id

<Ip::V4Address>

Released

Specifies the version number of the database that is


compatible with the software package.
This element is always shown.
Specifies the IP address of the TFTP server where
the software package can be found.
This element is always shown.
Specifies the IP address of a possible second TFTP
server where the software package can be found.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

54.5 File Status Command


Command Description
This command displays information about the relationships between the files known by the system and the available
OSWPs.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt swp-disk-file (name) file-name <PrintableString-0-32>
file-board-type <PrintableString-0-32>

Command Parameters
Table 54.5-1 "File Status Command" Resource Parameters
Resource Identifier
(name)
file-name
file-board-type

Type

Description

<PrintableString-0-32>
length: x<32
<PrintableString-0-32>
length: x<32
<PrintableString-0-32>
length: x<32

index to the Swm_Contains_File table


index to the Swm_Contains_File table
index to the Swm_Contains_File table

Command Output
Table 54.5-2 "File Status Command" Display parameters
Specific Information
name
file-format

available-status

file-priority

file-size

Type

Description

<SwMngt::fileFormat>
Possible values are :
- tar : file format is tar
- lz77 : file format is lz77
- ascii : file format is ascii
- exe : file format is exe
<SwMngt::availableStatus>
Possible values are :
- available : the file is avilable
- not-available : the file is not avilable
<SwMngt::filePriority>
Possible values are :
- part-min-set : part min set
- no-part-min-set : no part min set
<SwMngt::SwmFileSize>

Specifies the format of the file.


This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Specifies whether the file is available on the file


disk or not.
This element is always shown.
Specifies whether the file belongs to the minimum
set of the related OSWPs.
This element is only shown in detail mode.
Specifies the size of the file.

Released

697

54 Software Status Commands

name
file-type

file-decompression

698

Type

Description

unit: bytes
<SwMngt::SwmFileType>
Possible values are :
- file-type-a : file type A
- file-type-b : file type B
<SwMngt::swmFileDecompression>
Possible values are :
- decompressed : file is decompressed (for
ASAM R4 LSM board types)
- no-decompressed : file is not
decompressed (for ASAM R5 and ESAM
board types)

This element is only shown in detail mode.


Specifies the type of the file.
This element is only shown in detail mode.

Released

Specifies whether the file must be decompressed or


not before being sent to the applicable boards.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

54.6 Upload/Download Status Command


Command Description
This command shows the upload and download parameters.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt upload-download

Command Output
Table 54.6-2 "Upload/Download Status Command" Display parameters
Specific Information
name

Type

Description

disk-space

<SwMngt::TotalSpaceOnDisk>
unit: bytes

free-space

<SwMngt::FreeSpaceOnDisk>
unit: bytes

download-progress

The total space on the file disk that is reserved for


the storage of files.
This element is always shown.
Specifies the space on the file disk that is still
available for the storage of files.
This element is always shown.
Specifies the current status of the database
download process.
This element is always shown.

<SwMngt::downloadProgress>
Possible values are :
- download-ongoing : download ongoing
- download-success : download finished
and successfull
- download-fail : download finished but
failed
<SwMngt::downloadError>
Specifies the reason in case of a database download
Possible values are :
failure.
- not-defined : not defined
This element is always shown.
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation : illegal TFTP
operation
- unknown-transfer-id : transfer id is
unknown
- file-exists : file is already existing
- no-such-user : no such user
corrupted-database
:
corrupted/incompleted database
- system-restart : system restart
- no-error : no error in download

download-error

3HH-01016-AAAA-TCZZA Edition 03

Released

699

54 Software Status Commands

name
upload-progress

upload-error

700

Type

Description

<SwMngt::uploadProgress>
Possible values are :
- upload-ongoing : upload ongoing
- upload-success : upload finished and
successfull
- upload-fail : upload finished but failed
<SwMngt::uploadError>
Possible values are :
- not-defined : not defined
- file-not-found : file is not found
- access-violation : access violation
- diskfull-alloc-exced : disk is full
- illegal-tftp-operation : illegal TFTP
operation
- unknown-transfer-id : transfer id is
unknown
- file-exists : file is already existing
- no-such-user : no such user
- database-not-avail : selected database not
available
- system-restart : system restart
- no-error : no error in download

Specifies the current status of the database upload


process.
This element is always shown.

Released

Specifies the reason in case of a database upload


failure.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

54.7 SHub Software Management Status Command


Command Description
This command shows the status of software management on the SHub.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt shub

3HH-01016-AAAA-TCZZA Edition 03

Released

701

54 Software Status Commands

54.8 SHub Configuration File Status Command


Command Description
This command shows the status of SHub configuration files.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt shub config-file

Command Output
Table 54.8-2 "SHub Configuration File Status Command" Display parameters
Specific Information
name
db-save-status

sw-download-status

downloaded-sw
current-osp

702

Type

Description

<Sys::SaveStatus>
Possible values are :
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
<Sys::DownloadStatus>
Possible values are :
- inprogress : operation in progress
- successful : operation is successful
- failed : operation failed
<Ip::V4Address> : <Sys::FileName>

the status of the database save operation


This element is always shown.

<SwMngt::CurrOSPVersion>
Possible values are :
- config-1 : sets config1 version in BSP
- config-2 : sets config2 version in BSP
- tftp : sets tftp version in BSP

Released

the status of the software download operation


This element is always shown.

the specification of the downloaded software


package
This element is only shown in detail mode.
the current osp version
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

54 Software Status Commands

54.9 Status of the SHub Boot ROM update


Command Description
This command shows the status of SHub boot ROM update.

User Level
The command can be accessed by operators with software management privileges.

Command Syntax
The command has the following syntax:
> show software-mngt shub boot-rom-status

Command Output
Table 54.9-2 "Status of the SHub Boot ROM update" Display parameters
Specific Information
name
boot-rom-status

Type

Description

<SwMngt::ShubBootRomStatus>
the status of the boot ROM image update operation
Possible values are :
This element is always shown.
- in-progress : update operation in progress
- successful : update operation successful
- failed : update operation failed

3HH-01016-AAAA-TCZZA Edition 03

Released

703

55- IGMP Status Commands

55.1 IGMP System Status Command


55.2 IGMP Channel Sources Status Command
55.3 IGMP Channel Miscellaneous Status Command
55.4 IGMP Multicast Sources Statistics
55.5 IGMP Module Counter Status Commands
55.6 IGMP Module Time Status Command
55.7 IGMP Module Misc Status Command
55.8 SHub IGMP Vlan Router Port Status Command

704

Released

55-705
55-706
55-708
55-709
55-711
55-713
55-714
55-715

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

55.1 IGMP System Status Command


Command Description
This command shows the IGMP system-related parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp system

Command Output
Table 55.1-2 "IGMP System Status Command" Display parameters
Specific Information
name

Type

Description

startup-query-intvl

<Igmp::SystemQueryInterval>
range: [1...900] unit: sec

startup-query-count

<Igmp::SystemStartupQueryCount>
range: [1...10]

stats-intvl

<Sys::Time>

src-ipaddr

<Ip::V4Address>

The interval between general membership queries


sent on startup.
This element is always shown.
The number of queries sent out on startup separated
by the query interval.
This element is always shown.
This statistics indicates the network time of when
the system-wide statistics were last reset.
This element is always shown.
This object specifies the source IP address which is
contained in every multicast IP datagrams
transmitted on all IGMP control channels.
This element is always shown.
When the system acts as host on the network side
of the IGMP proxy, this value is the time how long
the system shall wait after hearing a Version 1
Query before it shall send any IGMPv2 messages.
This element is always shown.
The interval that must pass before the system
decides there are no more members of a group on a
network.
This element is always shown.

router-present-timeout <SignedInteger>

grp-memb-intvl

<SignedInteger>

3HH-01016-AAAA-TCZZA Edition 03

Released

705

55 IGMP Status Commands

55.2 IGMP Channel Sources Status Command


Command Description
This command shows the IGMP channel source.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp channel counter (port)

Command Parameters
Table 55.2-1 "IGMP Channel Sources Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 55.2-2 "IGMP Channel Sources Status Command" Display parameters
Specific Information
name

Type

Description

noperm-join

<Counter>

bitrate-fail

<Counter>

inval-classd

<Counter>

Indicates the number of times that a permission


bitmap failure has occurred.
This element is always shown.
Indicates the number of times that an IGMP join
message failed to trigger a multicast connection
because the resultant bandwidth would exceed the
maximum total bitrate allowed.
This element is always shown.
Indicates the number of times that the IP address is
not a multicast address, or it is a reserved multicast
address, or it isn't in Multicast Source Table, but its
low-order 23 bits are same as those of a group IP
address in multicast source table
This element is only shown in detail mode.
Indicates the number of one second intervals for
which overload protection has been applied
because the message rate exceeded the peak
threshold
This element is only shown in detail mode.

numsec-ovld-protappl <Counter>

706

Released

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

name

Type

Description

num-fail

<Counter>

sysnum-fail

<Counter>

Indicates the number of times that a join fails


because the resultant number of simultaneous
streams was higher than the maximum allowed on
the port.
This element is always shown.
Indicates the number of times that an IGMP join
fails because the resultant number of
all/unconfigured groups was higher than he
maximum number of all/unconfigured multicast
groups allowed.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

707

55 IGMP Status Commands

55.3 IGMP Channel Miscellaneous Status


Command
Command Description
This command shows the IGMP channel source.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp channel miscellaneous (port)

Command Parameters
Table 55.3-1 "IGMP Channel Miscellaneous Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 55.3-2 "IGMP Channel Miscellaneous Status Command" Display parameters
Specific Information
name

708

Type

Description

curr-num-group

<Gauge>

max-msg-rate

<Igmp::ChannelMaxMsgRate>
range: [0...65535] unit: msgs/sec

Indicates the current group number in this port


This element is always shown.
Indicates the maximum messages per second that
can be received by the IGMP protocol stack.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

55.4 IGMP Multicast Sources Statistics


Command Description
This command shows multicast-related parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module-mcast-src (slot) mcast-addr <MulticastAddress>

Command Parameters
Table 55.4-1 "IGMP Multicast Sources Statistics" Resource Parameters
Resource Identifier
(slot)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identifies an IGMP module by the logical SlotId
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<MulticastAddress>
mcast
src
address
in
network-byte
order(big-endian)

mcast-addr

Command Output
Table 55.4-2 "IGMP Multicast Sources Statistics" Display parameters
Specific Information
name

Type

peak-nbr-subs-channels <Counter>
short
name:pk-nr-sub-chan
peak-time

<Sys::Time>

curr-subs-channels

<Gauge>

nbr-connect-fail
<Counter>
short name:nr-con-fail

3HH-01016-AAAA-TCZZA Edition 03

Description
The peak number of subscribed IGMP channels
which have members connected to the source since
the last statistics reset. It is only for those groups
configured in multicast source table.
This element is always shown.
The network time indicating when the peak number
of subscribed IGMP channels for the source
occurred. It is only for those groups configured in
Multicast Source Table.
This element is always shown.
Indicates the current number of subscribed IGMP
channels for the source.
This element is only shown in detail mode.
Indicates the number of times that an attempt to
create a multicast connection fails.

Released

709

55 IGMP Status Commands

name

Type

Description
This element is always shown.

710

Released

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

55.5 IGMP Module Counter Status Commands


Command Description
This command displays the IGMP module counters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module counter (slot-index)

Command Parameters
Table 55.5-1 "IGMP Module Counter Status Commands" Resource Parameters
Resource Identifier
(slot-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 55.5-2 "IGMP Module Counter Status Commands" Display parameters
Specific Information
name

Type

Description

total-msg

<Counter>

total-igmp-msg

<Counter>

total-req

<Counter>

success-req

<Counter>

unsuccess-req

<Counter>

The total number of messages received from users,


including IGMP messages and invalid messages.
This element is always shown.
The total number of IGMP messages, which
includes join and leave requests from users, (both
successful and unsuccessful).
This element is always shown.
The total number of join requests from users, which
includes successful and unsuccessful attempts.
This element is always shown.
The total number of successful join requests from
users which includes new joins (which make a new
connection) and re-joins (which already have a
connection).
This element is always shown.
The total number of unsuccessful new join requests
from users. The failures could be due to the

3HH-01016-AAAA-TCZZA Edition 03

Released

711

55 IGMP Status Commands

name

712

Type

total-leave-req

<Counter>

total-inval-msg

<Counter>

num-connects

<Counter>

num-disconnects

<Counter>

peak-connects-sec

<Counter>

peak-disconnects-sec

<Counter>

peak-msg-sec

<Counter>

gmq

<Counter>

gsq

<Counter>

ovrld-app

<Counter>

Released

Description
following reasons: permission bitmap failure,
bitrate failure, lack of resource or invalid group
address.
This element is only shown in detail mode.
The total number of leave requests from users.
This element is only shown in detail mode.
The total number of invalid messages from users.
These messages could be invalid for the following
reasons: invalid IGMP message type, invalid IGMP
message CRC, invalid IGMP message size,
non-IGMP frame received, unexpected IGMP
Query (GSQ or GMQ) received, RFC 1483 errors,
MAC layer errors, or IP layer errors.
This element is only shown in detail mode.
The total number of connects due to successful new
IGMP join requests from users.
This element is always shown.
The total number of disconnects to users. They can
be due to GSQ or GMQ timer expiry or the
triggering of fast channel changes.
This element is only shown in detail mode.
The peak number of multicast branch connections
performed per second since the statistics were last
cleared.
This element is only shown in detail mode.
The peak number of disconnects to users performed
per second.
This element is only shown in detail mode.
The peak number of messages received from users
per second.
This element is only shown in detail mode.
The total number of GMQ requests from network.
This element is only shown in detail mode.
The total number of GSQ requests from network.
This element is only shown in detail mode.
The number of seconds during which module
overload protection has been applied affecting all
IGMP channels which are terminated at the IGMP
module.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

55.6 IGMP Module Time Status Command


Command Description
This command shows the IGMP module's time-related parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module time (slot-index)

Command Parameters
Table 55.6-1 "IGMP Module Time Status Command" Resource Parameters
Resource Identifier
(slot-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 55.6-2 "IGMP Module Time Status Command" Display parameters
Specific Information
name

Type

Description

peak-connects

<Sys::Time>

peak-disconnects

<Sys::Time>

peak-msg

<Sys::Time>

stats-intval

<Sys::Time>

This statistic is the network time indicating when


the peak number of connects performed per second
occurred.
This element is always shown.
The network time of when the peak number of
disconnects to users performed per second
occurred.
This element is always shown.
The network time of when the peak number of
messages received from users per second occurred.
This element is always shown.
The network time, when the module-wide statistics
were last reset.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

713

55 IGMP Status Commands

55.7 IGMP Module Misc Status Command


Command Description
This command displays the IGMP module parameters.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp module miscellaneous (slot-index)

Command Parameters
Table 55.7-1 "IGMP Module Misc Status Command" Resource Parameters
Resource Identifier
(slot-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identifies an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Command Output
Table 55.7-2 "IGMP Module Misc Status Command" Display parameters
Specific Information
name

714

Type

Description

curr-root-conn

<Gauge>

con-cfgd

<Gauge>

con-un-cfgd

<Gauge>

con-no-memb

<Gauge>

The number of the connected groups.


This element is always shown.
The number of the connected groups who are
configured in multicast source table.
This element is always shown.
The number of the connected groups who aren't
configured in multicast source table.
This element is always shown.
The number of the connected groups who is in
reserve state(no member).
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

55 IGMP Status Commands

55.8 SHub IGMP Vlan Router Port Status Command


Command Description
This command displays the status of the IGMP VLAN router ports.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show igmp shub vlan-router-port (vlan-id) network-port <Shub::NetworkPort>

Command Parameters
Table 55.8-1 "SHub IGMP Vlan Router Port Status Command" Resource Parameters
Resource Identifier
(vlan-id)
network-port

Type

Description

<Vlan::VlanId>
range: [1...4093]
<Shub::NetworkPort>
range: [1...7]

the id of a vlan for which a network port is


reachable
the network port that is reachable

Command Output
Table 55.8-2 "SHub IGMP Vlan Router Port Status Command" Display parameters
Specific Information
name
query-timer
config-status

Type

Description

<Igmp::VlanRouterQueryTimer>
range: [60...600]
<Vlan::VlanRouterConfigStatus>
Possible values are :
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry

time interval to wait for query packet


This element is always shown.
status of the router port
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

715

56- Transport Status Commands

56.1 ICMP Status Command


56.2 IP Address Status Command
56.3 IP Statistics
56.4 IP Route Status Command
56.5 IP Net-To-Media Status Command
56.6 SNMP Status Command
56.7 System Status Command
56.8 UDP Status Command
56.9 UDP Listener Status Command
56.10 Ethernet Dot3 Status Command
56.11 Interface MAU Status Command
56.12 SHub Ethernet Dot3 Status Command
56.13 SHub Dot3 Control Status Command
56.14 SHub Dot3 Pause Status Command
56.15 SHub Ethernet Dot3 Status Command
56.16 SHub L2 Filter Status Command
56.17 SHub Rate Status Command

716

Released

56-717
56-719
56-720
56-722
56-724
56-725
56-728
56-729
56-730
56-731
56-734
56-736
56-737
56-738
56-740
56-743
56-745

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.1 ICMP Status Command


Command Description
The Icmp parameters gives a count of how many icmp messages, an entity receives. Errors determine the number of
icmp specific errors in the icmp messages, it gives the numbers of messages which did not reach the destination,
time exceeded messages, problem messages received, source quench messages, redirect messages, echo request
and reply messages, time stamp request and reply messages, address mask request and reply messages, messages
which the entity attempted to send including the error messages, messages which the entity did not send due to the
problems like lack of buffer.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport icmp

Command Output
Table 56.1-2 "ICMP Status Command" Display parameters
Specific Information
name

Type

Description

rx-total-msgs

<Counter>

rx-err-msgs

<Counter>

rx-dest-unreach-msgs

<Counter>

rx-time-exceed-msgs

<Counter>

The total number of ICMP messages which the


entity received(includes errors also).
This element is always shown.
The number of ICMP messages which the entity
received but determined as having ICMP-specific
errors.
This element is always shown.
The number of ICMP destination unreachable
messages received.
This element is always shown.
The number of ICMP time exceeded messages
received.
This element is always shown.
The number of ICMP parameter problem messages
received.
This element is always shown.
The number of ICMP source quench messages
received.
This element is always shown.
The number of ICMP Redirect messages received.
This element is always shown.
The number of ICMP echo (request) messages
received.
This element is always shown.

rx-param-problem-msgs<Counter>
rx-src-quench-msgs

<Counter>

rx-redirect-msgs

<Counter>

rx-echo-req-msgs

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Released

717

56 Transport Status Commands

name
rx-echo-reply-msgs

Type

Description

<Counter>

The number of ICMP Echo Reply messages


received.
This element is always shown.
The number of ICMP time stamp (request)
messages received.
This element is always shown.
The number of ICMP timestamp reply messages
received.
This element is always shown.
The number of ICMP address mask request
messages received.
This element is always shown.
The number of ICMP address mask reply messages
received.
This element is always shown.
The total number of ICMP messages which was
attempted to send.
This element is always shown.
The number of ICMP messages which this entity
did not send due to problems discovered within
ICMP such as a lack of buffers.
This element is always shown.
The number of ICMP Destination Unreachable
messages sent.
This element is always shown.
The number of ICMP Time Exceeded messages
sent.
This element is always shown.
The number of ICMP Parameter Problem messages
sent.
This element is always shown.
The number of ICMP source quench messages sent.
This element is always shown.
The number of ICMP Redirect messages sent. For a
host, this object will always be zero, since hosts do
not send redirects.
This element is always shown.
The number of ICMP echo request messages sent.
This element is always shown.
The number of ICMP Echo Reply messages sent.
This element is always shown.
The number of ICMP timestamp request messages
sent.
This element is always shown.
The number of ICMP timestamp reply messages
sent.
This element is always shown.
The number of ICMP Address Mask Request
messages sent.
This element is always shown.
The number of ICMP Address Mask Reply
messages sent.
This element is always shown.

rx-timestamp-req-msgs <Counter>
rx-timestamp-reply

<Counter>

rx-addr-mask-req-msgs <Counter>
rx-addr-mask-reply

<Counter>

tx-total-msgs

<Counter>

not-tx-err-msgs

<Counter>

tx-dest-unreach-msgs

<Counter>

tx-time-exceed-msgs

<Counter>

tx-param-problem-msgs <Counter>
tx-src-quench-msgs

<Counter>

tx-redirect-msgs

<Counter>

tx-echo-req-msgs

<Counter>

tx-echo-reply-msgs

<Counter>

tx-timestamp-req-msgs <Counter>
tx-timestamp-reply

<Counter>

tx-addr-mask-req-msgs <Counter>
tx-addr-mask-reply

718

<Counter>

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.2 IP Address Status Command


Command Description
The IP-address parameters holds the addressing information for one of this entity's IP addresses.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-address (address)

Command Parameters
Table 56.2-1 "IP Address Status Command" Resource Parameters
Resource Identifier
(address)

Type

Description

<Ip::V4Address>

ip address where addressing information pertains

Command Output
Table 56.2-2 "IP Address Status Command" Display parameters
Specific Information
name

Type

Description

ifindex

<SignedInteger>

subnet-mask

<Ip::V4Address>

bcast-addr

<SignedInteger>

reas-max-size

<Transport::IpAdEntReasmMaxSize>
range: [0...65535]

Uniquely identifies the interface to which this is


applicable.
This element is always shown.
The subnet mask associated with the IP address.
This element is always shown.
The broadcast address used for sending datagrams
on the (logical) interface associated with the IP
address
This element is only shown in detail mode.
The size of the largest IP datagram which this
entity can re-assemble from incoming IP
fragmented datagrams received on this interface.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

719

56 Transport Status Commands

56.3 IP Statistics
Command Description
This node displays the IP statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-parameters

Command Output
Table 56.3-2 "IP Statistics" Display parameters
Specific Information
name

Type

Description

rx-total-datagrams

<Counter>

in-hdr-err-data

<Counter>

in-addr-err-data

<Counter>

forwarded-datagrams

<Counter>

The total number of input datagrams received from


interfaces, including those received in error.
This element is always shown.
The number of input datagrams discarded due to
errors in their IP headers, including bad checksums,
version number mismatch, other format errors,
time-to-live exceeded, errors discovered in
processing their IP options, etc.
This element is always shown.
The number of input datagrams discarded because
the IP address in their IP header's destination field
was not a valid address to be received at this entity.
This element is always shown.
The number of input datagrams for which this
entity was not their final IP destination, as a result
of which an attempt was made to find a route to
forward them to that final destination.
This element is always shown.
The number of locally-addressed datagrams
received successfully but discarded because of an
unknown or unsupported protocol.
This element is always shown.
The number of input IP datagrams for which no
problems were encountered to prevent their
continued processing, but which were discarded
(e.g., for lack of buffer space).
This element is always shown.
The total number of input datagrams successfully
delivered to IP user-protocols (including ICMP).

rx-unknown-proto-data <Counter>

720

discard-in-data

<Counter>

tot-deliv-in-data

<Counter>

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name

Type

tot-out-req-data

<Counter>

discard-out-data

<Counter>

out-no-route-datagrams <Counter>

timeout-reassem

<SignedInteger>

reassem-req-data

<Counter>

reassem-success-data

<Counter>

reassem-fail-data

<Counter>

frag-success-data

<Counter>

frag-fail-data

<Counter>

gener-frag-data

<Counter>

discard-rout-entrs

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
The total number of IP datagrams which local IP
user-protocols (including ICMP) supplied to IP in
requests for transmission.
This element is always shown.
The number of output IP datagrams for which no
problem was encountered to prevent their
transmission to their destination, but which were
discarded (e.g., for lack of buffer space).
This element is always shown.
The number of IP datagrams discarded because no
route could be found to transmit them to their
destination.
This element is always shown.
The maximum number of seconds which received
fragments are held while they are awaiting
reassembly at this entity.
This element is always shown.
The number of IP fragments received which needed
to be reassembled at this entity.
This element is always shown.
The number of IP datagrams successfully
re-assembled.
This element is always shown.
The number of failures detected by the IP
re-assembly algorithm
This element is always shown.
The number of IP datagrams that have been
successfully fragmented at this entity.
This element is always shown.
The number of IP datagrams that have been
discarded because they needed to be fragmented at
this entity but could not be, e.g., because their Don't
Fragment flag was set.
This element is always shown.
The number of IP datagram fragments that have
been generated as a result of fragmentation at this
entity.
This element is always shown.
The number of routing entries which were chosen
to be discarded even though they are valid.
This element is always shown.

Released

721

56 Transport Status Commands

56.4 IP Route Status Command


Command Description
This node is displays the IP routing statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-route (destination)

Command Parameters
Table 56.4-1 "IP Route Status Command" Resource Parameters
Resource Identifier
(destination)

Type

Description

<Ip::V4Address>

destination IP address of this route

Command Output
Table 56.4-2 "IP Route Status Command" Display parameters
Specific Information
name
routing-mechanism

info

722

Type

Description

<Transport::ipRouteProto>
Possible values are :
- other : entry is created via the BOOTP
protocol
- local : manually configured
- netmgmt : entry is created via the SNMP
protocol
- icmp : obtained via ICMP
- egp : egp protocol
- ggp : ggp protocol
- hello : hello protocol
- rip : rip protocol
- is-is : is-is protocol
- es-is : es-is protocol
- cisco-igrp : ciscoIgrp protocol
- bbn-spf-igp : bbnSpfIgp protocol
- ospf : ospf protocol
- bgp : bgp protocol
<SymbolicObject>

The routing mechanism via which this route was


learned.
This element is always shown.

Released

A reference to MIB definitions specific to the


particular routing protocol which is responsible for
this route.

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name

Type

Description
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

723

56 Transport Status Commands

56.5 IP Net-To-Media Status Command


Command Description
Displays the status of net-to-media.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ip-net-to-media (interface-name) network-addr <Ip::V4Address>

Command Parameters
Table 56.5-1 "IP Net-To-Media Status Command" Resource Parameters
Resource Identifier
(interface-name)
network-addr

Type

Description

<Transport::ifName>
<Ip::V4Address>

name of the interface


ip addr corresponding to media-dependent physical
addr

Command Output
Table 56.5-2 "IP Net-To-Media Status Command" Display parameters
Specific Information
name
phy-addr
type

724

Type

Description

<Sys::MacAddr>
length: 6
<Transport::ipNetToMediaType>
Possible values are :
- other : none of the following
- invalid : invalidating the corresponding
entry
- dynamic : dynamic mapping
- static : static mapping

media-dependent physical addr


This element is always shown.
type of mapping
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.6 SNMP Status Command


Command Description
This node displayes SNMP parameters.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport snmp

Command Output
Table 56.6-2 "SNMP Status Command" Display parameters
Specific Information
name

Type

Description

in-pkts

<Counter>

out-pkts

<Counter>

bad-version-pkts

<Counter>

The total number of messages delivered to the


SNMP entity from the transport service.
This element is always shown.
The total number of SNMP messages which were
passed from the SNMP protocol entity to the
transport service.
This element is always shown.
The total number of unsupported SNMP version
messages which were delivered to the SNMP
protocol entity.
This element is always shown.
The total number of SNMP Messages delivered to
the SNMP protocol entity which used a SNMP
community name that are not known.
This element is always shown.
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.
This element is always shown.
The total number of ASN.1 or BER errors
encountered by the SNMP protocol entity when
decoding received SNMP messages.
This element is always shown.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity with `tooBig'
error.
This element is always shown.
The total number of SNMP PDUs which were

bad-commun-name-pkts<Counter>

bad-commun-use-pkts <Counter>

asn-ber-err-pkts

<Counter>

deliv-toobig-err-pdus

<Counter>

deliv-nosuchname-pdus <Counter>

3HH-01016-AAAA-TCZZA Edition 03

Released

725

56 Transport Status Commands

name

Type

deliv-badvalues-pdus

<Counter>

deliv-ronly-err-pdus

<Counter>

delivered-gen-err-pdus <Counter>

retrieved-get-obj

<Counter>

success-set-objs

<Counter>

accepted-get-req

<Counter>

accepted-getnext-req

<Counter>

accepted-set-req

<Counter>

accepted-get-response <Counter>

accepted-trap

<Counter>

gener-toobigs-pdus

<Counter>

gener-nosuchname-pdus<Counter>

gener-badvalue-pdus

726

<Counter>

Released

Description
delivered to the SNMP protocol entity with
`noSuchName' error.
This element is always shown.
The total number of SNMP PDUs which were
delivered to the SNMP protocol entity with
`badValue' error.
This element is always shown.
The total number valid SNMP PDUs which were
delivered to the SNMP protocol entity with
`readOnly' error.
This element is always shown.
The total number valid SNMP PDUs which were
delivered to the SNMP protocol entity with `genErr'
error.
This element is always shown.
The total number of objects which have been
retrieved successfully by the SNMP protocol entity
as the result of receiving valid SNMP Get-Request
and Get-Next PDUs.
This element is always shown.
The total number of objects which have been
altered successfully by the SNMP protocol entity as
the result of receiving valid SNMP Set-Request
PDUs.
This element is always shown.
The total number of SNMP Get-Request PDUs
which have been accepted and processed by the
SNMP protocol entity.
This element is always shown.
The total number of SNMP Get-Next PDUs which
have been accepted and processed by the SNMP
protocol entity.
This element is always shown.
The total number of SNMP Set-Request PDUs
which have been accepted and processed by the
SNMP protocol entity.
This element is always shown.
The total number of SNMP Get-Response PDUs
which have been accepted and processed by the
SNMP protocol entity.
This element is always shown.
The total number of SNMP Trap PDUs which have
been accepted and processed by the SNMP protocol
entity.
This element is always shown.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity with
`tooBig' error.
This element is always shown.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity with
`noSuchName' error.
This element is always shown.
The total number of SNMP PDUs which were
generated by the SNMP protocol entity with
`badValue' error.
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name

Type

generated-gen-err-pdus <Counter>

total-get-req

<Counter>

total-getnext-req

<Counter>

total-set-req

<Counter>

total-get-responses

<Counter>

total-no-of-traps

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
The total number of SNMP PDUs which were
generated by the SNMP protocol entity with
`genErr' error.
This element is always shown.
The total number of SNMP Get-Request PDUs
which have been generated by the SNMP protocol
entity.
This element is always shown.
The total number of SNMP Get-Next PDUs which
have been generated by the SNMP protocol entity.
This element is always shown.
The total number of SNMP Set-Request PDUs
which have been generated by the SNMP protocol
entity.
This element is always shown.
The total number of SNMP Get-Response PDUs
which have been generated by the SNMP protocol
entity.
This element is always shown.
The total number of SNMP Trap PDUs which have
been generated by the SNMP protocol entity.
This element is always shown.

Released

727

56 Transport Status Commands

56.7 System Status Command


Command Description
This node displays the system statistics.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport system-parameters

Command Output
Table 56.7-2 "System Status Command" Display parameters
Specific Information
name

728

Type

Description

description

<PrintableString-0-255>
length: x<255

object-id

<Object>

up-time

<TimeTicks>
unit: msec

services

<Transport::SysServices>
range: [0...127] unit: milisec

A textual description which include's the full name


and version identification of the system's hardware
type, software operating-system, and networking
software.
This element is always shown.
The vendor's authoritative identification of the
network management subsystem contained in the
entity. This value is allocated within the SMI
enterprises subtree (1.3.6.1.4.1) and provides an
easy and unambiguous means for determining
`what kind of box' is being managed.
This element is always shown.
The time since the network management portion of
the system was last re-initialized.
This element is always shown.
A value which indicates the set of services that this
entity primarily offers.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.8 UDP Status Command


Command Description
These parameters keep track of number of UDP datagrams delivered to the UDP user, also keeps track of number
of errors occurred. Implementation of the UDP group is mandatory for all systems which implement the UDP.
The total number of UDP datagrams delivered to UDP users is given by total-delivered-datagrams parameter. The
no-port parameter gives the total number of received UDP datagrams for which there was no application at the
destination port. err-datagrams parameter gives the number of received UDP datagrams that could not be
delivered for reasons other than the lack of an application at the destination port. total-datagrams gives the total
number of UDP datagrams sent from this entity.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport udp-parameters

Command Output
Table 56.8-2 "UDP Status Command" Display parameters
Specific Information
name

Type

Description

tot-deliv-data

<Counter>

rx-tot-no-port-data

<Counter>

rx-err-datagrams

<Counter>

tx-total-datagrams

<Counter>

The total number of UDP datagrams delivered to


UDP users.
This element is always shown.
The total number of received UDP datagrams for
which there was no application at the destination
port.
This element is always shown.
The number of received UDP datagrams that could
not be delivered for reasons other than the lack of
an application at the destination port.
This element is always shown.
The total number of UDP datagrams sent from this
entity.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

729

56 Transport Status Commands

56.9 UDP Listener Status Command


Command Description
The UDP listener table contains information about this entity's UDP end-points on which a local application is
currently accepting datagrams.
The local IP address for this UDP listener is given by local-address parameter. In the case of a UDP listener which
is willing to accept datagrams for any IP interface associated with the node, the value 0.0.0.0 is used. The local
port number for this UDP listener is given by local-port parameter.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport udp (local-address) local-port <Transport::UdpLocalPort>

Command Parameters
Table 56.9-1 "UDP Listener Status Command" Resource Parameters
Resource Identifier
(local-address)
local-port

730

Type

Description

<Ip::V4Address>
<Transport::UdpLocalPort>
range: [0...65535]

local IP address for this UDP listener


local port number for this UDP listener

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.10 Ethernet Dot3 Status Command


Command Description
Statistics for a collection of ethernet-like interfaces attached to a particular system. There will be one row in this
table for each ethernet-like interface in the system. The parameter stats-index gives an index value that uniquely
identifies an interface to an ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error gives a count of frames received on a particular interface that are an integral number of octets in
length but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The single-collision-frame gives a count of successfully transmitted frames on a particular interface for which
transmission is inhibited by exactly one collision. This counter does not increment when the interface is operating
in full-duplex mode. The multiple-collision-frame gives a ount of successfully transmitted frames on a particular
interface for which transmission is inhibited by more than one collision. This counter also does not increment when
the interface is operating in full-duplex mode.
The deferred-transmission parameter gives a count of frames for which the first transmission attempt on a
particular interface is delayed because the medium is busy. The count represented by an instance of this object
does not include frames involved in collisions. This counter does not increment when the interface is operating in
full-duplex mode.
The late-collision gives the number of times that a collision is detected on a particular interface later than one
slotTime into the transmission of a packet. A (late) collision included in a count represented by an instance of this
object is also considered as a (generic) collision for purposes of other collision-related statistics. This counter does
not increment when the interface is operating in full-duplex mode.
The excessive-collision gives a count of frames for which transmission on a particular interface fails due to
excessive collisions. This counter does not increment when the interface is operating in full-duplex mode.
The internal-mac-tx-error gives a count of frames for which transmission on a particular interface fails due to an
internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not counted by
the corresponding instance of either the late collisions object, the excessive collisions object, or the carrier sense
errors object. The precise meaning of the count represented by an instance of this object is implementationspecific. In particular, an instance of this object may represent a count of transmission errors on a particular
interface that are not otherwise counted.
The frame-too-long parameter gives a count of frames received on a particular interface that exceed the maximum
permitted frame size. The count represented by an instance of this object is incremented when the frameTooLong
status is returned by the MAC service to the LLC.
The internal-mac-rx-error gives a count of frames for which reception on a particular interface fails due to an
internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted by the
corresponding instance of either the frame toolongs object, the alignment errors object, or the FCS errors object.
The precise meaning of the count represented by an instance of this object is implementation-specific. In particular,
an instance of this object may represent a count of receive errors on a particular interface that are not otherwise
counted.
The duplex-status is the mandatory mode of operation of the MAC entity. 'unknown' indicates that the mandatory
duplex mode could not be determined. Management control of the duplex mode is accomplished through the MAU
MIB. When an interface does not support autonegotiation, or when autonegotiation is not enabled, the duplex mode
is controlled using Mau default type. When autonegotiation is supported and enabled, duplex mode is controlled

3HH-01016-AAAA-TCZZA Edition 03

Released

731

56 Transport Status Commands

using if MAU auto negation advertised bits. In either case, the mandatoryly operating duplex mode is reflected both
in this object and in ifMauType.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ether-dot3 (stats-index)

Command Parameters
Table 56.10-1 "Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier
(stats-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::NtSlot> : <Itf::EthernetId>

Description
/ index of the interface to an ethernet-like medium

Command Output
Table 56.10-2 "Ethernet Dot3 Status Command" Display parameters
Specific Information
name

732

Type

Description

align-err

<Counter>

fcs-err

<Counter>

single-coll-frame

<Counter>

multiple-coll-frame

<Counter>

deferred-trans

<Counter>

late-coll

<Counter>

excessive-coll

<Counter>

A count of frames received on a particular interface


that are not an integral number of octets in length
and do not pass the FCS check.
This element is always shown.
A count of frames received on a particular interface
that are not an integral number of octets in length
and do not pass the FCS check.
This element is always shown.
A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by exactly one collision.
This element is always shown.
A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by more than one collision.
This element is always shown.
A count of frames for which the first transmission
attempt on a particular interface is delayed because
the medium is busy. The count represented by an
instance of this object does not include frames
involved in collisions.
This element is only shown in detail mode.
The number of times that a collision is detected on
a particular interface later than one slot Time into
the transmission of a packet.
This element is only shown in detail mode.
A count of frames for which transmission on a
particular interface fails due to excessive collisions.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name

Type

internal-mac-tx-err

<Counter>

frame-too-long

<Counter>

internal-mac-rx-err

<Counter>

duplex-status

<Ether::Dot3DuplexStatus>
Possible values are :
- unknown : Unknown type
- half-duplex : half duples mode
- full-duplex : full duplex mode

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is only shown in detail mode.
A count of frames for which transmission on a
particular interface fails due to an internal MAC
sublayer transmit error.
This element is only shown in detail mode.
A count of frames received on a particular interface
that exceed the maximum permitted frame size.
This element is only shown in detail mode.
A count of frames for which reception on a
particular interface fails due to an internal MAC
sublayer receive error.
This element is only shown in detail mode.
Specifies the mode of operation of the MAC.
This element is only shown in detail mode.

Released

733

56 Transport Status Commands

56.11 Interface MAU Status Command


Command Description
shows the ether mau parameters.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport ether-ifmau (if-index) index <Transport::Index>

Command Parameters
Table 56.11-1 "Interface MAU Status Command" Resource Parameters
Resource Identifier
(if-index)
index

Type

Description

<Transport::Index>
range: [1...[0-9]+]
<Transport::Index>
range: [1...[0-9]+]

interface to which the MAU is connected


identify MAU, among others connected to same
interface

Command Output
Table 56.11-2 "Interface MAU Status Command" Display parameters
Specific Information
name
type

734

Type

Description

<Ether::MAUType>
Possible values are :
- 10baset : UTP MAU
- 100basetxhd : 2 pair cat. 5 UTP half
duplex
- 100basetxfd : 2 pair cat. 5 UTP full
duplex
- 100basefxhd : X fiber over PMT half
duplex
- 100basefxfd : X fiber over PMT full
duplex
- 1000basexhd : PCS/PMA,unknown
PMD, half duplex
- 1000basexfd : PCS/PMA,unknown
PMD, full duplex
1000baselxhd
:
fiber
over
long-wavelength laser half duplex
1000baselxfd
:
fiber
over

Specifies the MAU type. If the MAU type is


unknown, then unknown Mac type will be returned.
If the MAU is a link or fiber type then
media-available is equivalent to the link test fail
state/low light function. For an AUI or a coax
(including broadband) MAU this indicates whether
or not loopback is detected on the DI circuit. The
value of this attribute persists between packets for
MAU types AUI, 10BASE5, 10BASE2,
10BROAD36, and 10BASE-FP.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name

media-available

med-avail-state-exits

jabbar-state

Type
long-wavelength laser full duplex
1000basesxhd
:
fiber
over
short-wavelength laser half duplex
1000basesxfd
:
fiber
over
short-wavelength laser full duplex
- 1000basethd : four-pair cat. 5 UTP over
short-wavelength laser half duplex
- 1000basetfd : four-pair cat. 5 UTP over
short-wavelength laser full duplex
<Transport::MauAvailable>
Possible values are :
- other : MAU in other state
- unknown : MAU's true state is unknown
- available :
- not-available : MAU is fully functional
- remote-fault : power down
- invalid-signal : reset the MAU
- remote-jabber : power down
- remote-link-loss : power down
- remote-test : power down
- off-line : power down
- auto-neg-error : power down
<Counter>

jabbering-state-enters

<Transport::MauJabber>
Possible values are :
- other : if not in any state
- unknown : MAU's true state is unknown
- no-jabber : MAU not jabbering
- jabbering : MAU is jabbering
<Counter>

false-carriers

<Counter>

auto-neg-supported

<Ether::TruthValue>
Possible values are :
- true :
- false :

3HH-01016-AAAA-TCZZA Edition 03

Description

Specifies whether the media is availble for the


MAU or not.
This element is always shown.

A count of the number of times that Mau-Media


available for this MAU instance leaves the state
available.
This element is always shown.
The jabbar-state indicates whether this entity is
jabbering, not jabbering, unknown or other state.
This element is always shown.

A count of the number of times that jabber-state for


this MAU instance enters the state jabbering.
This element is always shown.
A count of the number of false carrier events during
IDLE in 100BASE-X and 1000BASE-X links. For
all other MAU types, this counter will always
indicate zero. This counter does not increment at
the symbol rate.
This element is always shown.
Specifies whether or not auto-negotiation is
supported on this MAU.
This element is always shown.

Released

735

56 Transport Status Commands

56.12 SHub Ethernet Dot3 Status Command


Command Description
Shows The Related Dot3 Collision Status For SHub.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-coll (if-index) coll-count <Transport::CollisionCount>

Command Parameters
Table 56.12-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier
(if-index)
coll-count

Type

Description

<Ether::InterfaceIndex>
range: [0...2147483647]
<Transport::CollisionCount>
range: [0...16]

index of the collision interface


count of per-frame media collisions

Command Output
Table 56.12-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name
frequencies

736

Type

Description

<Counter>

A count of individual MAC frames for which the


transmission (successful or otherwise) on a
particular interface occurs after the frame has
experienced exactly the number of collisions as in
coll-count
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.13 SHub Dot3 Control Status Command


Command Description
This command shows the dot3 control status
The functions-supported parameter give a list of the possible MAC Control functions implemented for this
interface. The rx-unknown-opcodes parameter gives a count of MAC Control frames received on this interface that
contain an opcode that is not supported by this device.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-control (stats-index)

Command Parameters
Table 56.13-1 "SHub Dot3 Control Status Command" Resource Parameters
Resource Identifier
(stats-index)

Type

Description

<Shub::NetworkPort>
range: [1...7]

index of the interface to an ethernet-like medium

Command Output
Table 56.13-2 "SHub Dot3 Control Status Command" Display parameters
Specific Information
name

Type

Description

functions-supported

<PrintableString>

rx-unknown-opcodes

<Counter>

A list of the possible MAC Control functions


implemented for this interface.
This element is always shown.
A count of MAC Control frames received on this
interface that contain an opcode that is not
supported by this device.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

737

56 Transport Status Commands

56.14 SHub Dot3 Pause Status Command


Command Description
This command shows the dot3 pause parameters
The stats-index gives a value that uniquely identifies an interface to an ethernet-like medium. The operator-mode
parameter reflects the PAUSE mode mandatoryly in use on this interface, as determined by either (1) the result of
the auto-negotiation function or (2) if auto-negotiation is not enabled or is not implemented for the active MAU
attached to this interface, by the value of pause admin mode.
The parameter in-frames gives a count of MAC Control frames received on this interface with an opcode indicating
the PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode. The
out-frames gives a count of MAC Control frames transmitted on this interface with an opcode indicating the
PAUSE operation. This counter does not increment when the interface is operating in half-duplex mode.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-pause (stats-index)

Command Parameters
Table 56.14-1 "SHub Dot3 Pause Status Command" Resource Parameters
Resource Identifier
(stats-index)

Type

Description

<Shub::NetworkPort>
range: [1...7]

index of the interface to an ethernet-like medium

Command Output
Table 56.14-2 "SHub Dot3 Pause Status Command" Display parameters
Specific Information
name
operator-mode

in-frames

738

Type

Description

<Ether::Dot3PauseOperatorMode>
specifies pause mode in use on this interface
Possible values are :
This element is always shown.
- disabled : disabled
- enable-xmit : enabled only in transmit
direction
- enable-rcv : enabled only in receipt
- enable-xmit-rcv : enabled both transmit
and receipt
<Counter>
A count of MAC control frames received on this
interface with an opcode indicating the pause
operation.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

name
out-frames

Type
<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
A count of MAC control frames transmitted on this
interface with an opcode indicating the pause
operation.
This element is always shown.

Released

739

56 Transport Status Commands

56.15 SHub Ethernet Dot3 Status Command


Command Description
Statistics for a collection of ethernet-like interfaces attached to a particular system. There will be one row in this
table for each ethernet-like interface in the system. The parameter stats-index gives an index value that uniquely
identifies an interface to an ethernet-like medium.
The alignment-error parameter gives a count of frames received on a particular interface that are not an integral
number of octets in length and do not pass the FCS check. The count represented by an instance of this object is
incremented when the alignmentError status is returned by the MAC service to the LLC. This counter does not
increment for 8-bit wide group encoding schemes. Discontinuities in the value of this counter can occur at
re-initialization of the management system.
The fcs-error gives a count of frames received on a particular interface that are an integral number of octets in
length but do not pass the FCS check. This count does not include frames received with frame-too-long or
frame-too-short error.
The single-collision-frame gives a count of successfully transmitted frames on a particular interface for which
transmission is inhibited by exactly one collision. This counter does not increment when the interface is operating
in full-duplex mode. The multiple-collision-frame gives a ount of successfully transmitted frames on a particular
interface for which transmission is inhibited by more than one collision. This counter also does not increment when
the interface is operating in full-duplex mode.
The deferred-transmission parameter gives a count of frames for which the first transmission attempt on a
particular interface is delayed because the medium is busy. The count represented by an instance of this object
does not include frames involved in collisions. This counter does not increment when the interface is operating in
full-duplex mode.
The late-collision gives the number of times that a collision is detected on a particular interface later than one
slotTime into the transmission of a packet. A (late) collision included in a count represented by an instance of this
object is also considered as a (generic) collision for purposes of other collision-related statistics. This counter does
not increment when the interface is operating in full-duplex mode.
The excessive-collision gives a count of frames for which transmission on a particular interface fails due to
excessive collisions. This counter does not increment when the interface is operating in full-duplex mode.
The internal-mac-tx-error gives a count of frames for which transmission on a particular interface fails due to an
internal MAC sublayer transmit error. A frame is only counted by an instance of this object if it is not counted by
the corresponding instance of either the dot3StatsLateCollisions object, the dot3StatsExcessiveCollisions object, or
the dot3StatsCarrierSenseErrors object. The precise meaning of the count represented by an instance of this object
is implementation- specific. In particular, an instance of this object may represent a count of transmission errors
on a particular interface that are not otherwise counted.
The frame-too-long parameter gives a count of frames received on a particular interface that exceed the maximum
permitted frame size. The count represented by an instance of this object is incremented when the frameTooLong
status is returned by the MAC service to the LLC.
The internal-mac-rx-error gives a count of frames for which reception on a particular interface fails due to an
internal MAC sublayer receive error. A frame is only counted by an instance of this object if it is not counted by the
corresponding instance of either the frame too longs, the alignment errors, or the FCS errors object. The precise
meaning of the count represented by an instance of this object is implementation-specific. In particular, an instance
of this object may represent a count of receive errors on a particular interface that are not otherwise counted.
The duplex-status is the mandatory mode of operation of the MAC entity. 'unknown' indicates that the mandatory
duplex mode could not be determined. Management control of the duplex mode is accomplished through the MAU
MIB. When an interface does not support autonegotiation, or when autonegotiation is not enabled, the duplex mode
is controlled using Mau default type. When autonegotiation is supported and enabled, duplex mode is controlled
using MAU auto negotiation advertised bits. In either case, the mandatoryly operating duplex mode is reflected

740

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

both in this object and in if MAU type.


The carrier-sense-error gives the number of times that the carrier sense condition was lost or never asserted when
attempting to transmit a frame on a particular interface. The count represented by an instance of this object is
incremented at most once per transmission attempt, even if the carrier sense condition fluctuates during a
transmission attempt. This counter does not increment when the interface is operating in full-duplex mode.
The symbol-error for an interface operating at 100 Mb/s, the number of times there was an invalid data symbol
when a valid carrier was present. For an interface operating in half-duplex mode at 1000 Mb/s, the number of
times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than slotTime, and
during which there was at least one occurrence of an event that causes the PHY to indicate 'Data reception error'
or 'carrier extend error' on the GMII. For an interface operating in full-duplex mode at 1000 Mb/s, the number of
times the receiving media is non-idle a carrier event) for a period of time equal to or greater than minimum frame
size, and during which there was at least one occurrence of an event that causes the PHY to indicate 'Data
reception error' on the GMII. The count represented by an instance of this object is incremented at most once per
carrier event, even if multiple symbol errors occur during the carrier event. This count does not increment if a
collision is present.
The sqe-test-error gives a count of times that the SQE TEST ERROR message is generated by the PLS sublayer for
a particular interface. This counter does not increment on interfaces operating at speeds greater than 10 Mb/s, or
on interfaces operating in full-duplex mode.

User Level
The command can be accessed by operators with transport privileges.

Command Syntax
The command has the following syntax:
> show transport shub dot3-status (stats-index)

Command Parameters
Table 56.15-1 "SHub Ethernet Dot3 Status Command" Resource Parameters
Resource Identifier
(stats-index)

Type

Description

<Shub::NetworkPort>
range: [1...7]

index of the interface to an ethernet-like medium

Command Output
Table 56.15-2 "SHub Ethernet Dot3 Status Command" Display parameters
Specific Information
name

Type

Description

align-err

<Counter>

fcs-err

<Counter>

single-coll-frame

<Counter>

A count of frames received on a particular interface


that has alignment error status returned by MAC
service to the LLC(or other MAC user).
This element is always shown.
A count of frames received on a particular interface
that has frame check error status is returned by the
MAC service to the LLC (or other MAC user).
This element is always shown.
A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by exactly one collision.

3HH-01016-AAAA-TCZZA Edition 03

Released

741

56 Transport Status Commands

name

742

Type

multiple-coll-frame

<Counter>

deferred-trans

<Counter>

late-coll

<Counter>

excessive-coll

<Counter>

internal-mac-tx-err

<Counter>

frame-too-long

<Counter>

internal-mac-rx-err

<Counter>

duplex-status

carrier-sense-err

<Ether::Dot3DuplexStatus>
Possible values are :
- unknown : Unknown type
- half-duplex : half duples mode
- full-duplex : full duplex mode
<Counter>

ether-chipset

<SymbolicObject>

sym-err

<Counter>

sqe-test-err

<Counter>

Released

Description
This element is always shown.
A count of successfully transmitted frames on a
particular interface for which transmission is
inhibited by more than one collision.
This element is always shown.
A count of frames for which the first transmission
attempt on a particular interface is delayed because
the medium is busy, this does not include frames
involved in collisions.
This element is only shown in detail mode.
The number of times that a collision is detected on
a particular interface later than one slotTime into
the transmission of a packet.
This element is only shown in detail mode.
A count of frames for which transmission on a
particular interface fails due to excessive collisions.
This element is only shown in detail mode.
A count of frames for which transmission on a
particular interface fails due to an internal MAC
sublayer transmit error.
This element is only shown in detail mode.
A count of frames received on a particular interface
that exceed the maximum permitted frame size.
This element is only shown in detail mode.
A count of frames for which reception on a
particular interface fails due to an internal MAC
sublayer receive error.
This element is only shown in detail mode.
specifies the mode of operation of the MAC.
This element is only shown in detail mode.

The number of times that the carrier sense


condition was lost or never asserted when
attempting to transmit a frame on a particular
interface.
This element is only shown in detail mode.
Identifies the chipset used to realize the interface.
Ethernet-like interfaces are typically built out of
several different chips.
This element is only shown in detail mode.
The number of times there was an invalid data
symbol.
This element is always shown.
A count of times that the SQE test error message is
generated by the PLS sublayer for a particular
interface.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.16 SHub L2 Filter Status Command


Command Description
This node shows the L2 filter information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show transport shub mac (index-num)

Command Parameters
Table 56.16-1 "SHub L2 Filter Status Command" Resource Parameters
Resource Identifier
(index-num)

Type

Description

<Sys::Number>
range: [1...65535]

L2 Filter rule number

Command Output
Table 56.16-2 "SHub L2 Filter Status Command" Display parameters
Specific Information
name
protocol-type
dst-mac-addr

Type

Description

<Sys::ProtocolType>
range: [0,1536...65535]
<Vlan::MacAddr>
length: 6

Specifies the non IP protocol type to be filtered.


This element is always shown.
Specifies the destination MAC address to be
matched with the packet.
This element is always shown.
Specifies the source MAC address to be matched
with the packet.
This element is always shown.
Specifies the vlan id to be filtered.
This element is always shown.
Specifies the complete set of ports over which if the
packet arrives the filter rule will be applicable. If
the incoming port list is '0', the filter rule is
applicable for all the incoming ports.
This element is always shown.
Specifies the action to be taken on the packet.
This element is always shown.

src-mac-addr

<Vlan::MacAddr>
length: 6

vlan-id

<Sys::FilterVlanId>
range: [0...4094]
<Shub::PortList>
length: 3

in-port-list

action

<Sys::L2Action>
Possible values are :
- action-allow : the packet will be
forwarded
- action-drop : the packet will be discarded

3HH-01016-AAAA-TCZZA Edition 03

Released

743

56 Transport Status Commands

name
match-cnt

744

Type

Description

<Counter>

Number of times this filter is matched.


This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

56 Transport Status Commands

56.17 SHub Rate Status Command


Command Description
This node shows SHub rate information.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show transport shub rate (port)

Command Parameters
Table 56.17-1 "SHub Rate Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

port for which the rate parameters are displayed

Command Output
Table 56.17-2 "SHub Rate Status Command" Display parameters
Specific Information
name
dlf-limit

bcast-limit

mcast-limit

max-nbr-pkts
validity

Type

Description

<Sys::DlfStatus>
Possible values are :
- lookup-enabled : enable this status
- lookup-disabled : disable this status
<Sys::BcastStatus>
Possible values are :
- bcast-pkt-enabled : enable this status
- bcast-pkt-disabled : disable this status
<Sys::McastStatus>
Possible values are :
- mcast-pkt-enabled : enable this status
- mcast-pkt-disabled : disable this status
<Sys::RateCtrlLimit>
range: [1...65535]

Specifies destination lookup failure packet


transmission control over the interface is enabled or
not.
This element is always shown.
Specifies broadcast packet transmission control
over the interface is enabled or not.
This element is always shown.

<Sys::RateCtrlStatus>
Possible values are :
- valid : status is valid
- invalid : status is invalid

3HH-01016-AAAA-TCZZA Edition 03

Specifies multicast packet transmission control


over the interface is enabled or not.
This element is always shown.
Specifies the maximum number of packets that can
be transmitted over this interface.
This element is always shown.
Specifies whether this entry is valid or not.
This element is always shown.

Released

745

57- DHCP Relay Status Commands

57.1 DHCP Relay Port Statistics


57.2 DHCP Relay SHub Statistics

746

Released

57-747
57-748

3HH-01016-AAAA-TCZZA

Edition 03

57 DHCP Relay Status Commands

57.1 DHCP Relay Port Statistics


Command Description
This command allows the operator to view the DHCP relay port counters.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay port (port-interface)

Command Parameters
Table 57.1-1 "DHCP Relay Port Statistics" Resource Parameters
Resource Identifier
(port-interface)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ port number associated with bridge port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 57.1-2 "DHCP Relay Port Statistics" Display parameters
Specific Information
name

Type

Description

receive

<Counter>

transmit

<Counter>

large-msg-drop

<Counter>

untrust-agent-drop

<Counter>

untrust-option-82

<Counter>

long-option-82

<Counter>

error-summary

<Counter>

number of upstream dhcp packets


This element is always shown.
number of downstream dhcp messages
This element is always shown.
number of discarded upstream dhcp packets
This element is only shown in detail mode.
number of discarded upstream dhcp packets
untrusted
This element is only shown in detail mode.
nbr of discarded dhcp pkts with option 82 untrusted
This element is only shown in detail mode.
nbr of discarded upstream dhcp pkts without option
82
This element is only shown in detail mode.
Error summary for a port
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

747

57 DHCP Relay Status Commands

57.2 DHCP Relay SHub Statistics


Command Description
This command displays DHCP relay agent statistics for each VRF.

User Level
The command can be accessed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> show dhcp-relay shub vrf-agent-stats (vrf)

Command Parameters
Table 57.2-1 "DHCP Relay SHub Statistics" Resource Parameters
Resource Identifier
(vrf)

Type

Description

<Vrf::ShubVrfID>
range: [0...127]

vrf for which the agent is running

Command Output
Table 57.2-2 "DHCP Relay SHub Statistics" Display parameters
Specific Information
name

748

Type

Description

fwd-upstream

<Counter>

fwd-downstream

<Counter>

rx-upstream

<Counter>

rx-downstream

<Counter>

errors

<Counter>

number of forwarded upstream dhcp packets


This element is always shown.
number of forwarded downstream dhcp packets
This element is always shown.
number of received upstream dhcp packets
This element is always shown.
number of received downstream dhcp packets
This element is always shown.
number of erroneous dhcp packets discarded
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

58- Multicast Status Commands

58.1 Multicast VLAN FWD Port Status Command

3HH-01016-AAAA-TCZZA Edition 03

58-750

Released

749

58 Multicast Status Commands

58.1 Multicast VLAN FWD Port Status Command


Command Description
This command shows the VLAN list for the MAC multicast group.

User Level
The command can be accessed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> show mcast shub igs-vlan-grp (vlan-id) mcast-addr <Vlan::MacAddr>

Command Parameters
Table 58.1-1 "Multicast VLAN FWD Port Status Command" Resource Parameters
Resource Identifier
(vlan-id)
mcast-addr

Type

Description

<Vlan::VlanId>
range: [1...4093]
<Vlan::MacAddr>
length: 6

vlan id
multicast address

Command Output
Table 58.1-2 "Multicast VLAN FWD Port Status Command" Display parameters
Specific Information
name

750

Type

Description

fwd-port-list

<Shub::PortList>
length: 3

status

<Vlan::VlanMcastConfigStatus>
Possible values are :
- static : static group entry
- dynamic : dynamic entry
- static-dynamic : static dynamic entry

List of ports which are members for the MAC


multicast group and the Vlan Id. BIT 1-16 (MSB)
1/1/4 - 1/1/19, BIT 18-24 network:1-7, BIT 17 NT
This element is always shown.
The status of the igs-vlan multicast group
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

59- CPE Remote Status Commands

59.1 CPE Remote Management System Status Command

3HH-01016-AAAA-TCZZA Edition 03

59-752

Released

751

59 CPE Remote Status Commands

59.1 CPE Remote Management System Status


Command
Command Description
This command shows the packets statistics of the CPE Remote Management System.

User Level
The command can be accessed by operators with all privileges.

Command Syntax
The command has the following syntax:
> show cpeproxy

Command Output
Table 59.1-2 "CPE Remote Management System Status Command" Display parameters
Specific Information
name

752

Type

Description

pkts-from-cpemm

<Counter>

pkts-to-cpemm

<Counter>

discard-pkts-cpemm

<Counter>

discard-pkts-cpe

<Counter>

number of packets received from the CPE


Management Module.
This element is always shown.
number of packets sent to the CPE Management
Module.
This element is always shown.
number of packets received from the CPE
Management Module and discarded.
This element is only shown in detail mode.
number of packets received from the CPE and
discarded.
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

60- Session Status Commands

60.1 Session Status Command

3HH-01016-AAAA-TCZZA Edition 03

60-754

Released

753

60 Session Status Commands

60.1 Session Status Command


Command Description
This command shows the status of all sessions.

User Level
The command can be accessed and executed by an operator with admin privilege.

Command Syntax
The command has the following syntax:
> show session (id)

Command Parameters
Table 60.1-1 "Session Status Command" Resource Parameters
Resource Identifier
(id)

Type

Description

<Sec::SessionId>
the session number
range:
[1...(TelnetDaemon::maxTelnetSessions_c+CraftSessionManager::maxNumberOfCraftSessions_c)]

Command Output
Table 60.1-2 "Session Status Command" Display parameters
Specific Information
name

Type

Description

operator

<Sec::OperatorName>
range: [a-z0-9]length: 1<=x<11

from

<Sec::LoginAddress>
length: x<21
<Sec::TerminalType>
Possible values are :
- craft : craft terminal
- telnet : telnet terminal
- network : network terminal
- virtual : virtual terminal
<Sec::SessionStatus>
Possible values are :
- init : initialisation ongoing
- free : free
- login : start login procedure
- name : asking the operator name
- passwd : asking the password
- active : active

the name of the operator that is actually using the


session
This element is always shown.
the ip-address from where the user is logged in
This element is always shown.
the type of connection use. Network means that any
supported connection type over ip is possible.
This element is always shown.

type

status

754

Released

the status of the session. Special values are :


initializing=session is not yet ready to be used,
free=session is not used, selected=session is
reserved, stopping=the user is logging out,
invalid=the session is out-of-service
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

60 Session Status Commands

name
login-time
idle-time

Type
- logout : the operator is logging out
<Sys::Time>
unit: UTC
<ElapsedTime>
unit: sec

3HH-01016-AAAA-TCZZA Edition 03

Description
the time when the user connected to the terminal.
Never if no user is connected.
This element is always shown.
the time that this terminal is idle (the operator did
not type any character and did not modify its
window size
This element is always shown.

Released

755

61- PPPoX-Relay Status Commands

61.1 PPPoX CC Engine Statistics


61.2 PPPoX CC Client Port Statistics
61.3 PPPoX CC Engine Monitor Statistics
61.4 PPPoX CC Client Port Monitor Statistics
61.5 PPPoX CC Session Engine Status Command
61.6 PPPoX CC Session Client Port Status Command

756

Released

61-757
61-758
61-759
61-760
61-761
61-762

3HH-01016-AAAA-TCZZA

Edition 03

61 PPPoX-Relay Status Commands

61.1 PPPoX CC Engine Statistics


Command Description
This command shows the statistics for a particular VLAN ID.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect statistics engine (vlan-id)

Command Parameters
Table 61.1-1 "PPPoX CC Engine Statistics" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

engine identification

Command Output
Table 61.1-2 "PPPoX CC Engine Statistics" Display parameters
Specific Information
name

Type

Description

in-ctrl-frm

<PPPoX::EngineName>
length: 1<=x<32
<Counter>

out-ctrl-frm

<Counter>

err-ctrl-frm

<Counter>

ppp-cc

<SignedInteger>

name to identify the engine/service


This element is always shown.
number of ingress control messages
This element is always shown.
number of egress control messages
This element is always shown.
nbr of errored upstream and downstream control
msgs
This element is only shown in detail mode.
nbr of PPP cross-connections currently in use
This element is always shown.

engine-name

3HH-01016-AAAA-TCZZA Edition 03

Released

757

61 PPPoX-Relay Status Commands

61.2 PPPoX CC Client Port Statistics


Command Description
This command shows the statistics of client port.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect statistics client-port (client-port)

Command Parameters
Table 61.2-1 "PPPoX CC Client Port Statistics" Resource Parameters
Resource Identifier
(client-port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ client port identification
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 61.2-2 "PPPoX CC Client Port Statistics" Display parameters
Specific Information
name

758

Type

Description

in-ctrl-frm

<Counter>

out-ctrl-frm

<Counter>

err-ctrl-frm

<Counter>

number of ingress control messages


This element is always shown.
number of egress control messages
This element is always shown.
number of errored control messages
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

61 PPPoX-Relay Status Commands

61.3 PPPoX CC Engine Monitor Statistics


Command Description
This command shows the engine monitor statistics for a particular VLAN ID and lists the statistics of a configured
engine with monitor enabled.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect monitor-statistics engine (vlan-id)

Command Parameters
Table 61.3-1 "PPPoX CC Engine Monitor Statistics" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

engine identification

Command Output
Table 61.3-2 "PPPoX CC Engine Monitor Statistics" Display parameters
Specific Information
name

Type

Description

generic-err-cnt

<Counter>

inv-serv-name

<Counter>

nbr of discovery msgs that carried the Generic


Error tag
This element is always shown.
nbr of PAD-S msgs containing Service-Name-Error
tag
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

759

61 PPPoX-Relay Status Commands

61.4 PPPoX CC Client Port Monitor Statistics


Command Description
This command displays the client port monitor statistics and lists the statistics of a configured client port with
monitor enabled.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect monitor-statistics client-port (client-port)

Command Parameters
Table 61.4-1 "PPPoX CC Client Port Monitor Statistics" Resource Parameters
Resource Identifier
(client-port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ client port identification
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 61.4-2 "PPPoX CC Client Port Monitor Statistics" Display parameters
Specific Information
name

760

Type

Description

unexp-ctrl-msg

<Counter>

unexp-data-pkts

<Counter>

prt-mru-err-cnt

<Counter>

trans-age-out

<Counter>

session-age-out

<Counter>

number of unexpected control messages discarded


This element is always shown.
number of discarded data packets on this port
This element is always shown.
number of long messages discarded on this port
This element is only shown in detail mode.
nbr of events cleared because the transaction timed
out
This element is always shown.
nbr of events timed out for this port
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

61 PPPoX-Relay Status Commands

61.5 PPPoX CC Session Engine Status Command


Command Description
This command shows session data for the engine.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session engine (vlan-id)

Command Parameters
Table 61.5-1 "PPPoX CC Session Engine Status Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

engine identification

Command Output
Table 61.5-2 "PPPoX CC Session Engine Status Command" Display parameters
Specific Information
name
server-mac-addr
ext-session-id
client-port
int-session-id

Type

Description

<Vlan::MacAddr>
length: 6

mac-addr of the PPPoE Server of this PPP


cross-connection
This element is always shown.
<SignedInteger>
PPPoE session id of this PPP cross-connection
This element is always shown.
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ Index to which the PPPoE client is directly
<Eqpt::LtSlot>
/
<Eqpt::Port>
: associated
<Atm::DefaultVpi> : <Atm::DefaultVci> This element is always shown.
<SignedInteger>
index that uniquely indicate a PPP cross-connection
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

761

61 PPPoX-Relay Status Commands

61.6 PPPoX CC Session Client Port Status


Command
Command Description
This command shows session data for the client port.

User Level
The command can be accessed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> show pppox-relay cross-connect session client-port (client-port)

Command Parameters
Table 61.6-1 "PPPoX CC Session Client Port Status Command" Resource Parameters
Resource Identifier
(client-port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ client port identification
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 61.6-2 "PPPoX CC Session Client Port Status Command" Display parameters
Specific Information
name

Type

Description

server-mac-addr

<Vlan::MacAddr>
length: 6

ext-session-id

<SignedInteger>

engine-id

<PPPoX::EngineIndex>
range: [1...255]
<SignedInteger>

mac-addr of the PPPoE server of this PPP


cross-connection
This element is always shown.
PPPoE session id of this PPP cross-connection
This element is always shown.
index to where this PPP cross-connection belongs
This element is always shown.
index that uniquely indicate a PPP cross-connection
This element is always shown.

int-session-id

762

Released

3HH-01016-AAAA-TCZZA

Edition 03

62- OSPF Status Commands

62.1 OSPF Area Status Command


62.2 OSPF LSA Status Command
62.3 OSPF External Link State Status Command
62.4 OSPF Interface Status Command
62.5 OSPF Neighbour Status Command
62.6 OSPF Routing Status Command
62.7 OSPF Statistics
62.8 OSPF Parameter Status Command

3HH-01016-AAAA-TCZZA Edition 03

62-764
62-766
62-767
62-768
62-770
62-772
62-773
62-774

Released

763

62 OSPF Status Commands

62.1 OSPF Area Status Command


Command Description
This command shows the values of the area identifier, spf-runs, number of link state advertisements in the link-state
database, and the link-state-checksum.
This command also shows the number of border routers in the area, number of the AS border router, number of
OSPF interfaces in the area, total number of interfaces in the area, total number of networks in the area, and
number of NSSA translator events in the area.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf area (area-id)

Command Parameters
Table 62.1-1 "OSPF Area Status Command" Resource Parameters
Resource Identifier
(area-id)

Type

Description

<Ip::V4Address>

ospf area identifier

Command Output
Table 62.1-2 "OSPF Area Status Command" Display parameters
Specific Information
name

764

Type

Description

spf-runs

<Counter>

nbr-lsa

<Gauge>

lsa-checksum

<SignedInteger>

area-bdr-rtrs

<Gauge>

as-bdr-rtrs

<Gauge>

nbr-interfaces

<Gauge>

nbr-area-nw

<Gauge>

nssa-events

<Counter>

nbr of times the intra-area route table has been


calculated
This element is always shown.
nbr of lsa in this area's link-state database
This element is always shown.
checksums contained in this area's link-state
database
This element is always shown.
nbr of area border routers in this area
This element is only shown in detail mode.
nbr of autonomous sys border routers in this area
This element is only shown in detail mode.
total number of Interfaces in the area
This element is only shown in detail mode.
total number of networks in the area
This element is only shown in detail mode.
nbr of translator state changes since the last boot-up

Released

3HH-01016-AAAA-TCZZA

Edition 03

62 OSPF Status Commands

name

Type

Description
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

765

62 OSPF Status Commands

62.2 OSPF LSA Status Command


Command Description
This command shows the general information of OSPF link state advertisements based on the interface type.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf link-state-adv link-type (link-type) area-id <Ip::V4Address> router-id
<Ip::V4Address> itf-ip-addr <Ip::V4Address>

Command Parameters
Table 62.2-1 "OSPF LSA Status Command" Resource Parameters
Resource Identifier
(link-type)

area-id
router-id
itf-ip-addr

Type

Description

<Ospf::LinkType>
Possible values are :
- router : router link
- network : network link
- summary : summary link
- asbr-summary : assummary link
- nssa : nssa external link
<Ip::V4Address>
<Ip::V4Address>
<Ip::V4Address>

filter for the ospf database

ospf area identifier


originating router identifier
link state identifier

Command Output
Table 62.2-2 "OSPF LSA Status Command" Display parameters
Specific Information
name

Type

Description

sequence

<Ospf::LsAge>
range: [0...3600] unit: sec
<SignedInteger>

checksum

<SignedInteger>

advertisement

<Ospf::Advtsmnt>
length: 1<=x<65535

age of the link state advertisement in seconds


This element is always shown.
identifies the old and recent advertisements
This element is only shown in detail mode.
checksum of the complete contents of the
advertisement
This element is only shown in detail mode.
entire link state advertisement, including its header
This element is only shown in detail mode.

age

766

Released

3HH-01016-AAAA-TCZZA

Edition 03

62 OSPF Status Commands

62.3 OSPF External Link State Status Command


Command Description
This command shows the values of the OSPF process's link state database.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf link-state-adv asbr-external (itf-ip-addr) router-id <Ip::V4Address>

Command Parameters
Table 62.3-1 "OSPF External Link State Status Command" Resource Parameters
Resource Identifier
(itf-ip-addr)
router-id

Type

Description

<Ip::V4Address>
<Ip::V4Address>

external link state identifier


originating router identifier, a 32 bit number

Command Output
Table 62.3-2 "OSPF External Link State Status Command" Display parameters
Specific Information
name

Type

Description

sequence

<Ospf::LsAge>
range: [0...3600] unit: sec
<SignedInteger>

checksum

<SignedInteger>

advertisement

<Ospf::ExtAdvtsmnt>
length: 1<=x<36

age of the link state advertisement in seconds


This element is always shown.
identifies the old and recent advertisements
This element is only shown in detail mode.
checksum of the complete contents of the
advertisement
This element is only shown in detail mode.
entire link state advertisement, including its header
This element is only shown in detail mode.

age

3HH-01016-AAAA-TCZZA Edition 03

Released

767

62 OSPF Status Commands

62.4 OSPF Interface Status Command


Command Description
This command shows the values of the OSPF interface.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf interface (ip-addr)

Command Parameters
Table 62.4-1 "OSPF Interface Status Command" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

ip address of the interface

Command Output
Table 62.4-2 "OSPF Interface Status Command" Display parameters
Specific Information
name
oper-status

designated-router

Type

Description

<Ospf::OperStatus>
Possible values are :
- operup : operational status up
- operdown : operational status down
- loopback : operational status loopback
- unloop : operational status unloop
<Ip::V4Address>

operational status of the interface


This element is always shown.

bkp-designated-router <Ip::V4Address>

768

events

<Counter>

nbr-neighbors

<Gauge>

nbr-adjacencies

<Gauge>

rx-hello

<Counter>

tx-hello

<Counter>

Released

ip address of the designated router


This element is always shown.
ip address of the backup designated router
This element is only shown in detail mode.
nbr of times this OSPF interface has changed its
state
This element is only shown in detail mode.
total nbr of neighbour's through that Itf
This element is only shown in detail mode.
total nbr of adjacencies through that Itf
This element is only shown in detail mode.
total nbr of Hello pkts received through that Itf
This element is only shown in detail mode.
total nbr of hello pkts transmitted through that Itf
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

62 OSPF Status Commands

name

Type

Description

discard-hello

<Counter>

rx-ddp

<Counter>

tx-ddp

<Counter>

discard-ddp

<Counter>

discard-lrq

<Counter>

rx-lrq

<Counter>

tx-lrq

<Counter>

rx-lsus

<Counter>

tx-lsus

<Counter>

discard-lsus

<Counter>

discard-lak

<Counter>

rx-lak

<Counter>

tx-lak

<Counter>

total nbr of Hello pkts discarded through that Itf


This element is only shown in detail mode.
total nbr of Ddp pkts received through that Itf
This element is only shown in detail mode.
total nbr of Ddp pkts transmitted through that Itf
This element is only shown in detail mode.
total nbr of Ddp pkts discarded through that Itf
This element is only shown in detail mode.
total nbr of Lrq pkts discarded through that Itf
This element is only shown in detail mode.
total nbr of Lrq pkts received through that Itf
This element is only shown in detail mode.
total nbr of Lrq pkts transmitted through that Itf
This element is only shown in detail mode.
total nbr of Lsu pkts received through that Itf
This element is only shown in detail mode.
total nbr of Lsu pkts transmitted through that Itf
This element is only shown in detail mode.
total nbr of Lsu pkts discarded through that Itf
This element is only shown in detail mode.
total nbr of Lak pkts discarded on that Itf
This element is only shown in detail mode.
total nbr of Lak pkts received through that Itf
This element is only shown in detail mode.
total nbr of Lak pkts transmitted through that Itf
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

769

62 OSPF Status Commands

62.5 OSPF Neighbour Status Command


Command Description
This command shows the neighbour information.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf neighbour (ip-address)

Command Parameters
Table 62.5-1 "OSPF Neighbour Status Command" Resource Parameters
Resource Identifier
(ip-address)

Type

Description

<Ip::V4Address>

neighbour ip

Command Output
Table 62.5-2 "OSPF Neighbour Status Command" Display parameters
Specific Information
name

Type

Description

router-id

<Ip::V4Address>

state

<Ospf::NbrState>
Possible values are :
- down : down
- attempt : attempt
- init : init
- two-way : two-way
- exchange-start : exchange-start
- exchange : exchange
- loading : loading
- full : full
<Ospf::NbrPriority>
length: x<255

a 32-bit integer identifying the neighboring router


This element is always shown.
state of the relationship with this neighbor
This element is always shown.

priority

770

retrans-q-len

<Gauge>

options

<SignedInteger>

events

<Counter>

Released

priority of neighbor in designated router election


algorithm
This element is always shown.
current length of the retransmission queue
This element is only shown in detail mode.
bit mask corresponding to the neighbor
This element is only shown in detail mode.
nbr of times this neighbor has changed state
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

62 OSPF Status Commands

name

Type

Description
status of how the neighbor became known
This element is only shown in detail mode.

db-summary-q-len

<Ospf::NbrPermanence>
Possible values are :
- dynamic : dynamic
- permanent : permanent
<Ospf::HelloSuppress>
Possible values are :
- hello-suppressed : set hello-suppressed
value true
no-hello-suppressed
:
set
hello-suppressed false
<Gauge>

ls-req-q-len

<Gauge>

nbma-permanence

hello-suppressed

3HH-01016-AAAA-TCZZA Edition 03

indicates whether hellos are being suppressed to the


neighbor
This element is only shown in detail mode.

que length of the database summary list


This element is only shown in detail mode.
length of link state request que
This element is only shown in detail mode.

Released

771

62 OSPF Status Commands

62.6 OSPF Routing Status Command


Command Description
This command shows information about a single route.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf routing-table (destination) mask <Ip::V4Address> peer <Ip::V4Address>

Command Parameters
Table 62.6-1 "OSPF Routing Status Command" Resource Parameters
Resource Identifier
(destination)
mask
peer

Type

Description

<Ip::V4Address>
<Ip::V4Address>
<Ip::V4Address>

ip address of the route


ip address mask of the route
ip next hop of the route

Command Output
Table 62.6-2 "OSPF Routing Status Command" Display parameters
Specific Information
name

Type

Description

interface

<SignedInteger>

area-id

<Ip::V4Address>

metric

<Ospf::RouteCost>
length: x<16777215

route-type

<Ospf::RouteType>
Possible values are :
- intraarea : intraarea
- interarea : interarea
- type1-external : type1-external
- type2-external : type2-external
<Ospf::RouteCost>
length: x<16777215

interface index associated with the route


This element is always shown.
area id associated with the route
This element is always shown.
type 1 metrics expressed in the same units as OSPF
itf cost
This element is always shown.
type of the route
This element is only shown in detail mode.

type2-metric

772

Released

routing between AS is the major cost of routing a


pkt
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

62 OSPF Status Commands

62.7 OSPF Statistics


Command Description
This command shows various statistics, counts and external link-state advertisement counts

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf statistics

Command Output
Table 62.7-2 "OSPF Statistics" Display parameters
Specific Information
name

Type

Description

nbr-ext-lsa

<Gauge>

tx-new-lsas

<Counter>

rx-new-lsas

<Counter>

tx-pkts

<Counter>

rx-pkts

<Counter>

discard-pkts

<Counter>

nbr of ext link-state advertisements in the link-state


database
This element is always shown.
nbr of new link-state advertisements that have been
originated
This element is always shown.
nbr of link-state advertisements received to be new
instantiations
This element is always shown.
total no. of packets transmitted
This element is always shown.
total no. of packets received
This element is always shown.
total no. of packets discarded
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

773

62 OSPF Status Commands

62.8 OSPF Parameter Status Command


Command Description
This command shows the OSPF parameter status.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show ospf status

Command Output
Table 62.8-2 "OSPF Parameter Status Command" Display parameters
Specific Information
name

Type

Description

router-id

<Ip::V4Address>

version

<Ospf::Version>

area-bdr-rtr-stat

<Ospf::AreaRtrStat>
Possible values are :
- area-bdr-rtr-stat : set area-bdr-rtr-stat
value true
- no-area-bdr-rtr-stat : set area-bdr-rtr-stat
value false
<Ospf::AsRtrStat>
Possible values are :
- as-bdr-rtr-stat : set as-bdr-rtr-stat value
true
- no-as-bdr-rtr-stat : set as-bdr-rtr-stat
value false
<SignedInteger>

a 32-bit integer identifying the router in the


Autonomous Sys
This element is always shown.
current version number of the OSPF protocol is 2
This element is always shown.
indicates whether the router is an area border router
This element is always shown.

as-bdr-rtr-stat

ext-lsa-chcksm
overflow-state

774

<Ospf::OvflwState>
Possible values are :
- overflow-state : set overflow-state value
true
- no-overflow-state : set overflow-state
value false

Released

indicates whether the router is an Autonomous Sys


border router
This element is always shown.

a 32-bit LS checksums of the external link-state


advertisements
This element is always shown.
indicates the router overflow state
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

63- RIP Status Commands

63.1 RIP Statistics


63.2 RIP Peer Status Command
63.3 RIP Routing Status Command
63.4 RIP Global Status Command

3HH-01016-AAAA-TCZZA Edition 03

63-776
63-777
63-778
63-779

Released

775

63 RIP Status Commands

63.1 RIP Statistics


Command Description
This command shows the RIP interface status.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip statistics (ip-addr)

Command Parameters
Table 63.1-1 "RIP Statistics" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

show statistics of a specific IP interface

Command Output
Table 63.1-2 "RIP Statistics" Display parameters
Specific Information
name

776

Type

Description

periodical-update

<Counter>

rx-bad-pkts

<Counter>

rx-bad-routes

<Counter>

updates-sent

<Counter>

total nbr of periodic RIP updates sent on this


interface
This element is always shown.
number of RIP response pkts which were discarded
This element is always shown.
number of routes in valid RIP packets which were
ignored
This element is always shown.
number of triggered RIP updates sent on this
interface
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

63 RIP Status Commands

63.2 RIP Peer Status Command


Command Description
This command shows information about a single routing peer.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip peer (peer-ip-addr)

Command Parameters
Table 63.2-1 "RIP Peer Status Command" Resource Parameters
Resource Identifier
(peer-ip-addr)

Type

Description

<Ip::V4Address>

IP identifying the remote peer

Command Output
Table 63.2-2 "RIP Peer Status Command" Display parameters
Specific Information
name

Type

Description

peer-version

<SignedInteger>

last-updt-rx
rx-bad-pkts

<TimeTicks>
unit: msec
<Counter>

rx-bad-routes

<Counter>

version number in the header of the last RIP packet


This element is always shown.
most recent RIP update received from the system
This element is always shown.
number of RIP response pkts discarded as invalid
This element is always shown.
number of routes that were ignored
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

777

63 RIP Status Commands

63.3 RIP Routing Status Command


Command Description
This command shows a list of routes in the local routing table.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip routing-table (destination)

Command Parameters
Table 63.3-1 "RIP Routing Status Command" Resource Parameters
Resource Identifier
(destination)

Type

Description

<Ip::V4Address>

IP address of the destination network

Command Output
Table 63.3-2 "RIP Routing Status Command" Display parameters
Specific Information
name

778

Type

Description

mask

<Ip::V4Address>

peer

<Ip::V4Address>

gateway

<Ip::V4Address>

vlan-index
short name:vlan-idx
metric

<SignedInteger>

change-time

<SignedInteger>

valid

<SignedInteger>

mask for the destination network


This element is always shown.
nexthop address where datagrams are to be
forwarded
This element is always shown.
gateway address where datagrams are to be
forwarded
This element is always shown.
vlan through which the route is learnt
This element is always shown.
reachability cost for the destination
This element is always shown.
time when the route is installed
This element is only shown in detail mode.
row status for particular route entry
This element is only shown in detail mode.

<SignedInteger>

Released

3HH-01016-AAAA-TCZZA

Edition 03

63 RIP Status Commands

63.4 RIP Global Status Command


Command Description
This command shows information regarding the sum of all the interface related counter.

User Level
The command can be accessed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> show rip global

Command Output
Table 63.4-2 "RIP Global Status Command" Display parameters
Specific Information
name

Type

Description

periodic-updates

<Counter>

dropped-pkts

<Counter>

route-change

<Counter>

global-queries

<Counter>

total nbr of periodic RIP updates sent from this


router
This element is always shown.
number of packets dropped
This element is always shown.
number of routes changed
This element is always shown.
number of responses sent to RIP queries
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

779

64- Security Status Commands

64.1 Operator Information Status Command


64.2 Domain Status Command
64.3 User Sessions Status Command
64.4 Connection Profile Status Command
64.5 Local IP Pool Status Command
64.6 IP Address Status Command
64.7 RADIUS Authentication Server Statistics
64.8 RADIUS Authenticating Server Status Command
64.9 RADIUS Accounting Server Statistics
64.10 RADIUS Accounting Server Status Command
64.11 RADIUS Dynamic Authentication Client Status
Command
64.12 RADIUS Next Available Index
64.13 RADIUS Client Status Command
64.14 PAE Authenticator Status Command
64.15 EAPOL Statistics
64.16 Diagnostic Information Status Command
64.17 Session Statistics
64.18 PAE Port System Status Command
64.19 Mac-address Related Eapol Status Command

780

Released

64-781
64-782
64-783
64-785
64-786
64-787
64-788
64-790
64-791
64-793
64-794
64-796
64-797
64-798
64-800
64-802
64-805
64-807
64-808

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.1 Operator Information Status Command


Command Description
This command shows information about operators.

User Level
The command can be accessed by operators with all,forAdmin privileges.
Operators without security read or write permissions can never see the information about other operators.

Command Syntax
The command has the following syntax:
> show security operator (name)

Command Parameters
Table 64.1-1 "Operator Information Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Sec::OperatorName>
range: [a-z0-9]length: 1<=x<11

the name of the operator

Command Output
Table 64.1-2 "Operator Information Status Command" Display parameters
Specific Information
name
last-login
last-failed
failed-logins
last-passwd-change

Type

Description

<Sys::Time>
unit: UTC
<Sys::Time>
unit: UTC
<UnsignedInteger>

the time of the last successfull login


This element is always shown.
the time of the last unsuccessfull login attempt
This element is always shown.
the number of unsuccessfull login attempts since
the last successfull login
This element is always shown.
the time the password was changed for the last
time. It does not matter if the change was made by
this operator itself or by another operator.
This element is always shown.

<Sys::Time>
unit: UTC

3HH-01016-AAAA-TCZZA Edition 03

Released

781

64 Security Status Commands

64.2 Domain Status Command


Command Description
This command shows the domain status.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa domain (name)

Command Parameters
Table 64.2-1 "Domain Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<Aaa::DomainName>
length: 6<=x<64

name of the domain

Command Output
Table 64.2-2 "Domain Status Command" Display parameters
Specific Information
name
active-sessions

782

Type

Description

<Gauge>

the number of active sessions


This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.3 User Sessions Status Command


Command Description
This command shows the details of the user sessions.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa user-session (index) user <Aaa::DisplayString> domain
<Aaa::DisplayString>

Command Parameters
Table 64.3-1 "User Sessions Status Command" Resource Parameters
Resource Identifier
(index)
user
domain

Type

Description

<SignedInteger>
<Aaa::DisplayString>
length: 6<=x<64
<Aaa::DisplayString>
length: 6<=x<64

index to the domain user session table


user name
domain name

Command Output
Table 64.3-2 "User Sessions Status Command" Display parameters
Specific Information
name
interface

Type

Description

xdsl-line : <Eqpt::Rack> / <Eqpt::Shelf> / the interface on which the session is established.


<Eqpt::LtSlot> / <Eqpt::Port> | slip : This element is only shown in detail mode.
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> | ethernet : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::NtSlot>
:
<Itf::EthernetId>
|
pppoeses
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVci>
:
<PPPoE::LogicalSesId> | atm-bonding :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
|
xdsl-channel
:
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-if : <Eqpt::Rack> /

3HH-01016-AAAA-TCZZA Edition 03

Released

783

64 Security Status Commands

name

protocol

auth-type
auth-server
acc-server
accounting-id

vrf-index
ip-pool-index
ip-addr

784

Type
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> | atm-pvc : <Eqpt::Rack> /
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port> : <Atm::DefaultVpi> :
<Atm::DefaultVci> | bridge-port :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
pppoe : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci> |
l2-vlan : <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::NtSlot> : <Vlan::VlanIndex> | ip :
<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::NtSlot> : <Ip::LogicalId> |
sw-loopback
:
<Eqpt::Rack>
/
<Eqpt::Shelf> / <Eqpt::NtSlot>
<Aaa::Protocol>
Possible values are :
- ppp : ppp used to establish user sess
- dot1x : dot1x used to establish user sess
local | radius : <Aaa::RadPolicyName>

Description

the protocol at user side that was used to establish


this user session
This element is only shown in detail mode.

the Authentication type used for establishing this


user session
This element is only shown in detail mode.
none
|
name
: the name of the radius authentication server used
<Aaa::RadAuthServerName>
for this user session
This element is only shown in detail mode.
none | name : <Aaa::RadAccServerName> the name of the radius accounting server used for
this user session
This element is only shown in detail mode.
<Aaa::DisplayString>
the accounting id that is sent to the radius
length: 6<=x<64
accounting server for this user session. It will be
NULL in case of no accounting.
This element is only shown in detail mode.
<Aaa::VrfIndex>
the vrf to which the ip-address of this user session
range: [0...127]
belongs to
This element is only shown in detail mode.
<Aaa::DomainUserSessIpAddrPoolIndex> the ip-pool that was used to allocate an ip-address
range: [0...256]
to the user session
This element is only shown in detail mode.
<Ip::V4Address>
the IpAddress allocated to the user session
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.4 Connection Profile Status Command


Command Description
This command shows the status of connection profiles.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security aaa conn-profile (name)

Command Parameters
Table 64.4-1 "Connection Profile Status Command" Resource Parameters
Resource Identifier
(name)

Type

Description

<AsamProfileName>
range: [a-zA-Z0-9-_]length: 1<=x<32

name of connection profile

Command Output
Table 64.4-2 "Connection Profile Status Command" Display parameters
Specific Information
name

Type

Description

number-of-users

<AsamProfileRefCount>
range: [0...65535]

index

<AsamProfileIndex>
range: [1...65535]

The number of entities using this profile. The


profile can only be deleted when this number is 0.
This element is always shown.
connection profile index
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

785

64 Security Status Commands

64.5 Local IP Pool Status Command


Command Description
This command displays the status of the local IP address pool management.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security ip-addr-pool (name) vrf-index <Aaa::VrfIndex> ip-pool-status (ip-addr)

Command Parameters
Table 64.5-1 "Local IP Pool Status Command" Resource Parameters
Resource Identifier
(name)
vrf-index
(ip-addr)

Type

Description

<Aaa::IpPoolName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]
<Ip::V4Address>

name of the IP pool


vrf associated with this pool
ip pool address

Command Output
Table 64.5-2 "Local IP Pool Status Command" Display parameters
Specific Information
name
status

786

Type

Description

<Aaa::IpPoolStatus>
Possible values are :
- allocated :
- locally-reserved :
- remotely-reserved :

Specifies the status of the specified IP address


whether allocated or reserved(locally or remotely).
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.6 IP Address Status Command


Command Description
This command displays the IP address pool parameters.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security ip-addr-pool (name) vrf-index <Aaa::VrfIndex> number-addr

Command Parameters
Table 64.6-1 "IP Address Status Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::IpPoolName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the IP pool


vrf associated with this pool

Command Output
Table 64.6-2 "IP Address Status Command" Display parameters
Specific Information
name

Type

Description

free

<Gauge>

reserved

<Gauge>

allocated

<Gauge>

The number of IpAddresses that are still free and


can be used for allocation.
This element is always shown.
The number of IpAddresses that are reserved
(either locally or remotely) and cannot be used for
allocation.
This element is always shown.
The number of IpAddresses that are allocated to
existing user sessions.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

787

64 Security Status Commands

64.7 RADIUS Authentication Server Statistics


Command Description
This command displays the details of RADIUS authentication server statistics.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius auth-server auth-stats (name) vrf-index <Aaa::VrfIndex>

Command Parameters
Table 64.7-1 "RADIUS Authentication Server Statistics" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAuthServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of RADIUS authentication server


vrf to which this auth server belongs

Command Output
Table 64.7-2 "RADIUS Authentication Server Statistics" Display parameters
Specific Information
name

788

Type

Description

rndtrp-time

<TimeTicks>
unit: msec

num-access-req

<Counter>

num-access-retrn

<Counter>

num-access-acpts

<Counter>

num-access-rej

<Counter>

The time interval between the most recent


Access-Reply/Access-Challenge
and
the
Access-Request that matched it from this RADIUS
authentication server.
This element is always shown.
The number of RADIUS Access-Request packets
sent to this server. This does not include
retransmissions.
This element is always shown.
The number of RADIUS Access-Request packets
retransmitted to this RADIUS authentication
server.
This element is always shown.
The number of RADIUS Access-Accept packets
(valid or invalid) received from this server.
This element is always shown.
The number of RADIUS Access-Reject packets
(valid or invalid) received from this server.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

name

Type

num-access-challenges <Counter>
num-malf-access-resp <Counter>

num-bad-authenticators <Counter>

num-pending-req

<Gauge>

num-timeouts

<Counter>

num-unknown

<Counter>

num-packets-dropped

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
This element is always shown.
The number of RADIUS Access-Challenge packets
(valid or invalid) received from this server.
This element is only shown in detail mode.
The
number
of
malformed
RADIUS
Access-Response packets received from this server.
Malformed packets include packets with an invalid
length, Bad authenticators or Signature attributes or
unknown types are not included as malformed
access responses.
This element is only shown in detail mode.
The number of RADIUS Access-Response packets
containing invalid authenticators or signature
received from this server.
This element is only shown in detail mode.
The number of RADIUS Access-Request packets
destined for this server that have not yet timed out
or received a response.
This element is only shown in detail mode.
The number of authentication timeouts to this
server.
This element is only shown in detail mode.
The number of RADIUS packets of unknown type
which were received from this server on the
authentication port.
This element is only shown in detail mode.
The number of RADIUS packets of which were
received from this server on the authentication port
and dropped.
This element is only shown in detail mode.

Released

789

64 Security Status Commands

64.8 RADIUS Authenticating Server Status


Command
Command Description
This command shows the state of the RADIUS authentication server.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius auth-server state (name) vrf-index <Aaa::VrfIndex>

Command Parameters
Table 64.8-1 "RADIUS Authenticating Server Status Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAuthServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of RADIUS authentication server


vrf to which this auth server belongs

Command Output
Table 64.8-2 "RADIUS Authenticating Server Status Command" Display parameters
Specific Information
name
auth-state

790

Type

Description

<Aaa::OperState>
Possible values are :
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown

The operational state of the authentication server.


This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.9 RADIUS Accounting Server Statistics


Command Description
This command displays the statistics of the RADIUS accounting server.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius acc-server acc-stats (name) vrf-index <Aaa::VrfIndex>

Command Parameters
Table 64.9-1 "RADIUS Accounting Server Statistics" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAccServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the RADIUS accounting server


vrf to which the RADIUS Acc Server belongs

Command Output
Table 64.9-2 "RADIUS Accounting Server Statistics" Display parameters
Specific Information
name

Type

Description

rndtrip-time

<TimeTicks>
unit: msec

num-acc-req

<Counter>

num-req-retrans

<Counter>

num-resp

<Counter>

num-malf-resp

<Counter>

The time interval between the most recent


accounting-response and the accounting-request
that matched it from this RADIUS accounting
server.
This element is always shown.
The number of RADIUS accounting-request
packets sent. This does not include retransmissions.
This element is always shown.
The number of RADIUS accounting-request
packets retransmitted to this RADIUS accounting
server. Retransmissions include retries where the
identifier and acct-delay have been updated, as well
as those in which they remain the same.
This element is always shown.
The number of RADIUS packets received on the
accounting port from this server.
This element is always shown.
The
number
of
malformed
RADIUS

3HH-01016-AAAA-TCZZA Edition 03

Released

791

64 Security Status Commands

name

Type

num-bad-authenticators <Counter>

792

num-pending-reqts

<Gauge>

num-timeouts

<Counter>

num-unknown

<Counter>

num-packets-dropped

<Counter>

Released

Description
accounting-response packets received from this
server. Malformed packets include packets with an
invalid length. Bad authenticators and unknown
types are not included as malformed accounting
responses.
This element is only shown in detail mode.
The number of RADIUS accounting-response
packets which contained invalid authenticators
received from this server.
This element is only shown in detail mode.
The number of RADIUS accounting-request
packets sent to this server that have not yet timed
out or received a response.
This element is always shown.
The number of accounting timeouts to this server.
This element is only shown in detail mode.
The number of RADIUS packets of unknown type
which were received from this server on the
accounting port.
This element is only shown in detail mode.
The number of RADIUS packets which were
received from this server on the accounting port
and dropped.
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.10 RADIUS Accounting Server Status Command


Command Description
This command shows the state of the RADIUS accounting server.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius acc-server acc-server-state (name) vrf-index <Aaa::VrfIndex>

Command Parameters
Table 64.10-1 "RADIUS Accounting Server Status Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadAccServerName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the RADIUS accounting server


vrf to which the RADIUS Acc Server belongs

Command Output
Table 64.10-2 "RADIUS Accounting Server Status Command" Display parameters
Specific Information
name
acc-state

Type

Description

<Aaa::OperState>
Possible values are :
- up : Operational state up
- down : Operational state down
- unknown : Operational state unknown

Specifies the operational state of the accounting


server.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

793

64 Security Status Commands

64.11 RADIUS Dynamic Authentication Client


Status Command
Command Description
This command displays the statistics of the RADIUS Dynamic Authentication Client.
The conceptual table lists the statistics of the RADIUS Dynamic Authorization Clients with which the server shares
a secret.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius dyn-authclient-stats (name) vrf-index <Aaa::VrfIndex>

Command Parameters
Table 64.11-1 "RADIUS Dynamic Authentication Client Status Command" Resource Parameters
Resource Identifier
(name)
vrf-index

Type

Description

<Aaa::RadDynAuthClientName>
length: 1<=x<64
<Aaa::VrfIndex>
range: [0...127]

name of the RADIUS Dynamic Authorization


client
vrf to which the RADIUS Dyn Auth Client belongs

Command Output
Table 64.11-2 "RADIUS Dynamic Authentication Client Status Command" Display parameters
Specific Information
name

Type

Description

num-disconnect-reqs

<Counter>

num-disconnect-acks

<Counter>

num-access-naks

<Counter>

The number of RADIUS Disconnect-Request


packets recieved from this Dynamic Authorization
Client.
This element is always shown.
The number of RADIUS Disconnect-ACK packets
sent to this Dynamic Authorization Client.
This element is always shown.
The number of RADIUS Disconnect-NAK packets
sent to this Dynamic Authorization Client.
This element is always shown.
The
number
of
malformed
RADIUS
Disconnect-Request packets received from this
Dynamic Authorization client. Bad authenticators

num-malf-disconn-req <Counter>

794

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

name

num-bad-auth-in-req

Type

<Counter>

num-disconn-pkts-drop <Counter>

num-pkts-unknown-type<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
and unknown types are not included as malformed
Disconnect-Requests. Malformed packets include
packets with an invalid length.
This element is only shown in detail mode.
The number of RADIUS Disconnect-Request
packets which contained invalid Signature
attributes
received
from
this
Dynamic
Authorization Client.
This element is only shown in detail mode.
The number of incoming Disconnect-Requests
from this Dynamic Authorization Client silently
discarded for some reason other than malformed,
bad authenticators or unknown types.
This element is only shown in detail mode.
The number of incoming packets of unknown types
which were received on the Dynamic Authorization
port.
This element is only shown in detail mode.

Released

795

64 Security Status Commands

64.12 RADIUS Next Available Index


Command Description
This command shows the next available index.
The index is used to uniquely identify an entry in this table. The next-free-index shows the unique number within a
RADIUS policy that can be used to create a new entry in the RADIUS server. The value 0 indicates that no
unassigned entries are available. To obtain the RADIUS server index value for a new entry, the manager issues a
management protocol retrieval operation to obtain the current value of this object. After each retrieval, the agent
modifies the value to the next unassigned index.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius next-free-index (name)

Command Parameters
Table 64.12-1 "RADIUS Next Available Index" Resource Parameters
Resource Identifier
(name)

Type

Description

<Aaa::RadPolicyName>
length: 1<=x<64

name of the RADIUS policy

Command Output
Table 64.12-2 "RADIUS Next Available Index" Display parameters
Specific Information
name
next-free-index

796

Type

Description

<Aaa::RadServerSetNextFreeIndex>
range: [0...2]

A unique number within a radius policy that can be


used for creating a new radus server set.
This element is always shown.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.13 RADIUS Client Status Command


Command Description
This command shows the RADIUS client parameters.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security radius radius-client

Command Output
Table 64.13-2 "RADIUS Client Status Command" Display parameters
Specific Information
name
auth-invl-server-addr
acc-invl-server-addr
dynauth-ser-inv-addr
acc-ser-get-nxt-idx

dyn-auth-get-nxt-idx

Type

Description

<Counter>

The number of RADIUS Access-Response packets


received from unknown addresses.
This element is always shown.
<Counter>
The number of RADIUS Accounting-Response
packets received from unknown addresses.
This element is always shown.
<Counter>
The number of RADIUS Disconnect-Request
packets received from unknown addresses.
This element is always shown.
<Aaa::RadAccServerGetNextFreeIndex> The next free index value that can be used for
range: [0...256]
creating a new entry in the radius accounting
server.
This element is always shown.
<Aaa::RadDynAuthClentGetNextFreeIndex>The next free index value that can be used for
range: [0...256]
creating a new entry in the radius dyn auth client.
This element is always shown.

3HH-01016-AAAA-TCZZA Edition 03

Released

797

64 Security Status Commands

64.14 PAE Authenticator Status Command


Command Description
This command shows the details of authentication configuration.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae authenticator (port)

Command Parameters
Table 64.14-1 "PAE Authenticator Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of the bridge port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 64.14-2 "PAE Authenticator Status Command" Display parameters
Specific Information
name
auth-pae-state

auth-backend-state

798

Type

Description

<Aaa::AuthPaeState>
Possible values are :
- initialize :
- disconnected :
- connecting :
- authenticating :
- authenticated :
- aborting :
- held :
- force-auth :
- force-unauth :
<Aaa::AuthBackendState>
Possible values are :
- request :
- response :
- success :
- fail :
- timeout :
- idle :

the current state of the authenticator PAE state


machine
This element is always shown.

Released

the current state of the backend authentication state


machine
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

name

Type

admin-contr-direct

- initialize :
<Aaa::PaeControlledDirections>

oper-contr-direct

<Aaa::PaeControlledDirections>

port-status

<Aaa::PaeControlledPortStatus>
Possible values are :
- authorized :
- unauthorized :
<SignedInteger>

re-auth-period
re-auth-enabled

key-tx-enabled

<Aaa::TruthValue>
Possible values are :
- true :
- false :
<Aaa::TruthValue>
Possible values are :
- true :
- false :

3HH-01016-AAAA-TCZZA Edition 03

Description
describes which directions for the port are
configured to be controlled
This element is only shown in detail mode.
describes which directions for the port are currently
be controlled
This element is only shown in detail mode.
the current port status
This element is always shown.
the actual re-authentication period
This element is only shown in detail mode.
true if re-authentication is enabled
This element is only shown in detail mode.
true if key transmission is enabled
This element is only shown in detail mode.

Released

799

64 Security Status Commands

64.15 EAPOL Statistics


Command Description
This command shows the EAPOL statistics.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae eapol-stats (port)

Command Parameters
Table 64.15-1 "EAPOL Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 64.15-2 "EAPOL Statistics" Display parameters
Specific Information
name

800

Type

Description

rx-frames

<Counter>

tx-frames

<Counter>

starts

<Counter>

logoffs

<Counter>

rx-response-ids

<Counter>

rx-responses

<Counter>

the number of valid EAPOL frames of any type that


have been received by this Authenticator
This element is always shown.
the number of EAPOL frames of any type that have
been transmitted by this Authenticator
This element is always shown.
the number of EAPOL Start frames that have been
received by this Authenticator
This element is always shown.
the number of EAPOL Logoff frames that have
been received by this Authenticator
This element is always shown.
the number of EAP Resp/Id frames that have been
received by this Authenticator
This element is only shown in detail mode.
number of valid EAP Response frames (other than
Resp/Id frames) that have been received by this
Authenticator
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

name

Type

Description

tx-request-ids

<Counter>

tx-requests

<Counter>

invalid-frames

<Counter>

inv-length-frames

<Counter>

last-eap-version

<SignedInteger>

last-src-mac

<Vlan::MacAddr>
length: 6

the number of EAP Req/Id frames that have been


transmitted by this Authenticator
This element is only shown in detail mode.
the number of EAP Request frames (other than
Rq/Id frames) that have been transmitted by this
Authenticator
This element is only shown in detail mode.
the number of EAPOL frames that have been
received by this Authenticator in which the frame
type is not recognized
This element is always shown.
the number of EAPOL frames that have been
received by this Authenticator in which the Packet
Body Length field is invalid
This element is only shown in detail mode.
the protocol version number carried in the most
recently received EAPOL frame
This element is only shown in detail mode.
the source MAC address carried in the most
recently received EAPOL frame
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA Edition 03

Released

801

64 Security Status Commands

64.16 Diagnostic Information Status Command


Command Description
This command shows the diagnostic information.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae diagnostics (port)

Command Parameters
Table 64.16-1 "Diagnostic Information Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of the bridge port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 64.16-2 "Diagnostic Information Status Command" Display parameters
Specific Information
name

802

Type

Description

to-connecting-cnt

<Counter>

log-off-cnt

<Counter>

authenticating-cnt

<Counter>

authenticated-cnt

<Counter>

the number of times that the state machine


transitions to the CONNECTING state from any
other state
This element is always shown.
the number of times that the state machine
transitions
from
CONNECTING
to
DISCONNECTED as a result of receiving an
EAPOL-Logoff message
This element is always shown.
the number of times that the state machine
transitions
from
CONNECTING
to
AUTHENTICATING, as a result of an
EAP-Response/Identity message being received
from the Supplicant
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATING
to
AUTHENTICATED, as a result of the Backend
Authentication state machine indicating successful

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

name

Type

timeout-cnt

<Counter>

failed-cnt

<Counter>

re-authenticating-cnt

<Counter>

eap-start-cnt

<Counter>

eap-logoff-cnt

<Counter>

re-authenticated-cnt

<Counter>

eap-connecting-cnt

<Counter>

eap-logoff-cnt

<Counter>

access-req-cnt

<Counter>

access-challenge-cnt

<Counter>

3HH-01016-AAAA-TCZZA Edition 03

Description
authentication of the Supplicant (authSuccess =
TRUE)
This element is always shown.
the number of times that the state machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of the Backend
Authentication
state
machine
indicating
authentication timeout (authTimeout = TRUE)
This element is always shown.
the number of times that the state machine
transitions from AUTHENTICATING to HELD, as
a result of the Backend Authentication state
machine indicating authentication failure (authFail
= TRUE)
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of a reauthentication
request (reAuthenticate = TRUE)
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of an EAPOL-Start
message being received from the Supplicant
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATING
to
ABORTING, as a result of an EAPOL-Logoff
message being received from the Supplicant
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATED
to
CONNECTING, as a result of a reauthentication
request (reAuthenticate = TRUE)
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATED
to
CONNECTING, as a result of an EAPOL-Start
message being received from the Supplicant
This element is only shown in detail mode.
the number of times that the state machine
transitions
from
AUTHENTICATED
to
DISCONNECTED,
as
a
result
of
an
EAPOL-Logoff message being received from the
Supplicant
This element is only shown in detail mode.
the number of times that the state machine sends an
initial Access-Request packet to the Authentication
server
This element is only shown in detail mode.
the number of times that the state machine receives
an initial Access-Challenge packet from the
Authentication server (i.e., aReq becomes TRUE,
causing exit from the RESPONSE state). This
indicates that the Authentication Server has
communication with the Authenticator
This element is only shown in detail mode.

Released

803

64 Security Status Commands

name

804

Type

Description

eap-req-cnt

<Counter>

resp-non-eap-nak-cnt

<Counter>

eap-success-cnt

<Counter>

num-eap-failure

<Counter>

the number of times that the state machine sends an


EAP-Request packet (other than an Identity,
Notification, Failure or Success message) to the
Supplicant (i.e., executes txReq on entry to the
REQUEST state). This indicates that the
Authenticator chose an EAP-method.
This element is only shown in detail mode.
the number of times that the state machine receives
a response from the Supplicant to an initial
EAP-Request, and the response is something other
than EAP-NAK (i.e., rxResp becomes TRUE,
causing the state machine to transition from
REQUEST to RESPONSE, and the response is not
an EAP-NAK). This indicates that the Supplicant
can respond to the Authenticator's chosen
EAP-method
This element is only shown in detail mode.
the number of times that the state machine receives
an EAP-Success message from the Authentication
Server (i.e., aSuccess becomes TRUE, causing a
transition from RESPONSE to SUCCESS). This
indicates that the Supplicant has successfully
authenticated to the Authentication Server
This element is only shown in detail mode.
the number of times that the state machine receives
an EAP-Failure message from the Authentication
Server (i.e., aFail becomes TRUE, causing a
transition from RESPONSE to FAIL). This
indicates that the Supplicant has not authenticated
to the Authentication Server.
This element is only shown in detail mode.

Released

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.17 Session Statistics


Command Description
This command shows the statistics for the sessions.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae session-stats (port)

Command Parameters
Table 64.17-1 "Session Statistics" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of the bridge port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 64.17-2 "Session Statistics" Display parameters
Specific Information
name

Type

Description

rx-octets

<Counter>

tx-octets

<Counter>

rx-user-frames

<Counter>

tx-user-frames

<Counter>

ses-id

<Vlan::AdminString>
length: x<32
<Aaa::AuthenticMethod>
Possible values are :
- remote-auth-server :
- local-auth-server :
<TimeTicks>

the number of octets transmitted in user data frames


on this port during the session
This element is always shown.
the number of octets transmitted in user data frames
on this port during the session
This element is always shown.
the number of user data frames received on this
port during the session
This element is always shown.
the number of user data frames transmitted on this
port during the session
This element is always shown.
a unique identifier for the session
This element is only shown in detail mode.
the authentication method used to establish the
session
This element is only shown in detail mode.

auth-method

ses-time

3HH-01016-AAAA-TCZZA Edition 03

the duration of the session

Released

805

64 Security Status Commands

name
term-cause

user-name

806

Type

Description

unit: msec
<Aaa::TerminateCause>
Possible values are :
- supplicant-logoff :
- port-failure :
- supplicant-restart :
- reauth-failed :
- auth-cntr-forceunauth :
- port-reinit :
- port-admin-disabled :
- not-terminated-yet :
<Vlan::AdminString>
length: x<32

This element is always shown.


reason for the session termination
This element is only shown in detail mode.

Released

the name representing the identity of the Supplicant


PAE
This element is only shown in detail mode.

3HH-01016-AAAA-TCZZA

Edition 03

64 Security Status Commands

64.18 PAE Port System Status Command


Command Description
This command shows the PAE port-related system parameters.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae port-details (port)

Command Parameters
Table 64.18-1 "PAE Port System Status Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Command Output
Table 64.18-2 "PAE Port System Status Command" Display parameters
Specific Information
name

Type

Description

prot-ver

<SignedInteger>

capabilities

<Aaa::Capabilities>
Possible values are :
- auth-capable :
- supp-capable :
<Aaa::TruthValue>
Possible values are :
- true :
- false :

The protocol version associated with this Port.


This element is always shown.
Indicates the PAE functionality that this Port
supports
This element is always shown.

reauth

3HH-01016-AAAA-TCZZA Edition 03

Specifies currently in use by the Authenticator PAE


state machine.
This element is always shown.

Released

807

64 Security Status Commands

64.19 Mac-address Related Eapol Status Command


Command Description
This command shows the EAPOL data for each MAC address.

User Level
The command can be accessed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> show security pae mac-address (last-src-mac)

Command Parameters
Table 64.19-1 "Mac-address Related Eapol Status Command" Resource Parameters
Resource Identifier
(last-src-mac)

Type

Description

<Vlan::MacAddr>
length: 6

the source MAC address carried in the most


recently received EAPOL frame

Command Output
Table 64.19-2 "Mac-address Related Eapol Status Command" Display parameters
Specific Information
name
port
user-name
port-status

808

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>
<Vlan::AdminString>
length: x<32

the port identification


This element is always shown.

<Aaa::PaeControlledPortStatus>
Possible values are :
- authorized :
- unauthorized :

Released

the name representing the identity of the Supplicant


PAE
This element is only shown in detail mode.
the current port status
This element is always shown.

3HH-01016-AAAA-TCZZA

Edition 03

65- Alarm Management Commands

65.1 Alarm Management Command


65.2 Snap Shot Management Command
65.3 SHub Snap Shot Management Command
65.4 Alarm Delta Log Management Command
65.5 Log Management Command

3HH-01016-AAAA-TCZZA Edition 03

65-810
65-811
65-812
65-813
65-814

Released

809

65 Alarm Management Commands

65.1 Alarm Management Command


Command Description
This command allows the operator to manage the alarms.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm [(clr-logging) ][(clr-persist-loss) ]

Command Parameters
Table 65.1-2 "Alarm Management Command" Command Parameters
Parameter

810

Type

Description

(clr-logging)

<Alarm::AlarmReset>

(clr-persist-loss)

<Alarm::ClearLossPersistent>

optional parameter
clear log table - logging will start from index 1
optional parameter
clear the loss of persistent data alarm

Released

3HH-01016-AAAA-TCZZA

Edition 03

65 Alarm Management Commands

65.2 Snap Shot Management Command


Command Description
This command allows the operator to create a snap shot for a particular severity level.
The owner-id can be read by other users to see who has made the snap shot.
This command will fail if the snap shot is already in use. The snap shot is only kept for a limited time and will be
automatically cleared.
The snap shot is displayed with the show alarm shub snapshot command.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm snap-shot [(start) ]

Command Parameters
Table 65.2-2 "Snap Shot Management Command" Command Parameters
Parameter
(start)

Type

Description

start : [indeterminate | warning | minor | optional parameter


major | critical | <SignedInteger>] : start or stop the snap shot
<Alarm::alarmSnapShotOwner> | stop

3HH-01016-AAAA-TCZZA Edition 03

Released

811

65 Alarm Management Commands

65.3 SHub Snap Shot Management Command


Command Description
This command creates a snap shot for a particular severity level.
The command will fail if the snap shot is already in use. The snap shot is only kept for a limited time and is
automatically cleared.
The snap shot is displayed with the show alarm shub snapshot command.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm shub snap-shot [(start) ]

Command Parameters
Table 65.3-2 "SHub Snap Shot Management Command" Command Parameters
Parameter
(start)

812

Type

Description

start : [indeterminate | warning | minor | optional parameter


major | critical | <SignedInteger>] : start or stop the snap shot
<Alarm::alarmSnapShotOwner> | stop

Released

3HH-01016-AAAA-TCZZA

Edition 03

65 Alarm Management Commands

65.4 Alarm Delta Log Management Command


Command Description
This command allows the operator to manage the alarm delta logs.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm delta-log [(clr-indeterminate) ][(clr-warning) ][(clr-minor)
][(clr-major) ][(clr-critical) ]

Command Parameters
Table 65.4-2 "Alarm Delta Log Management Command" Command Parameters
Parameter

Type

Description

(clr-indeterminate)

<Alarm::IndetrLogAlarmResetType>

(clr-warning)

<Alarm::WarnLogAlarmResetType>

(clr-minor)

<Alarm::MinorLogAlarmResetType>

(clr-major)

<Alarm::MajorLogAlarmResetType>

(clr-critical)

<Alarm::CriticalLogAlarmResetType>

optional parameter
clear indeterminate delta-log table - set index to 1
optional parameter
clear warning delta-log table - set index to 1
optional parameter
clear minor delta-log table - set index to 1
optional parameter
clear major delta-log table - set index to 1
optional parameter
clear critical delta-log table - set index to 1

3HH-01016-AAAA-TCZZA Edition 03

Released

813

65 Alarm Management Commands

65.5 Log Management Command


Command Description
This command allows the operator to manage the logs.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin alarm log [(clr-error-log) ][(clr-set-log-table) ]

Command Parameters
Table 65.5-2 "Log Management Command" Command Parameters
Parameter

814

Type

Description

(clr-error-log)

<Error::errorResetType>

(clr-set-log-table)

<Trans::setLogTableReset>

optional parameter
clear the error log : index starts from 1
optional parameter
clear the set log table : index starts from 1

Released

3HH-01016-AAAA-TCZZA

Edition 03

66- ATM Management Commands

66.1 ATM Port Management Command

3HH-01016-AAAA-TCZZA Edition 03

66-816

Released

815

66 ATM Management Commands

66.1 ATM Port Management Command


Command Description
This command configures ATM port management. A f5 loopback end-to-end test can be started by giving the
parameter f5-loopback-ete a value of start.
The result of this test is displayed with the info command.

User Level
The command can be accessed by operators with atm privileges, and executed by operators with atm privileges.

Command Syntax
The command has the following syntax:
> admin atm port (port) [f5-loopback-ete start | not-started | in-progress |
not-supported | unable-to-run | aborted | failed | round-trip-delay =
<UnsignedInteger> ]

Command Parameters
Table 66.1-1 "ATM Port Management Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the port under test
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 66.1-2 "ATM Port Management Command" Command Parameters


Parameter
f5-loopback-ete

816

Type

Description

start | not-started | in-progress | optional parameter


not-supported | unable-to-run | aborted | the f5 end-to-end loopback test
failed
|
round-trip-delay
=
<UnsignedInteger>

Released

3HH-01016-AAAA-TCZZA

Edition 03

67- IGMP Management Commands

67.1 IGMP Management Command


67.2 IGMP Multicast Sources Management Command
67.3 IGMP Slot Management Command
67.4 IGMP Channel Management Command

3HH-01016-AAAA-TCZZA Edition 03

67-818
67-819
67-820
67-821

Released

817

67 IGMP Management Commands

67.1 IGMP Management Command


Command Description
This command allows the operator to manage IGMP.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin igmp [(clear-all-stats) ]

Command Parameters
Table 67.1-2 "IGMP Management Command" Command Parameters
Parameter
(clear-all-stats)

818

Type

Description

<Igmp::igmpClearAllStatus>

optional parameter
clears all statistics

Released

3HH-01016-AAAA-TCZZA

Edition 03

67 IGMP Management Commands

67.2 IGMP Multicast Sources Management


Command
Command Description
This command allows the operator to manage the IGMP multicast sources.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp mcast-src (slot-index) address <MulticastAddress> [(clear-statistics) ]

Command Parameters
Table 67.2-1 "IGMP Multicast Sources Management Command" Resource Parameters
Resource Identifier
(slot-index)

address

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identify an IGMP module by the logical SlotId
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]
<MulticastAddress>
mcast src address in network-byte order
(big-endian)

Table 67.2-2 "IGMP Multicast Sources Management Command" Command Parameters


Parameter
(clear-statistics)

Type

Description

<Igmp::igmpClearStatus>

optional parameter
clear the statistics

3HH-01016-AAAA-TCZZA Edition 03

Released

819

67 IGMP Management Commands

67.3 IGMP Slot Management Command


Command Description
This command allows the operator to manage IGMP related to a slot.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp module (slot-index) [(clear-statistics) ]

Command Parameters
Table 67.3-1 "IGMP Slot Management Command" Resource Parameters
Resource Identifier
(slot-index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identify an IGMP module by the logical slot id
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Table 67.3-2 "IGMP Slot Management Command" Command Parameters


Parameter
(clear-statistics)

820

Type

Description

<Igmp::igmpClearStatus>

optional parameter
clear the statistics

Released

3HH-01016-AAAA-TCZZA

Edition 03

67 IGMP Management Commands

67.4 IGMP Channel Management Command


Command Description
This command allows the operator to manage IGMP related to a channel.

User Level
The command can be accessed by operators with igmp privileges, and executed by operators with igmp privileges.

Command Syntax
The command has the following syntax:
> admin igmp channel (port) [(clear-statistics) ]

Command Parameters
Table 67.4-1 "IGMP Channel Management Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port:vpi:vci
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 67.4-2 "IGMP Channel Management Command" Command Parameters


Parameter
(clear-statistics)

Type

Description

<Igmp::igmpClearStatus>

optional parameter
whether the statistics of this table are cleared or to
ignore the request

3HH-01016-AAAA-TCZZA Edition 03

Released

821

68- PPPoX Management Commands

68.1 PPPoX Engine Port Management Command

822

Released

68-823

3HH-01016-AAAA-TCZZA

Edition 03

68 PPPoX Management Commands

68.1 PPPoX Engine Port Management Command


Command Description
This command deletes all ports for a specific engine.

User Level
The command can be accessed by operators with ppoe privileges, and executed by operators with ppoe privileges.

Command Syntax
The command has the following syntax:
> admin pppox-relay engine (vlan-id) [(remove-all-ports) ]

Command Parameters
Table 68.1-1 "PPPoX Engine Port Management Command" Resource Parameters
Resource Identifier
(vlan-id)

Type

Description

<Vlan::VlanId>
range: [1...4093]

vlan identity

Table 68.1-2 "PPPoX Engine Port Management Command" Command Parameters


Parameter
(remove-all-ports)

Type

Description

<PPPoX::RmvAllPorts>

optional parameter
remove all ports for a specific engine

3HH-01016-AAAA-TCZZA Edition 03

Released

823

69- xDSL Management Commands

69.1 xDSL Line Management Command

824

Released

69-825

3HH-01016-AAAA-TCZZA

Edition 03

69 xDSL Management Commands

69.1 xDSL Line Management Command


Command Description
This node allows the operator do manage an xDSL Line.

User Level
The command can be accessed by operators with xdsl privileges, and executed by operators with xdsl privileges.

Command Syntax
The command has the following syntax:
> admin xdsl-line (if-index) [loop-diagnostic <Xdsl::LoopDiagMode> ]

Command Parameters
Table 69.1-1 "xDSL Line Management Command" Resource Parameters
Resource Identifier
(if-index)

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> / <Eqpt::Port>

Description
/ interface index of the port

Table 69.1-2 "xDSL Line Management Command" Command Parameters


Parameter
loop-diagnostic

Type

Description

<Xdsl::LoopDiagMode>
Possible values are :
- stop : stop the loop diagnostic test
- start : start the diagnostic test

optional parameter
controls the loop diagnostic test

3HH-01016-AAAA-TCZZA Edition 03

Released

825

70- Software Management Commands

70.1 Software Management Command


70.2 OSWP Software Management Command
70.3 Database Management Command
70.4 File Management Command
70.5 SHub Software Management Command
70.6 SHub Database Management Command
70.7 SHub SWPackage Administration Command
70.8 Update the SHub Boot ROM

826

Released

70-827
70-828
70-829
70-830
70-831
70-832
70-833
70-834

3HH-01016-AAAA-TCZZA

Edition 03

70 Software Management Commands

70.1 Software Management Command


Command Description
This command allows the operator to manage the system software.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt [(clr-db-rollback-alrm) ][(clr-sw-rollback-alrm) ]

Command Parameters
Table 70.1-2 "Software Management Command" Command Parameters
Parameter

Type

(clr-db-rollback-alrm) <SwMngt::dbRollback>
(clr-sw-rollback-alrm) <SwMngt::swRollback>

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter
clear the implicit database rollback alarm
optional parameter
clear the implicit software rollback alarm

Released

827

70 Software Management Commands

70.2 OSWP Software Management Command


Command Description
This command allows the operator to manage the OSWP software packages.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt oswp (index) [download <SwMngt::oswpName> ][activate
<SwMngt::activationType> ][(commit) ][(abort-download) ]

Command Parameters
Table 70.2-1 "OSWP Software Management Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<SwMngt::swmOswpIdx>
range: [1...2]

index to the swm oswp table

Table 70.2-2 "OSWP Software Management Command" Command Parameters


Parameter

Type

Description
optional parameter
download a software package
optional parameter
activate an OSWP package

(commit)

<SwMngt::oswpName>
range: [a-zA-Z0-9-_.-/]
<SwMngt::activationType>
Possible values are :
- with-linked-db : activate OSWP with
linked database
- with-default-db : activate OSWP with
default database
- clear-db : prepare the NT board for
migration
<SwMngt::commitAction>

(abort-download)

<SwMngt::abortDownload>

download
activate

828

Released

optional parameter
commit the OSWP
optional parameter
abort the download of an oswp

3HH-01016-AAAA-TCZZA

Edition 03

70 Software Management Commands

70.3 Database Management Command


Command Description
This command allows the operator to manage the system database.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt database [download <Ip::V4Address> : <SwMngt::path> ][upload
actual-active : <Ip::V4Address> : <SwMngt::path> | preferred-active : <Ip::V4Address>
: <SwMngt::path> | previous-active : <Ip::V4Address> : <SwMngt::path> | failed-active
: <Ip::V4Address> : <SwMngt::path> | actual-not-active : <Ip::V4Address> :
<SwMngt::path> | preferred-not-active : <Ip::V4Address> : <SwMngt::path> |
previous-not-active : <Ip::V4Address> : <SwMngt::path> | failed-not-active :
<Ip::V4Address> : <SwMngt::path> | not-used : <Ip::V4Address> : <SwMngt::path> ]

Command Parameters
Table 70.3-2 "Database Management Command" Command Parameters
Parameter

Type

download

<Ip::V4Address> : <SwMngt::path>

upload

actual-active
:
<Ip::V4Address>
<SwMngt::path> | preferred-active
<Ip::V4Address> : <SwMngt::path>
previous-active : <Ip::V4Address>
<SwMngt::path>
|
failed-active
<Ip::V4Address> : <SwMngt::path>
actual-not-active : <Ip::V4Address>
<SwMngt::path> | preferred-not-active
<Ip::V4Address> : <SwMngt::path>
previous-not-active : <Ip::V4Address>
<SwMngt::path> | failed-not-active
<Ip::V4Address> : <SwMngt::path>
not-used
:
<Ip::V4Address>
<SwMngt::path>

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter
download the database
: optional parameter
: upload the database
|
:
:
|
:
:
|
:
:
|
:

Released

829

70 Software Management Commands

70.4 File Management Command


Command Description
This command manages disk and descriptor files.
A disk file contains information about the different software files and descriptor files that are stored on the file disk.
It also contains information such as the file name, file size, file type, file availability status, and file format.
The operator can remove an unused file from the disk by specifying the file name, which is unique over all unit
types and over all SWP types for all releases.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt disk-file (path) [(remove) ]

Command Parameters
Table 70.4-1 "File Management Command" Resource Parameters
Resource Identifier
(path)

Type

Description

<FilePath>
range: [.-z]length: 1<=x<256

an absolute file name

Table 70.4-2 "File Management Command" Command Parameters


Parameter
(remove)

830

Type

Description

<SwMngt::fileRemove>

optional parameter
remove the file

Released

3HH-01016-AAAA-TCZZA

Edition 03

70 Software Management Commands

70.5 SHub Software Management Command


Command Description
This command allows the operator to manage the software on the SHub.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub [select-config <SwMngt::ReqOSPDevice> ]

Command Parameters
Table 70.5-2 "SHub Software Management Command" Command Parameters
Parameter
select-config

Type

Description

<SwMngt::ReqOSPDevice>
Possible values are :
- config-1 : sets config1 version in BSP
- config-2 : sets config2 version in BSP
- tftp : sets tftp version in BSP

optional parameter
select the configuration to be used

3HH-01016-AAAA-TCZZA Edition 03

Released

831

70 Software Management Commands

70.6 SHub Database Management Command


Command Description
This command allows the operator to manage the database on the SHub.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub database [(save) ]

Command Parameters
Table 70.6-2 "SHub Database Management Command" Command Parameters
Parameter
(save)

832

Type

Description

<Sys::ConfigSaveValue>

optional parameter
save the database

Released

3HH-01016-AAAA-TCZZA

Edition 03

70 Software Management Commands

70.7 SHub SWPackage Administration Command


Command Description
This command allows the operator to manage the software package on the SHub.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub sw-package (package) [(download) ]

Command Parameters
Table 70.7-1 "SHub SWPackage Administration Command" Resource Parameters
Resource Identifier
(package)

Type

Description

<Ip::V4Address> : <Sys::FileName>

the identification of the software package

Table 70.7-2 "SHub SWPackage Administration Command" Command Parameters


Parameter
(download)

Type

Description

<Sys::ImageValue>

optional parameter
download the package

3HH-01016-AAAA-TCZZA Edition 03

Released

833

70 Software Management Commands

70.8 Update the SHub Boot ROM


Command Description
This command updates the SHub boot ROM.

User Level
The command can be accessed by operators with software management privileges, and executed by operators with
software management privileges.

Command Syntax
The command has the following syntax:
> admin software-mngt shub boot-rom (package)

Command Parameters
Table 70.8-2 "Update the SHub Boot ROM" Command Parameters
Parameter
(package)

834

Type

Description

<Ip::V4Address> : <Sys::FileName>

optional parameter
the identification of the bootrom image

Released

3HH-01016-AAAA-TCZZA

Edition 03

71- OSPF Management Commands

71.1 OSPF Interface MD5 Key Management Command

3HH-01016-AAAA-TCZZA Edition 03

71-836

Released

835

71 OSPF Management Commands

71.1 OSPF Interface MD5 Key Management


Command
Command Description
This command allows the operator to configure a MD5 key for an OSPF interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ospf interface (ip-addr) md5-key <Ospf::Md5KeyIndex> [accept-expires
<Ospf::MD5expiryDelay> ]generate-expires <Ospf::MD5expiryDelay>

Command Parameters
Table 71.1-1 "OSPF Interface MD5 Key Management Command" Resource Parameters
Resource Identifier
(ip-addr)
md5-key

Type

Description

<Ip::V4Address>
<Ospf::Md5KeyIndex>
range: [1...5]

ip address identifying the interface


the number of the md5 key

Table 71.1-2 "OSPF Interface MD5 Key Management Command" Command Parameters
Parameter
accept-expires

generate-expires

836

Type

Description

<Ospf::MD5expiryDelay>
optional parameter
Possible values are :
set the delay before the key expires for accepting
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire
<Ospf::MD5expiryDelay>
mandatory parameter
Possible values are :
set the delay before the key expires for generating
- now : the key will expire now
- never : the key will never expire
- <Ospf::MD5expiryDelay> : the delay
before the key will expire

Released

3HH-01016-AAAA-TCZZA

Edition 03

72- RIP Management Commands

72.1 RIP Interface MD5 Key Management Command

3HH-01016-AAAA-TCZZA Edition 03

72-838

Released

837

72 RIP Management Commands

72.1 RIP Interface MD5 Key Management Command


Command Description
This command allows the operator to manage a MD5 key for a RIP interface.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin rip interface (ip-addr) md5-key <Rip::Md5KeyIndex> [expires
<Rip::MD5expiryDelay> ]

Command Parameters
Table 72.1-1 "RIP Interface MD5 Key Management Command" Resource Parameters
Resource Identifier
(ip-addr)
md5-key

Type

Description

<Ip::V4Address>
<Rip::Md5KeyIndex>
range: [1...5]

interface IP address
the number of the md5 key

Table 72.1-2 "RIP Interface MD5 Key Management Command" Command Parameters
Parameter
expires

838

Type

Description

<Rip::MD5expiryDelay>
optional parameter
Possible values are :
set the delay before the key expires
- now : the key will expire now
- never : the key will never expire
- <Rip::MD5expiryDelay> : the delay
before the key will expire

Released

3HH-01016-AAAA-TCZZA

Edition 03

73- Equipment Management Commands

73.1 Equipment Management Command


73.2 Slot Management Command
73.3 SHub Port Management Command

3HH-01016-AAAA-TCZZA Edition 03

73-840
73-841
73-842

Released

839

73 Equipment Management Commands

73.1 Equipment Management Command


Command Description
This command allows the operator to manage the equipment.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment [(prepare-shutdown) ][reboot-shub <Sys::RestartValue> ][reboot-isam
<Equipm::SystemRestart> ]

Command Parameters
Table 73.1-2 "Equipment Management Command" Command Parameters
Parameter

Type

Description

(prepare-shutdown)

<Sys::SysShutdown>

reboot-shub

optional parameter
prepare the system for shutdown
optional parameter
reboot the shub

<Sys::RestartValue>
Possible values are :
- systemreset : restart the entire switch
- applicationreset : only restart the
application modules, excluding the BCM
driver and VxWorks
<Equipm::SystemRestart>
optional parameter
Possible values are :
reboot the isam (without shub)
- with-self-test : restart with selftest
- without-self-test : restart without selftest
- default-no-persist : restart with all
persistent data removed
- default-no-data : restart with all data
removed
- hot-restart : reboot, but don't touch the
hardware

reboot-isam

840

Released

3HH-01016-AAAA-TCZZA

Edition 03

73 Equipment Management Commands

73.2 Slot Management Command


Command Description
This command allows the operator to manage a slot and the units in the slot.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment slot (index) [reboot <Equipm::BoardRestart> ]

Command Parameters
Table 73.2-1 "Slot Management Command" Resource Parameters
Resource Identifier
(index)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ the identification of the slot
<Eqpt::Slot>
<Eqpt::Rack>=
range:
[1...1]/
<Eqpt::Shelf>=
range:
[1...1]/
<Eqpt::Slot>= range: [1...21]

Table 73.2-2 "Slot Management Command" Command Parameters


Parameter
reboot

Type

Description

<Equipm::BoardRestart>
optional parameter
Possible values are :
reboot the card in the slot
- with-selftest : reboot the board with self
test
- without-selftest : reboot the board
without self test
- hot-restart : reboot but don't touch the
hardware

3HH-01016-AAAA-TCZZA Edition 03

Released

841

73 Equipment Management Commands

73.3 SHub Port Management Command


Command Description
This command allows the operator to manage SHub ports.

User Level
The command can be accessed by operators with equipment privileges, and executed by operators with equipment
privileges.

Command Syntax
The command has the following syntax:
> admin equipment port (port) [copy-to-port <Shub::NetworkPort> ]

Command Parameters
Table 73.3-1 "SHub Port Management Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

identification of a port

Table 73.3-2 "SHub Port Management Command" Command Parameters


Parameter
copy-to-port

842

Type

Description

<Shub::NetworkPort>
range: [1...7]

optional parameter
copy the port to another port

Released

3HH-01016-AAAA-TCZZA

Edition 03

74- Bridge Management Commands

74.1 Learned Unicast Mac Address Management


Command
74.2 VLAN Management Command
74.3 Port Related RSTP Management Command

3HH-01016-AAAA-TCZZA Edition 03

74-844
74-845
74-846

Released

843

74 Bridge Management Commands

74.1 Learned Unicast Mac Address Management


Command
Command Description
User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin bridge learned-unicast-mac (unicast-mac-address) vlan-id <Vlan::UVlanIndex> |
<Vlan::SVlanIndex> : <Vlan::CVlanIndex> port <Eqpt::Rack> / <Eqpt::Shelf> /
<Eqpt::LtSlot> / <Eqpt::Port> : <Atm::DefaultVpi> : <Atm::DefaultVci> [(delete) ]

Command Parameters
Table 74.1-1 "Learned Unicast Mac Address Management Command" Resource Parameters
Resource Identifier

Type

Description

(unicast-mac-address) <Vlan::MacAddr>
unicast mac address
length: 6
vlan-id
<Vlan::UVlanIndex>
| vlan id
<Vlan::SVlanIndex>
:
<Vlan::CVlanIndex>
port
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ identification of a port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 74.1-2 "Learned Unicast Mac Address Management Command" Command Parameters
Parameter
(delete)

844

Type

Description

<Vlan::DeleteUnicastMac>

optional parameter
delete a learned unicast mac address

Released

3HH-01016-AAAA-TCZZA

Edition 03

74 Bridge Management Commands

74.2 VLAN Management Command


Command Description
This command allows to remove the association between a VLAN and all its member ports.
This command is the only means to remove dynamic associations.
Removal of the port VLAN association includes removal of all MAC address from the filtering database for these
port-VLAN associations.
Any outstanding duplicate MAC alarms for the port are cleared.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin bridge vlan-id (id) [(delete-member-ports) ]

Command Parameters
Table 74.2-1 "VLAN Management Command" Resource Parameters
Resource Identifier
(id)

Type
<Vlan::UVlanIndex>
<Vlan::SVlanIndex>
<Vlan::CVlanIndex>

Description
| vlan id
:

Table 74.2-2 "VLAN Management Command" Command Parameters


Parameter

Type

(delete-member-ports) <Vlan::DeletePorts>

3HH-01016-AAAA-TCZZA Edition 03

Description
optional parameter
delete all egress ports

Released

845

74 Bridge Management Commands

74.3 Port Related RSTP Management Command


Command Description
This node allows the operator to manage RSTP related to a port.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin bridge rstp port (port) [(clear-det-proto) ]

Command Parameters
Table 74.3-1 "Port Related RSTP Management Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Shub::NetworkPort>
range: [1...7]

the identification of a network port

Table 74.3-2 "Port Related RSTP Management Command" Command Parameters


Parameter
(clear-det-proto)

846

Type

Description

<Shub::PortMigration>

optional parameter
clear the list of detected protocols

Released

3HH-01016-AAAA-TCZZA

Edition 03

75- Trap Management Commands

75.1 Trap Manager Management Command

3HH-01016-AAAA-TCZZA Edition 03

75-848

Released

847

75 Trap Management Commands

75.1 Trap Manager Management Command


Command Description
This command allows the operator to manage a trap manager.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin trap manager (address) [(reset-trap-buffer) ]

Command Parameters
Table 75.1-1 "Trap Manager Management Command" Resource Parameters
Resource Identifier
(address)

Type

Description

<Ip::V4Address> : <Trap::Port>
the IP address of the manager
<Ip::V4Address>: <Trap::Port>= range:
[1...65535]

Table 75.1-2 "Trap Manager Management Command" Command Parameters


Parameter
(reset-trap-buffer)

848

Type

Description

<Trap::Reset>

optional parameter
reset the trap buffer

Released

3HH-01016-AAAA-TCZZA

Edition 03

76- IP Management Commands

76.1 Slot Related VRF Management Command


76.2 IP VRF Interface Reset Management Command
76.3 Traceroute Management Command

3HH-01016-AAAA-TCZZA Edition 03

76-850
76-851
76-852

Released

849

76 IP Management Commands

76.1 Slot Related VRF Management Command


Command Description
User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip vrf-media (vrf-slot) ip-address <Ip::V4Address> [(remove) ]

Command Parameters
Table 76.1-1 "Slot Related VRF Management Command" Resource Parameters
Resource Identifier
(vrf-slot)
ip-address

Type
<Eqpt::Rack>
/
<Eqpt::Shelf>
<Eqpt::LtSlot> : <Vrf::VrfIndex>
<Ip::V4Address>

Description
/ equipment slot ID.
ip address

Table 76.1-2 "Slot Related VRF Management Command" Command Parameters


Parameter
(remove)

850

Type

Description

<Vrf::MediaType>

optional parameter
remove the entry

Released

3HH-01016-AAAA-TCZZA

Edition 03

76 IP Management Commands

76.2 IP VRF Interface Reset Management Command


Command Description
This command resets VRF interface counters.

User Level
The command can be accessed by operators with ip privileges, and executed by operators with ip privileges.

Command Syntax
The command has the following syntax:
> admin ip vrf-stats (vrf-id) interface user port (port-interface) reset
<Vrf::AdminCounter>

Command Parameters
Table 76.2-1 "IP VRF Interface Reset Management Command" Resource Parameters
Resource Identifier
(vrf-id)
(port-interface)

Type

Description

<Vrf::VrfIndex>
the vrf index
range: [1...127]
<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 76.2-2 "IP VRF Interface Reset Management Command" Command Parameters
Parameter
reset

Type

Description

<Vrf::AdminCounter>

optional parameter
reset the vrf interface counter

3HH-01016-AAAA-TCZZA Edition 03

Released

851

76 IP Management Commands

76.3 Traceroute Management Command


Command Description
This command allows the operator to initiate a traceroute action, which aims at determining the route to a
destination address.
Only one traceroute can be ongoing at any time; the traceroute action must be explicitly terminated.
The results of the traceroute can be retrieved using the companion show command.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> admin ip traceroute (ip-addr) [ no max-ttl | max-ttl <Ip::TracerouteTTL> ][ no
min-ttl | min-ttl <Ip::TracerouteTTL> ][ no timeout | timeout <Ip::TracerouteTimeout>
][ no mtu-size | mtu-size <Ip::TracerouteMtu> ]

Command Parameters
Table 76.3-1 "Traceroute Management Command" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

the ip-address of the destination node

Table 76.3-2 "Traceroute Management Command" Command Parameters


Parameter
[ no ] max-ttl
[ no ] min-ttl
[ no ] timeout
[ no ] mtu-size

852

Type

Description

<Ip::TracerouteTTL>
range: [1...99]
<Ip::TracerouteTTL>
range: [1...99]
<Ip::TracerouteTimeout>
range: [1...100] unit: sec
<Ip::TracerouteMtu>
range: [1...100] unit: bytes

optional parameter with default value: 99L


the maximum time to wait for a response
optional parameter with default value: 1L
the maximum time to wait for a response
optional parameter with default value: 1L
the maximum time to wait for a response
optional parameter with default value: 64L
the size of the data portion of the ping PDU

Released

3HH-01016-AAAA-TCZZA

Edition 03

77- DHCP Management Command

77.1 DHCP Relay User Port Management Command

3HH-01016-AAAA-TCZZA Edition 03

77-854

Released

853

77 DHCP Management Command

77.1 DHCP Relay User Port Management Command


Command Description
This command allows the operator to manage the DHCP relay user port commands.

User Level
The command can be accessed by operators with dhcp privileges, and executed by operators with dhcp privileges.

Command Syntax
The command has the following syntax:
> admin dhcp-relay user-port (user-port) (reset-counters)

Command Parameters
Table 77.1-1 "DHCP Relay User Port Management Command" Resource Parameters
Resource Identifier
(user-port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port user-port
<Eqpt::LtSlot>
/
<Eqpt::Port>
: identification
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 77.1-2 "DHCP Relay User Port Management Command" Command Parameters
Parameter
(reset-counters)

854

Type

Description

<Dhcp::CounterReset>

optional parameter
reset the user port counters

Released

3HH-01016-AAAA-TCZZA

Edition 03

78- Transport Management Commands

78.1 IP Net to Media Management Command

3HH-01016-AAAA-TCZZA Edition 03

78-856

Released

855

78 Transport Management Commands

78.1 IP Net to Media Management Command


Command Description
This is used for deleting the IP address out of the ARP table.

User Level
The command can be accessed by operators with transport privileges, and executed by operators with transport
privileges.

Command Syntax
The command has the following syntax:
> admin transport ip-net-to-media (interface-name) network-addr <Ip::V4Address>
phy-addr <Sys::MacAddr> [(delete) ]

Command Parameters
Table 78.1-1 "IP Net to Media Management Command" Resource Parameters
Resource Identifier

Type

Description

(interface-name)
network-addr

<Transport::ifName>
<Ip::V4Address>

phy-addr

<Sys::MacAddr>
length: 6

name of the interface


ip addr corresponding to media-dependent physical
addr
media-dependent physical addr

Table 78.1-2 "IP Net to Media Management Command" Command Parameters


Parameter
(delete)

856

Type

Description

<IP::DeleteNetToMedia>

optional parameter
delete a ip-net-to-media

Released

3HH-01016-AAAA-TCZZA

Edition 03

79- SNTP Management Commands

79.1 SNTP Management Command

3HH-01016-AAAA-TCZZA Edition 03

79-858

Released

857

79 SNTP Management Commands

79.1 SNTP Management Command


Command Description
This command allows the operator to manage SNTP.

User Level
The command can be accessed by operators with vlan privileges, and executed by operators with vlan privileges.

Command Syntax
The command has the following syntax:
> admin sntp [system-time <Sys::Time> ][shub-time <Sys::Time> ]

Command Parameters
Table 79.1-2 "SNTP Management Command" Command Parameters
Parameter

858

Type

Description

system-time

<Sys::Time>

shub-time

<Sys::Time>

optional parameter
set the system time
optional parameter
set the system time for the shub

Released

3HH-01016-AAAA-TCZZA

Edition 03

80- Transactions Management Commands

80.1 Transaction Configuration Managemant Command

3HH-01016-AAAA-TCZZA Edition 03

80-860

Released

859

80 Transactions Management Commands

80.1 Transaction Configuration Managemant


Command
Command Description
This command allows the operator to manage transactions.

User Level
The command can be accessed by operators with alarm privileges, and executed by operators with alarm
privileges.

Command Syntax
The command has the following syntax:
> admin transaction [configure-lock <Trans::ownerIpAddr> ]

Command Parameters
Table 80.1-2 "Transaction Configuration Managemant Command" Command Parameters
Parameter
configure-lock

860

Type

Description

<Trans::ownerIpAddr>
optional parameter
Possible values are :
changes the status of the configuration lock
- acquire : prevents other managers from
configuring
- release : allow other managers to
configure

Released

3HH-01016-AAAA-TCZZA

Edition 03

81- Security Management Commands

81.1 Security 802.1x Port Authentication Management


Command

3HH-01016-AAAA-TCZZA Edition 03

81-862

Released

861

81 Security Management Commands

81.1 Security 802.1x Port Authentication


Management Command
Command Description
User Level
The command can be accessed by operators with aaa privileges, and executed by operators with aaa privileges.

Command Syntax
The command has the following syntax:
> admin security ext-authenticator (port) [(clear-statistics) ]

Command Parameters
Table 81.1-1 "Security 802.1x Port Authentication Management Command" Resource Parameters
Resource Identifier
(port)

Type

Description

<Eqpt::Rack>
/
<Eqpt::Shelf>
/ index (1/1/4/1..) of rack/shelf/slot/port
<Eqpt::LtSlot>
/
<Eqpt::Port>
:
<Atm::DefaultVpi> : <Atm::DefaultVci>

Table 81.1-2 "Security 802.1x Port Authentication Management Command" Command Parameters
Parameter
(clear-statistics)

862

Type

Description

<Aaa::PortClearStatistics>

optional parameter
clear non-accounting statistics

Released

3HH-01016-AAAA-TCZZA

Edition 03

82- Support Commands

82.1 Ping Command

3HH-01016-AAAA-TCZZA Edition 03

82-864

Released

863

82 Support Commands

82.1 Ping Command


Command Description
This command allows the operator to ping another host.

User Level
The command can be accessed by operators with all privileges, and executed by operators with all privileges.

Command Syntax
The command has the following syntax:
> ping (ip-addr) [ no timeout | timeout <Ip::PingTimeout> ][ no tries | tries
<Ip::PingTries> ][ no mtu-size | mtu-size <Ip::PingMtu> ]

Command Parameters
Table 82.1-1 "Ping Command" Resource Parameters
Resource Identifier
(ip-addr)

Type

Description

<Ip::V4Address>

the ip-address of the node to be pinged

Table 82.1-2 "Ping Command" Command Parameters


Parameter
[ no ] timeout
[ no ] tries
[ no ] mtu-size

Type

Description

<Ip::PingTimeout>
range: [1...100] unit: sec
<Ip::PingTries>
range: [1...100]
<Ip::PingMtu>
range: [0...2080] unit: bytes

optional parameter with default value: 1L


the maximum time to wait for a response
optional parameter with default value: 5L
the number of times the node must be pinged
optional parameter with default value: 500L
the size of the data portion of the ping PDU

Command Output
Table 82.1-3 "Ping Command" Display parameters
Specific Information
name

Type

Description

received

<Counter>

sent

<UnsignedInteger>

loss

<UnsignedInteger>

mean-delay

<Ip::PingDelay>
unit: sec
<Ip::PingDelay>
unit: sec
<Ip::PingDelay>
unit: sec

total number of packets sent to the destination


This element is always shown.
total number of packets sent to the destination
This element is always shown.
percentage of lost packets
This element is always shown.
the average round trip delay
This element is always shown.
the maximum round trip delay
This element is always shown.
the minimum round trip delay
This element is always shown.

max-delay
min-delay

864

Released

3HH-01016-AAAA-TCZZA

Edition 03

82 Support Commands

3HH-01016-AAAA-TCZZA Edition 03

Released

865

83- CLI Filters

83.1 Count Filter


83.2 Match Filter
83.3 Tee Filter

866

Released

83-867
83-868
83-869

3HH-01016-AAAA-TCZZA

Edition 03

83 CLI Filters

83.1 Count Filter


Command Description
The filter command counts the number of output characters, words, or lines and adds this information at the end of
the output.

User Level
This filter can be used by any user.

Command Syntax
The command has the following syntax:
> count [ no lines | lines ][ no words | words ][ no characters | characters ][ no
summary | summary ]

Command Parameters
Table 83.1-2 "Count Filter" Command Parameters
Parameter

Type

Description

[ no ] lines
[ no ] words
[ no ] characters

<Option::Lines>
<Option::Words>
<Option::Characters>

[ no ] summary

<Option::Summary>

optional parameter with default value: "no-lines"


optional parameter with default value: "no-words"
optional
parameter
with
default
value:
"no-characters"
optional
parameter
with
default
value:
"no-summary"

3HH-01016-AAAA-TCZZA Edition 03

Released

867

83 CLI Filters

83.2 Match Filter


Command Description
This filter allows the user to filter selected lines from the output based on the contents of these lines.
The user specifies a string with exact:.
The user can choose to keep (no skip) or discard (skip) a line that contains this string, or the user can use the filter
to keep all lines before the first match (before) or after (including) the first match (after).
The matching operation can be case sensitive (no case-insensitive) or case insensitive (case-insensitive).

User Level
This filter can be used by any user.

Command Syntax
The command has the following syntax:
> match (pattern) [ no case-insensitive | case-insensitive ][ no (skip) ]

Command Parameters
Table 83.2-2 "Match Filter" Command Parameters
Parameter

868

Type

Description

(pattern)

exact : <PrintableString>

[ no ] case-insensitive

<Option::CaseSensitivity>

[ no ] (skip)

<Option::MatchAction>
Possible values are :
- skip : matched lines are skipped
- match : matched lines are selected
- before : lines found before the first match
are selected
- after : lines found after the first match
are selected

optional parameter
describes
what
we
are
looking
for
(exact:|pattern:)<PrintableString>)
optional
parameter
with
default
value:
"case-sensitive"
pattern recognition is case-insensitive
optional parameter with default value: "match"
matched lines are skipped

Released

3HH-01016-AAAA-TCZZA

Edition 03

83 CLI Filters

83.3 Tee Filter


Command Description
This filter writes the output to a file. The file is placed in the /var/cmd directory.
The user can choose if the output is appended to the file or not.

User Level
This filter can be used by any operator.

Command Syntax
The command has the following syntax:
> tee (file) [ no append | append ]

Command Parameters
Table 83.3-2 "Tee Filter" Command Parameters
Parameter
(file)
[ no ] append

Type

Description

<FileName>
range: [.-z]length: 1<=x<256
<Option::Append>

optional parameter
the name of the file
optional parameter with default value: "overwrite"
append if the file exists

3HH-01016-AAAA-TCZZA Edition 03

Released

869

84- CLI Printers

84.1 More
84.2 No-More
84.3 Discard

870

Released

84-871
84-872
84-873

3HH-01016-AAAA-TCZZA

Edition 03

84 CLI Printers

84.1 More
Command Description
This printer allows the user to view the command output at the user's desired pace.

User Level
This printer can be used by any user.

Command Syntax
The command has the following syntax:
> more

3HH-01016-AAAA-TCZZA Edition 03

Released

871

84 CLI Printers

84.2 No-More
Command Description
This printer prints all output directly to the screen.

User Level
This printer can be used by any user.

Command Syntax
The command has the following syntax:
> no-more

872

Released

3HH-01016-AAAA-TCZZA

Edition 03

84 CLI Printers

84.3 Discard
Command Description
This printer discards all output. This can be useful in some scripts.

User Level
This command can be used by any operator.

Command Syntax
The command has the following syntax:
> discard

3HH-01016-AAAA-TCZZA Edition 03

Released

873

Error List

Error List
Error list for SNMP
Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10
11
12
13

No error
General error
Invalid Snmp Header
Index out of range
Community access Violation
Access violation
Invalid Type
Invalid Value
Out of Memory
Index != Index in entry
Cannot change existing row
Row not completely specified
Snmp Set During Transaction
Snmp Set while sets disabled

Error list for ATM MGT


Error
Error Description
Number
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

874

Successful operation
parameter not in valid range
name & scope not unique
maximum number of profiles reached
object in use
initialization failure
object already exists
wrong Atm Interface Snmp configuration
wrong Atm Interface Type
wrong NgcrAdminWeight
wrong access profile index
Atm Itf not planned
Incoherence with Interface Management
Incoherence with ATM Mapper
Invalid object reference
Cast type mismatch
Traffic descriptor mismatch
Already crossconnected
Topology mismatch
Ctp not found
Already in requested state
Time out on LT reply
LT returned failure in reply
Wrong tp type
Ctp not crossconnected
atmItf not found
wrapper Failed
still Cross Connected
wrongly Cross Connected
max Nbr VpCtp Reached
max Nbr VpTtp Reached
max Nbr VcCtp Reached

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
90
91
92
93

max Nbr VcTtp Reached


max Nbr VpCtpDI Reached
max Nbr VcCtpDI Reached
max Nbr VcTtpDI Reached
tp Already Exist
Tp not found
invalid Tp State
VpiVci Already Used
Lb To User Side is not allowed
Lb on P2mp is not allowed
Lb on Nt Interface is not allowed
global Lb already active
link Lb already active
trafficDescrType Mismatch
frameDiscard On is not allowed
incompatible Pcr and CastType
invalid input parameter
invalid Tau2 value
wrong TdType
still Svcs present
invalid AtmItf state
VpiVci out-of-range
sigVpi not usable for Vpc
no free VpiVci
incompatible SegmEP and ItfType
incompatible SegmEP and CastType
incompatible ItfType and CastType
Police on NT interface is not allowed
Nni GFC mode not allowed on UAI interface
incompatible TdType and CastType
AtmItf already used for Sig
AtmItf already used for Ilmi
Allocation of VpiVci on internal interfaces Pb
getSegment failed
board type not found
new Signalling Vpi/Vci value rejected
wrong configuration of the Segment End Point Parameter
lack of memory (number of available context too low)
HW Wrapper failure: invalid vxl identifier
HW Wrapper failure: invalid data pointer
HW Wrapper failure: port is disabled
HW Wrapper failure: internal error occurred
HW Wrapper failure: vxl does not exist
HW Wrapper failure: already exists
HW Wrapper failure: lack of memory resources
HW Wrapper failure: invalid vxl
HW Wrapper failure: generic request error
no offboard
LT not reachable
HW Wrapper failure : service not provided
HW Wrapper failure : IOCM call error
Error occurred when getting PM info from PMH
Error occured when getting number of intervals stored in PMH
Error occurred during PMH registration
Error occurred when asking a new interval to PMH

3HH-01016-AAAA-TCZZA Edition 03

Released

875

Error List

Error
Number

Error Description

95
96
97
98
99
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
140
141
142
144
145
146
147
148
149
150
151
152
153
154
155
156

maximum number of ctp monitor reached


ctp monitoring not allowed when loopback on
ctp monitoring not allowed on p2mp cnx
monitoring already active
ctp monitoring not supported for a ctp ending on NT board
CAC check failure: peak cell rate relative to line rate for input direction
CAC check failure: peak cell rate relative to line rate for output direction
CAC check failure: maximum number of connections per qos class for input direction
CAC check failure: maximum number of connections per qos class for output direction
CAC check failure: guaranteed bandwidth per qos class for input direction
CAC check failure: guaranteed bandwidth per qos class for output direction
CAC check failure: aggregate guaranteed bandwidth for input direction
CAC check failure: aggregate guaranteed bandwidth for output direction
CAC check failure: PVC aggregate total bandwidth for input direction
CAC check failure: PVC aggregate total bandwidth for output direction
CAC check failure: PVC+SVC aggregate total bandwidth for input direction
CAC check failure: PVC+SVC aggregate total bandwidth for output direction
CAC check failure: Buffer per qos class for input direction
CAC check failure: Buffer per qos class for output direction
CAC check failure: PCR of input alternative traffic contract needs more resources than primary
CAC check failure: PCR of output alternative traffic contract needs more resources than primary
CAC check failure: SCR of input alternative traffic contract needs more resources than primary
CAC check failure: SCR of output alternative traffic contract needs more resources than primary
CAC check failure: MCR of input alternative traffic contract needs more resources than primary
CAC check failure: MCR of output alternative traffic contract needs more resources than primary
CAC check failure: MBS of input alternative traffic contract needs more resources than primary
CAC check failure: MBS of output alternative traffic contract needs more resources than primary
CAC check failure: input maximum cell loss ratio exceeded
CAC check failure: output maximum cell loss ratio exceeded
CAC check failure: input maximum point to point cell delay variation exceeded
CAC check failure: output maximum point to point cell delay variation exceeded
CAC check failure: input maximum end to end transit delay exceeded
CAC check failure: output maximum end to end transit delay exceeded
CAC check failure: qos of primary and alternative input traffic descriptors during negotiation differ
CAC check failure: qos of primary and alternative output traffic descriptors during negotiation differ
CAC check failure: subtype of primary and alternative input traffic descriptors during negotiation differ
CAC check failure: subtype of primary and alternative output traffic descriptors during negotiation differ
CAC check failure: minimum PCR not available during negotiation in input direction
CAC check failure: minimum PCR not available during negotiation in output direction
requested object not present
cdvt profile not configured
connection admission control server stubbed
traffic contracts for input and output direction not compatible
interface type not known or not set
cac profiles not configured
qos not supported on hardware
alloc Bw rejected by infra
item not configured
modification not possible because connections are present
maximum number of LIM boards too large
maximum number of Access Profile too large
maximum number of Cac Profile too large
maximum number of Cdvt Profile too large
Fast/Interleaved config modification rejected because Ctps exist
Problem to printf LogicalIndex (Update PRLOGIDX1 macro)

876

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

157
158
160
161
162
170
171
172
173
174
175
176
177
178
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
223
224
225
226
227
228
229
230
231
232
233
234

The admin status of the Nt Interface must not be modified


IOCM error
generic or unknown error. Probably a bug in the software
invalid error code
request not supported
Wrong Svc Mode
resource currently blocked
maximum number of leafs reached
maximum number of p2mp connections reached
invalid crossconnect hierarchy
Max number of pending requests reached
ctp1 does not exist
ctp2 does not exist
The application has not subscribed to use ATM application interface yet
IQ BUS: The given QoS class is unknown
IQ BUS: The given 'requested' parameters are inconsistent
max F4F5 Loopback number reached
max F4F5 Loopback per Board reached
F4F5 Loopback not supported on p2mp connection
invalid connection admin state
invalid LLID requested
F4F5 Loopback already active
No F4F5 Loopback running
no F5 loopback on ILMI channel
Lb on Ilmi channel is not allowed
ILMI channels are only allowed on UAI interfaces
Aal profile not exists
wrong Aal category
Service profile not exists
wrong TM category
wrong TM conformance
wrong board type
not supported on SD boards
supported on UAI only
inconsistent parameters
not during audit
alarm mgt error
BCS could not allocate bandwidth
Invalid index passed to BCS
generic or unknown error. Probably a bug in the software
Loopback is not allowed when monitoring is enabled on a CTP
CTP reference is not valid to start history monitoring
ATM object creation failed
F4F5 Loopback test already in use
wrong test id
no F5 Loopback on ILMI channel
loopback invalid status
Max number of guaranteed roots reached
Cross connect creation failed due to internal segments/ctps
root and leaf shapings are different
the setOamVpiRange Infra event has not been received
Lb on Interface on MMC is not allowed
The application does not know the mcast mode yet
The policeMode is incompatible with CtpMonitor
The default profile can NOT be deleted

3HH-01016-AAAA-TCZZA Edition 03

Released

877

Error List

Error
Number

Error Description

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
360
361
362
363
364
365
380
381

IOCM : Unknown Error


IOCM : Nok
IOCM : Invocation is still pending
IOCM : Invocation is cancelled by the application
IOCM : Invoked server doesn?t support invoking interface
IOCM : Operation not enabled
IOCM : Operation not found
IOCM : Object not found
IOCM : When trying to remove something (e.g. invocation from a set)
IOCM : Not enough space
IOCM : Timeout occurred
IOCM : Timeout Secondary Waitpoint occurred
IOCM : Returned from PW when task is killed
IOCM : Current action is not allowed
IOCM : When something is empty (messagebox, queue, invocation, ?)
IOCM : Invocation is not pending (or set doesn?t contains pending invs)
IOCM : When reply received and inv id doesn?t match
IOCM : Interface is not bound yet
IOCM : Failure while packing message (internal problem)
IOCM : Object id exists already in the router table
IOCM : Enabled
IOCM : Disabled
IOCM : Special message for freeing resources (send by GC)
IOCM : Returned by functions which are not implemented
IOCM : Internal Error
IOCM : IOCM was not able to allocate memory
IOCM : When an invocation is processed in the SW
IOCM : Object Not Registered
IOCM : Already Registered
IOCM : Task Not Registered
IOCM : Secondary Already Registered
IOCM : Secondary Not Registered
IOCM : Initial
IOCM : Attempt to call _convertToIOCMTask on an IOCM task
IOCM : Connection Not Registered
IOCM : Suspended
IOCM : Max Invocation Reached
IOCM : Finished
IOCM : Invalid Priority
IOCM : Invalid Object_Id
IOCM : Invalid Object_Group_Id
IOCM : Invalid Node_Id
IOCM : Invalid Timeout
IOCM : Invalid Scope
IOCM : Invalid Addressability
IOCM : Not Member
IOCM : Already Member
INFRA : Unknown Error
wrong Oam Vpi Range reserved by INFRA
INFRA : Generic Error
INFRA : Bw Error
INFRA : Planning Not Approved
INFRA : Not Implemented
LOGSW : Unknown Error
LOGSW : Not Supported

878

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

382
383
384
385
386
387
388
389
390
391
392

LOGSW : Container Disabled


LOGSW : Container Unknown
LOGSW : Lack Of Memory
LOGSW : Xconnect Unknown
LOGSW : Xconnect Already Exists
LOGSW : Xconnect Non-Term
LOGSW : Vxl Unknown
LOGSW : Generic Error
Logical Switch, Parameter out of range
Logical Switch, Generic error
RFC, Time Out in Audit

Error list for ETH MGT


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10

cannot set defaultType because operStatus of interface is up


cannot obtain operState of interface from driver when trying to set default type
cannot set defaultType of interface in driver
given value of default type is invalid
unable to access port stats from ethernet driver
unable to set default type during init
unable to set shaping rate during init
unable to get persistent shaping rate
unable to access ethernet shaping rate from driver
unable to set shaping rate in driver
attempt to set ethernet shaping rate outside valid range

Error list for IP MGT


Error
Error Description
Number
0
1
2
3
4
5
6
10
11
12
13
14
15
16
20
21
22
23
24
25
30
31
32
33
34
35

an invalid value was given to one of the parameters


attempt to pass invalid index value to SNMP
a general software error occurred
an error occurred while opening a socket
requested action is currently not supported
null pointer passed to SNMP get
creation failed because object already exists
error reading IP group counter
requested address descriptor not found
requested ipNetToMediaNetAddress not found
error reading ipAddressTable
error during deletion of address descriptor
error in ipdata_put_addr function
error reading ipNetToMediaTable
error changing route destination
error while adding new route
error in ipdata_put_route function
route type unknown
error reading ipRouteTable
could not find route destination
error reading interface descriptor
interface type unknown
error during set of adminState
error during set of MTU
error because BOOTP is active
interface hardware address error

3HH-01016-AAAA-TCZZA Edition 03

Released

879

Error List

Error
Number

Error Description

36
37
40
50
51
52
60
61
62

persistent data present error


IP address already configured
error reading ICMP counter
error reading UDP descriptor
error reading UDP counter
error reading UDP table
error reading ARP table
VP/VC not found
error reading ATM VC Table

Error list for EQPT MGT


Error
Error Description
Number
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

The equipment is not yet planned


Internal IOCM communication error
The container still contains planned equipment
Service not supported
Maximum number of shelves planned
Identifier for the equipment is unknown to the system
The container is not yet planned
The ShelfClass and ShelfType are inconsistent
Board is incompatible with the applique
The equipment is not yet installed
Plan ShelfClass not supported when unplanning shelf
Unplanning board and setting of board-attribute not supported
Invalid or not applicable request
Invalid or not supported shelf class
ShelfType/ShelfLayout Unknown
Unplanning this detected equipment not allowed
Board planning not approved due to infrastructure deficiencies
Unknown Error
Invalid, not registered or not licensed BoardType
Number of allowed Boards of this BoardType in this shelf exceeded
Number of allowed Boards of this BoardType in the asam exceeded
Board is not allowed at this slot position
Not supported BoardType

Error list for INFRA MGT


Error
Error Description
Number
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Internal IOCM communication error


Not enough BW available on extension ring to plan shelf BW
Not enough BW available to plan HCL-LSM BW
Service not supported
The equipment is not yet installed
The shelf is not yet planned
The board is not yet planned
Tried to plan BW for a non HCL-LSM board
The BW of the HCL-LSM board is already planned
The BW of a shelf can't be changed because an IQ-LSM is still planned
The BW value is not allowed
Tried to plan BW for a non IQ shelf
InfraMgnt internal SW error
Not enough BW available on extension ring to plan BVB BW

Error list for XDSL MGT

880

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

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

Value out of range


Communication problem
No more free entries
No resource available
Profile id. already exists
Profile name/scope combination not unique
Inconsistent profile
Profile in wrong state
Profile is in use
Profile id. does not exist
Board is not created
The planned bandwidth in the XDSL Service profile was not accepted
Invalid opmode in OpModeMask
XDSL Service profile does not exist
XDSL Spectrum profile does not exist
TCA profile does not exist
Loop diagnostic test not supported
Interval out of range
Interval invalid
Inconsistent values for Noise Margin
Inconsistent values for Multi-DSL Modem Features
Inconsistent values for Multi-DSL Max Aggregate Power Level Downstream
Inconsistent values for Multi-DSL Max Aggregate Power Level Upstream
Inconsistent values for Multi-DSL PBO Mode Upstream
Inconsistent values for Multi-DSL Max Rx Aggr Power Up
VDSL Band Plan and opModes are inconsistent
VDSL PSD Shape Upstream and VDSL OpMode are inconsistent
VDSL PSD Shape Downstream and VDSL OpMode are inconsistent
VDSL PSD Shape Upstream and VDSL PSD Shape Downstream are inconsistent
Inconsistent values for Bitrate Downstream
Inconsistent values for Bitrate Upstream
Profile can not be modified
Line is in wrong state
Line is not configured
Bonding not supported
Bonding is not configured yet
Bonding has been configured
Group NT state machine error
Must remove lines from groupnt before unconfiguring group
Specified line does not exist in this bonding group
Group active, cannot add line
Group active, cannot remove line

Error list for IGMP MGT


Error
Error Description
Number
1
2
3
4
5
6
7
8
9
10

Internal error 1 encountered by IGMP subsystem


Internal error 2 encountered by IGMP subsystem
Internal error 3 encountered by IGMP subsystem
Internal error 4 encountered by IGMP subsystem
Internal error 5 encountered by IGMP subsystem
Internal error 6 encountered by IGMP subsystem
Internal error 7 encountered by IGMP subsystem
Internal error 8 encountered by IGMP subsystem
Internal error 9 encountered by IGMP subsystem
Internal error 10 encountered by IGMP subsystem

3HH-01016-AAAA-TCZZA Edition 03

Released

881

Error List

Error
Number

Error Description

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

Internal error 11 encountered by IGMP subsystem


Internal error 12 encountered by IGMP subsystem
Internal error 13 encountered by IGMP subsystem
Internal error 14 encountered by IGMP subsystem
Internal error 15 encountered by IGMP subsystem
Internal error 16 encountered by IGMP subsystem
Internal error 17 encountered by IGMP subsystem
Internal error 18 encountered by IGMP subsystem
Internal error 19 encountered by IGMP subsystem
Internal error 20 encountered by IGMP subsystem
Internal error 21 encountered by IGMP subsystem
Could not reserve VCI range for IGMP Channel. VCI already in use
Invalid VPI or VCI
Invalid VPI, VCI row status or sustain bit rate
Invalid Class D address
Invalid IGMP system source IP address
Invalid Multicast VPI
Invalid Multicast VCI
Invalid Multicast Service Category
Invalid IGMP Chan VPI
Invalid IGMP Chan Min VCI
Internal error 22 encountered by IGMP subsystem
Internal error 23 encountered by IGMP subsystem
Internal error 24 encountered by IGMP subsystem
Internal error 25 encountered by IGMP subsystem
Internal error 26 encountered by IGMP subsystem
Invalid Traffic Descriptor type
Invalid Service Category
Invalid package index
Invalid row status
Invalid old row status
Invalid IGMP Channel row
Invalid Multicast Class D address or clearStats column is false
Incompatible Service Category and Traffic Descriptor type
Incompatible Peak and Sustain Bit Rates
Invalid IGMP channel row status or multicast VPI or Multicast min VCI
Internal error 27 encountered by IGMP subsystem
Internal error 28 encountered by IGMP subsystem
Internal error 29 encountered by IGMP subsystem
Internal error 30 encountered by IGMP subsystem
Bad value for IGMP System Query Interval
Bad value for IGMP System Query Max response time
Bad value for IGMP System Robustness variable
Bad value for IGMP System Startup Query Interval
Bad value for IGMP System Startup Query Count
Bad value for IGMP System Last Membership Query Interval
Bad value for IGMP System Last Membership Query Count
Bad value for IGMP System Last Membership Max response time
Internal error 31 encountered by IGMP
Multicast Source objects violate in service modification rules
IGMP Channel objects violates in service modify rules
Static Leaf objects violate in service modification rules
Internal error 32 encountered by IGMP subsystem
Internal error 33 encountered by IGMP Multicast row
Internal error 34 encountered by IGMP subsystem

882

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

Internal error 35 encountered by IGMP subsystem


Internal error 36 encountered by IGMP subsystem
Internal error 37 encountered by IGMP subsystem
Internal error 38 encountered by IGMP subsystem
Internal error 39 encountered by IGMP subsystem
Internal error 40 encountered by IGMP subsystem
Internal error 41 encountered by IGMP subsystem
Internal error 42 encountered by IGMP subsystem
Internal error 43 encountered by IGMP subsystem
Internal error 44 encountered by IGMP subsystem
Internal error 45 encountered by IGMP subsystem
Internal error 46 encountered by IGMP subsystem
Multicast Source Conversion:entry does not exist
Static Leaf : entry does not exist
Entry does not exist
Internal error 47 encountered by IGMP subsystem
Maximum Static Leaf entries exceeded
Maximum Channel entries exceeded
Internal error 48 encountered by IGMP subsystem
Internal error 49 encountered by IGMP subsystem
Empty Multicast Source Table
Emtpy IGMP Channel table
Cannot perform task. No entry exist.
IGMP Channel index, VPI and VCI already exist
No next member after the matching channel in IGMP Channel table
Maximum Multicast Source entries exceeded
Static leaf creation not allowed: VPI/VCI reserved or PVC exists
Multicast source MAC address already exists

Error list for QOS MGT


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

subprofile does not exists


Profile cannot be deleted because it is in use
changing type is not allowed
Profile not supported by hardware
logical flow type incompatible with other field
Action not supported by hardware
Cac sanity check failed. Insufficient bandwidth available.
BAC check failed. Overbooking of downstream buffers.
Wrong or unsupported 'type' attribute
Policer pool exhausted
Incorrect threshold settings
warning: setting burst tolerance < 1518 causes ethernet frame discard
minimum treshold bigger than maximum
Up and Down Policer Profiles cannot be changed from NULL because it is in Use
Up and Down Policer Profiles cannot be changed to NULL because it is in Use
Some ethernet frames may get discarded since the CBS is less than 1518

Error list for DOT1X MGT


Error
Error Description
Number
0
1
2
3

Port does not exist


Table entry does NOT exist
Bad entry value for dot1xPaeSystemAuthControl
Bad entry value for dot1xAuthAdminControlledDirections

3HH-01016-AAAA-TCZZA Edition 03

Released

883

Error List

Error
Number

Error Description

4
5
6
7
8
9
10
11
12
13

Bad entry value for dot1xAuthAuthControlledPortControl


Bad entry value for dot1xAuthQuietPeriod
Bad entry value for dot1xAuthSuppTimeout
Bad entry value for dot1xAuthServerTimeout
Bad entry value for dot1xAuthMaxReq
Bad entry value for dot1xAuthReAuthPeriod
Bad entry value for extdot1xPaePortAuthState
Bad entry value for extdot1xPaePortInitiateAuthReq
Bad entry value for extdot1xPaePortHandshakeMode
Bad entry value for extdot1xPaePortHandshakePeriode

Error list for VLAN MGT


Error
Error Description
Number
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
37
38
39
40
41
42
43

884

Invalid port id
Not support creation
Not support deletion
Only support active status
Nothing can be modified
Frame value only support 2 or 5 octets
The max length of protocol group name reached
The given protocol group is not existent
Only protocol group name can be modified
No change on protocol group name
Error ocurrs during saving persistent data
PVC number reached max value
Not support double vlan tagged frame
Not support default vlan for tagged frame
Not support tagged frame on port already associated RB vlan
Max num of MAC must be power of 2
Total MAC number excess the max vlaue
Static number on port is larger than the max mac num to be configured
Qos profile on port is supported only by IXP board
Priority regeneration profile is not existent
Attaching QOS profile to port is failed
Association already exist
Not support terminated vlan
CC vlan already have more than one port
CC vlan associate to the port already associated to RB vlan
Bridged port is enabled by 802.1x or IGMP or DHCP
Bridged port is already attached by PPPoE server
RB vlan only associate to only untagged frame
RB vlan associate to the port already associated to CC vlan
vlan is set as port based default, not to be deleted
vlan is set as protocol port based default, not to be deleted
Protocol port based default vlan is supported only on IXP board
Protocol port based default vlan is only for only untagged frame
Invalid vlan id
Port id is already used
fdb index not in the range from 1 to 4096
Input Mac address should NOT be 00-80-c2 or 01-80-c2
The given Vlan and Port should be created and establish association
Given mac already exist
Static mac table is full
Full zero or broadcast address or multicast address can not be set as static MAC
Exceed the MAX mac address for one port

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

45
46
47
48
49
50
51
52
53
54
55
56
57
58
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

Vlan number has exeeded max suported vlan number


Configure vlan to Lsm failed
When vlan is associated with port, this vlan can't be deleted
When IGMP is using Vlan, this vlan can't be deleted
When AAA is using Vlan, this vlan can't be deleted
When terminated vlan is in use, this vlan can't be deleted
The length of vlan name excess the maximum value
Can't change vlan mode
Invalid vlan group id
ExtendDot1vProtocolVlanGroup has no meaning and can not be set for a VLAN in crossConnect mode.
PPPoE Relay tag has no meaning and can not be set for terminated vlan or CC vlan
DHCP option82 has no meaning and can not be set for terminated vlan or to CC vlan
BroadcastControl has no meaning and can not be set for terminated vlan or to CC vlan
ExtendDot1vProtocolVlanGroup has no meaning and can not be set for terminated vlan or CC vlan
Invalid vpi or vci
Pvc has not been created
Priority regeneration profile can be supported only by IXP board
Not support priority regeneration profile on double vlan tagged frame
Can not get VLAN_PRIO_REMARK from capability management
Can not get QOS_PROF_PORT from capability management
Can not get MAX_MACS_PER_LSM from capability management
Can not get MAX_VLANS_PER_PVC from capability management
Can not get QOS_PROF_PORT_VLAN from capability management
Qos profile on association is supported only by IXP board
Association number excess the maximum value
Attaching qos profile on association is failed
Association between given vlan and port is not existent
Detaching qos profile from association is failed
Can not create interface for bridged port by interface management
Can not get hardware reference from interface management
Can not get customer id from interface management
Can not get VLAN_PROT_FILTER from capability management
Another vlan is already existent on the protocol group
Bridged port has not been created yet
Invalid protocol group
Given vlan has not been created yet
This type board doesn't not support untagged frame
This type board doesn't not support tagged frame
This type board doesn't not support both tagged and untagged frame
Can not get VLAN_L2TERM from capability management
Can not get MAX_VLANS_PER_LSM from capability management
Association number execess the maximum value of board
Can not get VLAN_PORT_DEFAULT from capability management
This type board doesn't not support default vlan for port
Can not get VLAN_PORT_PROTO_PPPOE from capability management
This type board doesn't not support default PPPoE vlan for port
Can not get VLAN_PORT_PROTO_IPOE from capability management
This type board doesn't not support default IPoE vlan for port
Protocol port based vlan must be RB mode
No enough MAC entry in hardware
Not consistent with the previous association
Transmit mode is not consistent with the previous configuration
Frame type is not consistent with the previous configuration
Pvc bundle is not consistent with the previous configuration
RB vlan associate to the port already associated to QosAware vlan

3HH-01016-AAAA-TCZZA Edition 03

Released

885

Error List

Error
Number

Error Description

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

Vlan Type is invalid


PbitList conflict
This type board doesn't not support vlan stack
Invalid vlan mode
Vlan id used by PPPoAoE cant be delete by vlan module!
Static VLAN ram table entry exhausted
Invalid port based default vlan
Can not get MAX_VLANS_PER_DSL from capability management
The VlanId has been used
XCON Vlan can't use vlan id 1
Cc vlan can't share same id with none CC vlan
RB Vlan can't set SVlanID
if L2T Svlan %d is not exist,S/C vlan can't be created
Configured CBS is more than supported CBS
Configured CBS is less than supported CBS
Configured CIR is more than raw line rate
PVC's Encapstype is out of the supported encapstype type

Error list for LIAM


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Bad IP Pool Index.


Pool not configured.
Pool already configured.
Missing mandatory parameter.
Bad IP address value.
Bad address type.
Bad Pool name.
Wrong input of pool size.
Vrf is not configured.
Wrong subnet mask.
Unknown admin state.
Generic error due to system call.
Pool has addresses in use.
Pool has duplicate name.
Operational Error.

Error list for LUAM


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10
11
12

Invalid Input
Invalid Domain Range
Specified User doesn't exist
Memory allocation using inc_malloc failed
Invalid UserName Length
Missing Mandatory Parameter (Password)
Invalid Password Length
RowStatus cannot be set directly to Active
Invalid RowStatus Value
Error while writing to DM
Max. Number of users already configured
Same user already exists
Domain not configured

Error list for RADC

886

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

0
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54

Domain is using this policy. Detach it before attempting to delete\r\n


Policy name length is out of range \r\n
Policy NAS-ID length is out of range \r\n
Policy NAS-Ip-Addr-Type not supported \r\n
Policy NAS-Ip-Addr Octet string size out of range\r\n
Policy Stripping Domain boolean value out of range\r\n
Policy Bool flag boolean value out of range\r\n
Policy EAP boolean value out of range\r\n
The SET on policy failed..\r\n
policy index out of range/Row not created\r\n
policy index out of range \r\n
policy with the same index already exists..\r\n
policy name is mandatory and missing here..\r\n
policy NAS-ID or NAS-IP-addr is mandatory and missing here..\r\n
Row status active from operator is not supported.\r\n
Row status value not supported.\r\n
Modification is rejected because there is no policy with this index\r\n
Policy mapping name length is out of range \r\n
One of the Set Server value is wrong \r\n
policy index is out of range/policy not created\r\n
set index is out of range/set not created\r\n
policy index is out of range \r\n
set index is out of range \r\n
Set exists with the same index\r\n
Auth server index is mandatory\r\n
Priority is mandatory\r\n
Row status active is not allowed from operator\r\n
Row status value is not supported\r\n
Row itself doesn't exist to modify\r\n
policy index is out of range \r\n
Auth server is in use. First detach from set(s)\r\n
Server name size of out of range \r\n
IP addr type not supported \r\n
IP address octet string size is out of range \r\n
The SET on authServer failed..\r\n
auth index is out of range/server not created\r\n
auth index is out of range\r\n
Auth server with the same index exists\r\n
Auth server name is mandatory\r\n
Auth server vrf is mandatory\r\n
Auth server IP addr type is mandatory\r\n
Auth server IP addr is mandatory\r\n
Auth server secret is mandatory\r\n
Row status active is not accepted from operator\r\n
Row status value not supported\r\n
Row itslef doesn't exist. Modification request failed\r\n
auth index is out of range \r\n
Vrf ID out of range\r\n
Mapping name length out of range\r\n
Vrf Index out of range\r\n
Mapping name length out of range\r\n
Server being used. Detach from the Set first\r\n
Server name length out of range\r\n
Address type not supported\r\n
Address octet string size is out of range\r\n

3HH-01016-AAAA-TCZZA Edition 03

Released

887

Error List

Error
Number

Error Description

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

Secret size is out of range\r\n


The SET on acctServer failed..\r\n
acct index is out of range/server not created\r\n
Index is out of range\r\n
Row with the same index exists already\r\n
Server name is mandatory config. param.\r\n
Vrf Index is mandatory config. param.\r\n
Addr Type is mandatory config. param.\r\n
Address is mandatory config. param.\r\n
Secret is mandatory config. param.\r\n
Row status active is not allowed from operator\r\n
Row status value not supported\r\n
Row itself doesn't exist for modification\r\n
acct index is out of range \r\n
Vrf Index is out of range\r\n
Mapping name size is out of range\r\n
Vrf index is out of range\r\n
Mapping name size is out of range\r\n
Dyn auth client Name length is out of size\r\n
Addr Type is not supported\r\n
Addr octet string size is out of range\r\n
Secret size is out of size\r\n
The SET on DynAuthClient failed..\r\n
Index is out of range/Dyn Auth client not created\r\n
Index is out of range \r\n
Row with the same index exists already\r\n
Name is mandatory config. param. \r\n
Vrf Index is mandatory config. param.\r\n
Addr Type is mandatory config. param.\r\n
Address is mandatory config. param.\r\n
Secret size is out of range\r\n
Row status active is not supported from operator\r\n
Row status value is not supported\r\n
Row itself doesn't exist for modification\r\n
dyn auth index is out of range \r\n
Vrf ID is out of range \r\n
Mapping name length is out of range\r\n
Vrf Index is out of range\r\n
Mapping name size is out of range\r\n
Same index exists, deleting the record..\r\n
The retrieved record is not correct, deleting..\r\n
Server name length out of range\r\n
Vrf-ID out of range (or) not created \r\n
IP Address is not valid\r\n
UDP Port can't be more than 65535\r\n
Secret length out of range\r\n
Retry limit out of range\r\n
Timeout limit out of range\r\n
Admin state out of range\r\n
Dead Intvl out of range\r\n
Row status out of range\r\n
Server name not unique ..\r\n
IP address not unique ..\r\n
Same index exists, deleting the record..\r\n
The retrieved record is not correct, deleting..\r\n

888

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

Server name length out of range\r\n


Vrf-ID out of range (or) not created \r\n
IP Address is not valid\r\n
UDP Port can't be more than 65535\r\n
Secret length out of range\r\n
Retry limit out of range\r\n
Timeout limit out of range\r\n
Admin state out of range\r\n
Dead Intvl out of range\r\n
Row status out of range\r\n
Server name not unique ..\r\n
IP address not unique ..\r\n
Same index exists, deleting the record..\r\n
The retrieved record is not correct, deleting..\r\n
Server name length out of range\r\n
Vrf-ID out of range (or) not created \r\n
IP Address is not valid\r\n
Secret length out of range\r\n
Admin state out of range\r\n
Row status out of range\r\n
Server name not unique ..\r\n
IP address not unique ..\r\n
Same index exists, deleting the record..\r\n
The retrieved record is not correct, deleting..\r\n
policy name length out of range\r\n
NAS-ID length out of range\r\n
NAS-ID or NAS-IP-Address must be valid\r\n
Strip Domain flag is not valid\r\n
Boot flag is not valid\r\n
Acct Interim interval is not valid\r\n
EAP aware flag is not valid\r\n
Row status out of range\r\n
Policy name not unique ..\r\n
Same index exists, deleting the record..\r\n
The retrieved record is not correct, deleting..\r\n
auth server index is out of range \r\n
acct server index is out of range \r\n
priority value is out of range \r\n
Row status out of range\r\n
auth server is not configured (or) duplicate \r\n
acct server is not configured (or) duplicate \r\n
This priority is used already \r\n

Error list for AAAS MGT


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9

invalid input
persistent data update error
row not existing - connPolicyTable
row already existing - connPolicyTable
missing mandatory parameter - connPolicyProfileIndex
wrong value - not supported - connPolicyRowStatus
wrong index - out of range - connPolicyIfIndex
wrong value - out of range - connPolicyProfileIndex
row not existing - connProfileTable
row already existing - connProfileTable

3HH-01016-AAAA-TCZZA Edition 03

Released

889

Error List

Error
Number

Error Description

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
41
42
43
44
45
46
47
48
49

missing mandatory parameter - connProfileTable


wrong value - not supported - connProfileRowStatus
wrong index - out of range - connProfileIndex
wrong value - duplicate name - connProfileName
wrong value - out of range - connProfileVersionNbr
wrong value - ref object is not configured - connProfileDomainIndex
row not existing - domainTable
row already existing - domainTable
missing mandatory parameter - domainTable
wrong value - not supported - domainRowStatus
domainIndex is still in use by connProfileTable - domainTable
Active sessions are existing - domainTable
read only value - domainNumActiveSess
wrong value - out of range - domainName
wrong value - ref object is not configured - domainVrfIndex
wrong value - ref object is not configured - domainVlanIndex
wrong value - out of range - domainAddrType
wrong value - out of range - domainDnsIpAddr1
wrong value - out of range - domainDnsIpAddr2
wrong value - out of range - domainNbnsIpAddr1
wrong value - out of range - domainNbnsIpAddr2
wrong value - out of range - domainSessionTimeout
wrong value - out of range - domainQosProfileIndex
wrong value - ref object is not configured - domainQosProfileIndex
wrong value - out of range - domainAuthenticator
wrong value - ref object is not configured - domainRadPolicyIndex
wrong value - out of range - domainAdminState
wrong value - duplicate name - domainName
row not existing - connProfileMappingTable
row not existing - domainUserSessTable
row not existing - domainMappingTable
row not existing - domainIpPoolTable
wrong value - ref object is not configured - domainIndex
row already existing - domainIpPoolTable
missing mandatory parameter - domainIpPoolTable
wrong value - not supported - domainIpPoolRowStatus
wrong value - out of range - domainIpPoolPriority
wrong value - duplicate value - domainIpPoolPriority
connection profile is in use by connPolicyTable - connProfileTable
read only value - connProfileUsedStatus

Error list for USERIPMGNT


Error
Error Description
Number
0
1
2
3
4
5
6
7
8
9
10
11

890

VRF index is out of range


VRF is reserved
VRF exists
VRF does not exist
VRF name already exist
Invalid system IP address
System IP address already reserved
field from VRF config table out of range
field from VRF config table not supported
Client Using this VRF
Entry in IP address table does not exist
Entry in IP address table already exists

Released

3HH-01016-AAAA-TCZZA

Edition 03

Error List

Error
Number

Error Description

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

Invalid IP address specified for IP address table


Invalid prefix length specified
Invalid IP address / prefix length combination specified
invalid IfIndex for IP address table specified
IfIndex should not be emptye
field from IP address table out of range
field from IP address table table not supported
Maximum number of routes reached for IP address table
IPaddress is equal to next hop ip address of CIDR table
CIDR route table entry already exists
CIDR route table entry doesn't exist
Invalid route destination for CIDR route table
Invalid prefix length for CIDR route table
Invalid next hop address specified
Next hop address does not match a direct route
nexthop indicated IfIndex not match specified IfIndex
Invalid IfIndex in CIDR route table
field from CIDR route table out of range
field from CIDR route table not supported
Maximum number of routes reached for CIDR route table
Next hop IP address is same as system IP address
Invalid ThisLayerIndex
Invalid LowerLayerIndex
Maximum number of IPOX interface entries reached
Maximum number of ThisLayerIndex reached
Maximum number of LowLayerIndex per ThisLayerIndex reached
Invalid key specified for IpNetToMedia table
Entry not found in IpNetToMedia table
field from IpNetToMedia table out of range
Set Request valid only for Delete Entry
field from IpNetToMedia table not supported
Active PPPoE sessions present
Invalid Ifindex
UnnumberedFlag not specified
QoSProfileId should be zero for networkside interface
arp policy for userside/usergateway ip interface should be none
only one vrf in router mode can be created
the vrf is in use by ip interface table
the vrf is in use by ipaddress table or cidr table
the IPoX is in use by ip interface table
the IP interface is in use by ip address table
interface type not IPoX
the IP interface is in use by cidr table
vrf is routermode, only on netside ip interface supported
the ip address used by cidr table
the IP interface already exist
the IP interface not exist
the Maximum number of IP interface reached
nexhop interface should be specified if nexthop ip address is zero
can't configure ip address on unnumbered interace
the specified ip interace doesn't belong to the specified vrf
userside cidr route must belong to usergateway
userside cidr route type must be local
local route's nexthop must be zero
user side cidr dest can't be the same with ip address or networkside cidr route dest/nexthop or system IP

3HH-01016-AAAA-TCZZA Edition 03

Released

891

Error List

Error
Number

Error Description

67
68
69
70
71
72
73
74
75
76
77
78
79

IPoX interface not exist


IPoX interface with the lowerlayer ifindex already exist
arp for networkside ip interface in routermode vrf should be trusted
arp for networkside ip interface in forwarder mode vrf should be trusted or not Trusted
networkside ip interface for routermode vrf should be unnumbered
QoSProfileId not exist or qos required can't be satisfied
can't change ip interface If index
can't change ip interface unnumbered flag
no statistics on network side interface
slot unreachable
an ip address already created on the ip interface
an cidr entry with the same network number exists
only userside direct host route to the unnumbered IP interface on the user side can be created for router
mode vrf
only one default route can be created for each vrf
a direct route from ip address table exist
Next Hop overlaps with one of IpAddrs in ip address table
prefixlen for cidr to userside interface must be 32
nexthop interface not specified
the nexthop of an cidr entry belong this network but the nexthop interface is different
create direclty connected networkside route is not permitted
a same route with a different next hop already exist
the specified IfIndex is not valid
the speicified IfIndex is not network/userside ip interface
the vlan on which ip interafce created is used by dhcp
vrf mode could not be changed
nexhop is zero, routeType must be local
userside ip interface should be unnumbered interface
usergateway ip interface should be numbered interface
arppolicy not specified
vrf can't be changed
CIDR route can't be changed

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

892

Released

3HH-01016-AAAA-TCZZA

Edition 03

Abbreviations

Abbreviations
IP Internet protocol
SNMP simple network management protocol

3HH-01016-AAAA-TCZZA Edition 03

Released

893

Abbreviations

894

Released

3HH-01016-AAAA-TCZZA

Edition 03

Index

Index
ABCDEFGHIJKLMNOPQRSTUVWX
auth-type
autofetch
availability

A
aaa
aal5-encap-type
abr-type
accept-expires
accept-frame-type
accept-starts
acc-interval
acc-server
acc-server-state
acc-stats
ack
action
activate
actor-key
actor-port-prio
actor-sys-prio
address
admin-p2p
admin-status
adsl2-plus
adsl-adsl2
ageing-time
agent
agent-ip-addr
aggregate-addr
aggregate-list
aggregation
aggregator-info
aggregator-port
alarm
alarm-changes
applique
area
area-id
arp
arp-policy
asbr-external
atm
atm-overhead-fact
atm-peak-bit-rate
atm-pvc
atm-sus-bit-rate
authentication
authenticator
auth-server
auth-stats

3HH-01016-AAAA-TCZZA Edition 03

133
83
275
836
220
279
153
150
793
791
111
31
828
228
228
228
819
232
57
72
68
219
269
273
282
532
304
529
228
38
423
56
276
766
195
198
767
133
234
185
88
185
277
139
148
788

266
165
669

B
back
bcast-vlan
board
bonding-group
bonding-mode
boot-rom
boot-rom-status
bridge
bridgeport
bridge-port
bridge-port-fdb
burst-size

27
269
629
363
77
834
703
219
202
489
497
255

C
cac
cache-pending
cache-refresh
cache-retry-time
cache-timeout
cac-profile
capacity
carrier-data-mode
carrier-mask-down
carrier-mask-up
cc-max-age
cfg-res-time
channel
circuit-id
class
client-port
cluster
codepoint
coll-count
commands
committed-burst-size
committed-info-rate
community
community-string
config-control
config-file
configure

246
195
195
195
195
250
184
77
65
65
259
184
174
207
61
262
133
238
736
14
243
243
136
52
677
702
30

Released

895

Index

configure-lock
connection
conn-policy
conn-profile
conn-profile-name
contact
contact-person
context-lifetime
controlled-port
copy-to-port
count
counter
cpe-inventory
cpeproxy
critical
crit-log-full-act
cross-connect
current-15min
current-15min-stats
current-1day
current-day-stats
current-interval
custom
customer-id

860
642
144
143
144
125
101
273
157
842
867
706
628
311
440
43
490
553
513
557
515
604
366
88

D
d1p
d1p-alignment
d1p-dscp
d1p-dscp-contract
database
dead-interval
default-dot1p
default-dscp
default-metric
default-priority
default-route
default-severity
default-ttl
def-gateway
definition
def-ip-addr
delete
delta-log
desc
description
descriptor-files
dest
dest-ip-address
dest-proto
dhcp
diagnostics
direction
discard
disk-file
domain
domain-name

896

235
242
241
239
692
148
235
236
300
220
104
89
169
124
47
124
28
43
187
59
693
578
573
192
133
802
107
34
830
139
143

Released

dot1p-value
dot3-coll
dot3-control
dot3-pause
dot3-status
download
download-set
down-policer
dscp
dscp-contract
dscp-map-dot1p
dscp-value
dsl-bandwidth
dsl-port
dst-ip-addr
dup-mac
dup-mac-alarm
dup-vlan-id
dyn-auth-client
dyn-authclient-stats

239
736
737
738
740
828
165
247
236
237
252
238
549
250
107
502
502
502
152
794

E
eapol-stats
echo
egress-port
egress-rate
engine
entry
environment
eo-conversion
eps-quenchfactor
eqpt-holder
equipment
error
es-day-farend
es-day-nearend
es-farend
es-nearend
ether-dot3
ether-ifmau
ether-itf
ethernet
ether-shape-rate
eth-shub
exec
exit
expires
ext-authenticator
ext-vlan-id

800
17
214
253
260
39
36
359
57
336
133
99
80
80
80
80
731
734
344
449
101
454
19
26
303
159
127

F
f5-loopback-ete
far-end
fdb
fifteen-min

3HH-01016-AAAA-TCZZA

816
352
495
471

Edition 03

Index

file-board-type
file-name
filter
flow
forward-delay
forward-port

697
697
170
256
231
209

G
general
generate-expires
generate-starts
global
global-session
group
group-profile

183
836
279
488
259
96
307

159
278
231
24
16
581
273
103
178
176

I
icmp
id
if-table
igmp
igs-system
igs-vlan-grp
imp-noise-prot-dn
imp-noise-prot-up
in
indeterminate
indet-log-full-action
index
info
in-port
interface
interval-no
interval-num
interval-number
intvl-number
ip
ip-addr
ip-address
ip-addr-pool
ip-cfg-mode
ip-net-to-media

3HH-01016-AAAA-TCZZA Edition 03

418
720
141
786
722
566
59
766
277

J
junk-collection

302

K
keep-alive-intvl
key

H
handshake-period
hello-interval
hello-time
help
history
hop
hops-threshold
host-ip-address
host-purge-intv
host-report-intv

ipox
ip-parameters
ip-pool
ip-pool-status
ip-route
ip-statistics
isam
itf-ip-addr
itf-type

93
101
643
133
178
750
63
63
29
424
43
734
25
109
277
608
551
509
475
91
92
148
145
124
724

266
279

L
la
lacp-mode
last-max-resp-tim
last-memb-cnt
layer2-terminated
layer3-itf
learned-unicast-mac
leave-rsp-timer
license
line
link-type
local-port
location
log
log-entry
log-full-action
logical-flow-type
login-banner
logout
log-sev-level
loop-diagnostic
lower
lsa-type

227
228
176
176
493
190
844
179
683
77
766
730
101
814
687
38
247
130
15
38
825
663
295

M
mac
mac-address
mac-filter
major
major-log-full-action
management
manager
marker
mask
match

495
654
170
436
43
103
49
544
772
868

Released

897

Index

max-age
max-agpowlev-down
max-agpowlev-up
max-bitrate
max-bitrate-down
max-bitrate-up
max-cc
max-delay-down
max-delay-up
max-dst-port
max-ingress-rate
max-mcast-bandwidth
max-nbr-pkts
max-noise-down
max-noise-up
max-num-group
max-num-session
max-num-uncfg
max-pad-attempts
max-peer
max-per-window
max-psd-down
max-psd-up
max-queue-size
max-recv-power-up
max-req
max-retries
max-retry-itvl
max-rsp-time
max-src-port
max-ttl
max-unicast-mac
mcast-addr
mcast-mac
mcast-src
md5-key
mean-bit-rate
mem-query-int
meter
metric
metric-type
mgnt-vlan-id
min-bitrate-down
min-bitrate-up
min-dst-port
min-interval
min-length
min-noise-down
min-noise-up
min-num-numeric-char
min-num-special-char
minor
minor-log-full-action
min-severity
min-src-port
min-ttl
misc
miscellaneous

898

Released

231
68
68
183
63
63
262
63
63
111
255
246
172
65
65
174
267
184
259
299
49
68
68
49
68
157
195
195
176
111
852
220
709
216
819
279
183
176
255
194
283
101
63
63
111
49
161
65
65
161
161
432
43
49
111
852
347
708

mixed-case
mode
modification
module
module-mcast-src
monitor
more
msg-code
msg-type
mtu
mtu-size
my-ipaddress

161
94
65
820
709
261
871
107
107
90
852
187

N
name
nas-id
nas-ip-address
nbr-changed-alarms
near-end
neighbour
network
network-addr
network-port
network-port-info
next-free-index
next-hop
next-hop-address
no-more
non-itf-rep-sev-level
nssa-area
number-addr

63
153
153
459
349
770
197
724
180
533
796
189
573
872
38
289
787

O
one-day
operator
optional-band
optional-endfreq
ospf
oswp
oswp-number
out-port
overflow-state-it

473
131
74
74
275
165
692
110
275

P
package
pado-timeout
pads-timeout
pae
participant-port
password
password-timeout
path-cost
path-cost-type
peer

3HH-01016-AAAA-TCZZA

175
259
259
156
532
131
133
232
231
772

Edition 03

Index

perm-pkg-bitmap
phy-addr
phy-itf-status
ping
pkg-memb-bitmap
pkg-mem-bitmap
plan-bitrate-down
plan-bitrate-up
planned-type
plug-in-unit
policer
policy
poll
polling-rate
poll-interval
port
port-15min-stats
port-curr-15min-stats
port-curr-day-stats
port-details
port-event
port-filter
port-info
port-prev-day-stats
port-protocol
port-to-atm-pvc
port-type
port-vlan-map
ppoe
pppoe
pppox-interface
ppp-profile
ppp-profile-name
ppp-statistics
prev-15min
prev-1day
previous-15min-stats
previous-1day
previous-interval
primary-dns
primary-file-server-id
primary-nbns
print
prio-regen-prof
priority
priority-policy
priority-regen
privilege
profile
profiles
prompt
protection-element
protection-group
protocol
protocol-filter
protocol-group
protocol-type
proxy-mode

3HH-01016-AAAA-TCZZA Edition 03

174
856
657
864
183
185
63
63
55
339
243
153
22
105
278
86
509
505
507
807
503
119
538
511
210
482
94
499
133
265
267
266
267
645
551
555
517
610
608
139
165
139
36
220
47
206
500
136
131
583
36
58
57
119
207
210
170
311

psd-shape-down
psd-shape-up
pvc
pvid

74
74
83
220

Q
qos
qos-policy
qos-profile
query-interval
query-timer
queue
queue0-weight
queue1-weight
queue-config
queue-profile
quiet-period

133
139
201
176
180
244
253
253
253
251
157

R
rack
radius
radius-client
ra-mode-down
ra-mode-up
rate
rate-limit
re-adsl
reassem-timeout
reboot
reboot-isam
reboot-shub
receive
recv-psd-shape-up
redcy-ctrl-status
redistribution
redundancy
remote-id
report-fwd-intv
res-data-bandwidth
reserve-address
reset
residential-bridge
response-timer
res-voice-bandwidth
retransmit-itvl
retry-limit
rf-band-list
rip
robustness
route-age-out
route-dest
route-destination
route-map
router-id
router-priority

60
147
797
63
63
745
172
70
187
841
840
840
301
74
58
296
365
207
178
246
146
851
489
179
246
278
148
65
299
176
302
189
297
192
275
277

Released

899

Index

router-purge-intv
route-type
routing-table
rst
rstp
rx-pkt

178
193
772
111
231
648

S
sample
scheduler
scheduler-profile
second-dns
second-file-server-id
second-nbns
secret
secs-threshold
security
select-config
self-ip-addr
self-ip-addr-mode
send
server
server-ip-addr
server-name
server-port
servers
server-timeout
service-name
service-profile
ses-day-farend
ses-day-nearend
ses-farend
ses-nearend
session
session-stats
sess-timeout
set-log-table
severity
shelf
shelf-summary
show
shub
shub-dup-mac-alarm
shub-fdb
shub-filter-entry
shub-gen
shub-info
shub-manager
shub-port-vlan-map
shub-time
shub-vlan-name
size
sleep
slot
snap-shot
snmp
snmp-version

900

32
245
250
139
165
139
148
273
130
831
178
178
301
272
105
265
105
155
157
185
63
80
80
80
80
247
805
139
686
39
61
319
33
224
527
523
525
452
483
123
521
858
522
145
20
55
811
725
52

Released

sntp
software
software-mngt
source-proto
spectrum-profile
split-horizon
src
src-ip-addr
src-ip-address
stack
stacked-qos-vlan
stacked-vlan
start-addr
starts
state
statistics
stats
status
stub-area
sub-index
supp-timeout
sw-mgmt
swp
sw-package
swp-disk-file
sw-release-num
sw-ver-name
system
system-mac
system-parameters
system-time

105
126
133
192
65
301
185
107
176
663
492
491
145
303
790
773
647
128
283
305
157
345
696
833
697
126
126
101
101
728
858

T
table
tc-15min-int
tc-1day-int
tca-line-threshold
tca-xdsl
tc-int
tc-map-dot1p
tcp
tee
telnet
template-name
template-version
terminal-timeout
test
threshold
time
timeout
timeout-limit
time-out-value
timers
tos
total
traceroute
trace-selection

3HH-01016-AAAA-TCZZA

332
475
477
80
355
470
249
111
869
18
175
175
36
661
96
713
852
148
163
278
111
559
581
178

Edition 03

Index

traffic-class
transaction
transit-delay
trans-itvl
translation
trans-max-age
transport
tree
trgt-noise-down
trgt-noise-up
tries
tx-hold-count
tx-period
tx-pkt

254
163
278
289
289
259
133
21
65
65
864
231
157
650

U
uas-day-farend
uas-day-nearend
uas-farend
uas-nearend
udp
udp-parameters
udp-port
uncfg-res-time
unicast-mac
untag-port
update-timer
uplink-group
upload
upload-download
up-marker
up-policer
user
user-port
user-session

80
80
80
80
115
729
311
184
209
215
302
458
829
699
247
247
86
854
783

vrf-next-index
vrf-route
vrf-statistics

576
573
565

W
warning
warn-log-full-action
welcome-banner
wfq-q1-weight
window-size
write

428
43
130
245
49
23

X
xdsl
xdsl-int
xdsl-line

133
584
825

V
value
vdsl
vdsl-band-plan
version
vlan
vlan-bind
vlan-day-stats
vlan-filter
vlan-id
vlan-router-port
vrf
vrf-agent-stats
vrf-id
vrf-index
vrf-index-acc
vrf-index-auth
vrf-mapping
vrf-media

3HH-01016-AAAA-TCZZA Edition 03

193
74
74
63
127
190
519
181
90
180
187
748
91
139
155
155
575
574

Released

901

Index

902

Released

3HH-01016-AAAA-TCZZA

Edition 03

Released

3HH-01016-AAAA-TCZZA

Edition 03

You might also like